Merge pull request #484 from nautobot/develop

Develop to main for release
nautobot · Jan 9, 2025 · bd0648c · bd0648c
2 parents 6a9def4 + 077a62f
commit bd0648c
Show file tree

Hide file tree

Showing 53 changed files with 971 additions and 1,485 deletions.
diff --git a/.bandit.yml b/.bandit.yml
@@ -1,5 +1,7 @@
 ---
 skips: []
-# No need to check for security issues in the test scripts!
 exclude_dirs:
+  # No need to check for security issues in the test scripts!
   - "./tests/"
+  # Ignore locally installed collection
+  - "./collections/"
diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml
@@ -6,7 +6,7 @@ on: # yamllint disable
       runs-on:
         description: "The OS to run the job on"
         required: false
-        default: "ubuntu-22.04"
+        default: "ubuntu-24.04"
         type: string
       python-version:
         description: "The Python version to use"

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -6,7 +6,7 @@ on: # yamllint disable
       runs-on:
         description: "The OS to run the job on"
         required: false
-        default: "ubuntu-22.04"
+        default: "ubuntu-24.04"
         type: string
       full-integration:
         description: "Run full integration tests"
@@ -30,8 +30,8 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
+          - "3.12"
     env:
       INVOKE_NAUTOBOT_ANSIBLE_PYTHON_VER: "${{ matrix.python-version }}"
     steps:
@@ -51,12 +51,12 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.11"
+          - "3.12"
         nautobot-version:
           - "2.3"
         ansible-version:
-          - "2.16"
           - "2.17"
+          - "2.18"
     with:
       python-version: "${{ matrix.python-version }}"
       nautobot-version: "${{ matrix.nautobot-version }}"
@@ -70,8 +70,8 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
+          - "3.12"
         nautobot-version:
           - "2.0"
           - "2.1"
@@ -80,6 +80,14 @@ jobs:
         ansible-version:
           - "2.16"
           - "2.17"
+          - "2.18"
+        exclude:
+          - python-version: "3.12"
+            nautobot-version: "2.0"
+          - python-version: "3.12"
+            nautobot-version: "2.1"
+          - python-version: "3.12"
+            nautobot-version: "2.2"
     with:
       python-version: "${{ matrix.python-version }}"
       nautobot-version: "${{ matrix.nautobot-version }}"

diff --git a/.github/workflows/trigger_release.yml b/.github/workflows/trigger_release.yml
@@ -6,7 +6,7 @@ on: # yamllint disable
 
 jobs:
   lint:
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-24.04"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
@@ -15,13 +15,13 @@ jobs:
       - name: "Linting"
         run: "invoke lint"
   unit:
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-24.04"
     strategy:
       fail-fast: false
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
+          - "3.12"
     env:
       INVOKE_NAUTOBOT_ANSIBLE_PYTHON_VER: "${{ matrix.python-version }}"
     steps:
@@ -39,8 +39,8 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
+          - "3.12"
         nautobot-version:
           - "2.0"
           - "2.1"
@@ -49,6 +49,14 @@ jobs:
         ansible-version:
           - "2.16"
           - "2.17"
+          - "2.18"
+        exclude:
+          - python-version: "3.12"
+            nautobot-version: "2.0"
+          - python-version: "3.12"
+            nautobot-version: "2.1"
+          - python-version: "3.12"
+            nautobot-version: "2.2"
     with:
       python-version: "${{ matrix.python-version }}"
       nautobot-version: "${{ matrix.nautobot-version }}"
@@ -57,15 +65,15 @@ jobs:
       - "unit"
   publish_github:
     name: "Publish to GitHub"
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-24.04"
     if: "startsWith(github.ref, 'refs/tags/v')"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: "Install Python Packages"
         run: "pip install ansible-core"
       - name: "Build the collection"
@@ -82,15 +90,15 @@ jobs:
       - "integration"
   publish_galaxy:
     name: "Publish to Ansible Galaxy"
-    runs-on: "ubuntu-22.04"
+    runs-on: "ubuntu-24.04"
     if: "startsWith(github.ref, 'refs/tags/v')"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: "Install Python Packages"
         run: "pip install ansible-core"
       - name: "Create the ansible.cfg file"

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -8,9 +8,9 @@ version: 2
 
 # Set the version of Python in the build environment.
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "3.10"
+    python: "3.11"
   jobs:
     post_install:
       - "ansible-galaxy collection install . --force"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # networktocode.nautobot Release Notes
 
