aplos-nca-saas-sdk 0.0.11__py3-none-any.whl → 0.0.13__py3-none-any.whl

aplos_nca_saas_sdk/integration_testing/integration_test_base.py

@@ -1,11 +1,11 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
-from typing import Dict, Any, List
 from abc import ABC, abstractmethod
+from typing import List
 
 from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
     TestConfiguration,
@@ -21,11 +21,18 @@ class IntegrationTestBase(ABC):
     """
 
     def __init__(self, name: str | None = None, index: int = 0):
-        self.name = name
+        self.__name = name
         self.index = index
         self.__config: TestConfiguration = TestConfiguration()
         self.__results: List[IntegrationTestResponse] = []
 
+    @property
+    def name(self) -> str:
+        """
+        Get the name of the test
+        """
+        return self.__name if self.__name is not None else self.__class__.__name__
+
     @property
     def config(self) -> TestConfiguration:
         """

aplos_nca_saas_sdk/integration_testing/integration_test_configurations.py

@@ -1,16 +1,21 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
 import json
 from typing import Any, Dict
-from aplos_nca_saas_sdk.integration_testing.configs.app_settings import (
+from aplos_nca_saas_sdk.integration_testing.configs.app_settings_config import (
     ApplicationSettings,
 )
-from aplos_nca_saas_sdk.integration_testing.configs.file_upload import FileUploads
-from aplos_nca_saas_sdk.integration_testing.configs.login import Logins
+from aplos_nca_saas_sdk.integration_testing.configs.file_upload_config import (
+    FileUploadConfigs,
+)
+from aplos_nca_saas_sdk.integration_testing.configs.login_config import LoginConfigs
+from aplos_nca_saas_sdk.integration_testing.configs.nca_execution_config import (
+    NCAExecutionConfigs,
+)
 
 
 class TestConfiguration:
@@ -21,8 +26,10 @@ class TestConfiguration:
 
     def __init__(self):
         self.app_config: ApplicationSettings = ApplicationSettings()
-        self.logins: Logins = Logins()
-        self.file_uploads: FileUploads = FileUploads()
+        self.logins: LoginConfigs = LoginConfigs()
+        self.file_uploads: FileUploadConfigs = FileUploadConfigs()
+        self.nca_executions: NCAExecutionConfigs = NCAExecutionConfigs()
+
     def load(self, file_path: str):
         """
         Loads the configuration from a file
@@ -37,4 +44,5 @@ class TestConfiguration:
 
         self.logins.load(config.get("login_test", {}))
         self.app_config.load(config.get("application_config_test", {}))
-        self.file_uploads.load(config.get("file_upload_test", {}))
+        self.file_uploads.load(config.get("file_upload_test", {}))
+        self.nca_executions.load(config.get("analysis_execution_test", {}))

aplos_nca_saas_sdk/integration_testing/integration_test_factory.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """

aplos_nca_saas_sdk/integration_testing/integration_test_response.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """

aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -93,6 +93,8 @@ class IntegrationTestSuite:
         return len(failures) == 0
 
     def __print_results(self, start_time: datetime, failures: List[Dict[str, Any]]):
+        print("")
+        print("--------------------------------")
         print("Test Results:")
         skipped = sum([test["skipped_count"] for test in self.test_results])
 
@@ -101,8 +103,6 @@ class IntegrationTestSuite:
             print(
                 f"  {test_result['test_name']} {'succeeded' if test_result['success'] else 'failed'} duration: {duration}"
             )
-            if not test_result["success"]:
-                print(f"    Errors: {test_result['errors']}")
 
         print(f"Test Suite completed in {datetime.now(UTC) - start_time}")
 
@@ -110,3 +110,10 @@ class IntegrationTestSuite:
         print(f"  Successful: {len(self.test_results) - len(failures) - skipped}")
         print(f"  Skipped: {skipped}")
         print(f"  Failed: {len(failures)}")
+
+        if len(failures) > 0:
+            print("--------------------------------")
+
+        for test_result in self.test_results:
+            if not test_result["success"]:
+                print(f"Errors: {test_result['errors']}")

aplos_nca_saas_sdk/integration_testing/main.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -47,18 +47,18 @@ def override_config(config: TestConfiguration):
     """Override the configuration for the tests"""
     username = os.getenv("TEST_USERNAME")
     password = os.getenv("TEST_PASSWORD")
-    domain = os.getenv("TEST_DOMAIN")
+    host = os.getenv("TEST_HOST")
 
-    if not username or not password or not domain:
+    if not username or not password or not host:
         raise RuntimeError(
-            "TEST_USERNAME, TEST_PASSWORD, and TEST_DOMAIN must be set in the environment"
+            "TEST_USERNAME, TEST_PASSWORD, and TEST_HOST must be set in the environment"
         )
 
     config.logins.list.clear()
-    config.logins.add(username=username, password=password, domain=domain)
+    config.logins.add(username=username, password=password, host=host)
 
     config.app_config.domains.list.clear()
-    config.app_config.domains.add(domain=domain)
+    config.app_config.domains.add(host=host)
 
 
 if __name__ == "__main__":

aplos_nca_saas_sdk/integration_testing/readme.md

@@ -9,7 +9,7 @@ The integration tests will require the following:
 ### Environment Vars
 |Variable Name|Description|
 |--|--|
-|APLOS_API_DOMAIN|The full domain. e.g. app.aplos-nca.com| 
+|APLOS_host|The full host name. e.g. app.aplos-nca.com| 
 
 
 ### Users

aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -27,10 +27,10 @@ class TestAppConfiguration(IntegrationTestBase):
 
         self.results.clear()
         for domain_config in self.config.app_config.domains.list:
-            config: NCAAppConfiguration = NCAAppConfiguration(domain_config.domain)
+            config: NCAAppConfiguration = NCAAppConfiguration(domain_config.host)
 
             test_response: IntegrationTestResponse = IntegrationTestResponse()
-            test_response.meta = {"domain": domain_config}
+            test_response.meta = {"host": domain_config}
 
             if not domain_config.enabled or not self.config.app_config.enabled:
                 test_response.skipped = True

aplos_nca_saas_sdk/integration_testing/tests/app_login_test.py

@@ -1,10 +1,10 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
-from aplos_nca_saas_sdk.nca_resources.nca_login import NCALogin
+from aplos_nca_saas_sdk.nca_resources.nca_authenticator import NCAAuthenticator
 
 
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
@@ -35,11 +35,11 @@ class TestAppLogin(IntegrationTestBase):
                 self.results.append(test_response)
                 continue
             try:
-                nca_login = NCALogin(aplos_saas_domain=login.domain)
+                nca_login = NCAAuthenticator(host=login.host)
                 token = nca_login.authenticate(
                     username=login.username, password=login.password
                 )
-                test_response.response = token
+
                 if not token:
                     test_response.error = "Failed to authenticate"
 

aplos_nca_saas_sdk/integration_testing/tests/file_upload_test.py

@@ -1,16 +1,16 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
 import time
 from datetime import datetime, timedelta
-from typing import Any, Dict
+from typing import Any, Dict, List
 
 import requests
 from aws_lambda_powertools import Logger
-from aplos_nca_saas_sdk.integration_testing.configs.login import Login
+from aplos_nca_saas_sdk.integration_testing.configs.login_config import LoginConfig
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
@@ -18,8 +18,12 @@ from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
     IntegrationTestResponse,
 )
 from aplos_nca_saas_sdk.nca_resources.nca_file_upload import NCAFileUpload
-from aplos_nca_saas_sdk.nca_resources.nca_login import NCALogin
+from aplos_nca_saas_sdk.nca_resources.nca_file_download import NCAFileDownload
+from aplos_nca_saas_sdk.nca_resources.nca_authenticator import NCAAuthenticator
 from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
+from aplos_nca_saas_sdk.integration_testing.configs.file_upload_config import (
+    FileUploadConfig,
+)
 
 logger = Logger()
 
@@ -35,28 +39,30 @@ class FileUploadTest(IntegrationTestBase):
 
         self.results.clear()
 
-        for fileupload in self.config.file_uploads.list:
+        file_upload: FileUploadConfig
+        for file_upload in self.config.file_uploads.list:
             test_response: IntegrationTestResponse = IntegrationTestResponse()
             test_response.name = self.name
             try:
                 # Confirm Login
-                nca_login = self.__login(fileupload.login)
-                if not nca_login.jwt:
-                    test_response.error = "Failed to authenticate"
+                nca_login = self.__login(file_upload.login)
+                # if not nca_login.cognito.jwt:
+                #     test_response.error = "Failed to authenticate"
+                # else:
+                # Confirm Upload
+                upload_response: Dict[str, Any] = self.__upload(
+                    nca_login, file_upload.file_path
+                )
+                if upload_response is None:
+                    test_response.error = "Failed to upload"
                 else:
-                    # Confirm Upload
-                    upload_response: Dict[str, Any] = self.__upload(
-                        nca_login, fileupload.filepath
-                    )
-                    if upload_response is None:
-                        test_response.error = "Failed to upload"
-                    else:
-                        # Confirm conversion and download
-                        # Allow time buffer so file data is available
-                        time.sleep(3)
-                        self.__download(
-                            nca_login, upload_response.get("file_id"), test_response
-                        )
+                    # Confirm conversion and download
+                    # Allow time buffer so file data is available
+                    file_id: str = upload_response.get("file_id", "")
+                    if not file_id:
+                        raise RuntimeError("Failed to get a file_id from the upload")
+                    time.sleep(3)
+                    self.__download(nca_login, file_id, test_response)
 
             except Exception as e:  # pylint: disable=w0718
                 test_response.error = str(e)
@@ -65,91 +71,37 @@ class FileUploadTest(IntegrationTestBase):
 
         return self.success()
 
-    def __login(self, login: Login) -> NCALogin:
-        nca_login = NCALogin(aplos_saas_domain=login.domain)
+    def __login(self, login: LoginConfig) -> NCAAuthenticator:
+        nca_login = NCAAuthenticator(host=login.host)
         nca_login.authenticate(username=login.username, password=login.password)
         return nca_login
 
-    def __upload(self, nca_login: NCALogin, upload_file_path: str) -> Dict[str, Any]:
+    def __upload(self, auth: NCAAuthenticator, upload_file_path: str) -> Dict[str, Any]:
         logger.info({"message": "Uploading file", "file_path": upload_file_path})
 
-        nca_file_upload = NCAFileUpload(nca_login)
+        nca_file_upload = NCAFileUpload(auth.host)
+        nca_file_upload.authenticator = auth
         upload_response: Dict[str, Any] = nca_file_upload.upload(upload_file_path)
         return upload_response
 
     def __download(
         self,
-        nca_login: NCALogin,
+        nca_login: NCAAuthenticator,
         file_id: str,
         test_response: IntegrationTestResponse,
     ):
         logger.info({"message": "Downloading file", "file_id": file_id})
-        file_data_endpoint = nca_login.config.endpoints.file_data(
-            nca_login.cognito.tenant_id,
-            nca_login.cognito.user_id,
-            file_id,
-        )
-        file_info_endpoint = nca_login.config.endpoints.file(
-            nca_login.cognito.tenant_id,
-            nca_login.cognito.user_id,
-            file_id,
-        )
-
-        max_wait_in_minutes: int = 3
-        headers = HttpUtilities.get_headers(nca_login.jwt)
-        current_time = datetime.now()
-
-        # Create a timedelta object representing 3 minutes
-        time_delta = timedelta(minutes=max_wait_in_minutes)
-        # Add the timedelta to the current time
-        max_time = current_time + time_delta
-
-        complete = False
-        while not complete:
-            response = requests.get(file_info_endpoint, headers=headers, timeout=60)
-            json_response: dict = response.json()
-            errors = []
-            errors.extend(json_response.get("errors") or [])
-            status = json_response.get("workable_state")
-            complete = status == "ready"
-
-            if status == "invalid" or len(errors) > 0:
-                test_response.success = False
-                test_response.error = (
-                    "File conversion failed."
-                    if len(errors) < 0
-                    else f"File conversion failed with errors ${errors}."
-                )
-                break
-            if complete:
-                break
-            if not complete:
-                time.sleep(5)
-            if datetime.now() > max_time:
-                test_response.success = False
-                test_response.error = (
-                    "Timeout attempting to get conversion file status. "
-                    f"The current timeout limit is {max_wait_in_minutes} minutes. "
-                    "You may need to up the timeout period, or check for errors. "
-                )
-                break
-
-        if test_response.error is not None:
-            return
+        downloader: NCAFileDownload = NCAFileDownload(nca_login.host)
+        downloader.authenticator = nca_login
+        response = downloader.download(file_id)
 
-        file_response = requests.get(file_data_endpoint, headers=headers, timeout=30)
-
-        json_file_response: dict = file_response.json()
-        data = json_file_response.get("data", None)
-        error = json_file_response.get("error", None)
-
-        if data is None:
+        status = response.get("workable_state")
+        if status != "ready":
             test_response.success = False
-            test_response.error = "File download missing expected data. "
-        if error is not None:
-            test_response.success = False
-            test_response.error = (
-                test_response.error or ""
-            ) + f"File download contained error ${error}"
+            test_response.error = f"File conversion failed. Status: {status}"
+        else:
+            test_response.success = True
+
+        test_response.response = response
 
-        test_response.success = True
+        return response

aplos_nca_saas_sdk/integration_testing/tests/nca_analysis_test.py

@@ -0,0 +1,89 @@
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from pathlib import Path
+
+from aws_lambda_powertools import Logger
+
+from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
+    IntegrationTestBase,
+)
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
+from aplos_nca_saas_sdk.nca_resources.nca_analysis import NCAAnalysis
+from aplos_nca_saas_sdk.utilities.file_utility import FileUtility
+
+logger = Logger(service="NCAAnalysisTest")
+
+
+class NCAAnalysisTest(IntegrationTestBase):
+    """NCA Execution Test Container"""
+
+    def __init__(self):
+        super().__init__("nca-execution")
+
+    def test(self) -> bool:
+        """Test Engine Execution"""
+
+        self.results.clear()
+
+        for nca_execution_config in self.config.nca_executions.list:
+            test_response: IntegrationTestResponse = IntegrationTestResponse()
+            test_response.name = self.name
+
+            input_file_path = (
+                FileUtility.load_filepath(nca_execution_config.input_file_path),
+            )
+            logger.info(
+                {
+                    "message": "Creating NCA Analysis Execution for input file.",
+                    "path": input_file_path,
+                    "path2": nca_execution_config.input_file_path,
+                }
+            )
+            try:
+                # Create new NCA Execution
+                nca_execution: NCAAnalysis = NCAAnalysis(
+                    nca_execution_config.login.host
+                )
+
+                # Initialize Configuration Data
+
+                # Execute, the execution should raise errors that will fail the test
+                logger.info({"message": "Invoking Execution"})
+                execution_response = nca_execution.execute(
+                    username=nca_execution_config.login.username,
+                    password=nca_execution_config.login.password,
+                    input_file_path=FileUtility.load_filepath(
+                        nca_execution_config.input_file_path
+                    ),
+                    config_data=nca_execution_config.config_data,
+                    meta_data=nca_execution_config.meta_data,
+                    wait_for_results=True,
+                    output_directory=nca_execution_config.output_dir,
+                    unzip_after_download=False,
+                )
+
+                # Verify Download
+                logger.info(
+                    {"message": "Execution complete. Verifying results download."}
+                )
+
+                expected_output_file = execution_response.get("results", {}).get("file")
+                if expected_output_file is None:
+                    raise RuntimeError(
+                        "Expected populated output_file from NCAExecution was None."
+                    )
+                elif not Path(expected_output_file).is_file():
+                    raise RuntimeError("Expected downloaded file does not exist.")
+
+            except Exception as e:  # pylint: disable=w0718
+                test_response.error = str(e)
+
+            self.results.append(test_response)
+
+        return self.success()

aplos_nca_saas_sdk/integration_testing/tests/{app_execution_test.py → validation_test.py}

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """

aplos_nca_saas_sdk/nca_resources/_api_base.py

@@ -0,0 +1,44 @@
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Any
+
+
+from aplos_nca_saas_sdk.nca_resources.nca_authenticator import NCAAuthenticator
+from aplos_nca_saas_sdk.nca_resources.nca_endpoints import NCAEndpoints
+
+
+class NCAApiBaseClass:
+    """NCA Api Base Class"""
+
+    def __init__(self, host: str) -> None:
+        self.host = host
+        self.__authenticator: NCAAuthenticator = NCAAuthenticator(host=host)
+        self.__endpoints: NCAEndpoints = NCAEndpoints(host=host)
+        if not host:
+            raise ValueError("Missing Aplos Api Domain")
+
+    @property
+    def authenticator(self) -> NCAAuthenticator:
+        """Gets the authenticator"""
+
+        return self.__authenticator
+
+    @authenticator.setter
+    def authenticator(self, value: Any) -> None:
+        """Sets the authenticator"""
+
+        self.__authenticator = value
+
+    @property
+    def endpoints(self) -> NCAEndpoints:
+        """Gets the endpoints"""
+
+        if self.authenticator.cognito.jwt:
+            self.__endpoints.tenant_id = self.authenticator.cognito.tenant_id
+            self.__endpoints.user_id = self.authenticator.cognito.user_id
+
+        return self.__endpoints

aplos_nca_saas_sdk/{aws_resources → nca_resources}/aws_cognito.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -14,10 +14,9 @@ from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
 )
 
 
