alertlogic-sdk-python 1.0.72__tar.gz → 1.0.74__tar.gz

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/.github/workflows/release_pypi.yml

@@ -14,9 +14,9 @@ jobs:
       matrix:
         python-version: [3.7, 3.8, 3.9]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -31,11 +31,11 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alertlogic-sdk-python
-Version: 1.0.72
+Version: 1.0.74
 Summary: Alert Logic Software Development Kit for Python.
 Home-page: https://github.com/alertlogic/alertlogic-sdk-python
 Author: Alert Logic Inc.
@@ -151,6 +151,23 @@ export ALERTLOGIC_ENDPOINT="http://api.aesolo.com:3001"
 
 ## History
 
+### v1.0.74
+
+* Wed, 8 Mar 2023 08:54:55 -0600 - Merge pull request #123 from EvanBrown96/fix-service-name-bug-environment-creation
+* Tue, 7 Mar 2023 11:05:42 -0600 - Merge pull request #122 from alertlogic/update_workflow
+* Mon, 6 Mar 2023 13:16:59 -0500 - fix bug where the service name was not being used correctly when querying dynamodb/ssm for credentials
+* Fri, 3 Mar 2023 11:20:19 -0600 - Update workflow to stop using depricated node versions
+
+### v1.0.73
+
+* Thu, 2 Mar 2023 09:09:13 -0600 - Merge pull request #121 from EvanBrown96/add-ssm-keys-check-2
+* Tue, 28 Feb 2023 13:58:20 -0500 - use raise from
+* Tue, 28 Feb 2023 13:52:05 -0500 - documentation clarity
+* Tue, 28 Feb 2023 13:50:37 -0500 - re-add both-source functionality
+* Tue, 28 Feb 2023 10:34:25 -0500 - fix a couple bugs and update tests
+* Tue, 28 Feb 2023 10:09:12 -0500 - switch to just one application in AlEnv creation
+* Tue, 28 Feb 2023 09:55:27 -0500 - update to fix bugs/better implementation
+
 ### v1.0.72
 
 * Thu, 23 Feb 2023 16:11:36 -0600 - Merge pull request #114 from alertlogic/fix_deprication_warning

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/alertlogic_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alertlogic-sdk-python
-Version: 1.0.72
+Version: 1.0.74
 Summary: Alert Logic Software Development Kit for Python.
 Home-page: https://github.com/alertlogic/alertlogic-sdk-python
 Author: Alert Logic Inc.
@@ -151,6 +151,23 @@ export ALERTLOGIC_ENDPOINT="http://api.aesolo.com:3001"
 
 ## History
 
+### v1.0.74
+
+* Wed, 8 Mar 2023 08:54:55 -0600 - Merge pull request #123 from EvanBrown96/fix-service-name-bug-environment-creation
+* Tue, 7 Mar 2023 11:05:42 -0600 - Merge pull request #122 from alertlogic/update_workflow
+* Mon, 6 Mar 2023 13:16:59 -0500 - fix bug where the service name was not being used correctly when querying dynamodb/ssm for credentials
+* Fri, 3 Mar 2023 11:20:19 -0600 - Update workflow to stop using depricated node versions
+
+### v1.0.73
+
+* Thu, 2 Mar 2023 09:09:13 -0600 - Merge pull request #121 from EvanBrown96/add-ssm-keys-check-2
+* Tue, 28 Feb 2023 13:58:20 -0500 - use raise from
+* Tue, 28 Feb 2023 13:52:05 -0500 - documentation clarity
+* Tue, 28 Feb 2023 13:50:37 -0500 - re-add both-source functionality
+* Tue, 28 Feb 2023 10:34:25 -0500 - fix a couple bugs and update tests
+* Tue, 28 Feb 2023 10:09:12 -0500 - switch to just one application in AlEnv creation
+* Tue, 28 Feb 2023 09:55:27 -0500 - update to fix bugs/better implementation
+
 ### v1.0.72
 
 * Thu, 23 Feb 2023 16:11:36 -0600 - Merge pull request #114 from alertlogic/fix_deprication_warning

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/alertlogic_sdk_python.egg-info/requires.txt

@@ -4,7 +4,7 @@ pyyaml>=5.4.1
 jsonschema[format_nongpl]==3.2.0
 m2r2==0.3.2
 boto3>=1.16.57
-alertlogic-sdk-definitions>=0.1.109
+alertlogic-sdk-definitions>=0.1.110
 
 [dev]
 pytest>=3

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/almdrlib/config.py

@@ -104,26 +104,31 @@ class Config():
         else:
             self._initialize_defaults()
 
-        self._init_al_env_credentials(service_name)
+        self._init_al_env_credentials()
 
         logger.debug("Finished configuraiton initialization. " +
                      f"access_key_id={self._access_key_id}, " +
                      f"account_id={self._account_id}, " +
                      f"global_endpoint={self._global_endpoint}")
 
