Merge branch 'dev' into TPT-3447-obj-gen2

Author: ezilber-akamai

.github/workflows/e2e-test-pr.yml

@@ -80,7 +80,7 @@ jobs:
         run: |
           timestamp=$(date +'%Y%m%d%H%M')
           report_filename="${timestamp}_sdk_test_report.xml"
-          make testint TEST_ARGS="--junitxml=${report_filename}" TEST_SUITE="${{ github.event.inputs.test_suite }}"
+          make test-int TEST_ARGS="--junitxml=${report_filename}" TEST_SUITE="${{ github.event.inputs.test_suite }}"
         env:
           LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}
 

.github/workflows/e2e-test.yml

@@ -4,18 +4,18 @@ on:
   workflow_dispatch:
     inputs:
       use_minimal_test_account:
-        description: 'Use minimal test account'
+        description: 'Indicate whether to use a minimal test account with limited resources for testing. Defaults to "false"'
         required: false
         default: 'false'
       sha:
-        description: 'The hash value of the commit'
-        required: false
+        description: 'Specify commit hash to test. This value is mandatory to ensure the tests run against a specific commit'
+        required: true
         default: ''
       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
@@ -28,8 +28,8 @@ on:
       - dev
 
 env:
-  DEFAULT_PYTHON_VERSION: "3.9"
-  EOL_PYTHON_VERSION: "3.8"
+  DEFAULT_PYTHON_VERSION: "3.10"
+  EOL_PYTHON_VERSION: "3.9"
   EXIT_STATUS: 0
 
 jobs:
@@ -72,24 +72,18 @@ jobs:
         run: |
           timestamp=$(date +'%Y%m%d%H%M')
           report_filename="${timestamp}_sdk_test_report.xml"
-          make testint TEST_ARGS="--junitxml=${report_filename}"
+          make test-int TEST_ARGS="--junitxml=${report_filename}"
         env:
           LINODE_TOKEN: ${{ env.LINODE_TOKEN }}
 
-      - name: Upload test results
+      - name: Upload Test Report as Artifact
         if: always()
-        run: |
-          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
-          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/add_gha_info_to_xml.py \
-          --branch_name "${GITHUB_REF#refs/*/}" \
-          --gha_run_id "$GITHUB_RUN_ID" \
-          --gha_run_number "$GITHUB_RUN_NUMBER" \
-          --xmlfile "${filename}"
-          sync
-          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/xml_to_obj.py "${filename}"
-        env:
-          LINODE_CLI_OBJ_ACCESS_KEY: ${{ secrets.LINODE_CLI_OBJ_ACCESS_KEY }}
-          LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report-file
+          if-no-files-found: ignore
+          path: '*.xml'
+          retention-days: 1
 
   apply-calico-rules:
     runs-on: ubuntu-latest
@@ -156,10 +150,54 @@ jobs:
         env:
           LINODE_CLI_TOKEN: ${{ env.LINODE_TOKEN }}
 
+  process-upload-report:
+    runs-on: ubuntu-latest
+    needs: [integration-tests]
+    if: always() && github.repository == 'linode/linode_api4-python' # Run even if integration tests fail and only on main repository
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: 'recursive'
+
+      - name: Download test report
+        uses: actions/download-artifact@v4
+        with:
+          name: test-report-file
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install Python dependencies
+        run: pip3 install requests wheel boto3==1.35.99
+
+      - name: Set release version env
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+
+      - name: Add variables and upload test results
+        if: always()
+        run: |
+          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
+          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/add_gha_info_to_xml.py \
+          --branch_name "${GITHUB_REF#refs/*/}" \
+          --gha_run_id "$GITHUB_RUN_ID" \
+          --gha_run_number "$GITHUB_RUN_NUMBER" \
+          --xmlfile "${filename}"
+          sync
+          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/xml_to_obj.py "${filename}"
+        env:
+          LINODE_CLI_OBJ_ACCESS_KEY: ${{ secrets.LINODE_CLI_OBJ_ACCESS_KEY }}
+          LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}
+
   notify-slack:
     runs-on: ubuntu-latest
     needs: [integration-tests]
-    if: ${{ (success() || failure()) && github.repository == 'linode/linode_api4-python' }} # Run even if integration tests fail and only on main repository
+    if: ${{ (success() || failure()) }} # Run even if integration tests fail and only on main repository
     steps:
       - name: Notify Slack
         uses: slackapi/slack-github-action@v2.0.0

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

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

Makefile

@@ -1,29 +1,9 @@
 PYTHON ?= python3
 
