Merge pull request #1504 from netbox-community/devel

Release v3.22.0

Author: sc68cal

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -67,7 +67,7 @@ body:
         Describe in detail the exact steps that someone else can take to
         reproduce this bug using the current stable release of the Ansible NetBox collection.
         Include any sanatized playbooks, variables, & tasks specifically showing just the issue.
-      #placeholder: |
+      # placeholder: |
 
     validations:
       required: true

.github/workflows/main.yml

@@ -15,13 +15,20 @@ jobs:
       - name: Run black
         uses: psf/black@stable
 
+      - name: Run yamllint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          file_or_dir: .
+          config_file: .yamllint.yml
+          strict: true
+
   unit_testing:
     runs-on: ubuntu-24.04
     needs: linting
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.13"]
+        python-version: ["3.11", "3.12", "3.13"]
 
     steps:
 
@@ -66,13 +73,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include:                    
-          - VERSION: "v4.0"
-            NETBOX_DOCKER_VERSION: 2.9.1
+        include:
           - VERSION: "v4.1"
             NETBOX_DOCKER_VERSION: 3.0.1
           - VERSION: "v4.2"
-            NETBOX_DOCKER_VERSION: 3.1.0
+            NETBOX_DOCKER_VERSION: 3.2.1
+          - VERSION: "v4.3"
+            NETBOX_DOCKER_VERSION: 3.3.0
 
     steps:
 
@@ -114,7 +121,7 @@ jobs:
           docker container ls
           docker logs netbox-docker-netbox-1
           timeout 300 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:32768/login/)" != "200" ]]; do echo "waiting for NetBox"; sleep 5; done' || false
-        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox        
+        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
       - name: Pre-populate NetBox
         run: ./tests/integration/netbox-deploy.py
@@ -126,13 +133,13 @@ jobs:
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} inventory-${{ matrix.VERSION }}
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
-      - name: Run regression tests        
+      - name: Run regression tests
         continue-on-error: true
-        run: |          
-          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}          
+        run: |
+          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
-      - name: Run integration tests        
+      - name: Run integration tests
         run: |
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} ${{ matrix.VERSION }}
           ansible-test coverage report --all --omit "tests/*,hacking/*,docs/*" --show-missing

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 ---
 name: Deploy collection to Ansible Galaxy
 on:
-  create:
+  push:
     tags:
       - "v*"
 jobs:

.github/workflows/tests.yml

@@ -47,4 +47,4 @@ jobs:
           '${{ needs.unit-galaxy.result }}',
           '${{ needs.unit-source.result }}',
           '${{ needs.ansible-lint.result }}'
-          ])"
+          ])"

.yamllint.yml

@@ -0,0 +1,52 @@
+---
+extends: default
+
+# see rules at https://yamllint.readthedocs.io/en/latest/rules.html
+ignore: |
+  - .cache/
+  - .venv/
+  - .github/
+
+rules:
+  braces:
+    max-spaces-inside: 20
+    level: error
+  brackets:
+    max-spaces-inside: 20
+    level: error
+  colons:
+    max-spaces-before: 1
+    max-spaces-after: 20
+    level: error
+  commas:
+    max-spaces-before: 50
+    min-spaces-after: 1
+    max-spaces-after: 20
+    level: error
+  comments:
+    min-spaces-from-content: 1
+  comments-indentation: disable
+  document-start:
+    present: true
+  empty-lines:
+    max: 3
+    level: error
+  hyphens:
+    level: error
+  indentation:
+    spaces: 2
+    indent-sequences: whatever
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length:
+    max: 230
+    level: warning
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true
+  new-line-at-end-of-file: enable
+  new-lines:
+    type: unix
+  trailing-spaces: enable
+  truthy: disable
+  octal-values:
+    forbid-explicit-octal: true

CHANGELOG.rst

@@ -4,6 +4,52 @@ NetBox.NetBox Release Notes
 
 .. contents:: Topics
 
+v3.22.0
+=======
+
+Minor Changes
+-------------
+
+- Add integration tests for contact groups
+- Add support for custom headers for all modules
+- Change `netbox_contact.contact_group` to `contact_groups`
+- Fix ansible-bad-import-from pylint errors
+- Fix broken code path when using old api path on old netbox systems
+- Make the unit-test data structures more flexible.
+- Remove abandoned unit-test data.
+- add workaround to _build_query_params for services and Netbox 4.3.0 - 4.4.3 (wrong parent_object_type data type)
+- add yamllint to project pipeline.
+- improve version_check_greater to be more universal
+- netbox_circuit_termination - Add parameters termination_id and termination_type for NetBox 4.2+
+- netbox_tag - Add support for object_types on tags
+- rename variable full_version to netbox_version.
+- rename variable version to api_version.
+- sanitize netbox versions received from api
+- test suite expanded to run on Python 3.11, 3.12, and 3.13.
+- user.groups, user.permissions, user_group.permissions, permission.actions, and permission.object_types are now treated as unordered sets for update comparison purposes.
+
+Bugfixes
+--------
+
+- Add netbox version check to support service creation for netbox version prior of 4.3
+- Fix integration test for circuit termination, missing assignment
+- Fix integration test for service
+- Fix task duplicate task name in documentation that cause ansible-lint error
+- Fix typos in tag integration tests.
+- Support for related_object_filter when related_object_type is "object"
+- Use dedicated function to check netbox version istead of self.full_version for rack.
+- add parent_object_type and parent_object_id to services ALLOWED_QUERY_PARAMS
+- nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation
+- nb_inventory - Fix service collection for version greater than 4.3
+- nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path
+- netbox_service - Fix issue 1426 - broken netbox_service module
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_contact_assignment - Manage contact assignments in NetBox
+- netbox.netbox.netbox_data_source - Manage data sources in NetBox
+
 v3.21.0
 =======
 

