aplos-nca-saas-sdk 0.0.3__tar.gz → 0.0.5__tar.gz

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/.vscode/settings.json

@@ -11,8 +11,7 @@
     ],
     "python.testing.cwd": "${workspaceFolder}",
     "python.analysis.extraPaths": [                
-        "${workspaceFolder}/src",
-        "${workspaceFolder}/src/aplos_nca_saas_sdk",        
+        "${workspaceFolder}/src",             
         "${workspaceFolder}/tests",
         "${workspaceFolder}/devops",
         "${workspaceFolder}/devops/cdk",

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: aplos_nca_saas_sdk
-Version: 0.0.3
+Version: 0.0.5
 Summary: Aplos NCA SaaS SDK
 Project-URL: Homepage, https://aplosanalytics.com/
 Project-URL: Documentation, https://docs.aplosanalytics.com/
@@ -16,8 +16,9 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
-Requires-Dist: aws-lambda-powertools==2.38.1
+Requires-Dist: aws-lambda-powertools>=3.3.0
 Requires-Dist: boto3==1.34.110
+Requires-Dist: mypy-boto3-cognito-idp>=1.35.68
 Requires-Dist: pyjwt==2.9.0
 Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: requests==2.31.0

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/devops/pypi/build.py

@@ -4,8 +4,8 @@ import shutil
 import subprocess
 from pathlib import Path
 from typing import List
-import toml
 
+import toml
 from aws_lambda_powertools import Logger
 
 logger = Logger()
@@ -35,8 +35,8 @@ def main():
 
 def run_local_clean_up():
     """run a local clean up and remove older items in the dist directory"""
-    root = Path(__file__).parent.parent
-    dist_dir = os.path.join(root, "dist")
+    project_root = Path(__file__).parents[2]
+    dist_dir = os.path.join(project_root, "dist")
     if os.path.exists(dist_dir):
         # clear it out
         shutil.rmtree(dist_dir)

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/pyproject.toml

@@ -26,7 +26,7 @@ keywords = [
     "Clinical Trials"
 ]
 
-version = "0.0.3"
+version = "0.0.5"
 authors = [
   { name="Eric Wilson", email="eric.wilson@aplosanalytics.com" }
 ]
@@ -46,11 +46,12 @@ classifiers = [
 ]
 
 dependencies = [
-  "aws-lambda-powertools==2.38.1",
+  "aws-lambda-powertools>=3.3.0",
   "requests==2.31.0",
   "boto3==1.34.110",  
   "python-dotenv==1.0.1",
-  "PyJWT==2.9.0"
+  "PyJWT==2.9.0",
+  "mypy_boto3_cognito_idp>=1.35.68"
 ]
 
 [project.urls]

aplos_nca_saas_sdk-0.0.5/src/aplos_nca_saas_sdk/integration_testing/configs/_config_base.py

@@ -0,0 +1,13 @@
+from typing import Dict
+from typing import Any
+
+
+class ConfigBase:
+    """Base Configuration Class"""
+
+    def __init__(self, enabled: bool = True):
+        self.enabled: bool = enabled
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the configuration from a dictionary"""
+        self.enabled = test_config.get("enabled", True)

aplos_nca_saas_sdk-0.0.5/src/aplos_nca_saas_sdk/integration_testing/configs/app_settings.py

@@ -0,0 +1,60 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+
+
+class ApplicationDomain(ConfigBase):
+    """
+    Application Domain: Defines the domains that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__domain: str | None = None
+
+    @property
+    def domain(self) -> str:
+        """The domain to validate"""
+        if self.__domain is None:
+            raise RuntimeError("Domain is not set")
+        return self.__domain
+
+    @domain.setter
+    def domain(self, value: str):
+        self.__domain = value
+
+
+class ApplicationSettings:
+    """
+    Application Settings: Defines the domains that the application settings (configuration endpoint) tests will check against
+
+    """
+
+    def __init__(self):
+        self.__domains: List[ApplicationDomain] = []
+
+    @property
+    def domains(self) -> List[ApplicationDomain]:
+        return self.__domains
+
+    @domains.setter
+    def domains(self, value: List[ApplicationDomain]):
+        self.__domains = value
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the domains from the config"""
+        domains: List[Dict[str, Any]] = test_config.get("domains", [])
+
+        domain: Dict[str, Any]
+        for domain in domains:
+            app_domain = ApplicationDomain()
+            app_domain.domain = domain.get("domain", None)
+            app_domain.enabled = bool(domain.get("enabled", True))
+
+            self.__domains.append(app_domain)

aplos_nca_saas_sdk-0.0.5/src/aplos_nca_saas_sdk/integration_testing/configs/config_sample.json

@@ -0,0 +1,105 @@
+{
+    "application_config_test": {
+        "purpose": "Tests the application configuration endpoints",
+        "domains": [
+            {
+                "domain": "api.example.com",
+                "expected_results" : {
+                    "status_code": 200
+                },
+                "enabled": true
+            },
+            {
+                "domain": "XXXXXXXXXXXXXXXXXXXXX",
+                "expected_results" : {
+                    "status_code": 403
+                },
+                "enabled": false
+            }
+        ]
+    },
+    "login_test": {
+        "purpose": "Tests the login endpoints",
+        "logins": [
+            {
+                "username": "foo",
+                "password": "barr",
+                "domain": "api.example.com",
+                "roles": []
+                
+            },
+            {
+                "username": "XXXXXXXXXXXXXXXXXXXXX",
+                "password": "XXXXXXXXXXXXXXXXXXXXX",
+                "domain": "XXXXXXXXXXXXXXXXXXXXX",
+                "roles": [
+                    "XXXXXXXXXXXXXXXXXXXXX"
+                ],
+                "enabled" : false,
+                "expected_results" : {
+                    "exception": "InvalidCredentialsException"
+                }
+            }
+        ]    
+    },
+    "file_upload_test": {
+        "purpose": "Tests the file upload endpoints.",
+        "notes": "a file can be on the local drive or pulled from a public https source.",
+        "login": {
+            "purpose": "optional: if present this login is used, unless a specific login is defined for the test",
+            "username": "foo",
+            "password": "bar",
+            "domain": "api.example.com"          
+        },
+        "files": [
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",                
+                "expected_results" : {
+                    "status_code": 200
+                }
+            },
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "login" : {
+                    "purpose": "optional: if present tests an upload for a specific user",
+                    "username": "XXXXXXXXXXXXXXXXXXXXX",
+                    "password": "XXXXXXXXXXXXXXXXXXXXX",
+                    "domain": "XXXXXXXXXXXXXXXXXXXXX" 
+                },
+                "expected_results" : {
+                    "status_code": 403
+                }
+            }
+        ]
+    },
+    "analysis_execution_test": {
+        "purpose": "Tests the analysis execution endpoints.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "domain": "XXXXXXXXXXXXXXXXXXXXX"          
+        },
+        "analyses": [
+            {                
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "meta": {},
+                "config": {},
+                "expected_results" : {
+                    "status_code": 200
+                }
+            }
+        ]
+    },
+    "validation_test": {
+        "purpose": "Tests the validation execution.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "domain": "XXXXXXXXXXXXXXXXXXXXX"          
+        },
+        "expected_results": {
+            "status_code": 200
+        }
+    }
+    
+}

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/src/aplos_nca_saas_sdk/integration_testing/configs/login.py

@@ -4,10 +4,11 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
-from typing import List, Optional
+from typing import List, Optional, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
 
 
-class TestLogin:
+class Login(ConfigBase):
     """
     Application Login: Defines the login that the application configuration tests will check against
 
@@ -18,10 +19,13 @@ class TestLogin:
         username: Optional[str] = None,
         passord: Optional[str] = None,
         domain: Optional[str] = None,
+        roles: Optional[List[str]] = None,
     ):
