Skip to content

FIX: Test Exclusions for 5.2 & update README #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 8, 2025
Merged

FIX: Test Exclusions for 5.2 & update README #469

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10673cd
FIX: Test Exclusions for 5.2 & update README
bewithgaurav Aug 7, 2025
fe87de0
remove duplication
bewithgaurav Aug 7, 2025
693503e
Merge branch 'dev' into bewithgaurav/fix_tests_readme
bewithgaurav Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.

## Features

- Supports Django 3.2, 4.0, 4.1, 4.2 and 5.0
- Supports Django 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, and 5.2
- **Django 5.0 and below**: Full production support
- **Django 5.1**: Supported with minor limitations (composite primary key inspectdb)
- **Django 5.2**: Supported with enhanced SQL Server compatibility features and documented limitations (see Django 5.2 Specific Limitations section below)
- Tested on Microsoft SQL Server 2016, 2017, 2019, 2022
- Passes most of the tests of the Django test suite
- Enhanced SQL Server compatibility with automatic schema creation and improved identifier quoting
- Compatible with
[Micosoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server),
[SQL Server Native Client](https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx),
Expand Down Expand Up @@ -273,6 +277,42 @@ The following features are currently not fully supported:
- Date extract function
- Bulk insert into a table with a trigger and returning the rows inserted

### Django 5.1 Specific Limitations

Django 5.1 introduces composite primary key support which has limited compatibility with SQL Server:
- **inspectdb command**: Cannot properly inspect tables with composite primary keys
- **Backend debugging**: SQL execution wrapper debug functionality may not work correctly
- **Schema operations**: Some field unique constraint removal operations may have issues
- Most other Django 5.1 features work correctly with SQL Server

### Django 5.2 Specific Limitations

Django 5.2 introduces new features that may cause regressions for existing Django 5.0+ applications. This release includes enhanced SQL Server compatibility for Django 5.2, with automatic schema creation and improved identifier quoting. The following limitations remain:

**Critical Limitations (May Affect Common Use Cases):**
- **Tuple lookups**: Queries like `Model.objects.filter((col1, col2)__in=[(val1, val2)])` will fail with SQL syntax errors as SQL Server doesn't support `(col1, col2) IN (...)` syntax
- **Multi-column foreign key relationships**: Complex queries involving foreign keys with multiple columns may fail in Django 5.2 due to tuple lookup generation
- **JSONField with special characters**: JSONField lookups involving special characters (quotes, emojis, escape sequences) may generate invalid SQL
- **JSONField bulk updates**: Bulk update operations on JSONField with null handling may fail

**Moderate Impact:**
- **Complex aggregations**: Some aggregation queries with filtered references and subqueries may not work correctly
- **Prefetch operations**: `prefetch_related()` operations on multi-column foreign keys may fail

**Low Impact (Edge Cases):**
- **Migration operations**: Advanced migration operations involving composite primary keys and generated fields
- **Backend debugging**: Certain backend debugging and introspection features
- **JSONField CASE WHEN updates**: JSONField updates using CASE WHEN expressions with null handling

**Specific Test Failures in Django 5.2:**
- All `foreign_object.test_tuple_lookups.TupleLookupsTests.*` tests
- All `foreign_object.tests.MultiColumnFKTests.*` tests involving complex queries
- `model_fields.test_jsonfield.TestQuerying.test_lookups_special_chars*` tests
- `queries.test_bulk_update.BulkUpdateTests.test_json_field_sql_null` test
- Various migration and backend debugging tests

**Workaround**: These limitations are documented in the test exclusions (`testapp/settings.py`) and are excellent candidates for community contributions. Applications using Django 5.0 and below are unaffected by these limitations.

