aplos-nca-saas-sdk 0.0.14__tar.gz → 0.0.15__tar.gz

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aplos_nca_saas_sdk
-Version: 0.0.14
+Version: 0.0.15
 Summary: Aplos NCA SaaS SDK
 Project-URL: Homepage, https://aplosanalytics.com/
 Project-URL: Documentation, https://docs.aplosanalytics.com/

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/pyproject.toml

@@ -26,7 +26,7 @@ keywords = [
     "Clinical Trials"
 ]
 
-version = "0.0.14"
+version = "0.0.15"
 authors = [
   { name="Eric Wilson", email="eric.wilson@aplosanalytics.com" }
 ]

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/integration_testing/configs/app_settings_config.py

@@ -85,4 +85,6 @@ class ApplicationSettings(ConfigBase):
     def load(self, test_config: Dict[str, Any]):
         """Load the hosts from the config"""
         super().load(test_config)
+        if not self.enabled:
+            return
         self.hosts.load(test_config)

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/integration_testing/configs/file_upload_config.py

@@ -71,6 +71,9 @@ class FileUploadConfigs(ConfigBase):
         """Load the file uploads from a list of dictionaries"""
 
         super().load(test_config)
+        if not self.enabled:
+            return
+
         test_config_login: LoginConfig | None = LoginConfigs.try_load_login(
             test_config.get("login", None)
         )

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/integration_testing/configs/login_config.py

@@ -98,6 +98,9 @@ class LoginConfigs(ConfigBase):
         """Load the logins from a list of dictionaries"""
 
         super().load(test_config)
+        if not self.enabled:
+            return
+
         logins: List[Dict[str, str]] = test_config.get("logins", [])
         for login in logins:
             login_config = LoginConfigs.try_load_login(login)

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/integration_testing/configs/nca_execution_config.py

@@ -4,16 +4,18 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
-import os
 import json
+import os
 from typing import Any, Dict, List
+
+from aws_lambda_powertools import Logger
+
 from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
 from aplos_nca_saas_sdk.integration_testing.configs.login_config import (
     LoginConfig,
     LoginConfigs,
 )
 from aplos_nca_saas_sdk.utilities.file_utility import FileUtility
-from aws_lambda_powertools import Logger
 
 logger = Logger(service="NCAExecutionConfig")
 
@@ -124,6 +126,8 @@ class NCAExecutionConfigs(ConfigBase):
         """Loads the NCA Execution configs from a list of dictionaries"""
 
         super().load(test_config)
