Merge branch 'mongodb-labs:main' into INTPYTHON-348

Author: aclark4life

.github/workflows/test-python.yml

@@ -63,6 +63,7 @@ jobs:
           dates
           datetimes
           db_functions
+          dbshell_
           delete
           delete_regress
           empty

README.md

@@ -19,7 +19,7 @@ You can create a new project that's configured based on these steps using a
 project template:
 
 ```bash
-$ django-admin startproject mysite --template https://github.com/aclark4life/django-mongodb-project/archive/refs/heads/5.0.x.zip
+$ django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip
 ```
 (where "5.0" matches the version of Django that you're using.)
 
@@ -97,7 +97,7 @@ Alternatively, you can use the following `startapp` template which includes
 this change:
 
 ```bash
-$ python manage.py startapp myapp --template https://github.com/aclark4life/django-mongodb-app/archive/refs/heads/5.0.x.zip
+$ python manage.py startapp myapp --template https://github.com/mongodb-labs/django-mongodb-app/archive/refs/heads/5.0.x.zip
 ```
 (where "5.0" matches the version of Django that you're using.)
 

django_mongodb/fields/auto.py

@@ -34,6 +34,9 @@ def get_prep_value(self, value):
     def db_type(self, connection):
         return "objectId"
 
+    def rel_db_type(self, connection):
+        return "objectId"
+
     def to_python(self, value):
         if value is None or isinstance(value, int):
             return value

pyproject.toml

@@ -37,7 +37,6 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-test = ["pytest>=7"]
 docs = [ "sphinx>=7"]
 
 [project.urls]
@@ -49,18 +48,6 @@ Tracker = "https://github.com/mongodb-labs/django-mongodb/issues"
 [tool.setuptools.dynamic]
 version = {attr = "django_mongodb.__version__"}
 
-[tool.pytest.ini_options]
-minversion = "7"
-addopts = ["-ra", "--strict-config", "--strict-markers", "--junitxml=xunit-results/TEST-results.xml"]
-testpaths = ["test"]
-log_cli_level = "INFO"
-norecursedirs = ["test/*"]
-faulthandler_timeout = 1500
-xfail_strict = true
-filterwarnings = [
-    "error"
-]
-
 [tool.mypy]
 strict = true
 show_error_codes = true
@@ -87,7 +74,6 @@ select = [
   "PGH",         # pygrep-hooks
   "PIE",         # flake8-pie
   "PL",          # pylint
-  "PT",          # flake8-pytest-style
   "PTH",         # flake8-use-pathlib
   "RET",         # flake8-return
   "RUF",         # Ruff-specific

test/test_basic.py

@@ -0,0 +1,116 @@
+import signal
+from unittest import mock
+
+from django.db import connection
+from django.test import SimpleTestCase
+
+from django_mongodb.client import DatabaseClient
+
+
+class MongoDbshellTests(SimpleTestCase):
+    def settings_to_cmd_args_env(self, settings_dict, parameters=None):
+        if parameters is None:
+            parameters = []
+        return DatabaseClient.settings_to_cmd_args_env(settings_dict, parameters)
+
+    def test_fails_with_keyerror_on_incomplete_config(self):
+        with self.assertRaises(KeyError):
+            self.settings_to_cmd_args_env({})
+
+    def test_basic_params_specified_in_settings(self):
+        for options_parameters in [(None, None, None), ("value1", "value2", True)]:
+            with self.subTest(keys=options_parameters):
+                authentication_database, authentication_mechanism, retry_writes = options_parameters
+                if authentication_database is not None:
+                    expected_args = [
+                        "mongosh",
+                        "--host",
+                        "somehost",
+                        "--port",
+                        444,
+                        "--username",
+                        "someuser",
+                        "--password",
+                        "somepassword",
+                        "--retryWrites",
+                        "true",
+                        "somedbname",
+                    ]
+                else:
+                    expected_args = [
+                        "mongosh",
+                        "--host",
+                        "somehost",
+                        "--port",
+                        444,
+                        "--username",
+                        "someuser",
+                        "--password",
+                        "somepassword",
+                        "somedbname",
+                    ]
+
+                self.assertEqual(
+                    self.settings_to_cmd_args_env(
+                        {
+                            "NAME": "somedbname",
+                            "USER": "someuser",
+                            "PASSWORD": "somepassword",
+                            "HOST": "somehost",
+                            "PORT": 444,
+                            "OPTIONS": {
+                                "authenticationDatabase": authentication_database,
+                                "authenticationMechanism": authentication_mechanism,
+                                "retryWrites": retry_writes,
+                            },
+                        }
+                    ),
+                    (expected_args, None),
+                )
+
+    def test_options_override_settings_proper_values(self):
+        settings_port = 444
+        options_port = 555
+        self.assertNotEqual(settings_port, options_port, "test pre-req")
+        expected_args = [
+            "mongosh",
+            "--host",
+            "settinghost",
+            "--port",
+            444,
+            "--username",
+            "settinguser",
+            "--password",
+            "settingpassword",
+            "settingdbname",
+        ]
+        expected_env = None
+
+        self.assertEqual(
+            self.settings_to_cmd_args_env(
+                {
+                    "NAME": "settingdbname",
+                    "USER": "settinguser",
+                    "PASSWORD": "settingpassword",
+                    "HOST": "settinghost",
+                    "PORT": settings_port,
+                    "OPTIONS": {"port": options_port},
+                }
+            ),
+            (expected_args, expected_env),
+        )
+
+    def test_sigint_handler(self):
+        """SIGINT is ignored in Python and passed to Mongodb to abort queries."""
+
+        def _mock_subprocess_run(*args, **kwargs):  # noqa: ARG001
+            handler = signal.getsignal(signal.SIGINT)
+            self.assertEqual(handler, signal.SIG_IGN)
+
+        sigint_handler = signal.getsignal(signal.SIGINT)
+        # The default handler isn't SIG_IGN.
+        self.assertNotEqual(sigint_handler, signal.SIG_IGN)
+        with mock.patch("subprocess.run", new=_mock_subprocess_run):
+            connection.client.runshell([])
+        # dbshell restores the original handler.
+        self.assertEqual(sigint_handler, signal.getsignal(signal.SIGINT))

tests/dbshell_/__init__.py

@@ -0,0 +1,16 @@
+from django.db import models
+
+
+class Author(models.Model):
+    name = models.CharField(max_length=10)
+
+    def __str__(self):
+        return self.name
+
+
+class Book(models.Model):
+    title = models.CharField(max_length=10)
+    author = models.ForeignKey(Author, models.CASCADE)
+
+    def __str__(self):
+        return self.title

tests/dbshell_/tests.py

@@ -0,0 +1,26 @@
+from django.test import TestCase
+
+from .models import Author, Book
+
+
+class MQLTests(TestCase):
+    def test_all(self):
+        with self.assertNumQueries(1) as ctx:
+            list(Author.objects.all())
+        query = ctx.captured_queries[0]["sql"]
+        self.assertEqual(query, "db.queries__author.aggregate([{'$match': {'$expr': {}}}])")
+
+    def test_join(self):
+        with self.assertNumQueries(1) as ctx:
+            list(Book.objects.filter(author__name="Bob"))
+        query = ctx.captured_queries[0]["sql"]
+        self.assertEqual(
+            query,
+            "db.queries__book.aggregate(["
+            "{'$lookup': {'from': 'queries__author', "
+            "'let': {'parent__field__0': '$author_id'}, "
+            "'pipeline': [{'$match': {'$expr': "
+            "{'$and': [{'$eq': ['$$parent__field__0', '$_id']}]}}}], 'as': 'queries__author'}}, "
+            "{'$unwind': '$queries__author'}, "
+            "{'$match': {'$expr': {'$eq': ['$queries__author.name', 'Bob']}}}])",
+        )