-    def _init_al_env_credentials(self, service_name):
-        try:
-            if self._access_key_id is None or self._secret_key is None:
-                service_name_key = f"{service_name}.aims_authc",
-                env = AlEnv(service_name_key)
-                # attempt SSM first, then dynamoDB
+    def _init_al_env_credentials(self):
+        if self._access_key_id is None or self._secret_key is None:
+            try:
+                # attempt ssm first
+                env = AlEnv(self._service_name, "aims_authc", "ssm")
                 self._access_key_id = env.get_parameter('access_key_id', decrypt=True)
                 self._secret_key = env.get_parameter('secret_access_key', decrypt=True)
-                if self._access_key_id is None or self._secret_key is None:
-                    self._access_key_id = env.get('access_key_id')
-                    self._secret_key = env.get('secret_access_key')
-        except Exception as e:
-            logger.debug(f"Did not initialise aims credentials for {service_name} because {e}")
+            except Exception as e:
+                logger.debug(f"Did not initialise aims credentials via SSM for {self._service_name} because {e}")
+        if self._access_key_id is None or self._secret_key is None:
+            try:
+                # if that doesn't work, attempt dynamodb
+                env = AlEnv(self._service_name, "aims_authc", "dynamodb")
+                self._access_key_id = env.get('access_key_id')
+                self._secret_key = env.get('secret_access_key')
+            except Exception as e:
+                logger.debug(f"Did not initialise aims credentials via dynamodb for {self._service_name} because {e}")
+           
 
     def _read_config_file(self):
         try:

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/almdrlib/environment.py

@@ -15,6 +15,8 @@ Network or io errors are not handled.
 Usage:
 # export ALERTLOGIC_STACK_REGION=us-east-1
 # export ALERTLOGIC_STACK_NAME=integration
+
+Dynamodb usage:
 >> env = AlEnv("myapplication")
 # Assuming parameter is stored in ddb as '"value"'
 >> env.get("my_parameter")
@@ -29,6 +31,9 @@ Usage:
 # Assuming parameter is stored in ddb as '"true"'
 >> env.get("my_parameter", type='boolean')
 True
+
+SSM usage:
+>> env = AlEnv("myapplication", source="ssm")
 # For String types in SSM:
 >> env.get_parameter("my_parameter")
 'value'
@@ -54,27 +59,36 @@ class AlEnvAwsConfigurationException(AlEnvException):
 class AlEnvConfigurationTableUnavailableException(AlEnvException):
     pass
 
+class AlmdrlibSourceNotEnabledError(AlEnvException):
+    pass
+
 
 class AlEnv:
-    def __init__(self, application_name):
+    def __init__(self, application_name, client=None, source=("dynamodb",)):
         self.application_name = application_name
+        self.client = client
+        self.source = source if type(source) in [tuple, list] else (source,)
         self.region = AlEnv._get_region()
         self.stack_name = AlEnv._get_stack_name()
         self.table_name = AlEnv._table_name(self.region, self.stack_name)
         try:
             self.dynamodb = boto3.resource('dynamodb')
-            self.table = self.dynamodb.Table(self.table_name)
-            self._table_date_time = self.table.creation_date_time
             self.ssm = boto3.client('ssm')
-        except botocore.exceptions.ClientError as e:
-            if e.response['Error']['Code'] == 'ResourceNotFoundException':
-                raise AlEnvConfigurationTableUnavailableException(self.table_name)
-            else:
-                raise AlEnvException(e)
         except (botocore.exceptions.NoRegionError, botocore.exceptions.NoCredentialsError) as e:
-            raise AlEnvAwsConfigurationException(f'Please validate your AWS configuration: {e}')
+            raise AlEnvAwsConfigurationException(f'Please validate your AWS configuration') from e
+        if "dynamodb" in source:
+            try:
+                self.table = self.dynamodb.Table(self.table_name)
+                self._table_date_time = self.table.creation_date_time
+            except botocore.exceptions.ClientError as e:
+                if e.response['Error']['Code'] == 'ResourceNotFoundException':
+                    raise AlEnvConfigurationTableUnavailableException(self.table_name)
+                else:
+                    raise AlEnvException() from e
 
     def get(self, key, default=None, format='decoded', type=None):
+        if "dynamodb" not in self.source:
+            raise AlmdrlibSourceNotEnabledError("dynamodb is not enabled for this environment")
         fetched_value = self.table.get_item(Key={"key": self._make_ddb_key(key)}).get('Item', {}).get('value')
         converted = AlEnv._convert(fetched_value, format, type)
         if converted is not None:
@@ -83,18 +97,28 @@ class AlEnv:
             return default
 
     def get_parameter(self, key, default=None, decrypt=False):
+        if "ssm" not in self.source:
+            raise AlmdrlibSourceNotEnabledError("ssm is not enabled for this environment")
         try:
             parameter = self.ssm.get_parameter(Name=self._make_ssm_key(key), WithDecryption=decrypt)
         except self.ssm.exceptions.ParameterNotFound:
             return default
+        except botocore.exceptions.ClientError as e:
+            raise AlEnvException() from e
         return parameter["Parameter"]["Value"]
 
     def _make_ssm_key(self, option_key):
