aplos-nca-saas-sdk 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

aplos_nca_saas_sdk/aws_resources/aws_cognito.py

@@ -4,9 +4,11 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
+from typing import Optional
+
 import boto3
 import jwt as jwt_lib
-from typing import Optional
+from mypy_boto3_cognito_idp.client import CognitoIdentityProviderClient
 from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
     NCAAppConfiguration,
 )
@@ -31,7 +33,7 @@ class CognitoAuthenication:
         self.__access_token: Optional[str] = None
         self.__refresh_token: Optional[str] = None
         self.__region: str = region or "us-east-1"
-        self.__client: Optional[boto3.client] = None
+        self.__client: Optional[CognitoIdentityProviderClient] = None
         self.__user_id: Optional[str] = None
         self.__tenant_id: Optional[str] = None
         self.__config: Optional[NCAAppConfiguration] = None
@@ -40,7 +42,7 @@ class CognitoAuthenication:
         self.__validate_parameters()
 
     @property
-    def client(self) -> boto3.client:
+    def client(self) -> CognitoIdentityProviderClient:
         """
         Get the boto3 client
 
@@ -53,7 +55,7 @@ class CognitoAuthenication:
         return self.__client
 
     @property
-    def client_id(self) -> str:
+    def client_id(self) -> str | None:
         """
         Client Id
         Returns:
@@ -62,7 +64,7 @@ class CognitoAuthenication:
         return self.__client_id
 
     @property
-    def region(self) -> str:
+    def region(self) -> str | None:
         """
         Region
         Returns:

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/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 domains(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.domains = domain.get("domain", None)
+            app_domain.enabled = bool(domain.get("enabled", True))
+
+            self.__domains.append(app_domain)

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/integration_testing/configs/login.py

@@ -0,0 +1,105 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List, Optional, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+
+
+class Login(ConfigBase):
+    """
+    Application Login: Defines the login that the application configuration tests will check against
+
+    """
+
+    def __init__(
+        self,
+        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:
+        if self.__username is None:
+            raise RuntimeError("Username is not set")
+        return self.__username
+
+    @username.setter
+    def username(self, value: str):
+        self.__username = value
+
+    @property
+    def password(self) -> str:
+        if self.__password is None:
+            raise RuntimeError("Password is not set")
+        return self.__password
+
+    @password.setter
+    def password(self, value: str):
+        self.__password = value
+
+    @property
+    def domain(self) -> str:
+        if self.__domain is None:
+            raise RuntimeError("Domain is not set")
+        return self.__domain
+
+    @domain.setter
+    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 Logins(ConfigBase):
+    """
+    Application Logins: Defines the logins that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__logins: List[Login] = []
+
+    @property
+    def list(self) -> List[Login]:
+        """List the logins"""
+        return self.__logins
+
+    def add(self, *, username: str, password: str, domain: str, enabled: bool = True):
+        """Add a loging"""
+        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/integration_testing/integration_test_base.py

@@ -4,9 +4,14 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
-from typing import Dict, Any
-from aplos_nca_saas_sdk.utilities.environment_vars import EnvironmentVars
-from aplos_nca_saas_sdk.nca_resources.nca_endpoints import NCAEndpoints
+from typing import Dict, Any, List
+
+from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
+    TestConfiguration,
+)
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
 
 
 class IntegrationTestBase:
