Merge branch 'dev' into proj/dc-specific-pricing

Author: lgarber-akamai

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

@@ -78,11 +78,37 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - run: make INTEGRATION_TEST_PATH="${{ inputs.test_path }}" testint
-        if: ${{ steps.validate-tests.outputs.match == '' }}
+      - name: Run Integration tests
+        run: |
+          timestamp=$(date +'%Y%m%d%H%M')
+          report_filename="${timestamp}_sdk_test_report.xml"
+          status=0
+          if ! python3 -m pytest test/integration/${INTEGRATION_TEST_PATH} --junitxml="${report_filename}"; then
+            echo "Tests failed, but attempting to upload results anyway"
+          fi
         env:
           LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}
 
+      - name: Set release version env
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      - name: Add additional information to XML report
+        run: |
+          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
+          python test/script/add_to_xml_test_report.py \
+          --branch_name "${{ env.RELEASE_VERSION }}" \
+          --gha_run_id "$GITHUB_RUN_ID" \
+          --gha_run_number "$GITHUB_RUN_NUMBER" \
+          --xmlfile "${filename}"
+
+      - name: Upload test results
+        run: |
+          report_filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$')
+          python3 test/script/test_report_upload_script.py "${report_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/github-script@v6
         id: update-check-run
         if: ${{ inputs.pull_request_number != '' && fromJson(steps.commit-hash.outputs.data).repository.pullRequest.headRef.target.oid == inputs.sha }}

Makefile

@@ -62,6 +62,10 @@ lint: build
 testint:
 	python3 -m pytest test/integration/${INTEGRATION_TEST_PATH}${MODEL_COMMAND} ${TEST_CASE_COMMAND}
 
+@PHONEY: testunit
+testunit:
+	python3 -m python test/unit
+
 @PHONEY: smoketest
 smoketest:
 	pytest -m smoke test/integration --disable-warnings

linode_api4/linode_client.py

@@ -62,6 +62,7 @@ def __init__(
         retry_rate_limit_interval=1.0,
         retry_max=5,
         retry_statuses=None,
+        ca_path=None,
     ):
         """
         The main interface to the Linode API.
@@ -96,11 +97,14 @@ def __init__(
         :param retry_statuses: Additional HTTP response statuses to retry on.
                                By default, the client will retry on 408, 429, and 502
                                responses.
+        :param ca_path: The path to a CA file to use for API requests in this client.
+        :type ca_path: str
         """
         self.base_url = base_url
         self._add_user_agent = user_agent
         self.token = token
         self.page_size = page_size
+        self.ca_path = ca_path
 
         retry_forcelist = [408, 429, 502]
 
