Testing fixes (#1248)

* Resolves #1247, Resolves #1245: Added CI

* Resolves #1244: Update readme with minmimum Ansible version

* Resolves #1241: Drop obsolete Ansible and Python versions

* Fixes #1243: Add ansible-lint configuration

* Fixes #1243: Remove yamllint config in favour of ansible-lint

* Fixes #1247: Add requirements for CI pipeline

* Fixes #1247: Remove yamllint from old test suite

* Closes #1243: Test failures

* Closes #1247: Add a changelog

Author: minitriga

.ansible-lint

@@ -0,0 +1,15 @@
+---
+profile: production
+
+exclude_paths:
+  - .cache/ # implicit unless exclude_paths is defined in config
+  - .venv/
+  - .github/
+
+skip_list:
+  - args[module]
+  - no-handler
+  - yaml[key-duplicates]
+  - yaml[line-length]
+
+offline: false

.ansible-lint-ignore

@@ -0,0 +1,2 @@
+# This file contains ignores rule violations for ansible-lint
+changelogs/fragments/housekeeping.yml yaml[comments]

.github/workflows/main.yml

@@ -15,15 +15,6 @@ jobs:
       - name: Run black
         uses: psf/black@stable
 
-      - name: 'Yamllint'
-        uses: karancode/yamllint-github-action@master
-
-      #- name: Run isort
-      #  uses: jamescurtin/isort-action@master
-
-      #- name: Run ruff
-      #  uses: chartboost/ruff-action@v1
-
   unit_testing:
     runs-on: ubuntu-20.04
     needs: linting

.github/workflows/tests.yml

@@ -0,0 +1,50 @@
+---
+name: "CI"
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+    branches: [main, devel]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  changelog:
+    uses: ansible/ansible-content-actions/.github/workflows/changelog.yaml@main
+    if: github.event_name == 'pull_request'
+  build-import:
+    uses: ansible/ansible-content-actions/.github/workflows/build_import.yaml@main
+  ansible-lint:
+    uses: ansible/ansible-content-actions/.github/workflows/ansible_lint.yaml@main
+  sanity:
+    uses: ansible/ansible-content-actions/.github/workflows/sanity.yaml@main
+  unit-galaxy:
+    uses: ansible/ansible-content-actions/.github/workflows/unit.yaml@main
+  unit-source:
+    uses: ansible-network/github_actions/.github/workflows/unit_source.yml@main
+    with:
+      collection_pre_install: >-
+        git+https://github.com/ansible-collections/ansible.utils.git
+  all_green:
+    if: ${{ always() }}
+    needs:
+      - changelog
+      - sanity
+      - ansible-lint
+      - unit-galaxy
+      - unit-source
+    runs-on: ubuntu-latest
+    steps:
+      - run: >-
+          python -c "assert 'failure' not in
+          set([
+          '${{ needs.changelog.result }}',
+          '${{ needs.sanity.result }}',
+          '${{ needs.unit-galaxy.result }}',
+          '${{ needs.unit-source.result }}',
+          '${{ needs.ansible-lint.result }}'
+          ])"

.readthedocs.yml

@@ -1,7 +1,7 @@
 ---
 version: 2
-#sphinx:
-#  configuration: docs/conf.py
+# sphinx:
+#   configuration: docs/conf.py
 
 build:
   os: ubuntu-22.04

.yamllint

@@ -410,8 +410,8 @@ v3.1.2
 Release Summary
 ---------------
 
-This release focuses on ansible-core 2.11 compatibility, general CI fixes for NetBox 2.10-2.11, and doc updates. 
-This release works with NetBox 3.0, but needs further investigation with regards to idopmentcy (nothing really major) & some CI. 
+This release focuses on ansible-core 2.11 compatibility, general CI fixes for NetBox 2.10-2.11, and doc updates.
+This release works with NetBox 3.0, but needs further investigation with regards to idopmentcy (nothing really major) & some CI.
 The next release will idenify and resolve any issues with NetBox 3.0.
 
 Minor Changes

CHANGELOG.rst

@@ -1,19 +1,19 @@
-# Ansible Modules for NetBox 
+# Ansible Modules for NetBox
 
 ## Description
-The NetBox Ansible project provides an Ansible collection for interacting with NetBox, the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. 
+The NetBox Ansible project provides an Ansible collection for interacting with NetBox, the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation.
 
-This Ansible collection consists of a set of modules to define the intended network state in NetBox, along with plugins to drive automation of the network using data from NetBox. 
+This Ansible collection consists of a set of modules to define the intended network state in NetBox, along with plugins to drive automation of the network using data from NetBox.
 
 ## Requirements
 
 - 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.8+
+- 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 modules:
-  - pytz 
-  - pynetbox 
-- Ansible 2.12+ 
+  - pytz
+  - pynetbox
+- Ansible 2.15+
 
 ## Installation
 
@@ -41,10 +41,10 @@ To upgrade the collection to the latest available version, run the following com
 ```
 ansible-galaxy collection install netbox.netbox --upgrade
 ```
-You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 3.17.0:
+You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 3.18.0:
 
 ```
-ansible-galaxy collection install netbox.netbox:==3.17.0 
+ansible-galaxy collection install netbox.netbox:==3.18.0
 ```
 See using [Ansible collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-collections) for more details.
 
@@ -75,13 +75,13 @@ This is useful to test code within PRs.
 ## Use Cases
 
 ### Use Case 1 - Define Intended Network State in NetBox
-Define the intended state of your network in NetBox, by interacting with the NetBox database to define objects and their associated state in the following ways: 
+Define the intended state of your network in NetBox, by interacting with the NetBox database to define objects and their associated state in the following ways:
 
 - Make sure objects exit
 - Update objects if they do exist
 - Remove objects if they do not not exist
 
-For example, to make sure a new aggregate network prefix exists:   
+For example, to make sure a new aggregate network prefix exists:
 ```
 tasks:
     - name: Create aggregate within NetBox with only required information
@@ -95,9 +95,9 @@ tasks:
 ```
 
 ### Use Case 2 - NetBox as a Dynamic Inventory Source for Ansible
-Use the Inventory Plugin to dynamically generate Ansible inventory from device data in NetBox. Use query filters, groups and mappings to tailor the generated inventory to your specific needs. 
+Use the Inventory Plugin to dynamically generate Ansible inventory from device data in NetBox. Use query filters, groups and mappings to tailor the generated inventory to your specific needs.
 
-The following example builds an Ansible inventory that groups devices by `role`, and filters for only devices that have the `network-edge-router` role, have a primary IP address and belong to the `internal` tenant:  
+The following example builds an Ansible inventory that groups devices by `role`, and filters for only devices that have the `network-edge-router` role, have a primary IP address and belong to the `internal` tenant:
 ```
 # netbox_inventory.yml file in YAML format
 # Example command line: ansible-inventory -v --list -i netbox_inventory.yml
@@ -116,9 +116,9 @@ device_query_filters:
 ```
 
 ### Use Case 3 - Query and Return Elements from NetBox
-Use the Lookup plugin to query NetBox and return data to drive network automation, such as lists of devices, device configurations, prefixes and IP addresses etc. 
+Use the Lookup plugin to query NetBox and return data to drive network automation, such as lists of devices, device configurations, prefixes and IP addresses etc.
 
-The following example returns a list of devices and their manufacturers, using an API filter to only return devices with the `management` role and the NetBox tag of `Dell`: 
+The following example returns a list of devices and their manufacturers, using an API filter to only return devices with the `management` role and the NetBox tag of `Dell`:
 ```
 tasks:
   # query a list of devices
@@ -134,13 +134,13 @@ tasks:
 
 ```
 ## Testing
-Tested with Ansible Core v2.15.9. Ansible Core versions prior to 2.15.9 are not supported.
+Tested with Ansible Core v2.15+ Ansible Core versions prior to 2.15 are not supported.
 
 ## Contributing
 If you would to contribute to the project then you can find out how to get started [here](https://github.com/netbox-community/ansible_modules/blob/devel/CONTRIBUTING.md).
 
 ## Support
-There are various options to get support for the collection: 
+There are various options to get support for the collection:
 -  Search through previous [GitHub Discussions](https://github.com/netbox-community/ansible_modules/discussions) or start a new one.
 - Raise a [GitHub Issue](https://github.com/netbox-community/ansible_modules/issues)
 - Read the module [documentation](https://netbox-ansible-collection.readthedocs.io/en/latest/)
@@ -149,11 +149,11 @@ There are various options to get support for the collection:
 Customers of NetBox Labs and Ansible using the officially certified version of the collection can get support via the usual Ansible channels. Escalation to the NetBox Labs support team will be provided as needed.
 
 ## Release Notes
-The collection release notes and changelog can be found [here](https://github.com/netbox-community/ansible_modules/releases). 
+The collection release notes and changelog can be found [here](https://github.com/netbox-community/ansible_modules/releases).
 
 ## Related Information
-Some extra resources you might find useful for both the Anisble collection and for NetBox itself: 
-- [NetBox Zero to Hero](https://netboxlabs.com/zero-to-hero/) - free 12 part course that takes you from an empty NetBox through to a fully deployed branch site, using the Ansible collection extensively along the way. 
+Some extra resources you might find useful for both the Anisble collection and for NetBox itself:
+- [NetBox Zero to Hero](https://netboxlabs.com/zero-to-hero/) - free 12 part course that takes you from an empty NetBox through to a fully deployed branch site, using the Ansible collection extensively along the way.
 - [Network Configuration Assurance with NetBox and Ansible](https://netboxlabs.com/blog/network-configuration-assurance-with-netbox-and-ansible/) - blog post featuring the Inventory plugin being used in a simple network automation use case to compare actual network state Vs intended state as defined in NetBox.
 - Official NetBox [documentation](https://docs.netbox.dev/en/stable/).
 
@@ -162,4 +162,4 @@ GNU General Public License v3.0 or later.
 
 See [LICENSE](https://github.com/netbox-community/ansible_modules/blob/devel/LICENSE) for the full text of the license.
 
-Link to the license that the collection is published under. 
+Link to the license that the collection is published under.