@@ -14,21 +19,52 @@ class IntegrationTestBase:
     Integration Test Base Class
     """
 
-    def __init__(self, name: str, index: int = 0):
+    def __init__(self, name: str | None = None, index: int = 0):
         self.name = name
         self.index = index
-        self.env_vars: EnvironmentVars = EnvironmentVars()
+        self.__config: TestConfiguration | None = None
+        self.__results: List[IntegrationTestResponse] = []
 
-        if not self.env_vars.api_domain:
+    @property
+    def config(self) -> TestConfiguration:
+        """
+        Get the configuration for the test
+        """
+        if self.__config is None:
             raise RuntimeError(
-                "APLOS_API_DOMAIN environment variable is not set. "
-                "This is required to run the tests"
+                "Test configuration not set. "
+                "A configuration is required to run integration tests."
             )
+        return self.__config
+
+    @config.setter
+    def config(self, value: TestConfiguration):
+        """
+        Set the configuration for the test
+        """
+        self.__config = value
+
+    @property
+    def results(self) -> List[IntegrationTestResponse]:
+        """
+        Get the results of the test
+        """
+        return self.__results
 
-        self.endpoints: NCAEndpoints = NCAEndpoints(
-            aplos_saas_domain=self.env_vars.api_domain,
-        )
+    def success(self) -> bool:
+        """
+        Returns True if all tests in the suite were successful
+        """
+        return all([result.success for result in self.results])
 
-    def test(self) -> Dict[str, Any] | None:
-        """Run the Test"""
+    def test(self) -> bool:
+        """
+        Run the Test
+        Args:
+            config: The Test Configuration
+        Returns:
+            True if the test was successful, False otherwise.  If any
+            of the tests fail, it will be false.  Execeptions are only
+            raised if the raise_on_failure flag is set to True.
+        """
         raise RuntimeError("This should be implemented by the subclass.")

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/integration_testing/integration_test_response.py

@@ -0,0 +1,28 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Dict, Any, Optional
+
+
+class IntegrationTestResponse:
+    """Integration Test Response"""
+
+    def __init__(self):
+        self.name: str = ""
+        self.meta: Dict[str, Any] = {}
+        self.response: Dict[str, Any] = {}
+        self.error: Optional[str] = None
+        self.success: bool = False
+
+    def to_dict(self) -> Dict[str, Any]:
+        """JSON Dictionary Object"""
+        return {
+            "name": self.name,
+            "meta": self.meta,
+            "response": self.response,
+            "error": self.error,
+            "success": self.success,
+        }

aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -6,12 +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.integration_test_configurations import (
+    TestConfiguration,
+)
+
+logger = Logger(service="IntegrationTestSuite")
 
 
 class IntegrationTestSuite:
@@ -21,64 +27,72 @@ 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) -> bool:
+    def test(self, test_config: TestConfiguration) -> bool:
         """Run a full suite of integration tests"""
+
+        # reset the test results
+        self.test_results = []
+
         start_time: datetime = datetime.now(UTC)
         factory: IntegrationTestFactory = IntegrationTestFactory()
-        test_class: IntegrationTestBase | None = None
-        for test_class in factory.test_classes:
-            test_instance: IntegrationTestBase = test_class
-            test: Dict[str, Any] = {
-                "test_name": test_instance.name,
+        test: IntegrationTestBase | None = None
+        for test in factory.test_classes:
+            test.config = test_config
+            test_result: Dict[str, Any] = {
+                "test_name": test.name,
                 "success": True,
                 "error": None,
                 "start_time_utc": datetime.now(UTC),
                 "end_time_utc": None,
             }
-            if self.verbose:
-                print(f"Running test class {test_instance.name}")
-            try:
-                results = test_instance.test()
-                test["results"] = results
 
+            logger.info(f"Running test class {test.name}")
+            try:
+                success = test.test()
+                test_result["success"] = success
+                test_result["results"] = test.results
             except Exception as e:  # pylint: disable=broad-except
-                test["success"] = False
-                test["error"] = str(e)
-
-            test["end_time_utc"] = datetime.now(UTC)
-            self.test_results.append(test)
-
-            if self.verbose:
-                if test["success"]:
-                    print(f"Test {test_instance.name} succeeded")
-                else:
-                    print(
-                        f"Test {test_instance.name} failed with error {test['error']}"
-                    )
+                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 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)
 
         # print the results
 
+        if self.raise_on_failure and len(failures) > 0:
+            count = len(failures)
+            logger.error(f"{count} tests failed. Raising exception.")
+            raise RuntimeError(f"{count} tests failed")
+
+        return len(failures) == 0
+
+    def __print_results(self, start_time: datetime, failures: List[Dict[str, Any]]):
         print("Test Results:")
-        for test in self.test_results:
-            duration = test["end_time_utc"] - test["start_time_utc"]
+        for test_result in self.test_results:
+            duration = test_result["end_time_utc"] - test_result["start_time_utc"]
             print(
-                f"  {test['test_name']} {'succeeded' if test['success'] else 'failed'} duration: {duration}"
+                f"  {test_result['test_name']} {'succeeded' if test_result['success'] else 'failed'} duration: {duration}"
             )
-            if not test["success"]:
-                print(f"    Error: {test['error']}")
+            if not test_result["success"]:
+                print(f"    Error: {test_result['error']}")
 
         print(f"Test Suite completed in {datetime.now(UTC) - start_time}")
 
         print(f"Total Tests: {len(self.test_results)}")
         print(f"Successful Tests: {len(self.test_results) - len(failures)}")
         print(f"Failed Tests: {len(failures)}")
-
-        if self.raise_on_failure and len(failures) > 0:
-            count = len(failures)
-            print(f"{count} tests failed. Raising exception.")
-            raise RuntimeError(f"{count} tests failed")
-
-        return len(failures) == 0

aplos_nca_saas_sdk/integration_testing/main.py

@@ -5,10 +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.integration_test_configurations import (
+    TestConfiguration,
+)
 
 
 def main():
@@ -21,7 +25,36 @@ def main():
         evs.load_environment(starting_path=__file__, file_name=env_file)
 
     its: IntegrationTestSuite = IntegrationTestSuite()
-    its.test()
+    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")
+
+    if not username or not password or not domain:
+        raise RuntimeError(
+            "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.clear()
+    config.app_config.domains.append(domain)
 
 
 if __name__ == "__main__":

aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py

@@ -11,6 +11,10 @@ from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
 
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
+
 
 class TestAppConfiguration(IntegrationTestBase):
     """Application Configuration Tests"""
@@ -18,13 +22,22 @@ class TestAppConfiguration(IntegrationTestBase):
     def __init__(self):
         super().__init__(name="app_configuration")
 
-    def test(self) -> dict:
+    def test(self) -> bool:
         """Test loading the application configuration"""
 
-        config: NCAAppConfiguration = NCAAppConfiguration(self.env_vars.api_domain)
-        response = config.get()
+        self.results.clear()
+        for domain in self.config.app_config.domains:
+            config: NCAAppConfiguration = NCAAppConfiguration(domain)
+
+            test_response: IntegrationTestResponse = IntegrationTestResponse()
+            test_response.meta = {"domain": domain}
+            try:
+                response = config.get()
+                test_response.response = response
+                test_response.success = True
+            except Exception as e:  # pylint: disable=W0718
+                test_response.error = str(e)
 
-        if response.status_code != 200:
-            raise RuntimeError("App configuration url is not working.")
+            self.results.append(test_response)
 
-        return response.json()
+        return self.success()

aplos_nca_saas_sdk/integration_testing/tests/app_login_test.py

@@ -10,6 +10,9 @@ from aplos_nca_saas_sdk.nca_resources.nca_login import NCALogin
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
 
 
 class TestAppLogin(IntegrationTestBase):
@@ -18,15 +21,28 @@ class TestAppLogin(IntegrationTestBase):
     def __init__(self):
         super().__init__("app-login")
 
-    def test(self) -> dict:
+    def test(self) -> bool:
         """Test a login"""
 
-        user_name = self.env_vars.username
-        password = self.env_vars.password
+        self.results.clear()
+
+        for login in self.config.logins.list:
+            test_response: IntegrationTestResponse = IntegrationTestResponse()
+            test_response.name = self.name
+            try:
+                nca_login = NCALogin(aplos_saas_domain=login.domain)
+                token = nca_login.authenticate(
+                    username=login.username, password=login.password
+                )
+                test_response.response = token
+                if not token:
+                    test_response.error = "Failed to authenticate"
+
+                else:
+                    test_response.success = True
+            except Exception as e:  # pylint: disable=w0718
+                test_response.error = str(e)
+
+            self.results.append(test_response)
 
-        login = NCALogin(aplos_saas_domain=self.env_vars.api_domain)
-        token = login.authenticate(username=user_name, password=password)
-        if not token:
-            raise RuntimeError("Failed to authenticate")
-        else:
-            return {"token": token}
+        return self.success()

aplos_nca_saas_sdk/nca_resources/nca_executions.py

@@ -48,6 +48,9 @@ class NCAEngine:
     @property
     def api_root(self) -> str:
         """Gets the base url"""
+        if self.__api_domain is None:
+            raise RuntimeError("Missing Aplos Api Domain")
+
         url = HttpUtilities.build_url(self.__api_domain)
         if isinstance(url, str):
             return (

aplos_nca_saas_sdk/nca_resources/nca_login.py

@@ -59,7 +59,7 @@ class NCALogin:
         return self.__cognito
 
     @property
-    def domain(self) -> str:
+    def domain(self) -> str | None:
         """
         Domain
         Returns:

