add support for sqlmigrate

Author: timgraham

django_mongodb/features.py

@@ -670,15 +670,6 @@ def django_test_expected_failures(self):
             "migrations.test_commands.MigrateTests.test_migrate_fake_split_initial",
             "migrations.test_executor.ExecutorTests.test_soft_apply",
         },
-        "SchemaEditor doesn't log or collect queries.": {
-            # https://github.com/mongodb-labs/django-mongodb/issues/141
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_backwards",
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_for_non_atomic_migration",
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_for_non_transactional_databases",
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_forwards",
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_replaced_migration",
-            "migrations.test_commands.MigrateTests.test_sqlmigrate_squashed_migration",
-        },
     }
 
     @cached_property

django_mongodb/schema.py

@@ -1,13 +1,18 @@
 from django.db.backends.base.schema import BaseDatabaseSchemaEditor
 
 from .query import wrap_database_errors
+from .utils import OperationCollector
 
 
 class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
     def get_collection(self, name):
+        if self.collect_sql:
+            return OperationCollector(self.collected_sql, collection=self.connection.database[name])
         return self.connection.get_collection(name)
 
     def get_database(self):
+        if self.collect_sql:
+            return OperationCollector(self.collected_sql, db=self.connection.database)
         return self.connection.get_database()
 
     @wrap_database_errors

django_mongodb/utils.py

@@ -26,6 +26,17 @@ def check_django_compatability():
 
 
 class OperationDebugWrapper:
+    # The PyMongo database and collection methods that this backend uses.
+    wrapped_methods = {
+        "aggregate",
+        "create_collection",
+        "drop",
+        "insert_many",
+        "delete_many",
+        "rename",
+        "update_many",
+    }
+
     def __init__(self, db, collection=None):
         self.collection = collection
         self.db = db
@@ -82,13 +93,34 @@ def wrapper(self, *args, **kwargs):
 
         return wrapper
 
-    # These are the operations that this backend uses.
-    aggregate = logging_wrapper("aggregate")
-    create_collection = logging_wrapper("create_collection")
-    drop = logging_wrapper("drop")
-    insert_many = logging_wrapper("insert_many")
-    delete_many = logging_wrapper("delete_many")
-    rename = logging_wrapper("rename")
-    update_many = logging_wrapper("update_many")
 
-    del logging_wrapper
+if hasattr(OperationDebugWrapper, "logging_wrapper"):
+    for attr in OperationDebugWrapper.wrapped_methods:
+        setattr(OperationDebugWrapper, attr, OperationDebugWrapper.logging_wrapper(attr))
+    del OperationDebugWrapper.logging_wrapper
+
+
+class OperationCollector(OperationDebugWrapper):
+    def __init__(self, collected_sql=None, *, collection=None, db=None):
+        super().__init__(db, collection)
+        self.collected_sql = collected_sql
+
+    def log(self, op, args, kwargs=None):
+        # If kwargs are used by any operations in the future, they must be
+        # added to this logging.
+        args = ", ".join(repr(arg) for arg in args)
+        collection_name = f"{self.collection.name}." if self.collection is not None else ""
+        operation = f"db.{collection_name}{op}({args})"
+        self.collected_sql.append(operation)
+
+    def logging_wrapper(method):
+        def wrapper(self, *args, **kwargs):
+            self.log(method, args, kwargs)
+
+        return wrapper
+
+
+if hasattr(OperationCollector, "logging_wrapper"):
+    for attr in OperationCollector.wrapped_methods:
+        setattr(OperationCollector, attr, OperationCollector.logging_wrapper(attr))
+    del OperationCollector.logging_wrapper