+        super().__init__()
         self.__username: Optional[str] = username
         self.__password: Optional[str] = passord
         self.__domain: Optional[str] = domain
+        self.__roles: List[str] = roles if roles is not None else []
 
     @property
     def username(self) -> str:
@@ -53,25 +57,49 @@ class TestLogin:
     def domain(self, value: str):
         self.__domain = value
 
+    @property
+    def roles(self) -> List[str]:
+        """A list of roles to check for"""
+        return self.__roles
+
+    @roles.setter
+    def roles(self, value: List[str] | None):
+        if value is None:
+            value = []
+        self.__roles = value
 
-class TestLogins:
+
+class Logins(ConfigBase):
     """
     Application Logins: Defines the logins that the application configuration tests will check against
 
     """
 
     def __init__(self):
-        self.__logins: List[TestLogin] = []
+        super().__init__()
+        self.__logins: List[Login] = []
 
     @property
-    def list(self) -> List[TestLogin]:
+    def list(self) -> List[Login]:
         """List the logins"""
         return self.__logins
 
-    def add(self, *, username: str, password: str, domain: str):
+    def add(self, *, username: str, password: str, domain: str, enabled: bool = True):
         """Add a loging"""
-        login = TestLogin()
+        login = Login()
         login.username = username
         login.password = password
         login.domain = domain