+        if not self.enabled:
+            return
 
         base_login: LoginConfig | None = LoginConfigs.try_load_login(
             test_config.get("login", None)

aplos_nca_saas_sdk-0.0.15/src/aplos_nca_saas_sdk/integration_testing/configs/nca_validation_config.py

@@ -0,0 +1,95 @@
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Any, Dict, List
+
+from aws_lambda_powertools import Logger
+
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+from aplos_nca_saas_sdk.integration_testing.configs.login_config import (
+    LoginConfig,
+    LoginConfigs,
+)
+
+
+logger = Logger(service="NCAValidationConfig")
+
+
+class NCAValidationConfig(ConfigBase):
+    """
+    NCA Validation Config: Defines an NCA Validation configuration that the application tests will check against
+
+    """
+
+    def __init__(
+        self,
+        login: LoginConfig,
+    ):
+        super().__init__()
+
+        if login is None:
+            raise RuntimeError("login is required")
+        self.__login = login
+
+    @property
+    def login(self) -> LoginConfig:
+        """Login Configuration"""
+        return self.__login
+
+
+class NCAValidationConfigs(ConfigBase):
+    """
+    NCA Validation Configs: Defines the configurations that the application NCA Engine tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__list: List[NCAValidationConfig] = []
+
+    @property
+    def list(self) -> List[NCAValidationConfig]:
+        """List the nca validation configurations"""
+        return list(filter(lambda x: x.enabled, self.__list))
+
+    def add(
+        self,
+        *,
+        login: LoginConfig,
+        enabled: bool = True,
+    ):
+        """Add an NCA Validation Config"""
+        config = NCAValidationConfig(login)
+        config.enabled = enabled
+        self.__list.append(config)
+
+    def load(self, test_config: Dict[str, Any]):
+        """Loads the NCA Validation configs from a list of dictionaries"""
+
+        super().load(test_config)
+        if not self.enabled:
+            return
+
+        base_login: LoginConfig | None = LoginConfigs.try_load_login(
+            test_config.get("login", None)
+        )
+
+        validations: List[Dict[str, Any]] = test_config.get("validations", [])
+        for validation in validations:
+            enabled = bool(validation.get("enabled", True))
+            login: LoginConfig | None = None
+            if "login" in validation:
+                login = LoginConfigs.try_load_login(validation["login"])
+            else:
+                login = base_login
+
+            if not login:
+                raise RuntimeError("Failed to load the login configuration")
+
+            self.add(
+                login=login,
+                enabled=enabled,
+            )

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/integration_testing/integration_test_configurations.py

@@ -17,6 +17,10 @@ from aplos_nca_saas_sdk.integration_testing.configs.nca_execution_config import
     NCAExecutionConfigs,
 )
 
+from aplos_nca_saas_sdk.integration_testing.configs.nca_validation_config import (
+    NCAValidationConfigs,
+)
+
 
 class TestConfiguration:
     """
@@ -29,6 +33,7 @@ class TestConfiguration:
         self.logins: LoginConfigs = LoginConfigs()
         self.file_uploads: FileUploadConfigs = FileUploadConfigs()
         self.nca_executions: NCAExecutionConfigs = NCAExecutionConfigs()
+        self.nca_validations: NCAValidationConfigs = NCAValidationConfigs()
 
     def load(self, file_path: str):
         """
@@ -46,3 +51,4 @@ class TestConfiguration:
         self.app_config.load(config.get("application_config_test", {}))
         self.file_uploads.load(config.get("file_upload_test", {}))
         self.nca_executions.load(config.get("analysis_execution_test", {}))
+        self.nca_validations.load(config.get("analysis_validation_test", {}))

aplos_nca_saas_sdk-0.0.15/src/aplos_nca_saas_sdk/integration_testing/tests/nca_analysis_validation_test.py

@@ -0,0 +1,62 @@
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+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_validations import NCAValidation
+
+
+logger = Logger(service="NCAAnalysisValidationTest")
+
+
+class NCAAnalysisValidationTest(IntegrationTestBase):
+    """NCA Validation Test Container"""
+
+    def __init__(self):
+        super().__init__("nca-validation")
+
+    def test(self) -> bool:
+        """Test Engine Validation"""
+
+        self.results.clear()
+
+        for config in self.config.nca_validations.list:
+            test_response: IntegrationTestResponse = IntegrationTestResponse()
+            test_response.name = self.name
+
+            try:
+                # Create new NCA Execution
+                nca_validation: NCAValidation = NCAValidation(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_validation.execute(
+                    username=config.login.username,
+                    password=config.login.password,
+                    wait_for_results=True,
+                )
+
+                # Verify Download
+                logger.info({"message": "Validation complete. Verifying results."})
+
+                pass_fail = execution_response.get("results", {}).get("pass_fail")
+                if pass_fail != "pass":
+                    raise RuntimeError("One or more validations failed.")
+
+            except Exception as e:  # pylint: disable=w0718
+                test_response.error = str(e)
+
+            self.results.append(test_response)
+
+        return self.success()

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/nca_resources/nca_analysis.py

@@ -150,7 +150,7 @@ class NCAAnalysis(NCAApiBaseClass):
             raise ValueError(
                 "Missing config_data.  Please provide a valid config_data."
             )
-        headers = HttpUtilities.get_headers(self.authenticator.cognito.jwt)
+        headers = self.authenticator.get_jwt_http_headers()
         # to start a new execution we need the location of the file (s3 bucket and object key)
         # you basic configuration
         # optional meta data

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/nca_resources/nca_authenticator.py

@@ -9,6 +9,7 @@ from aplos_nca_saas_sdk.nca_resources.aws_cognito import CognitoAuthentication
 from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
     NCAAppConfiguration,
 )
+from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
 
 
 class NCAAuthenticator:
@@ -105,3 +106,7 @@ class NCAAuthenticator:
         self.cognito.login(username=username, password=password)
 
         return self.cognito.jwt
+
+    def get_jwt_http_headers(self) -> str:
+        """Get the formatted http headers for the JWT"""
+        return HttpUtilities.get_headers(self.cognito.jwt)

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/nca_resources/nca_endpoints.py

@@ -70,6 +70,10 @@ class NCAEndpoints:
         """Returns the validations endpoint"""
         return f"{self.user_path}/nca/validations"
 
+    def validation(self, batch_id: str) -> str:
+        """Returns the validations endpoint for a specific batch"""
+        return f"{self.validations}/{batch_id}"
+
     @property
     def files(self) -> str:
         """Returns the files endpoint"""

aplos_nca_saas_sdk-0.0.15/src/aplos_nca_saas_sdk/nca_resources/nca_validations.py

@@ -0,0 +1,101 @@
+"""
+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
+
+import requests
+from aws_lambda_powertools import Logger
+from aplos_nca_saas_sdk.nca_resources._api_base import NCAApiBaseClass
+
+logger = Logger(service="nca-validations")
+
+
+class NCAValidation(NCAApiBaseClass):
+    """NCA Analysis Validation API"""
+
+    def __init__(self, host: str) -> None:
+        super().__init__(host)
+
+    def execute(
+        self,
+        username: str,
+        password: str,
+        wait_for_results: bool = True,
+        max_wait_in_seconds: int = 900,
+    ) -> Dict[str, Any]:
+        """
+        Runs a validation
+
+        Args:
+            username (str): username
+            password (str): password
+
+        Returns:
+            Dict[str, Any]: response object
+        """
+
+        self.authenticator.authenticate(username=username, password=password)
+        url = self.endpoints.validations
+        # no payload required
+        headers = self.authenticator.get_jwt_http_headers()
+        validation_post_response = requests.post(url, headers=headers, timeout=30)
+
+        if validation_post_response.status_code != 200:
+            raise RuntimeError(
+                f"Failed to execution a validation batch. Status Code: {validation_post_response.status_code}"
+                f"Reason: {validation_post_response.reason}"
+            )
+
+        response = {
+            "queued": validation_post_response.json(),
+            "results": None,
+        }
+
+        if wait_for_results:
+            batch_id = (
+                validation_post_response.json().get("validation_batch", {}).get("id")
+            )
+
+            if not batch_id:
+                raise RuntimeError(
+                    "Failed to get the validation batch id from the response."
+                )
+            completed = False
+            current_time = datetime.now()
+            # Create a timedelta object representing 15 minutes
+            time_delta = timedelta(seconds=max_wait_in_seconds)
+            # Add the timedelta to the current time
+            max_time = current_time + time_delta
+            while not completed:
+                validation_get_response = requests.get(
+                    self.endpoints.validation(batch_id=batch_id),
+                    timeout=30,
+                    headers=self.authenticator.get_jwt_http_headers(),
+                )
+                if validation_get_response.status_code != 200:
+                    raise RuntimeError(
+                        f"Failed to get validation results. Status Code: {validation_get_response.status_code}"
+                        f"Reason: {validation_get_response.reason}"
+                    )
+                status = validation_get_response.json().get("status")
+                completed = status == "complete"
+
+                if not completed:
+                    if datetime.now() > max_time:
+                        raise RuntimeError(
+                            "Timeout attempting to get validation results. "
+                            f"The current timeout limit is {max_wait_in_seconds} seconds. "
+                            "You may need to up the timeout period, or check for errors. "
+                        )
+                    logger.info(f"waiting for results.... {status}")
+                    time.sleep(15)
+                else:
+                    response["results"] = validation_get_response.json()
+
+        logger.info("Validation complete.")
+        return response

{aplos_nca_saas_sdk-0.0.14 → aplos_nca_saas_sdk-0.0.15}/src/aplos_nca_saas_sdk/version.py

@@ -1,4 +1,4 @@
 # Aplos NCA SaaS SDK Version File
 # This is automatically generated during the build process. 
 # DO NOT UPDATE IT DIRECTLY. IT WILL BE OVERWRITTEN. 
-__version__ = '0.0.14'
+__version__ = '0.0.15'

aplos_nca_saas_sdk-0.0.14/src/aplos_nca_saas_sdk/nca_resources/nca_validations.py

@@ -1,34 +0,0 @@
-"""
-Copyright 2024-2025 Aplos Analytics
-All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
-Property of Aplos Analytics, Utah, USA
-"""
-
-import requests
-
-from aplos_nca_saas_sdk.nca_resources._api_base import NCAApiBaseClass
-
-
-class NCAValidation(NCAApiBaseClass):
-    """NCA Analysis Validation API"""
-
-    def __init__(self, host: str) -> None:
-        super().__init__(host)
-
-    def validate(self, jwt: str) -> bool:
-        """
-        Validates the JWT
-
-        Args:
-            jwt (str): JWT
-
-        Returns:
-            bool: True if the JWT is valid
-        """
-        url = self.endpoints.validations
-        response = requests.post(url, json={"jwt": jwt}, timeout=30)
-
-        if response.status_code != 200:
-            return False
-
-        return True