Merge branch 'main' into DRIVERS-2917

Author: NoahStapp

.evergreen/run-tests.sh

@@ -15,8 +15,8 @@ pip install -e ..
 pip install -r requirements/py3.txt
 popd
 
-# Copy the test settings file
-cp ./.github/workflows/mongodb_settings.py django_repo/tests/
+# Copy the test settings files
+cp ./.github/workflows/*_settings.py django_repo/tests/
 
 # Copy the test runner file
 cp ./.github/workflows/runtests.py django_repo/tests/runtests_.py

.github/workflows/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+JIRA TICKET
+
+## Changes in this PR
+
+<!-- What changes did you make to the code? What new APIs (public or private) were added, removed, or edited to generate the desired outcome explained in the above summary? -->
+
+## Test Plan
+
+<!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why. All code should be tested in some way – so please list what your validation strategy was. -->
+
+## Checklist
+
+<!-- Do not delete the items provided on this checklist -->
+
+### Checklist for Author
+
+- [ ] Did you update the changelog (if necessary)?
+- [ ] Is the intention of the code captured in relevant tests?
+- [ ] If there are new TODOs, has a related JIRA ticket been created?
+
+### Checklist for Reviewer
+
+- [ ] Does the title of the PR reference a JIRA Ticket?
+- [ ] Do you fully understand the implementation? (Would you be comfortable explaining how this code works to someone else?)
+- [ ] Have you checked for spelling & grammar errors?
+- [ ] Is all relevant documentation (README or docstring) updated?

.github/workflows/codeql.yml

@@ -45,7 +45,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         ref: ${{ inputs.ref }}
         persist-credentials: false
@@ -56,7 +56,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@192325c86100d080feab897ff886c34abd4c83a3 # v3.30.3
+      uses: github/codeql-action/init@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4.31.7
       with:
         languages: ${{ matrix.language }}
         build-mode: none
@@ -72,6 +72,6 @@ jobs:
         pip install -e .
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@192325c86100d080feab897ff886c34abd4c83a3 # v3.30.3
+      uses: github/codeql-action/analyze@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4.31.7
       with:
         category: "/language:${{ matrix.language }}"

.github/workflows/dist.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: release
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       with:
         ref: ${{ inputs.ref }}
         persist-credentials: false
@@ -32,7 +32,7 @@ jobs:
     - name: Create packages
       run: python -m build .
     - name: Store package artifacts
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
           name: all-dist-${{ github.run_id }}
           path: "dist/*"

.github/workflows/django_settings.py

@@ -0,0 +1,37 @@
+# Settings for django/tests.
+import os
+
+from pymongo.uri_parser import parse_uri
+
+if mongodb_uri := os.getenv("MONGODB_URI"):
+    db_settings = {
+        "ENGINE": "django_mongodb_backend",
+        "HOST": mongodb_uri,
+    }
+    # Workaround for https://github.com/mongodb-labs/mongo-orchestration/issues/268
+    uri = parse_uri(mongodb_uri)
+    if uri.get("username") and uri.get("password"):
+        db_settings["OPTIONS"] = {"tls": True, "tlsAllowInvalidCertificates": True}
+    DATABASES = {
+        "default": {**db_settings, "NAME": "djangotests"},
+        "other": {**db_settings, "NAME": "djangotests-other"},
+    }
+else:
+    DATABASES = {
+        "default": {
+            "ENGINE": "django_mongodb_backend",
+            "NAME": "djangotests",
+            # Required when connecting to the Atlas image in Docker.
+            "OPTIONS": {"directConnection": True},
+        },
+        "other": {
+            "ENGINE": "django_mongodb_backend",
+            "NAME": "djangotests-other",
+            "OPTIONS": {"directConnection": True},
+        },
+    }
+
+DEFAULT_AUTO_FIELD = "django_mongodb_backend.fields.ObjectIdAutoField"
+PASSWORD_HASHERS = ("django.contrib.auth.hashers.MD5PasswordHasher",)
+SECRET_KEY = "django_tests_secret_key"  # noqa: S105
+USE_TZ = False

.github/workflows/linters.yml

@@ -12,7 +12,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
       - uses: actions/setup-python@v6
@@ -32,7 +32,7 @@ jobs:
     name: Docs Checks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
       - uses: actions/setup-python@v6

.github/workflows/mongodb_settings.py

@@ -1,36 +1,4 @@
-import os
+# Settings for django_mongodb_backend/tests.
+from django_settings import *  # noqa: F403
 
-from pymongo.uri_parser import parse_uri
-
-if mongodb_uri := os.getenv("MONGODB_URI"):
-    db_settings = {
-        "ENGINE": "django_mongodb_backend",
-        "HOST": mongodb_uri,
-    }
-    # Workaround for https://github.com/mongodb-labs/mongo-orchestration/issues/268
-    uri = parse_uri(mongodb_uri)
-    if uri.get("username") and uri.get("password"):
-        db_settings["OPTIONS"] = {"tls": True, "tlsAllowInvalidCertificates": True}
-    DATABASES = {
-        "default": {**db_settings, "NAME": "djangotests"},
-        "other": {**db_settings, "NAME": "djangotests-other"},
-    }
-else:
-    DATABASES = {
-        "default": {
-            "ENGINE": "django_mongodb_backend",
-            "NAME": "djangotests",
-            # Required when connecting to the Atlas image in Docker.
-            "OPTIONS": {"directConnection": True},
-        },
-        "other": {
-            "ENGINE": "django_mongodb_backend",
-            "NAME": "djangotests-other",
-            "OPTIONS": {"directConnection": True},
-        },
-    }
-
-DEFAULT_AUTO_FIELD = "django_mongodb_backend.fields.ObjectIdAutoField"
-PASSWORD_HASHERS = ("django.contrib.auth.hashers.MD5PasswordHasher",)
-SECRET_KEY = "django_tests_secret_key"
-USE_TZ = False
+DATABASE_ROUTERS = ["django_mongodb_backend.routers.MongoRouter"]

.github/workflows/release-python.yml

@@ -39,17 +39,17 @@ jobs:
     outputs:
       version: ${{ steps.pre-publish.outputs.version }}
     steps:
-      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
+      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v3 # Cannot be pinned
         with:
           app_id: ${{ vars.APP_ID }}
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
-      - uses: mongodb-labs/drivers-github-tools/setup@v2
+      - uses: mongodb-labs/drivers-github-tools/setup@v3 # Cannot be pinned
         with:
           aws_role_arn: ${{ secrets.AWS_ROLE_ARN }}
           aws_region_name: ${{ vars.AWS_REGION_NAME }}
           aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
           artifactory_username: ${{ vars.ARTIFACTORY_USERNAME }}
-      - uses: mongodb-labs/drivers-github-tools/python/pre-publish@v2
+      - uses: mongodb-labs/drivers-github-tools/python/pre-publish@v3 # Cannot be pinned
         id: pre-publish
         with:
           dry_run: ${{ env.DRY_RUN }}
@@ -75,7 +75,7 @@ jobs:
       id-token: write
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: all-dist-${{ github.run_id }}
           path: dist/
@@ -99,17 +99,17 @@ jobs:
       attestations: write
       security-events: write
     steps:
-      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
+      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v3 # Cannot be pinned
         with:
           app_id: ${{ vars.APP_ID }}
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
-      - uses: mongodb-labs/drivers-github-tools/setup@v2
+      - uses: mongodb-labs/drivers-github-tools/setup@v3 # Cannot be pinned
         with:
           aws_role_arn: ${{ secrets.AWS_ROLE_ARN }}
           aws_region_name: ${{ vars.AWS_REGION_NAME }}
           aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
           artifactory_username: ${{ vars.ARTIFACTORY_USERNAME }}
-      - uses: mongodb-labs/drivers-github-tools/python/post-publish@v2
+      - uses: mongodb-labs/drivers-github-tools/python/post-publish@v3 # Cannot be pinned
         with:
           following_version: ${{ env.FOLLOWING_VERSION }}
           product_name: ${{ env.PRODUCT_NAME }}

.github/workflows/runtests.py

@@ -172,11 +172,19 @@
     test_apps.extend(["gis_tests", "gis_tests_"])
 
 runtests = pathlib.Path(__file__).parent.resolve() / "runtests.py"
-run_tests_cmd = f"python3 {runtests} %s --settings mongodb_settings -v 2"
+run_tests_cmd = f"python3 {runtests} %s --settings %s -v 2"
 
 shouldFail = False
 for app_name in test_apps:
-    res = os.system(run_tests_cmd % app_name)  # noqa: S605
+    # Use the custom settings module only for django_mongodb_backend's tests
+    # (which always end with an underscore). Some of Django's tests aren't
+    # compatible with extra DATABASE_ROUTERS or other DATABASES aliases.
+    settings_module = (
+        os.environ.get("DJANGO_SETTINGS_MODULE", "mongodb_settings")
+        if app_name.endswith("_")
+        else "django_settings"
+    )
+    res = os.system(run_tests_cmd % (app_name, settings_module))  # noqa: S605
     if res != 0:
         shouldFail = True
 sys.exit(1 if shouldFail else 0)

.github/workflows/test-python-atlas.yml

@@ -22,15 +22,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout django-mongodb-backend
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           persist-credentials: false
       - name: install django-mongodb-backend
         run: |
           pip3 install --upgrade pip
           pip3 install -e .
       - name: Checkout Django
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           repository: 'mongodb-forks/django'
           ref: 'mongodb-5.2.x'
@@ -45,8 +45,8 @@ jobs:
           cd django_repo/tests/
           pip3 install -e ..
           pip3 install -r requirements/py3.txt
-      - name: Copy the test settings file
-        run: cp .github/workflows/mongodb_settings.py django_repo/tests/
+      - name: Copy the test settings files
+        run: cp .github/workflows/*_settings.py django_repo/tests/
       - name: Copy the test runner file
         run: cp .github/workflows/runtests.py django_repo/tests/runtests_.py
       - name: Start local Atlas