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

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

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

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

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

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

@@ -11,7 +11,7 @@ from aplos_nca_saas_sdk.integration_testing.configs.login_config import (
     LoginConfig,
     LoginConfigs,
 )
-from aplos_nca_saas_sdk.utilities.environment_services import EnvironmentServices
+
 from aplos_nca_saas_sdk.utilities.file_utility import FileUtility
 
 

aplos_nca_saas_sdk-0.0.15/src/aplos_nca_saas_sdk/integration_testing/main.py → aplos_nca_saas_sdk-0.0.16/src/aplos_nca_saas_sdk/integration_testing/example_main.py

@@ -16,19 +16,25 @@ from aplos_nca_saas_sdk.integration_testing.integration_test_configurations impo
 
 
 def main():
-    """Run the tests"""
+    """This is an example on how you can run the unit tests"""
 
+    # Optionally use our convient Environment Services loader
+    # which can help during intial testings.
     evs: EnvironmentServices = EnvironmentServices()
+    # see if we have a local .env, .env.uat, etc configured to look up
     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)
 
+    # this is where the work begins
     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.
+    # here were going to load a config file that is local, for security purpose
+    # you should store this in SecretsManager, Parameter Store, a secure S3 bucket etc.
+    # the configs typically contain sensitive information like usernames & passwords
+    # so be careful where you store it!
     config_file = os.path.join(
         Path(__file__).parent,
         "configs",
@@ -37,14 +43,16 @@ def main():
     # load it so we can see what it looks like
     config.load(file_path=config_file)
 
-    # override the configuration
-    # override_config(config)
-
+    # run the tests
     its.test(test_config=config)
 
 
 def override_config(config: TestConfiguration):
-    """Override the configuration for the tests"""
+    """
+    Override the configuration for the tests.
+    This is some sample code how you can use a combination of a config file
+    and then override the username/password combos using environment vars.
+    """
     username = os.getenv("TEST_USERNAME")
     password = os.getenv("TEST_PASSWORD")
     host = os.getenv("TEST_HOST")

{aplos_nca_saas_sdk-0.0.15 → aplos_nca_saas_sdk-0.0.16}/src/aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -70,15 +70,15 @@ class IntegrationTestSuite:
                 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)
+            finally:
+                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 len(test["errors"]) > 0]
         self.__print_results(start_time, failures)

aplos_nca_saas_sdk-0.0.16/src/aplos_nca_saas_sdk/integration_testing/readme.md

@@ -0,0 +1,205 @@
+# 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:
+- A valid user Aplos NCA User Account
+- A valid subscription
+
+
+### 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.
+
+
+### Subscriptions
+Your subscription will control how may executions are allowed for user or tenancy.  Make sure you have enough executions.  If you need
+additional executions, please reach-out to your support contact.
+
+## Running the test
+See the `example_main.py` for updated examples, but in general you follow the code below to run tests.  Also, see the `configs` section below
+for guidance on defining what is tested.
+
+```python
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+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():
+    """This is an example on how you can run the unit tests"""
+
+    # Optionally use our convient Environment Services loader
+    # which can help during intial testings.
+    evs: EnvironmentServices = EnvironmentServices()
+    # See if we have a local .env, .env.uat, etc configured to look up
+    # for local configuration settings
+    # 
+    # Use local .env files when testing locally.  As a best practice
+    # you should avoid adding these to source control or deployments.
+    env_file = os.getenv("ENV_FILE")
+    if env_file:
+        # if we have an environment file defined, let's load it
+        # this will prep our environment with local values.
+        evs.load_environment(starting_path=__file__, file_name=env_file)
+
+    # this is where the work begins
+    its: IntegrationTestSuite = IntegrationTestSuite()
+    config: TestConfiguration = TestConfiguration()
+
+    # here were going to load a config file that is local, for security purpose
+    # you should store this in SecretsManager, Parameter Store, a secure S3 bucket etc.
+    # the configs typically contain sensitive information like usernames & passwords
+    # so be careful where you store it!
+    config_file = os.path.join(
+        Path(__file__).parent,
+        "configs",
+        os.getenv("TEST_CONFIG_FILE") or "config_sample.json",
+    )
+    # load it so we can see what it looks like
+    config.load(file_path=config_file)
+
+    # run the tests
+    its.test(test_config=config)
+
+
+```
+
+### Configs
+Tests are run based on configurations.  The following is an example of supported configurations:
+
+- Appliction Configuration Settings
+- Logins & Access
+- Executing an Analysis
+- Running a Validation
+
+```json
+{
+    "application_config_test": {
+        "purpose": "Tests the application configuration endpoints",
+        "hosts": [
+            {
+                "host": "api.example.com",
+                "expected_results": {
+                    "status_code": 200
+                },
+                "enabled": true
+            },
+            {
+                "host": "XXXXXXXXXXXXXXXXXXXXX",
+                "expected_results": {
+                    "status_code": 403
+                },
+                "enabled": false
+            }
+        ]
+    },
+    "login_test": {
+        "purpose": "Tests the login endpoints",
+        "logins": [
+            {
+                "username": "foo",
+                "password": "barr",
+                "host": "api.example.com",
+                "roles": []
+            },
+            {
+                "username": "XXXXXXXXXXXXXXXXXXXXX",
+                "password": "XXXXXXXXXXXXXXXXXXXXX",
+                "host": "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",
+            "host": "api.example.com"
+        },
+        "files": [
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX"
+            },
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "login": {
+                    "purpose": "optional: if present tests an upload for a specific user",
+                    "username": "XXXXXXXXXXXXXXXXXXXXX",
+                    "password": "XXXXXXXXXXXXXXXXXXXXX",
+                    "host": "XXXXXXXXXXXXXXXXXXXXX"
+                }
+            }
+        ]
+    },
+    "analysis_execution_test": {
+        "purpose": "Tests the analysis execution endpoints.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "host": "XXXXXXXXXXXXXXXXXXXXX"
+        },
+        "output_dir": "XXXXXXXXXXXXXXXXXXXXX",
+        "analyses": [
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "meta": {},
+                "config": {},
+                "expected_results": {
+                    "status_code": 200
+                },
+                "output_dir": "XXXXXXXXXXXXXXXXXXXXX"
+            },
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "meta": {},
+                "config": {},
+                "login": {
+                    "username": "XXXXXXXXXXXXXXXXXXXXX",
+                    "password": "XXXXXXXXXXXXXXXXXXXXX",
+                    "host": "XXXXXXXXXXXXXXXXXXXXX"
+                },
+                "expected_results": {
+                    "status_code": 200
+                }
+            }
+        ]
+    },
+    "validation_test": {
+        "purpose": "Tests the validation execution.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "host": "XXXXXXXXXXXXXXXXXXXXX"
+        },
+        "expected_results": {
+            "status_code": 200
+        }
+    }
+}
+
+```

{aplos_nca_saas_sdk-0.0.15 → aplos_nca_saas_sdk-0.0.16}/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.15'
+__version__ = '0.0.16'

aplos_nca_saas_sdk-0.0.15/src/aplos_nca_saas_sdk/integration_testing/readme.md

@@ -1,18 +0,0 @@
-# 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_host|The full host name. 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-0.0.15/src/aplos_nca_saas_sdk/integration_testing/tests/validation_test.py

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