+v5.6.0
+======
+
+Minor Changes
+-------------
+- (#470) Dropped support for Python 3.10 to follow ansible-core 2.18
+- (#472) Added documentation on using custom fields in compose variables with the `inventory` plugin
+- (#474) Fixed `lookup` plugin to properly handle templated variables in `api_filter`
+- (#475) Added documentation for the `device_interface` module that `type` is required when creating a new interface
+- (#477) Fixed query example in the `lookup_graphql` plugin documentation for compatibility with Nautobot 2.X
+- (#478) Fixed the `cable` module to properly work with all cable types
+- (#480) Fixed environment variable fallback for `url` and `token` in all modules
+- (#481) Fixed environment variable fallback for `validate_certs` in all modules
+
 v5.5.0
 ======
 

diff --git a/Dockerfile b/Dockerfile
@@ -3,11 +3,11 @@
 #
 #  This base stage just installs the dependencies required for production
 #  without any development deps.
-ARG PYTHON_VER=3.10
+ARG PYTHON_VER=3.11
 FROM python:${PYTHON_VER} AS base
 
 # Allow for flexible Python versions, for broader testing
-ARG PYTHON_VER=3.10
+ARG PYTHON_VER=3.11
 ENV PYTHON_VERSION=${PYTHON_VER}
 ENV DEBIAN_FRONTEND=noninteractive
 RUN apt-get update -yqq && apt-get install -yqq shellcheck && apt-get clean
@@ -60,7 +60,7 @@ FROM lint AS unittests
 ARG ANSIBLE_COLLECTIONS_PATH=/usr/share/ansible/collections
 ENV ANSIBLE_COLLECTIONS_PATH=${ANSIBLE_COLLECTIONS_PATH}
 
-ARG PYTHON_VER=3.10
+ARG PYTHON_VER=3.11
 ENV PYTHON_VERSION=${PYTHON_VER}
 
 # Allows for custom command line arguments to be passed to ansible-test (like -vvv)
@@ -89,7 +89,7 @@ RUN ansible-test sanity $ANSIBLE_SANITY_ARGS \
     plugins/
 
 # Run unit tests
-RUN ansible-test units $ANSIBLE_UNIT_ARGS --coverage --python ${PYTHON_VERSION}
+RUN ansible-test units $ANSIBLE_UNIT_ARGS --coverage --requirements --python ${PYTHON_VERSION}
 
 ############
 # Integration Tests

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -545,3 +545,14 @@ releases:
       minor_changes:
       - (#464) Added full support for caching to GraphQL Inventory plugin
       - (#465) Changed `parent_location_type` to allow for explicit name attribute lookup
+  5.6.0:
+    changes:
+      minor_changes:
+      - (#470) Dropped support for Python 3.10 to follow ansible-core 2.18
+      - (#472) Added documentation on using custom fields in compose variables with the `inventory` plugin
+      - (#474) Fixed `lookup` plugin to properly handle templated variables in `api_filter`
+      - (#475) Added documentation for the `device_interface` module that `type` is required when creating a new interface
+      - (#477) Fixed query example in the `lookup_graphql` plugin documentation for compatibility with Nautobot 2.X
+      - (#478) Fixed the `cable` module to properly work with all cable types
+      - (#480) Fixed environment variable fallback for `url` and `token` in all modules
+      - (#481) Fixed environment variable fallback for `validate_certs` in all modules
diff --git a/development/requirements.txt b/development/requirements.txt
@@ -1 +1 @@
-nautobot-bgp-models==0.20.0
+nautobot-bgp-models==2.3.0
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,6 +2,8 @@
 x-args:
   &args
   PYTHON_VER: ${PYTHON_VER}
+  ANSIBLE_SANITY_ARGS: ${ANSIBLE_SANITY_ARGS:-}
+  ANSIBLE_UNIT_ARGS: ${ANSIBLE_UNIT_ARGS:-}
 # Build block with context and target default
 x-build:
   &build
@@ -14,7 +16,8 @@ x-service:
     ANSIBLE_INTEGRATION_ARGS: ${ANSIBLE_INTEGRATION_ARGS:-}
     ANSIBLE_SANITY_ARGS: ${ANSIBLE_SANITY_ARGS:-}
     ANSIBLE_UNIT_ARGS: ${ANSIBLE_UNIT_ARGS:-}
-    NAUTOBOT_VER: ${INVOKE_NAUTOBOT_ANSIBLE_NAUTOBOT_VER:-}
+    NAUTOBOT_VER: ${NAUTOBOT_VER:-}
+    OUTPUT_INVENTORY_JSON: ${OUTPUT_INVENTORY_JSON:-}
 
 services:
   unit:
@@ -33,3 +36,6 @@ services:
     build:
       <<: *build
       target: integration
+    volumes:
+      # This allows us to update the inventory files from inside the container
+      - ${PWD}/tests/integration/targets/inventory/files/:/tmp/inventory_files/
diff --git a/docs/getting_started/how-to-use/inventory.md b/docs/getting_started/how-to-use/inventory.md
@@ -11,6 +11,16 @@ compose:
   ansible_network_os: platform.network_driver
 ```
 
+You can also use custom fields on the device or a nested object.
+
+```yaml
+---
+plugin: networktocode.nautobot.inventory
+compose:
+  device_owner: custom_fields.device_owner
+  ansible_network_os: platforms.custom_fields.ansible_network_os
+```
+
 ## Using Keyed Groups to set `ansible_network_os` to Platform Network Driver
 
 ```yaml

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-ansible-core==2.15.12
+ansible-core==2.18
 mkdocs==1.6.1
 mkdocs-ansible-collection==0.2.0
 mkdocs-material==9.5.30

diff --git a/galaxy.yml b/galaxy.yml
@@ -9,7 +9,7 @@ namespace: networktocode
 name: nautobot
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 5.5.0
+version: 5.6.0
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

diff --git a/hacking/local-test.sh b/hacking/local-test.sh
@@ -1,13 +1,18 @@
 #!/usr/bin/env bash
 
-# Usage: ./hacking/local-test.sh
+################################################################################
+# DEPRECATED
+# Run `invoke unit` or `invoke integration` to run the tests locally instead!
+################################################################################
 
-# Run build, which will remove previously installed versions
-./hacking/build.sh
+# # Usage: ./hacking/local-test.sh
 
-# Install new built version
-ansible-galaxy collection install networktocode-nautobot-*.tar.gz -p .
+# # Run build, which will remove previously installed versions
+# ./hacking/build.sh
 
-# You can now cd into the installed version and run tests
-(cd ansible_collections/networktocode/nautobot/ && ansible-test units -v --python 3.9 && ansible-test sanity --requirements -v --python 3.9 --skip-test pep8 plugins/)
-rm -rf ansible_collections
+# # Install new built version
+# ansible-galaxy collection install networktocode-nautobot-*.tar.gz -p .
+
+# # You can now cd into the installed version and run tests
+# (cd ansible_collections/networktocode/nautobot/ && ansible-test units -v --python 3.9 && ansible-test sanity --requirements -v --python 3.9 --skip-test pep8 plugins/)
+# rm -rf ansible_collections
diff --git a/hacking/make-docs.sh b/hacking/make-docs.sh
@@ -1,12 +1,17 @@
 #!/usr/bin/env bash
 
-# Usage: ./hacking/make-docs.sh
+################################################################################
+# DEPRECATED
+# Run `invoke docs` to host the docs locally instead!
+################################################################################
 
-# Run build, which will remove previously installed versions
-./hacking/build.sh
+# # Usage: ./hacking/make-docs.sh
 
-# Install new built version
-ansible-galaxy collection install networktocode-nautobot-*.tar.gz -f
+# # Run build, which will remove previously installed versions
+# ./hacking/build.sh
 
-# Run antisbull-docs now
-antsibull-docs collection --use-current --squash-hierarchy --dest-dir docs/plugins/ networktocode.nautobot
+# # Install new built version
+# ansible-galaxy collection install networktocode-nautobot-*.tar.gz -f
+
+# # Run antisbull-docs now
+# antsibull-docs collection --use-current --squash-hierarchy --dest-dir docs/plugins/ networktocode.nautobot
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		nautobot-bgp-models==0.20.0
		nautobot-bgp-models==2.3.0