aplos_nca_saas_sdk/utilities/environment_vars.py

@@ -6,7 +6,7 @@ class EnvironmentVars:
 
     def __init__(self) -> None:
         # load defaults
-        self.api_domain = os.getenv("APLOS_API_DOMAIN")
+        self.api_domain = os.getenv("APLOS_API_DOMAIN", "")
 
         self.aws_region = os.getenv("COGNITO_REGION")
         self.client_id = os.getenv("COGNITO_CLIENT_ID")
@@ -17,7 +17,7 @@ class EnvironmentVars:
         self.metadata_file = os.getenv("METADATA_FILE")
         self.analysis_file = os.getenv("ANALYSIS_FILE")
 
-        if "https://" in self.api_domain:
+        if self.api_domain is not None and "https://" in self.api_domain:
             self.api_domain = self.api_domain.replace("https://", "")
 
         self.aplos_api_url = f"https://{self.api_domain}"

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.2'
+__version__ = '0.0.4'

aplos_nca_saas_sdk-0.0.4.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.3
+Name: aplos_nca_saas_sdk
+Version: 0.0.4
+Summary: Aplos NCA SaaS SDK
+Project-URL: Homepage, https://aplosanalytics.com/
+Project-URL: Documentation, https://docs.aplosanalytics.com/
+Project-URL: Repository, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK
+Project-URL: Issues, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK/issues
+Author-email: Eric Wilson <eric.wilson@aplosanalytics.com>
+License: MIT License
+Keywords: Bioavailability Studies,Bioequivalence Studies,Clinical Pharmacology,Clinical Trials,Dose-Proportionality Studies,Drug Interaction Studies,NCA,Non-Compartmental Analysis,PK Analysis,PK modeling,Pharma Data Analysis,Pharmacokinetic Analysis,Pharmacokinetics,Pharmacokinetics Software,SaaS
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+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
+Description-Content-Type: text/markdown
+
+# Aplos NCA SaaS SDK for python
+
+Welcome to the Aplos NCA SaaS SDK for automating your PK Analyis.  A secure set of API's to connect to our Cloud System and automate your PK analysis.
+
+This SDK works for our
+- Trial Accounts (Multi Tenancy)
+- Academic Accounts (Multi Tenancy)
+- Professional Accounts (Multi Tenancy)
+- Team Accounts (Single Tenancy)
+- Enterprise Accounts (Single Tenancy)
+
+## Use 🐍 python to perform an NCA Analysis with the Aplos NCA SaaS Solution.  
+If you can make HTTPS 🔐 request 🛜 - you can automation your PK Analysis Workflow Systems.
+
+## 👉 We use this for our demos 🚀🚀 👈
+> We'll keep this maintained as we use it for our customer demo as well as Integration Testings.  
+> So keep coming back for new features.
+>
+> If you're not sure how to get started, kick off the Integration Test Suite, set some break points
+> and you'll see a wide range of example use cases.
+
+## API Settings 🛑 A valid Aplos NCA Account is required. 🛑
+
+
+> In order to run the executions and connect to our system, you will need a valid account with an active subscription (reach out for a trial subscription if you are evaluating our solutions).
+>
+> You'll need your username (email address and a password), a Cognito Client Id
+> which allows the USER_PASSWORD_AUTH flow, and your API URL.
+>
+> Technically if you have your API Domain (from your account), you can use this to query for your Cognito Client Id  
+> 
+> Otherwise, the Client Id (aka Cognito Client Key) and API URL can be found in your user account.
+>
+> Your username is your email address and your password would have been provided to you during your
+> onboarding or with a "forgot password" request and reset.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+You can perform:
+- Logins
+- File Uploads
+- PK Analysis Executions
+- PK Analysis Results
+- File Downloads
+- PK Validations (run validations against our calculations engine)
+- Tenant & User Management (for Team & Enterprise Accounts)
+- and more...
+
+
+## API Integration Testing
+You can use the integration testing to test your environment. You can also use the Integration Testing modules
+to learn how to use the API.
+
+## Source
+Full source code can also be found on [GitHub](https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK)
+
+## Documentation
+[The Docs](https://docs.aplosanalytics.com/)
+
+## Corporate Home Page
+[Aplos Analytics](https://aplosanalytics.com/)
+
+
+
+

{aplos_nca_saas_sdk-0.0.2.dist-info → aplos_nca_saas_sdk-0.0.4.dist-info}/RECORD

@@ -1,29 +1,35 @@
 aplos_nca_saas_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aplos_nca_saas_sdk/version.py,sha256=V3mRVcxh2tUI7Mn6MWg59BFD43T3MuX0gvMHJHOo4ok,171
-aplos_nca_saas_sdk/aws_resources/aws_cognito.py,sha256=jJQnHrIIKTry0Bk1vWem6WEKvxo-4BUI3O81WRWti_4,6306
+aplos_nca_saas_sdk/version.py,sha256=gBIZC-1MsRi6HxaRfdvsl5EHu6glEpq7V2uKtlVdLyg,171
+aplos_nca_saas_sdk/aws_resources/aws_cognito.py,sha256=pxyEdIoeeT7of_hjxYlplOnyLQpo3I-dnc5mHeGP47c,6427
 aplos_nca_saas_sdk/aws_resources/aws_s3_presigned_payload.py,sha256=rbTaeUgPpRsw1KV0YjnmkD5sQvlYet9XBj6Ie7nXz5Y,1987
 aplos_nca_saas_sdk/aws_resources/aws_s3_presigned_upload.py,sha256=WK7CKzuHcgU15k2BWiBqSZ8UdQSVSo39L8Las-7gvC0,3940
 aplos_nca_saas_sdk/files/analysis_files/single_ev/configuration_single_ev.json,sha256=lLnRV0jwzaSn32D8NlOekOF5oGFfUwugUlvlwoKz540,986
 aplos_nca_saas_sdk/files/analysis_files/single_ev/meta_data.json,sha256=p1KYOAe5Cl3rjtfF1t96oRG-QtFJJCo9otReRPNtvIk,447
 aplos_nca_saas_sdk/files/analysis_files/single_ev/single_ev.csv,sha256=qFSAlgLOmERsabMmp1X6PAZa-8yFthZlHacM_f7_AOY,6528
-aplos_nca_saas_sdk/integration_testing/integration_test_base.py,sha256=wp0uneVMnksj0hkSvks06CqyTB6YCDQs6qfVAWFIvnM,1037
+aplos_nca_saas_sdk/integration_testing/integration_test_base.py,sha256=mdBTHUk-SjKGbvSy0T9aLXQKOULaruYAI9z4MB35FRk,2000
+aplos_nca_saas_sdk/integration_testing/integration_test_configurations.py,sha256=ZE-Yqm8v7QPOPENmcVIksniFhikndHWVB21HkQspupE,1100
 aplos_nca_saas_sdk/integration_testing/integration_test_factory.py,sha256=9wQzdtBLMrBb4dfYkNE7-miyayPNhTHOWgqEMSL9-Yc,2081
-aplos_nca_saas_sdk/integration_testing/integration_test_suite.py,sha256=QHoJzAp9Qm4XTOeYE8waNqZmMh2S5XO2AYq0RfGwj4s,3020
-aplos_nca_saas_sdk/integration_testing/main.py,sha256=y2OqzPRccGb45d_MoAIRjxRblFHgHxZ8PH-e52R5blw,736
+aplos_nca_saas_sdk/integration_testing/integration_test_response.py,sha256=HkHTb5-KbhVvYJJ-0PmcCuvQferejd1LyVU-QnGjDEU,742
+aplos_nca_saas_sdk/integration_testing/integration_test_suite.py,sha256=sYm7EzhzVayL6BOSxJnOo0T97PWwdyx8LHuRxNy9yII,3598
+aplos_nca_saas_sdk/integration_testing/main.py,sha256=M0Ee6QJXNzbeYzpyfDniNlZpySy9EZwYgtYzRZYXnnA,1976
 aplos_nca_saas_sdk/integration_testing/readme.md,sha256=sX-_gzx17UUF-ZqvCWq0R5zcqgOMC4JjQKnjgxQH9vM,629
-aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py,sha256=Ezz3mZWE3Nv8CIfc-zXnpE0WgbI5QgQvVfHqP8lfb3Y,861
+aplos_nca_saas_sdk/integration_testing/configs/_config_base.py,sha256=O48Y1r8JFe2KvSMTY5EttZAz1-hQsU6-Su6CzDUKDmE,347
+aplos_nca_saas_sdk/integration_testing/configs/app_settings.py,sha256=vPWPIpk41I2BGeOZt6lvx6dob-_m5tI-al4KC_XBUsI,1700
+aplos_nca_saas_sdk/integration_testing/configs/config_sample.json,sha256=50tqWe9OpD1b-EWe2_wQlwYtQ0n_OqfwobFkRraoxwc,3328
+aplos_nca_saas_sdk/integration_testing/configs/login.py,sha256=ql2F8iqkbKLL7xeu7-D-Y1XJlR9NBcKEaAwOT53KBlo,2966
+aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py,sha256=_ZQqAPnXkruIpmV1hio4-xfWL_ggrGInGdxJw2nL5U0,1332
 aplos_nca_saas_sdk/integration_testing/tests/app_execution_test.py,sha256=bDyVvtOKSJdy0sdCVYVuCdUrQYhn8D3peCmM1OCkSVg,145
-aplos_nca_saas_sdk/integration_testing/tests/app_login_test.py,sha256=rE5hSDKgLLTkgL6pwtFax8SO1HknAXkLJvmFvb_BHtI,877
+aplos_nca_saas_sdk/integration_testing/tests/app_login_test.py,sha256=gXMoDOnoxY9H5mjngRCd4GUYKtuCWv87g6l_X7Abnmc,1448
 aplos_nca_saas_sdk/integration_testing/tests/app_validation_test.py,sha256=bDyVvtOKSJdy0sdCVYVuCdUrQYhn8D3peCmM1OCkSVg,145
 aplos_nca_saas_sdk/nca_resources/nca_app_configuration.py,sha256=mRK_OK2k0q4o4pH11tpeR3yKve7sgw3XTtQ0HG9KKFU,1877
 aplos_nca_saas_sdk/nca_resources/nca_endpoints.py,sha256=8jQK8mniRFaQaGnpG1g_D0si8HCJciVvcLA6wFtOers,2026
-aplos_nca_saas_sdk/nca_resources/nca_executions.py,sha256=M-bwZOL9w4FNUfC8m2eMTw4H_P45J1psfffY6KeBwtM,12565
-aplos_nca_saas_sdk/nca_resources/nca_login.py,sha256=iw8JFITWm9vRyxzRlW4BJMVCQyL3Qeo_nwxKVB3bpUM,3024
+aplos_nca_saas_sdk/nca_resources/nca_executions.py,sha256=LIar1Rs4_X0dRUlLmuYWARcEfa1BtKR4u4RGaSSdk1U,12663
+aplos_nca_saas_sdk/nca_resources/nca_login.py,sha256=wTwuQhntyGKgm6C96ock3uyG8bFWCaMzG-0GJgQ3Ouo,3031
 aplos_nca_saas_sdk/utilities/commandline_args.py,sha256=WKIPNKMMMpEk580xXMQY7sGwxZP-uX6DVqD-8SX3NKM,11721
 aplos_nca_saas_sdk/utilities/environment_services.py,sha256=K6xnxDb9eNdmjJZKPW0JfmmV9rGGwm2urlxCBZwxMMs,2272
-aplos_nca_saas_sdk/utilities/environment_vars.py,sha256=abzjw2egdRJxrUP6sHDwCV4R56R4LzfsVI69QyHYvhU,776
+aplos_nca_saas_sdk/utilities/environment_vars.py,sha256=pfcfX2eYmwYrmY-PZIHCONU9ds_-6GZmb-JibGROJGI,812
 aplos_nca_saas_sdk/utilities/http_utility.py,sha256=7VGWeSOuJbjnUQkzNA6cquKv0g2FJoHsBnDSgE2Buic,696
-aplos_nca_saas_sdk-0.0.2.dist-info/METADATA,sha256=wNz2934lydrL4HFRIaDjgMRh6jH9AOc-zDBhh3hCh18,2218
-aplos_nca_saas_sdk-0.0.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-aplos_nca_saas_sdk-0.0.2.dist-info/licenses/LICENSE,sha256=pAZXnNE2dxxwXFIduGyn1gpvPefJtUYOYZOi3yeGG94,1068
-aplos_nca_saas_sdk-0.0.2.dist-info/RECORD,,
+aplos_nca_saas_sdk-0.0.4.dist-info/METADATA,sha256=QQJysA2KZhm7Ju1nE6OL9ZIsDc3pRQmtz7PQM0IokhU,3769
+aplos_nca_saas_sdk-0.0.4.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+aplos_nca_saas_sdk-0.0.4.dist-info/licenses/LICENSE,sha256=pAZXnNE2dxxwXFIduGyn1gpvPefJtUYOYZOi3yeGG94,1068
+aplos_nca_saas_sdk-0.0.4.dist-info/RECORD,,

aplos_nca_saas_sdk-0.0.2.dist-info/METADATA

@@ -1,57 +0,0 @@
-Metadata-Version: 2.3
-Name: aplos_nca_saas_sdk
-Version: 0.0.2
-Summary: Aplos NCA SaaS SDK
-Project-URL: Homepage, https://aplosanalytics.com/
-Project-URL: Documentation, https://docs.aplosanalytics.com/
-Project-URL: Repository, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK
-Project-URL: Issues, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK/issues
-Author-email: Eric Wilson <eric.wilson@aplosanalytics.com>
-License: MIT License
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-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: boto3==1.34.110
-Requires-Dist: pyjwt==2.9.0
-Requires-Dist: python-dotenv==1.0.1
-Requires-Dist: requests==2.31.0
-Description-Content-Type: text/markdown
-
-# Aplos NCA SaaS SDK for python
-
-You can use 🐍 python to perform analysis with Aplos NCA using API calls via secure HTTPS requests.
-
-> 👉 We use this for our demos 🚀🚀 👈
-> We'll keep this maintained as we use it for our customer demos.  So keep coming back for new features.
-
-
-## API Settings
-
-> 🛑 A valid Aplos NCA Account is required. 🛑
-> In order to run the executions and connect to our system, you will need a valid account with an active subscription.
->
-> You'll need your username (email address and a password) a Cognito Client Id
-> which allows the USER_PASSWORD_AUTH flow, and your API URL.  
-> 
-> The Client Id (aka Cognito Client Key) and API URL can be found in your user account.
-> Your username is your email address and your password would have been provided to you during your
-> onboarding or with a "forgot password" request and reset.
-
-
-## API
-You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
-
-## API Integration Testing
-You can use the integration testing to test your environment. You can also use the Integration Testing modules
-to learn how to use the API.
-
-## Source
-Full source code can also be found on [GitHub](https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK)
-
-
-