+        login.enabled = enabled
         self.__logins.append(login)
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the logins from a list of dictionaries"""
+        self.enabled = bool(test_config.get("enabled", True))
+        logins: List[Dict[str, str]] = test_config.get("logins", [])
+        for login in logins:
+            self.add(
+                username=login["username"],
+                password=login["password"],
+                domain=login["domain"],
+            )

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/src/aplos_nca_saas_sdk/integration_testing/integration_test_base.py

@@ -6,7 +6,9 @@ Property of Aplos Analytics, Utah, USA
 
 from typing import Dict, Any, List
 
-from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
+from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
+    TestConfiguration,
+)
 from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
     IntegrationTestResponse,
 )

aplos_nca_saas_sdk-0.0.5/src/aplos_nca_saas_sdk/integration_testing/integration_test_configurations.py

@@ -0,0 +1,38 @@
+"""
+Copyright 2024 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 (
+    ApplicationSettings,
+)
+from aplos_nca_saas_sdk.integration_testing.configs.login import Logins
+
+
+class TestConfiguration:
+    """
+    Testing Suite Configuration: Provides a way to define the testing configuration for the Aplos Analytics SaaS SDK
+
+    """
+
+    def __init__(self):
+        self.app_config: ApplicationSettings = ApplicationSettings()
+        self.logins: Logins = Logins()
+
+    def load(self, file_path: str):
+        """
+        Loads the configuration from a file
+
+        :param file_path: The path to the configuration file
+        :return: None
+        """
+
+        config: Dict[str, Any] = {}
+        with open(file_path, "r", encoding="utf-8") as f:
+            config = json.load(f)
+
+        self.logins.load(config.get("login_test", {}))
+        self.app_config.load(config.get("application_config_test", {}))

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/src/aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -6,13 +6,18 @@ Property of Aplos Analytics, Utah, USA
 
 from typing import List, Dict, Any
 from datetime import datetime, UTC
+from aws_lambda_powertools import Logger
 from aplos_nca_saas_sdk.integration_testing.integration_test_factory import (
     IntegrationTestFactory,
 )
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
-from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
+from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
+    TestConfiguration,
+)
+
+logger = Logger(service="IntegrationTestSuite")
 
 
 class IntegrationTestSuite:
@@ -22,6 +27,7 @@ class IntegrationTestSuite:
         self.test_results: List[Dict[str, Any]] = []
         self.verbose: bool = False
         self.raise_on_failure: bool = False
+        self.fail_fast: bool = False
 
     def test(self, test_config: TestConfiguration) -> bool:
         """Run a full suite of integration tests"""
@@ -41,8 +47,8 @@ class IntegrationTestSuite:
                 "start_time_utc": datetime.now(UTC),
                 "end_time_utc": None,
             }
-            if self.verbose:
-                print(f"Running test class {test.name}")
+
+            logger.info(f"Running test class {test.name}")
             try:
                 success = test.test()
                 test_result["success"] = success
@@ -50,15 +56,18 @@ class IntegrationTestSuite:
             except Exception as e:  # pylint: disable=broad-except
                 test_result["success"] = False
                 test_result["error"] = str(e)
+                if self.fail_fast:
+                    # just break and let the failure routine handle it
+                    break
 
             test_result["end_time_utc"] = datetime.now(UTC)
             self.test_results.append(test_result)
 
-            if self.verbose:
-                if test_result["success"]:
-                    print(f"Test {test.name} succeeded")
-                else:
-                    print(f"Test {test.name} failed with error {test_result['error']}")
+            if test_result["success"]:
+                logger.info(f"Test {test.name} succeeded")
+                logger.debug(test_result)
+            else:
+                logger.error(test_result)
         # find the failures
         failures = [test for test in self.test_results if not test["success"]]
         self.__print_results(start_time, failures)