JSONField lookups have limitations, more details [here](https://github.com/microsoft/mssql-django/wiki/JSONField).

## Contributing
Expand Down
89 changes: 84 additions & 5 deletions testapp/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@
USE_TZ = False

TEST_RUNNER = "testapp.runners.ExcludedTestSuiteRunner"

# Test exclusions for features not supported by SQL Server or requiring special handling
# Community contributions welcome to implement these features incrementally
EXCLUDED_TESTS = [
'aggregation_regress.tests.AggregationTests.test_annotation_with_value',
'aggregation.tests.AggregateTestCase.test_distinct_on_aggregate',
Expand Down Expand Up @@ -289,13 +292,89 @@
'queries.test_qs_combinators.QuerySetSetOperationTests.test_union_with_select_related_and_order',
'expressions_window.tests.WindowFunctionTests.test_limited_filter',
'schema.tests.SchemaTests.test_remove_ignored_unique_constraint_not_create_fk_index',

# Generated field 5.0.6 tests
'migrations.test_operations.OperationTests.test_invalid_generated_field_changes_on_rename_virtual',
'migrations.test_operations.OperationTests.test_invalid_generated_field_changes_on_rename_stored',


]

# Django 5.0 specific exclusions - these tests fail due to SQL Server limitations
if VERSION >= (5, 0):
EXCLUDED_TESTS.extend([
# Generated field 5.0.6 tests
'migrations.test_operations.OperationTests.test_invalid_generated_field_changes_on_rename_virtual',
'migrations.test_operations.OperationTests.test_invalid_generated_field_changes_on_rename_stored',
])

# Django 5.1 specific exclusions - these tests fail due to SQL Server limitations
if VERSION >= (5, 1):
EXCLUDED_TESTS.extend([
# Composite primary key tests - not supported in SQL Server
'inspectdb.tests.InspectDBTransactionalTests.test_composite_primary_key',

# Backend and schema test failures that appear in Django 5.1
# TODO: Fix SQL Server specific backend behavior
'backends.base.test_base.ExecuteWrapperTests.test_wrapper_debug',
'indexes.tests.SchemaIndexesTests.test_alter_field_unique_false_removes_deferred_sql',
])

# Django 5.2 specific exclusions - tuple lookups not supported in SQL Server
# These are good candidates for community contributions - see GitHub issues
if VERSION >= (5, 2):
EXCLUDED_TESTS.extend([
# Tuple lookup tests - SQL Server doesn't support (col1, col2) IN syntax
# TODO: Implement tuple lookup handling for SQL Server compatibility
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_exact',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_gt',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_gte',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_in',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_lt',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_lte',
'foreign_object.test_tuple_lookups.TupleLookupsTests.test_tuple_in_subquery',
'foreign_object.test_agnostic_order_trimjoin.TestLookupQuery.test_deep_mixed_backward',

# inspectdb tests that expect specific table structures in inspectdb_special/pascal schemas
'inspectdb.tests.InspectDBTestCase.test_custom_normalize_table_name',
'inspectdb.tests.InspectDBTestCase.test_special_column_name_introspection',
'inspectdb.tests.InspectDBTestCase.test_table_name_introspection',

# Multi-column foreign key tests with tuple lookups - also affected by SQL Server limitations
# TODO: Fix tuple lookup generation for multi-column FKs
'foreign_object.tests.MultiColumnFKTests.test_double_nested_query',
'foreign_object.tests.MultiColumnFKTests.test_forward_in_lookup_filters_correctly',
'foreign_object.tests.MultiColumnFKTests.test_prefetch_foreignobject_forward',
'foreign_object.tests.MultiColumnFKTests.test_prefetch_foreignobject_hidden_forward',
'foreign_object.tests.MultiColumnFKTests.test_prefetch_foreignobject_reverse',
'foreign_object.tests.MultiColumnFKTests.test_prefetch_related_m2m_forward_works',
'foreign_object.tests.MultiColumnFKTests.test_prefetch_related_m2m_reverse_works',
'foreign_object.tests.MultiColumnFKTests.test_reverse_query_returns_correct_result',

# JSONField special character handling - SQL Server specific syntax issues
# TODO: Fix JSONField key escaping for special characters
'model_fields.test_jsonfield.TestQuerying.test_lookups_special_chars',
'model_fields.test_jsonfield.TestQuerying.test_lookups_special_chars_double_quotes',

# JSONField bulk update with null handling
# TODO: Fix bulk update SQL generation for JSONField null values
'queries.test_bulk_update.BulkUpdateTests.test_json_field_sql_null',

# Migration and composite primary key issues
# TODO: Implement composite primary key support
'migrations.test_operations.OperationTests.test_composite_pk_operations',
'migrations.test_operations.OperationTests.test_generated_field_changes_output_field',

# Backend and schema test failures
# TODO: Fix SQL Server specific backend behavior
# 'backends.base.test_base.ExecuteWrapperTests.test_wrapper_debug', # Removed duplicate; now only in Django 5.2+ block
'indexes.tests.SchemaIndexesTests.test_alter_field_unique_false_removes_deferred_sql',

# Aggregation with filtered references
# TODO: Fix complex aggregation queries with outer references
'aggregation.test_filter_argument.FilteredAggregateTests.test_filtered_aggregrate_ref_in_subquery_annotation',

# JSONField test failures
# TODO: Fix JSONField update with CASE WHEN handling
'expressions.tests.BasicExpressionsTests.test_update_jsonfield_case_when_key_is_null',

])

REGEX_TESTS = [
'lookup.tests.LookupTests.test_regex',
'lookup.tests.LookupTests.test_regex_backreferencing',
Expand Down
Loading