Merge pull request #536 from nautobot/release-3.1.0

Release 3.1.0

Author: jdrew82

.cookiecutter.json

@@ -21,15 +21,15 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.3.0",
+            "template_ref": "refs/tags/nautobot-app-v2.3.2",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
             "post_actions": [
                 "black"
             ],
             "draft": true,
-            "baked_commit_ref": "edf831ea98364f9a475ef147f13c1fb2f17b825f"
+            "baked_commit_ref": "022954d51f46c54813d3c8c81584a16f0faea1f5"
         }
     }
 }

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments
   pull_request: ~
 
 env:
-  APP_NAME: "nautobot-app-ssot"
+  APP_NAME: "nautobot-ssot"
 
 jobs:
   ruff-format:
@@ -91,6 +91,10 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+      - name: "Constrain Nautobot version and regenerate lock file"
+        env:
+          INVOKE_NAUTOBOT_SSOT_LOCAL: "true"
+        run: "poetry run invoke lock --constrain-nautobot-ver --constrain-python-ver"
       - name: "Set up Docker Buildx"
         id: "buildx"
         uses: "docker/setup-buildx-action@v3"
@@ -108,6 +112,7 @@ jobs:
           build-args: |
             NAUTOBOT_VER=${{ matrix.nautobot-version }}
             PYTHON_VER=${{ matrix.python-version }}
+            CI=true
       - name: "Copy credentials"
         run: "cp development/creds.example.env development/creds.env"
       - name: "Linting: pylint"
@@ -122,14 +127,14 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.11"]
+        python-version: ["3.8", "3.12"]
         db-backend: ["postgresql"]
         nautobot-version: ["stable"]
         include:
           - python-version: "3.11"
             db-backend: "postgresql"
             nautobot-version: "2.2.1"
-          - python-version: "3.11"
+          - python-version: "3.12"
             db-backend: "mysql"
             nautobot-version: "stable"
     runs-on: "ubuntu-22.04"
@@ -158,6 +163,7 @@ jobs:
           build-args: |
             NAUTOBOT_VER=${{ matrix.nautobot-version }}
             PYTHON_VER=${{ matrix.python-version }}
+            CI=true
       - name: "Copy credentials"
         run: "cp development/creds.example.env development/creds.env"
       - name: "Use Mysql invoke settings when needed"
@@ -195,7 +201,7 @@ jobs:
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       - name: "Install Python Packages"
         run: "pip install poetry"
       - name: "Set env"
@@ -230,7 +236,7 @@ jobs:
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       - name: "Install Python Packages"
         run: "pip install poetry"
       - name: "Set env"

changes/536.housekeeping

@@ -0,0 +1 @@
+Cut release for 3.1.0

changes/562.housekeeping

@@ -53,29 +53,18 @@ RUN which poetry || curl -sSL https://install.python-poetry.org | python3 - && \
 WORKDIR /source
 COPY . /source
 
-# Get container's installed Nautobot version as a forced constraint
-# NAUTOBOT_VER may be a branch name and not a published release therefor we need to get the installed version
-#  so pip can use it to recognize local constraints.
-RUN pip show nautobot | grep "^Version: " | sed -e 's/Version: /nautobot==/' > constraints.txt
+# Build args must be declared in each stage
+ARG PYTHON_VER
 
-# Use Poetry to grab dev dependencies from the lock file
-# Can be improved in Poetry 1.2 which allows `poetry install --only dev`
-#
-# We can't use the entire freeze as it takes forever to resolve with rigidly fixed non-direct dependencies,
-#   especially those that are only direct to Nautobot but the container included versions slightly mismatch
-RUN poetry export -f requirements.txt --without-hashes --extras all --output poetry_freeze_base.txt
-RUN poetry export -f requirements.txt --without-hashes --extras all --with dev --output poetry_freeze_all.txt
-RUN sort poetry_freeze_base.txt poetry_freeze_all.txt | uniq -u > poetry_freeze_dev.txt
-
-# Install all local project as editable, constrained on Nautobot version, to get any additional
-#   direct dependencies of the app
-RUN --mount=type=cache,target="/root/.cache/pip",sharing=locked \
-    pip install -c constraints.txt -e .[all]
+# Constrain the Nautobot version to NAUTOBOT_VER
+# In CI, this should be done outside of the Dockerfile to prevent cross-compile build failures
+ARG CI
+RUN if [ -z "${CI+x}" ]; then \
+    INSTALLED_NAUTOBOT_VER=$(pip show nautobot | grep "^Version" | sed "s/Version: //"); \
+    poetry add --lock nautobot@${INSTALLED_NAUTOBOT_VER} --python ${PYTHON_VER}; fi
 
