Merge pull request #643 from linode/dev

Release v0.34.1

Author: lgarber-akamai

.github/workflows/docs.yml

@@ -20,7 +20,7 @@ jobs:
       - name: setup python 3
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
 
       - name: install dependencies
         run: make deps

.github/workflows/integration-tests-pr.yml

@@ -2,14 +2,14 @@ on:
   pull_request:
   workflow_dispatch:
     inputs:
-      tests:
-        description: 'The tests to run.'
+      test_suite:
+        description: "Specify  test suite to run from the 'tests/integration/targets' directory. Examples: 'domain_basic', 'image_basic', etc. If not provided, all suites are executed"
         required: false
       sha:
-        description: 'The hash value of the commit.'
+        description: 'Specify commit hash to test. This value is mandatory to ensure the tests run against a specific commit'
         required: true
       pull_request_number:
-        description: 'The number of the PR.'
+        description: 'Specify pull request number associated with the commit. Optional, but recommended when providing a commit hash (sha)'
         required: false
 
 name: Integration tests on PR
@@ -26,7 +26,7 @@ jobs:
       - uses: actions-ecosystem/action-regex-match@v2
         id: disallowed-char-check
         with:
-          text: ${{ inputs.tests }}
+          text: ${{ inputs.test_suite }}
           regex: '[^a-z0-9_]'
           flags: gi
 
@@ -56,7 +56,7 @@ jobs:
       - name: replace existing keys
         run: rm -rf ~/.ansible/test && mkdir -p ~/.ansible/test && ssh-keygen -m PEM -q -t rsa -N '' -f ~/.ansible/test/id_rsa
 
-      - run: make deps && make TEST_ARGS="-v ${{ inputs.tests }}" test
+      - run: make deps && make TEST_SUITE="${{ inputs.test_suite }}" test-int
         if: ${{ steps.disallowed-char-check.outputs.match == '' }}
         env:
           LINODE_API_TOKEN: ${{ secrets.DX_LINODE_TOKEN }}

.github/workflows/integration-tests.yml

@@ -4,10 +4,10 @@ on:
   workflow_dispatch:
     inputs:
       python-version:
-        description: 'Specify Python version to use'
+        description: 'Specify the Python version to use for running tests. Leave empty to use the default Python version configured in the environment'
         required: false
       run-eol-python-version:
-        description: 'Run EOL python version?'
+        description: 'Indicates whether to run tests using an End-of-Life (EOL) Python version. Defaults to "false". Choose "true" to include tests for deprecated Python versions'
         required: false
         default: 'false'
         type: choice
@@ -21,7 +21,7 @@ on:
 
 env:
   DEFAULT_PYTHON_VERSION: "3.10"
-  EOL_PYTHON_VERSION: "3.8"
+  EOL_PYTHON_VERSION: "3.9"
   EXIT_STATUS: 0
 
 jobs:
@@ -92,7 +92,7 @@ jobs:
           python-version: '3.x'
 
       - name: Install Python dependencies
-        run: pip3 install requests wheel boto3
+        run: pip3 install requests wheel boto3==1.35.99
 
       # Create directory if it doesn't exist
       - name: Create output directory

.github/workflows/labeler.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@b54af0c25861143e7c8813d7cbbf46d2c341680c
+        uses: crazy-max/ghaction-github-labeler@31674a3852a9074f2086abcf1c53839d466a47e7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml

.github/workflows/nightly-smoke-tests.yml

@@ -48,7 +48,7 @@ jobs:
       - name: Run smoke tests
         id: smoke_tests
         run: |
-          make smoketest
+          make test-smoke
         env:
           LINODE_API_TOKEN: ${{ secrets.DX_LINODE_TOKEN }}
 

.github/workflows/unit-tests.yml

@@ -33,4 +33,4 @@ jobs:
 
       - name: Run unit tests
         run: |
-          make unittest
+          make test-unit

