Merge branch 'main' of github.com:linode/linode_api4-python into proj/nb-udp

Author: lgarber-akamai

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

@@ -2,6 +2,22 @@ on:
   pull_request:
   workflow_dispatch:
     inputs:
+      run_db_fork_tests:
+        description: 'Set this parameter to "true" to run fork database related test cases'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'true'
+          - 'false'
+      run_db_tests:
+        description: 'Set this parameter to "true" to run database related test cases'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'true'
+          - 'false'
       test_suite:
         description: 'Enter specific test suite. E.g. domain, linode_client'
         required: false
@@ -80,7 +96,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 RUN_DB_FORK_TESTS=${{ github.event.inputs.run_db_fork_tests }} RUN_DB_TESTS=${{ github.event.inputs.run_db_tests }} TEST_ARGS="--junitxml=${report_filename}" TEST_SUITE="${{ github.event.inputs.test_suite }}"
         env:
           LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}
 

.github/workflows/e2e-test.yml

@@ -3,19 +3,38 @@ name: Integration Tests
 on:
   workflow_dispatch:
     inputs:
+      run_db_fork_tests:
+        description: 'Set this parameter to "true" to run fork database related test cases'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'true'
+          - 'false'
+      run_db_tests:
+        description: 'Set this parameter to "true" to run database related test cases'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'true'
+          - 'false'
+      test_suite:
+        description: 'Enter specific test suite. E.g. domain, linode_client'
+        required: false
       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 +47,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 +91,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 RUN_DB_FORK_TESTS=${{ github.event.inputs.run_db_fork_tests }} RUN_DB_TESTS=${{ github.event.inputs.run_db_tests }} TEST_SUITE="${{ github.event.inputs.test_suite }}" 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,12 +169,69 @@ jobs:
         env:
           LINODE_CLI_TOKEN: ${{ env.LINODE_TOKEN }}
 
-  notify-slack:
+  process-upload-report:
     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: always() && github.repository == 'linode/linode_api4-python' # Run even if integration tests fail and only on main repository
+    outputs:
+      summary: ${{ steps.set-test-summary.outputs.summary }}
+
+    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 }}
+
+      - name: Generate test summary and save to output
+        id: set-test-summary
+        run: |
+          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
+          test_output=$(python3 e2e_scripts/tod_scripts/generate_test_summary.py "${filename}")
+          {
+            echo 'summary<<EOF'
+            echo "$test_output"
+            echo EOF
+          } >> "$GITHUB_OUTPUT"
+
+  notify-slack:
+    runs-on: ubuntu-latest
+    needs: [integration-tests, process-upload-report]
+    if: ${{ (success() || failure()) }} # Run even if integration tests fail and only on main repository
     steps:
       - name: Notify Slack
+        id: main_message
         uses: slackapi/[email protected]
         with:
           method: chat.postMessage
@@ -172,7 +242,7 @@ jobs:
               - type: section
                 text:
                   type: mrkdwn
-                  text: ":rocket: *${{ github.workflow }} Completed in: ${{ github.repository }}* :white_check_mark:"
+                  text: ":rocket: *${{ github.workflow }} Completed in: ${{ github.repository }}* ${{ needs.integration-tests.result == 'success' && ':white_check_mark:' || ':failed:' }}"
               - type: divider
               - type: section
                 fields:
@@ -190,4 +260,15 @@ jobs:
               - type: context
                 elements:
                   - type: mrkdwn
-                    text: "Triggered by: :bust_in_silhouette: `${{ github.actor }}`"
+                    text: "Triggered by: :bust_in_silhouette: `${{ github.actor }}`"
+
+      - name: Test summary thread
+        if: success()
+        uses: slackapi/[email protected]
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            thread_ts: "${{ steps.main_message.outputs.ts }}"
+            text: "${{ needs.process-upload-report.outputs.summary }}"

.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@24d110aa46a59976b8a7f35518cb7f14f434c916
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml

.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 }}
 

.github/workflows/publish-pypi.yaml

@@ -5,7 +5,11 @@ on:
     types: [ published ]
 jobs:
   pypi-release:
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     runs-on: ubuntu-latest
+    environment: pypi-release
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -24,6 +28,4 @@ jobs:
           LINODE_SDK_VERSION: ${{ github.event.release.tag_name }}
 
       - name: Publish the release artifacts to PyPI
-        uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70 # pin@release/v1.12.3
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # pin@release/v1.12.4

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

@@ -8,6 +8,7 @@
 from .image import *
 from .linode import *
 from .lke import *
+from .lke_tier import *
 from .longview import *
 from .networking import *
 from .nodebalancer import *

linode_api4/groups/__init__.py

@@ -101,7 +101,7 @@ def settings(self):
         s = AccountSettings(self.client, result["managed"], result)
         return s
 
-    def invoices(self):
+    def invoices(self, *filters):
         """
         Returns Invoices issued to this account.
 
@@ -112,9 +112,9 @@ def invoices(self):
         :returns: Invoices issued to this account.
         :rtype: PaginatedList of Invoice
         """
-        return self.client._get_and_filter(Invoice)
+        return self.client._get_and_filter(Invoice, *filters)
 
-    def payments(self):
+    def payments(self, *filters):
         """
         Returns a list of Payments made on this account.
 
@@ -123,7 +123,7 @@ def payments(self):
         :returns: A list of payments made on this account.
         :rtype: PaginatedList of Payment
         """
-        return self.client._get_and_filter(Payment)
+        return self.client._get_and_filter(Payment, *filters)
 
     def oauth_clients(self, *filters):
         """
@@ -337,7 +337,7 @@ def add_promo_code(self, promo_code):
                 json=resp,
             )
 
-    def service_transfers(self):
+    def service_transfers(self, *filters):
         """
         Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.
 
@@ -347,7 +347,7 @@ def service_transfers(self):
         :rtype: PaginatedList of ServiceTransfer
         """
 
-        return self.client._get_and_filter(ServiceTransfer)
+        return self.client._get_and_filter(ServiceTransfer, *filters)
 
     def service_transfer_create(self, entities):
         """