@@ -267,7 +271,9 @@ def _api_call(
         if data is not None:
             body = json.dumps(data)
 
-        response = method(url, headers=headers, data=body)
+        response = method(
+            url, headers=headers, data=body, verify=self.ca_path or True
+        )
 
         warning = response.headers.get("Warning", None)
         if warning:

linode_api4/login_client.py

@@ -324,7 +324,11 @@ def serialize(scopes):
 
 class LinodeLoginClient:
     def __init__(
-        self, client_id, client_secret, base_url="https://login.linode.com"
+        self,
+        client_id,
+        client_secret,
+        base_url="https://login.linode.com",
+        ca_path=None,
     ):
         """
         Create a new LinodeLoginClient.  These clients do not make any requests
@@ -339,10 +343,13 @@ def __init__(
         :param base_url: The URL for Linode's OAuth server.  This should not be
                          changed.
         :type base_url: str
+        :param ca_path: The path to the CA file to use for requests run by this client.
+        :type ca_path: str
         """
         self.base_url = base_url
         self.client_id = client_id
         self.client_secret = client_secret
+        self.ca_path = ca_path
 
     def _login_uri(self, path):
         return "{}{}".format(self.base_url, path)
@@ -423,6 +430,7 @@ def oauth_redirect():
                 "client_id": self.client_id,
                 "client_secret": self.client_secret,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:
@@ -467,6 +475,7 @@ def refresh_oauth_token(self, refresh_token):
                 "client_secret": self.client_secret,
                 "refresh_token": refresh_token,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:
@@ -501,6 +510,7 @@ def expire_token(self, token):
                 "client_secret": self.client_secret,
                 "token": token,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:

test/script/add_to_xml_test_report.py

@@ -0,0 +1,41 @@
+import argparse
+import xml.etree.ElementTree as ET
+
+# Parse command-line arguments
+parser = argparse.ArgumentParser(
+    description="Modify XML with workflow information"
+)
+parser.add_argument("--branch_name", required=True)
+parser.add_argument("--gha_run_id", required=True)
+parser.add_argument("--gha_run_number", required=True)
+parser.add_argument(
+    "--xmlfile", required=True
+)  # Added argument for XML file path
+
+args = parser.parse_args()
+
+# Open and parse the XML file
+xml_file_path = args.xmlfile
+tree = ET.parse(xml_file_path)
+root = tree.getroot()
+
+# Create new elements for the information
+branch_name_element = ET.Element("branch_name")
+branch_name_element.text = args.branch_name
+
+gha_run_id_element = ET.Element("gha_run_id")
+gha_run_id_element.text = args.gha_run_id
+
+gha_run_number_element = ET.Element("gha_run_number")
+gha_run_number_element.text = args.gha_run_number
+
+# Add the new elements to the root of the XML
+root.append(branch_name_element)
+root.append(gha_run_id_element)
+root.append(gha_run_number_element)
+
+# Save the modified XML
+modified_xml_file_path = xml_file_path  # Overwrite it
+tree.write(modified_xml_file_path)
+
+print(f"Modified XML saved to {modified_xml_file_path}")

test/script/test_report_upload_script.py

@@ -0,0 +1,43 @@
+import os
+import sys
+
+import boto3
+from botocore.exceptions import NoCredentialsError
+
+ACCESS_KEY = os.environ.get("LINODE_CLI_OBJ_ACCESS_KEY")
+SECRET_KEY = os.environ.get("LINODE_CLI_OBJ_SECRET_KEY")
+BUCKET_NAME = "dx-test-results"
+
+linode_obj_config = {
+    "aws_access_key_id": ACCESS_KEY,
+    "aws_secret_access_key": SECRET_KEY,
+    "endpoint_url": "https://us-southeast-1.linodeobjects.com",
+}
+
+
+def upload_to_linode_object_storage(file_name):
+    try:
+        s3 = boto3.client("s3", **linode_obj_config)
+
+        s3.upload_file(Filename=file_name, Bucket=BUCKET_NAME, Key=file_name)
+
+        print(f"Successfully uploaded {file_name} to Linode Object Storage.")
+
+    except NoCredentialsError:
+        print(
+            "Credentials not available. Ensure you have set your AWS credentials."
+        )
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python upload_to_linode.py <file_name>")
+        sys.exit(1)
+
+    file_name = sys.argv[1]
+
+    if not file_name:
+        print("Error: The provided file name is empty or invalid.")
+        sys.exit(1)
+
+    upload_to_linode_object_storage(file_name)

test/unit/base.py

@@ -36,7 +36,7 @@ def load_json(url):
     return FIXTURES.get_fixture(formatted_url)
 
 
-def mock_get(url, headers=None, data=None):
+def mock_get(url, headers=None, data=None, **kwargs):
     """
     Loads the response from a JSON file
     """

test/unit/linode_client_test.py

@@ -258,6 +258,28 @@ def test_tag_create_with_entities(self):
                 },
             )
 
+    def test_override_ca(self):
+        """
+        Tests that the CA file used for API requests can be overridden.
+        """
+        self.client.ca_path = "foobar"
+
+        called = False
+
+        old_get = self.client.session.get
+
+        def get_mock(*params, verify=True, **kwargs):
+            nonlocal called
+            called = True
+            assert verify == "foobar"
+            return old_get(*params, **kwargs)
+
+        self.client.session.get = get_mock
+
+        self.client.linode.instances()
+
+        assert called
+
 
 class AccountGroupTest(ClientBaseCase):
     """