README.md

@@ -9,11 +9,11 @@ This Ansible collection consists of a set of modules to define the intended netw
 
 - You must be running one of the two most recent releases of NetBox
 - A NetBox write-enabled API token when using modules or a read-only token for the `nb_lookup` and `nb_inventory` plugins.
-- Python 3.10+
+- Python 3.11+
 - Python modules:
   - pytz
   - pynetbox
-- Ansible 2.15+
+- Ansible 2.18+
 
 ## Installation
 

changelogs/changelog.yaml

@@ -1,3 +1,4 @@
+---
 ancestor: null
 releases:
   0.1.0:
@@ -851,6 +852,71 @@ releases:
       name: netbox_mac_address
       namespace: ''
     release_date: '2025-03-04'
+  3.22.0:
+    changes:
+      minor_changes:
+      - Change `netbox_contact.contact_group` to `contact_groups`
+      - Add integration tests for contact groups
+      - Add support for custom headers for all modules
+      - Fix ansible-bad-import-from pylint errors
+      - Fix broken code path when using old api path on old netbox systems
+      - add workaround to _build_query_params for services and Netbox 4.3.0 - 4.4.3 (wrong parent_object_type data type)
+      - netbox_circuit_termination - Add parameters termination_id and termination_type for NetBox 4.2+
+      - netbox_tag - Add support for object_types on tags
+      - improve version_check_greater to be more universal
+      - sanitize netbox versions received from api
+      - test suite expanded to run on Python 3.11, 3.12, and 3.13.
+      - Make the unit-test data structures more flexible.
+      - Remove abandoned unit-test data.
+      - user.groups, user.permissions, user_group.permissions, permission.actions, and permission.object_types are now treated as unordered sets for update comparison purposes.
+      - rename variable version to api_version.
+      - rename variable full_version to netbox_version.
+      - add yamllint to project pipeline.
+      bugfixes:
+      - Fix task duplicate task name in documentation that cause ansible-lint error
+      - nb_inventory - Fix service collection for version greater than 4.3
+      - Add netbox version check to support service creation for netbox version prior of 4.3
+      - Use dedicated function to check netbox version istead of self.full_version for rack.
+      - Fix typos in tag integration tests.
+      - Fix integration test for circuit termination, missing assignment
+      - Fix integration test for service
+      - "nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation"
+      - add parent_object_type and parent_object_id to services ALLOWED_QUERY_PARAMS
+      - nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path
+      - Support for related_object_filter when related_object_type is "object"
+      - netbox_service - Fix issue 1426 - broken netbox_service module
+    modules:
+    - description: Manage data sources in NetBox
+      name: netbox_data_source
+      namespace: ''
+    - description: Manage contact assignments in NetBox
+      name: netbox_contact_assignment
+      namespace: ''
+    fragments:
+    - 1182-fix-contact-groups.yml
+    - 1433-add-custom-headers.yml
+    - 1435-fix-duplicate-task-name.yml
+    - 1438-fix-inventory-service-collection.yml
+    - 1439-fix-sevral-bug-discovered-by-integration-tests.yml
+    - 1459-add-netbox-data-sources.yml
+    - 1462-fix-pylint-errors.yml
+    - 1464-fix-mac-lookup-by-id.yml
+    - 1469-fix-old-apis.yml
+    - 1479-fix-services_parent_object.yml
+    - contacts.yml
+    - nb_inventory.yml
+    - netbox_circuit_termination.yml
+    - netbox_custom_field.yml
+    - netbox_service.yml
+    - netbox_tag.yml
+    - netbox_version_check_greater.yml
+    - netbox_version_sanitize.yml
+    - python_versions.yml
+    - unit_test_data.yml
+    - users-ordering.yml
+    - version_api.yml
+    - version_netbox.yml
+    - yamllint.yml
   3.3.0:
     changes:
       minor_changes:

docs/conf.py

@@ -27,7 +27,7 @@
 author = "Mikhail Yohman <@FragmentedPacket>"
 
 # The full version, including alpha/beta/rc tags
-release = "3.21.0"
+release = "3.22.0"
 
 
 # -- General configuration ---------------------------------------------------

docs/getting_started/contributing/modules/architecture.rst

@@ -284,14 +284,15 @@ We set several instance attributes that are used within other methods throughout
       url = self.module.params["netbox_url"]
       token = self.module.params["netbox_token"]
       ssl_verify = self.module.params["validate_certs"]
+      headers = self.module.params["headers"]
 
       # Attempt to initiate connection to NetBox
       if nb_client is None:
-          self.nb = self._connect_netbox_api(url, token, ssl_verify)
+          self.nb = self._connect_netbox_api(url, token, ssl_verify, headers)
       else:
           self.nb = nb_client
           try:
-              self.version = self.nb.version
+              self.api_version = self.nb.version
           except AttributeError:
               self.module.fail_json(msg="Must have pynetbox >=4.1.0")