@@ -67,7 +76,7 @@ class IntegrationTestSuite:
 
         if self.raise_on_failure and len(failures) > 0:
             count = len(failures)
-            print(f"{count} tests failed. Raising exception.")
+            logger.error(f"{count} tests failed. Raising exception.")
             raise RuntimeError(f"{count} tests failed")
 
         return len(failures) == 0

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/src/aplos_nca_saas_sdk/integration_testing/main.py

@@ -5,11 +5,14 @@ Property of Aplos Analytics, Utah, USA
 """
 
 import os
+from pathlib import Path
 from aplos_nca_saas_sdk.utilities.environment_services import EnvironmentServices
 from aplos_nca_saas_sdk.integration_testing.integration_test_suite import (
     IntegrationTestSuite,
 )
-from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
+from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
+    TestConfiguration,
+)
 
 
 def main():
@@ -23,6 +26,21 @@ def main():
 
     its: IntegrationTestSuite = IntegrationTestSuite()
     config: TestConfiguration = TestConfiguration()
+
+    # normally we'd pull a test configuration file from Secrets Manager, Parameter Store, or some other secure location
+    # here we're going to pull the sample file and then override some it's values.
+    config_file = os.path.join(Path(__file__).parent, "configs", "config_sample.json")
+    # load it so we can see what it looks like
+    config.load(file_path=config_file)
+
+    # override the configuration
+    override_config(config)
+
+    its.test(test_config=config)
+
+
+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")
@@ -32,10 +50,11 @@ def main():
             "TEST_USERNAME, TEST_PASSWORD, and TEST_DOMAIN must be set in the environment"
         )
 
+    config.logins.list.clear()
     config.logins.add(username=username, password=password, domain=domain)
-    config.app_config.domains.append(domain)
 
-    its.test(test_config=config)
+    config.app_config.domains.clear()
+    config.app_config.domains.append(domain)
 
 
 if __name__ == "__main__":

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/src/aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py

@@ -26,11 +26,11 @@ class TestAppConfiguration(IntegrationTestBase):
         """Test loading the application configuration"""
 
         self.results.clear()
-        for domain in self.config.app_config.domains:
-            config: NCAAppConfiguration = NCAAppConfiguration(domain)
+        for domain_config in self.config.app_config.domains:
+            config: NCAAppConfiguration = NCAAppConfiguration(domain_config.domain)
 
             test_response: IntegrationTestResponse = IntegrationTestResponse()
-            test_response.meta = {"domain": domain}
+            test_response.meta = {"domain": domain_config}
             try:
                 response = config.get()
                 test_response.response = response

{aplos_nca_saas_sdk-0.0.3 → aplos_nca_saas_sdk-0.0.5}/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.3'
+__version__ = '0.0.5'

aplos_nca_saas_sdk-0.0.3/src/aplos_nca_saas_sdk/integration_testing/configs/app_config.py

@@ -1,25 +0,0 @@
-"""
-Copyright 2024 Aplos Analytics
-All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
-Property of Aplos Analytics, Utah, USA
-"""
-
-from typing import List
-
-
-class TestApplicationConfiguration:
-    """
-    Application Configuration: Defines the domains that the application configuration tests will check against
-
-    """
-
-    def __init__(self):
-        self.__domains: List[str] = []
-
-    @property
-    def domains(self) -> List[str]:
-        return self.__domains
-
-    @domains.setter
-    def domains(self, value: List[str]):
-        self.__domains = value

aplos_nca_saas_sdk-0.0.3/src/aplos_nca_saas_sdk/integration_testing/configs/config.py

@@ -1,21 +0,0 @@
-"""
-Copyright 2024 Aplos Analytics
-All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
-Property of Aplos Analytics, Utah, USA
-"""
-
-from aplos_nca_saas_sdk.integration_testing.configs.app_config import (
-    TestApplicationConfiguration,
-)
-from aplos_nca_saas_sdk.integration_testing.configs.login import TestLogins
-
-
-class TestConfiguration:
-    """
-    Testing Suite Configuration: Provides a way to define the testing configuration for the Aplos Analytics SaaS SDK
-
-    """
-
-    def __init__(self):
-        self.app_config: TestApplicationConfiguration = TestApplicationConfiguration()
-        self.logins: TestLogins = TestLogins()