Makefile

@@ -8,6 +8,7 @@ TEST_API_VERSION ?= v4beta
 TEST_API_CA ?=
 
 TEST_ARGS := -v
+TEST_SUITE :=
 INTEGRATION_CONFIG := ./tests/integration/integration_config.yml
 
 clean:
@@ -63,7 +64,7 @@ gendocs:
 integration-test: create-integration-config create-e2e-firewall
 	@echo "Running Integration Test(s)..."
 	{ \
-		ansible-test integration $(TEST_ARGS); \
+		ansible-test integration $(TEST_ARGS) $(TEST_SUITE); \
 		TEST_EXIT_CODE=$$?; \
 		make delete-e2e-firewall; \
 		exit $$TEST_EXIT_CODE; \
@@ -95,17 +96,17 @@ delete-e2e-firewall: update-test-submodules
 	fi
 
 update-test-submodules:
-	@git submodule update --init
+	@git submodule update --init --recursive
 
-test: integration-test
+test-int: integration-test
 
 testall:
 	./scripts/test_all.sh
 
-smoketest:
+test-smoke:
 	./scripts/test_basic_smoke.sh
 
-unittest:
+test-unit:
 	ansible-test units --target-python default
 
 

docs/inventory/instance.rst

@@ -14,7 +14,7 @@ Synopsis
 
 Reads instance inventories from Linode.
 
-Uses a YAML configuration file that ends with linode.(yml|yaml).
+Uses a YAML configuration file that ends with linode.(yml\|yaml).
 
 Linode labels are used by default as the hostnames.
 
@@ -76,19 +76,19 @@ Parameters
 
 
       **parent_group (type=str):**
-        \• parent group for keyed group.
+        \• parent group for keyed group
 
 
       **prefix (type=str):**
-        \• A keyed group name will start with this prefix.
+        \• A keyed group name will start with this prefix
 
 
       **separator (type=str, default=_):**
-        \• separator used to build the keyed group name.
+        \• separator used to build the keyed group name
 
 
       **key (type=str):**
-        \• The key from input dictionary used to generate groups.
+        \• The key from input dictionary used to generate groups
 
 
       **default_value (type=str):**
@@ -98,7 +98,7 @@ Parameters
 
 
       **trailing_separator (type=bool, default=True):**
-        \• Set this option to :literal:`false` to omit the :literal:`keyed\_groups[].separator` after the host variable when the value is an empty string.
+        \• Set this option to :literal:`False` to omit the :literal:`keyed\_groups[].separator` after the host variable when the value is an empty string.
 
         \• This option is mutually exclusive with :literal:`keyed\_groups[].default\_value`.
 
@@ -109,13 +109,13 @@ Parameters
 
 
   **leading_separator (type=boolean, default=True):**
-    \• Use in conjunction with :literal:`keyed\_groups`.
+    \• Use in conjunction with keyed\_groups.
 
     \• By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.
 
-    \• This is because the default prefix is :literal:`""` and the default separator is :literal:`"\_"`.
+    \• This is because the default prefix is "" and the default separator is "\_".
 
-    \• Set this option to :literal:`false` to omit the leading underscore (or other separator) if no prefix is given.
+    \• Set this option to False to omit the leading underscore (or other separator) if no prefix is given.
 
     \• If the group name is derived from a mapping the separator is still used to concatenate the items.
 

plugins/module_utils/linode_common.py

@@ -24,7 +24,10 @@
 )
 
 try:
-    from linode_api4 import VPC, ApiError
+    from linode_api4 import (
+        VPC,
+        ApiError,
+    )
     from linode_api4 import Base as LinodeAPIType
     from linode_api4 import (
         Image,

requirements.txt

@@ -1,3 +1,3 @@
 linode-api4>=5.24.0
 polling==0.3.2
-ansible-specdoc>=0.0.15
+ansible-specdoc>=0.0.18