-# Install any dev dependencies frozen from Poetry
-# Can be improved in Poetry 1.2 which allows `poetry install --only dev`
-RUN --mount=type=cache,target="/root/.cache/pip",sharing=locked \
-    pip install -c constraints.txt -r poetry_freeze_dev.txt
+# Install the app
+RUN poetry install --extras all --with dev
 
 COPY development/nautobot_config.py ${NAUTOBOT_ROOT}/nautobot_config.py
 # !!! USE CAUTION WHEN MODIFYING LINES ABOVE

development/Dockerfile

@@ -40,7 +40,9 @@ def _main():
             **SchemaBuilder().to_json_schema(app_config),  # type: ignore
         }
         app_config = import_module(package_name).config
-        _enrich_object_schema(schema, app_config.default_settings, app_config.required_settings)
+        _enrich_object_schema(
+            schema, app_config.default_settings, app_config.required_settings
+        )
         schema_path.write_text(json.dumps(schema, indent=4) + "\n")
         print(f"\n==================\nGenerated schema:\n\n{schema_path}\n")
         print(

development/app_config_schema.py

@@ -18,8 +18,12 @@
 
     if "debug_toolbar" not in INSTALLED_APPS:  # noqa: F405
         INSTALLED_APPS.append("debug_toolbar")  # noqa: F405
-    if "debug_toolbar.middleware.DebugToolbarMiddleware" not in MIDDLEWARE:  # noqa: F405
-        MIDDLEWARE.insert(0, "debug_toolbar.middleware.DebugToolbarMiddleware")  # noqa: F405
+    if (
+        "debug_toolbar.middleware.DebugToolbarMiddleware" not in MIDDLEWARE
+    ):  # noqa: F405
+        MIDDLEWARE.insert(
+            0, "debug_toolbar.middleware.DebugToolbarMiddleware"
+        )  # noqa: F405
 
 #
 # Misc. settings
@@ -51,7 +55,9 @@
             "NAUTOBOT_DB_PORT",
             default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"],
         ),  # Database port, default to postgres
-        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", "300")),  # Database timeout
+        "CONN_MAX_AGE": int(
+            os.getenv("NAUTOBOT_DB_TIMEOUT", "300")
+        ),  # Database timeout
         "ENGINE": nautobot_db_engine,
     }
 }

development/nautobot_config.py

@@ -14,16 +14,17 @@ While that last supported version will not be strictly enforced--via the max_ver
 | 2.0.0-beta.2                   | 2.0.0b2                        | 2.0.0b2                       |
 | 2.0.0-rc.1                     | 2.0.0rc1                       | 2.0.0rc1                      |
 | 2.0.0-rc.2                     | 2.0.0rc2                       | 2.0.0rc99                     |
-| 2.0.0                          | 2.0.0                          | 2.99.09                       |
-| 2.0.1                          | 2.0.0                          | 2.99.09                       |
-| 2.0.2                          | 2.0.0                          | 2.99.09                       |
-| 2.1.0                          | 2.0.0                          | 2.99.09                       |
-| 2.2.0                          | 2.0.0                          | 2.99.09                       |
-| 2.3.0                          | 2.1.0                          | 2.99.09                       |
-| 2.4.0                          | 2.1.0                          | 2.99.09                       |
-| 2.5.0                          | 2.1.0                          | 2.99.09                       |
-| 2.6.0                          | 2.1.0                          | 2.99.09                       |
-| 2.7.0                          | 2.1.0                          | 2.99.09                       |
-| 2.8.0                          | 2.1.0                          | 2.99.09                       |
-| 3.0.0                          | 2.1.0                          | 2.99.09                       |
-| 3.0.1                          | 2.1.0                          | 2.99.09                       |
+| 2.0.0                          | 2.0.0                          | 2.99.99                       |
+| 2.0.1                          | 2.0.0                          | 2.99.99                       |
+| 2.0.2                          | 2.0.0                          | 2.99.99                       |
+| 2.1.0                          | 2.0.0                          | 2.99.99                       |
+| 2.2.0                          | 2.0.0                          | 2.99.99                       |
+| 2.3.0                          | 2.1.0                          | 2.99.99                       |
+| 2.4.0                          | 2.1.0                          | 2.99.99                       |
+| 2.5.0                          | 2.1.0                          | 2.99.99                       |
+| 2.6.0                          | 2.1.0                          | 2.99.99                       |
+| 2.7.0                          | 2.1.0                          | 2.99.99                       |
+| 2.8.0                          | 2.1.0                          | 2.99.99                       |
+| 3.0.0                          | 2.1.0                          | 2.99.99                       |
+| 3.0.1                          | 2.1.0                          | 2.99.99                       |
+| 3.1.0                          | 2.1.0                          | 2.99.99                       |

