aplos-nca-saas-sdk 0.0.1__py3-none-any.whl

aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -0,0 +1,84 @@
+"""
+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 datetime import datetime, UTC
+from aplos_nca_saas_sdk.integration_testing.integration_test_factory import (
+    IntegrationTestFactory,
+)
+from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
+    IntegrationTestBase,
+)
+
+
+class IntegrationTestSuite:
+    """Runs Tests against an active instance"""
+
+    def __init__(self):
+        self.test_results: List[Dict[str, Any]] = []
+        self.verbose: bool = False
+        self.raise_on_failure: bool = False
+
+    def test(self) -> bool:
+        """Run a full suite of integration tests"""
+        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,
+                "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
+
+            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']}"
+                    )
+        # find the failures
+        failures = [test for test in self.test_results if not test["success"]]
+
+        # print the results
+
+        print("Test Results:")
+        for test in self.test_results:
+            duration = test["end_time_utc"] - test["start_time_utc"]
+            print(
+                f"  {test['test_name']} {'succeeded' if test['success'] else 'failed'} duration: {duration}"
+            )
+            if not test["success"]:
+                print(f"    Error: {test['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

@@ -0,0 +1,28 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+import os
+from aplos_nca_saas_sdk.utilities.environment_services import EnvironmentServices
+from aplos_nca_saas_sdk.integration_testing.integration_test_suite import (
+    IntegrationTestSuite,
+)
+
+
+def main():
+    """Run the tests"""
+
+    evs: EnvironmentServices = EnvironmentServices()
+    env_file = os.getenv("ENV_FILE")
+    if env_file:
+        # if we have an environment file defined, let's load it
+        evs.load_environment(starting_path=__file__, file_name=env_file)
+
+    its: IntegrationTestSuite = IntegrationTestSuite()
+    its.test()
+
+
+if __name__ == "__main__":
+    main()

aplos_nca_saas_sdk/integration_testing/readme.md

@@ -0,0 +1,18 @@
+# Integration Test
+
+This module runs integration tests against a live environment.  The goal is to catch anything before it's deployed.
+However you can also use this as a learning tool or a base on how to use our API's.
+
+## Requirements
+The integration tests will require the following:
+
+### Environment Vars
+|Variable Name|Description|
+|--|--|
+|APLOS_API_DOMAIN|The full domain. e.g. app.aplos-nca.com| 
+
+
+### Users
+You will need valid user accounts with the appropriate permissions for the endpoints they are executing.
+
+If you are testing permission bounderies then you should set up multiple users with different permissions.

aplos_nca_saas_sdk/integration_testing/tests/app_configuration_test.py

@@ -0,0 +1,30 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
+    NCAAppConfiguration,
+)
+from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
+    IntegrationTestBase,
+)
+
+
+class TestAppConfiguration(IntegrationTestBase):
+    """Application Configuration Tests"""
+
+    def __init__(self):
+        super().__init__(name="app_configuration")
+
+    def test(self) -> dict:
+        """Test loading the application configuration"""
+
+        config: NCAAppConfiguration = NCAAppConfiguration(self.env_vars.api_domain)
+        response = config.get()
+
+        if response.status_code != 200:
+            raise RuntimeError("App configuration url is not working.")
+
+        return response.json()

aplos_nca_saas_sdk/integration_testing/tests/app_execution_test.py

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

aplos_nca_saas_sdk/integration_testing/tests/app_login_test.py

@@ -0,0 +1,32 @@
+"""
+Copyright 2024 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.integration_testing.integration_test_base import (
+    IntegrationTestBase,
+)
+
+
+class TestAppLogin(IntegrationTestBase):
+    """Application Configuration Tests"""
+
+    def __init__(self):
+        super().__init__("app-login")
+
+    def test(self) -> dict:
+        """Test a login"""
+
+        user_name = self.env_vars.username
+        password = self.env_vars.password
+
+        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}

aplos_nca_saas_sdk/integration_testing/tests/app_validation_test.py

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

aplos_nca_saas_sdk/nca_resources/nca_app_configuration.py

