Add support for py3.12

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # Default owner(s) of all files in this repository
-* @cmsirbu @snaselj @whitej6
+* @nautobot/maintain-nautobot-apps

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments
   pull_request: ~
 
 env:
-  APP_NAME: "nautobot-app-dev-example"
+  APP_NAME: "nautobot-dev-example"
 
 jobs:
   ruff-format:
@@ -91,6 +91,13 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+      - name: "Constrain Nautobot version"
+        run: |
+          # Retrieve the version from the Docker image - for cases where the input version is "stable" or "latest"
+          docker run --rm --entrypoint "" ghcr.io/nautobot/nautobot-dev:${{ matrix.nautobot-version }}-py${{ matrix.python-version }} pip show nautobot | \
+          grep "^Version" | sed "s/Version: //" > /tmp/nautobot_version.txt
+          export NAUTOBOT_VER=$(cat /tmp/nautobot_version.txt)
+          poetry add nautobot@$NAUTOBOT_VER --python ${{ matrix.python-version }}
       - name: "Set up Docker Buildx"
         id: "buildx"
         uses: "docker/setup-buildx-action@v3"
@@ -108,6 +115,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 +130,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.0.0"
-          - python-version: "3.11"
+          - python-version: "3.12"
             db-backend: "mysql"
             nautobot-version: "stable"
     runs-on: "ubuntu-22.04"
@@ -141,6 +149,13 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+      - name: "Constrain Nautobot version"
+        run: |
+          # Retrieve the version from the Docker image - for cases where the input version is "stable" or "latest"
+          docker run --rm --entrypoint "" ghcr.io/nautobot/nautobot-dev:${{ matrix.nautobot-version }}-py${{ matrix.python-version }} pip show nautobot | \
+          grep "^Version" | sed "s/Version: //" > /tmp/nautobot_version.txt
+          export NAUTOBOT_VER=$(cat /tmp/nautobot_version.txt)
+          poetry add nautobot@$NAUTOBOT_VER --python ${{ matrix.python-version }}
       - name: "Set up Docker Buildx"
         id: "buildx"
         uses: "docker/setup-buildx-action@v3"
@@ -158,6 +173,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"
@@ -196,7 +212,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"
@@ -231,7 +247,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"

development/Dockerfile

@@ -18,6 +18,10 @@ FROM ghcr.io/nautobot/nautobot-dev:${NAUTOBOT_VER}-py${PYTHON_VER}
 # Runtime argument and environment setup
 ARG NAUTOBOT_ROOT=/opt/nautobot
 
+# Docker needs to specify the build args in each stage
+ARG NAUTOBOT_VER
+ARG PYTHON_VER
+
 ENV prometheus_multiproc_dir=/prom_cache
 ENV NAUTOBOT_ROOT=${NAUTOBOT_ROOT}
 ENV INVOKE_NAUTOBOT_DEV_EXAMPLE_LOCAL=true
@@ -53,29 +57,15 @@ 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
-
-# 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 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
 
 COPY development/nautobot_config.py ${NAUTOBOT_ROOT}/nautobot_config.py
 # !!! USE CAUTION WHEN MODIFYING LINES ABOVE

invoke.example.yml

@@ -1,7 +1,7 @@
 ---
 nautobot_dev_example:
   project_name: "nautobot-dev-example"
-  nautobot_ver: "2.0.0"
+  nautobot_ver: "2.3.1"
   local: false
   python_ver: "3.11"
   compose_dir: "development"