docs/admin/compatibility_matrix.md

@@ -15,7 +15,19 @@ pip install nautobot-ssot[infoblox]
 !!! note
     Legacy configuration settings defined in the `nautobot_config.py` and environmental variables are deprecated. These settings are migrated on a best-effort basis on the first startup following migration to the Nautobot SSOT 2.7.0 or higher.
 
-Integration configuration is defined in the instance of the `SSOTInfobloxConfig` model. Multiple configuration instances are supported. Synchronization jobs take the `Config` parameter which specifies the configuration instance to use.
+The integration with Infoblox utilizes [External Integrations](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/externalintegration/?h=external) to specify your Infoblox host information. To enable this integration, the only modification needed is to activate it in the nautobot_config.py file.
+
+Below is an example snippet from `nautobot_config.py` that demonstrates how to enable the Infoblox integration:
+
+```python
+PLUGINS_CONFIG = {
+    "nautobot_ssot": {
+        "enable_infoblox": True,
+    }
+}
+```
+
+The remaining integration configuration is defined in the instance of the `SSOTInfobloxConfig` model. Multiple configuration instances are supported. Synchronization jobs take the `Config` parameter which specifies the configuration instance to use.
 
 To access integration configuration navigate to `Apps -> Installed Apps` and click on the cog icon in the `Single Source of Truth` entry. Then in the table `SSOT Integration Configs` click on the `Infoblox Configuration List` link. This will take you to the view where you can view/modify existing config instances or create new ones.
 

docs/admin/integrations/infoblox_setup.md

@@ -0,0 +1,27 @@
+
+## [v3.1.0 (2024-09-06)](https://github.com/nautobot/nautobot-app-ssot/releases/tag/v3.1.0)
+
+### Added
+
+- [#527](https://github.com/nautobot/nautobot-app-ssot/issues/527) - Added Python 3.12 support.
+- [#528](https://github.com/nautobot/nautobot-app-ssot/issues/528) - Added DNA Center integration to _MIN_NAUTOBOT_VERSION as it requires Nautobot 2.2 for Controller object.
+
+### Changed
+
+- [#526](https://github.com/nautobot/nautobot-app-ssot/issues/526) - Updated the ExampleDataSource job to improve memory utilization with large data sets.
+- [#526](https://github.com/nautobot/nautobot-app-ssot/issues/526) - Changed memory profiling logging output to format bytes into KiB/MiB.
+
+### Fixed
+
+- [#521](https://github.com/nautobot/nautobot-app-ssot/issues/521) - Fixed generalized Exception with SecretsGroup and add custom Exception in case SecretsGroup not found on ExternalIntegration.
+- [#528](https://github.com/nautobot/nautobot-app-ssot/issues/528) - Fixed bug preventing use of Nautobot 2.1 due to ACI requiring 2.2.
+- [#528](https://github.com/nautobot/nautobot-app-ssot/issues/528) - Fixed JobResult association to Sync object to CASCADE instead of PROTECT so Sync object is deleted when JobResult is instead of preventing deletion.
+- [#530](https://github.com/nautobot/nautobot-app-ssot/issues/530) - Fixed Infoblox Configuration List Bug when on Nautobot 2.3 by disabling SSOTInfobloxConfig from being a saved view.
+
+### Documentation
+
+- [#520](https://github.com/nautobot/nautobot-app-ssot/issues/520) - Added instructions for enabling Infoblox integration.
+
+### Housekeeping
+
+- [#527](https://github.com/nautobot/nautobot-app-ssot/issues/527) - Rebaked from the cookie 'nautobot-app-v2.3.2'.