@@ -0,0 +1,69 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Any, Dict
+
+import requests
+
+from aplos_nca_saas_sdk.nca_resources.nca_endpoints import NCAEndpoints
+
+
+class NCAAppConfiguration:
+    """
+    NCA Application Configuration
+
+
+
+    "idp": {
+        "Auth": {
+        "Cognito": {
+            "region": "<region>",
+            "userPoolId": "<user-pool-id>",
+            "userPoolClientId": "<user-pool-client-id>",
+            "authenticationFlowType": "<auth-flow-type>"
+        }
+        }
+    },
+
+    """
+
+    def __init__(self, aplos_saas_domain: str):
+        self.endpoints: NCAEndpoints = NCAEndpoints(aplos_saas_domain=aplos_saas_domain)
+        self.__response: requests.Response | None = None
+
+    def get(self) -> requests.Response:
+        """Executes a HTTP Get request"""
+
+        if self.__response is not None:
+            return self.__response
+
+        url = self.endpoints.app_configuration()
+        self.__response = requests.get(url, timeout=30)
+        if self.__response.status_code != 200:
+            raise RuntimeError("App configuration url is not working.")
+
+        return self.__response
+
+    @property
+    def cognito_client_id(self) -> str:
+        """Returns the cognito client id"""
+        data: Dict[str, Any] = self.get().json()
+        cognito_client_id = (
+            data.get("idp", {})
+            .get("Auth", {})
+            .get("Cognito", {})
+            .get("userPoolClientId")
+        )
+        return cognito_client_id
+
+    @property
+    def cognito_region(self) -> str:
+        """Returns the cognito region"""
+        data: Dict[str, Any] = self.get().json()
+        cognito_client_id = (
+            data.get("idp", {}).get("Auth", {}).get("Cognito", {}).get("region")
+        )
+        return cognito_client_id

aplos_nca_saas_sdk/nca_resources/nca_endpoints.py

@@ -0,0 +1,54 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+
+class NCAEndpoints:
+    """Aplos NCA SaaS Endpoints"""
+
+    def __init__(self, *, aplos_saas_domain: str):
+        self.__domain: str = aplos_saas_domain
+        self.__protocal: str = "https://"
+
+    def __base(self, tenant_id: str | None = None, user_id: str | None = None) -> str:
+        """Returns the base endpoint"""
+        route = f"{self.__protocal}{self.__domain}"
+
+        if tenant_id:
+            route = f"{route}/tenants/{tenant_id}"
+        if user_id:
+            if not tenant_id:
+                raise ValueError("Tenant ID is required on the users path")
+            route = f"{route}/users/{user_id}"
+
+        return route
+
+    def tenant(self, tenant_id: str) -> str:
+        """Returns the tenant endpoint"""
+        return f"{self.__base(tenant_id=tenant_id)}"
+
+    def app_configuration(self) -> str:
+        """Returns the configuration endpoint"""
+        return f"{self.__base()}/app/configuration"
+
+    def user(self, tenant_id: str, user_id: str) -> str:
+        """Returns the user endpoint"""
+        return f"{self.__base(tenant_id=tenant_id, user_id=user_id)}"
+
+    def executions(self, tenant_id: str, user_id: str) -> str:
+        """Returns the executions endpoint"""
+        return f"{self.__base(tenant_id=tenant_id, user_id=user_id)}/nca/executions"
+
+    def execution(self, tenant_id: str, user_id: str, execution_id: str) -> str:
+        """Returns the executions endpoint"""
+        return f"{self.executions(tenant_id=tenant_id, user_id=user_id)}/{execution_id}"
+
+    def files(self, tenant_id: str, user_id: str) -> str:
+        """Returns the files endpoint"""
+        return f"{self.__base(tenant_id=tenant_id, user_id=user_id)}/nca/files"
+
+    def file(self, tenant_id: str, user_id: str, file_id: str) -> str:
+        """Returns the file endpoint"""
+        return f"{self.files(tenant_id=tenant_id, user_id=user_id)}/{file_id}"