-TEST_CASE_COMMAND :=
-TEST_SUITE :=
-TEST_ARGS :=
-
 LINODE_SDK_VERSION ?= "0.0.0.dev"
 VERSION_MODULE_DOCSTRING ?= \"\"\"\nThe version of this linode_api4 package.\n\"\"\"\n\n
 VERSION_FILE := ./linode_api4/version.py
 
-ifdef TEST_CASE
-    TEST_CASE_COMMAND = -k $(TEST_CASE)
-endif
-
-ifdef TEST_SUITE
-    ifneq ($(TEST_SUITE),linode_client)
-        ifneq ($(TEST_SUITE),login_client)
-            TEST_COMMAND = models/$(TEST_SUITE)
-        else
-            TEST_COMMAND = login_client
-        endif
-    else
-        TEST_COMMAND = linode_client
-    endif
-endif
-
 .PHONY: clean
 clean:
 	mkdir -p dist
@@ -73,14 +53,21 @@ lint: build
 	$(PYTHON) -m pylint linode_api4
 	$(PYTHON) -m twine check dist/*
 
-.PHONY: testint
-testint:
-	$(PYTHON) -m pytest test/integration/${TEST_COMMAND} ${TEST_CASE_COMMAND} ${TEST_ARGS}
+# Integration Test Arguments
+# TEST_SUITE: Optional, specify a test suite (e.g. domain), Default to run everything if not set
+# TEST_CASE: Optional, specify a test case (e.g. 'test_image_replication')
+# TEST_ARGS: Optional, additional arguments for pytest (e.g. '-v' for verbose mode)
+
+TEST_COMMAND = $(if $(TEST_SUITE),$(if $(filter $(TEST_SUITE),linode_client login_client),$(TEST_SUITE),models/$(TEST_SUITE)))
+
+.PHONY: test-int
+test-int:
+	$(PYTHON) -m pytest test/integration/${TEST_COMMAND} $(if $(TEST_CASE),-k $(TEST_CASE)) ${TEST_ARGS}
 
-.PHONY: testunit
-testunit:
+.PHONY: test-unit
+test-unit:
 	$(PYTHON) -m pytest test/unit
 
-.PHONY: smoketest
-smoketest:
+.PHONY: test-smoke
+test-smoke:
 	$(PYTHON) -m pytest -m smoke test/integration

README.rst

@@ -148,16 +148,16 @@ Running the tests
 ^^^^^^^^^^^^^^^^^
 Run the tests locally using the make command. Run the entire test suite using command below::
 
-    make testint
+    make test-int
 
 To run a specific package/suite, use the environment variable `TEST_SUITE` using directory names in `integration/...` folder ::
 
-    make TEST_SUITE="account" testint          // Runs tests in `integration/models/account` directory
-    make TEST_SUITE="linode_client" testint    // Runs tests in `integration/linode_client` directory
+    make TEST_SUITE="account" test-int          // Runs tests in `integration/models/account` directory
+    make TEST_SUITE="linode_client" test-int    // Runs tests in `integration/linode_client` directory
 
-Lastly to run a specific test case use environment variable `TEST_CASE` with `testint` command::
+Lastly to run a specific test case use environment variable `TEST_CASE` with `test-int` command::
 
-    make TEST_CASE=test_get_domain_record testint
+    make TEST_CASE=test_get_domain_record test-int
 
 Documentation
 -------------

e2e_scripts

@@ -1,3 +1,4 @@
+import logging
 from test.unit.base import ClientBaseCase
 
 from linode_api4 import PostgreSQLDatabase
@@ -106,6 +107,8 @@ def test_create(self):
         Test that MySQL databases can be created
         """
 
+        logger = logging.getLogger(__name__)
+
         with self.mock_post("/databases/mysql/instances") as m:
             # We don't care about errors here; we just want to
             # validate the request.
@@ -117,8 +120,10 @@ def test_create(self):
                     "g6-standard-1",
                     cluster_size=3,
                 )
-            except Exception:
-                pass
+            except Exception as e:
+                logger.warning(
+                    "An error occurred while validating the request: %s", e
+                )
 
             self.assertEqual(m.method, "post")
             self.assertEqual(m.call_url, "/databases/mysql/instances")

test/unit/objects/database_test.py

@@ -138,7 +138,7 @@ def test_list_ips(self):
 
         ip = result[0]
         assert ip.address == "10.0.0.2"
-        assert ip.address_range == None
+        assert ip.address_range is None
         assert ip.vpc_id == 123
         assert ip.subnet_id == 456
         assert ip.region == "us-mia"