-class CognitoAuthenication:
+class CognitoAuthentication:
     """
     Cognito Authentication
-
     """
 
     def __init__(
@@ -73,22 +72,26 @@ class CognitoAuthenication:
         return self.__region
 
     def __validate_parameters(self) -> None:
+        """
+        Validate the required parameters.
+        We need either:
+          - the Cognito ClientId and Cognito Region
+          - or the Aplos Domain (which can get the clientId and region)
+        """
         if self.__client_id is None and self.__aplos_domain is not None:
-            self.__config = NCAAppConfiguration(aplos_saas_domain=self.__aplos_domain)
+            self.__config = NCAAppConfiguration(host=self.__aplos_domain)
             self.__client_id = self.__config.cognito_client_id
             self.__region = self.__config.cognito_region
 
         if self.__client_id is None:
             raise RuntimeError(
                 "Missing Cognito Client Id. "
-                "Pass in a client_id as a command arg or set the COGNITO_CLIENT_ID enviornment var. "
                 "Alternatively, set the aplos_domain to automatically get the client_id and region."
             )
 
         if self.__region is None:
             raise RuntimeError(
                 "Missing Cognito Region"
-                "Pass in a region as a command arg or set the COGNITO_REGION enviornment var. "
                 "Alternatively, set the aplos_domain to automatically get the client_id and region."
             )
 
@@ -139,13 +142,16 @@ class CognitoAuthenication:
             self.__parse_jwt(self.__jwt)
             return self.__jwt
 
-        raise RuntimeError("Failed to get a JWT token")
+        raise RuntimeError(
+            "Failed to get a JWT token.  Check the error logs for more information."
+        )
 
     def __parse_jwt(self, encoded_jwt: str) -> None:
         # Decode the payload (second part) from Base64
         decoded_jwt: dict = jwt_lib.decode(
             encoded_jwt, options={"verify_signature": False}
         )
+        # custom fields contain information we'll need for later requests
         self.__user_id = decoded_jwt.get("custom:aplos_user_id")
         self.__tenant_id = decoded_jwt.get("custom:aplos_user_tenant_id")
 

aplos_nca_saas_sdk/{aws_resources → nca_resources}/aws_s3_presigned_payload.py

@@ -1,12 +1,12 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
 
-class S3PresignedPayload:
-    """S3PresignedPayload"""
+class S3PresignedUrlPayload:
+    """S3 Presigned Url Payload"""
 
     def __init__(self, payload: dict | None = None) -> None:
         self.url: str | None = None