-        return f"/deployments/{self._get_region()}/env-settings/{self._make_ddb_key(option_key)}"
+        return f"/deployments/{self.stack_name}/{self._get_region()}/env-settings/{self.application_name}/{self._make_client_option_key(option_key)}"
 
     def _make_ddb_key(self, option_key):
-        return f"{self.application_name}.{option_key}"
+        return f"{self.application_name}.{self._make_client_option_key(option_key)}"
 
+    def _make_client_option_key(self, option_key):
+        if self.client is None:
+            return option_key
+        else:
+            return f"{self.client}.{option_key}"
+        
     @staticmethod
     def _convert(value, format, type):
         if format == 'raw' and value:

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/almdrlib/version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '1.0.72'
-__version_tuple__ = version_tuple = (1, 0, 72)
+__version__ = version = '1.0.74'
+__version_tuple__ = version_tuple = (1, 0, 74)

{alertlogic-sdk-python-1.0.72 → alertlogic-sdk-python-1.0.74}/tests/test_environment.py

@@ -1,6 +1,6 @@
 import unittest
 from unittest.mock import MagicMock
-from almdrlib.environment import AlEnv
+from almdrlib.environment import AlEnv, AlmdrlibSourceNotEnabledError
 import os
 import boto3
 
@@ -22,6 +22,8 @@ class MockDDBTable:
             return {"Item": {"key": Key, "value": "\"true\""}}
         elif Key == 'someapplication.boolkeyfalse':
             return {"Item": {"key": Key, "value": "\"false\""}}
+        elif Key == 'otherapplication.authc.strkey':
+            return {"Item": {"key": Key, "value": "\"strvalue\""}} 
 
 
 class MockBotoDDB:
@@ -47,13 +49,15 @@ class MockBotoSSM:
         Name = kwargs.get('Name')
         WithDecryption = kwargs.get('WithDecryption')
 
-        if Name == '/deployments/us-west-1/env-settings/someapplication.stringparam':
+        if Name == '/deployments/production/us-west-1/env-settings/someapplication/stringparam':
             return {'Parameter': {'Value': 'testingtesting'}}
-        elif Name == '/deployments/us-west-1/env-settings/someapplication.securestringparam':
+        elif Name == '/deployments/production/us-west-1/env-settings/someapplication/securestringparam':
             if WithDecryption:
                 return {'Parameter': {'Value': 'testingtestingtesting'}}
             else:
                 return {'Parameter': {'Value': 'AQICAHhxjBnL9Dhpl/8CUT7/NC07HUYnX+P'}}
+        elif Name == '/deployments/production/us-west-1/env-settings/otherapplication/authc.stringparam':
+            return {'Parameter': {'Value': 'testingtesting'}}
         else:
             raise MockBotoSSM.exceptions.ParameterNotFound()
 
@@ -64,7 +68,7 @@ class TestAlEnv(unittest.TestCase):
         boto3.client = MagicMock(return_value=MockBotoSSM)
         os.environ['ALERTLOGIC_STACK_REGION'] = 'us-west-1'
         os.environ['ALERTLOGIC_STACK_NAME'] = 'production'
-        env = AlEnv("someapplication")
+        env = AlEnv("someapplication", source="dynamodb")
         assert env.table_name == 'us-west-1.production.dev.global.settings'
         assert env.get("strkey") == 'strvalue'
         assert env.get("strkey", format='raw') == '"strvalue"'
@@ -75,11 +79,26 @@ class TestAlEnv(unittest.TestCase):
         assert env.get("boolkeytrue", type='boolean') is True
         assert env.get("floatkey") == '1.0'
         assert env.get("floatkey", type='float') == 1.0
+        with self.assertRaises(AlmdrlibSourceNotEnabledError):
+            assert env.get_parameter("testparam")    
+        env = AlEnv("otherapplication", "authc", source="dynamodb")
+        assert env.get("strkey") == 'strvalue'
+
+        env = AlEnv("someapplication", source="ssm")
         assert env.get_parameter("stringparam") == 'testingtesting'
         assert env.get_parameter("securestringparam") == 'AQICAHhxjBnL9Dhpl/8CUT7/NC07HUYnX+P'
         assert env.get_parameter("securestringparam", decrypt=False) == 'AQICAHhxjBnL9Dhpl/8CUT7/NC07HUYnX+P'
         assert env.get_parameter("securestringparam", decrypt=True) == 'testingtestingtesting'
         assert env.get_parameter("invalidparam", "default") == 'default'
+        with self.assertRaises(AlmdrlibSourceNotEnabledError):
+            assert env.get("testparam")    
+        env = AlEnv("otherapplication", "authc", source="ssm")
+        assert env.get_parameter("stringparam") == 'testingtesting'
+
+        env = AlEnv("someapplication", source=("ssm", "dynamodb"))
+        assert env.get("strkey") == 'strvalue'
+        assert env.get_parameter("stringparam") == 'testingtesting'
+
 
 if __name__ == '__main__':
     unittest.main()