alertlogic-sdk-python 1.0.72__py3-none-any.whl → 1.0.74__py3-none-any.whl

{alertlogic_sdk_python-1.0.72.dist-info → alertlogic_sdk_python-1.0.74.dist-info}/METADATA

@@ -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.
@@ -28,7 +28,7 @@ Requires-Dist: pyyaml (>=5.4.1)
 Requires-Dist: jsonschema[format_nongpl] (==3.2.0)
 Requires-Dist: m2r2 (==0.3.2)
 Requires-Dist: boto3 (>=1.16.57)
-Requires-Dist: alertlogic-sdk-definitions (>=0.1.109)
+Requires-Dist: alertlogic-sdk-definitions (>=0.1.110)
 Provides-Extra: dev
 Requires-Dist: pytest (>=3) ; extra == 'dev'
 Requires-Dist: mock (>=2.0.0) ; extra == 'dev'
@@ -163,6 +163,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.dist-info → alertlogic_sdk_python-1.0.74.dist-info}/RECORD

@@ -1,17 +1,17 @@
 almdrlib/__init__.py,sha256=0UF4wnDFZhA2xWeOKc3mlMZ7oUmXrbek5wEPQNdWvB4,2313
 almdrlib/client.py,sha256=k_SVsTLx534iijG32-oaxUqUhmyL-N4ZvAmnYgDZVCU,33218
-almdrlib/config.py,sha256=LH56CIAARn7-uYfcP7I2mAwe0H-TRV0pJNQeQgRERJw,10114
+almdrlib/config.py,sha256=DAGPx_75nM22XPXNZ-sXXiroc5oMUPYNX1hLvoHIll4,10351
 almdrlib/constants.py,sha256=tBjHCqt8J1N7olctA_WGgIXu1Np1vQjl9TtTGQOD4Hk,434
-almdrlib/environment.py,sha256=thScSSsNz83NyaLRKcTFgJMsxMwXe2KuEcBc9FYqXLI,5004
+almdrlib/environment.py,sha256=pzxMDBx5Pd1ro7TDvBX3rCAv0ySGaw7b1EhxCDL8DzQ,5997
 almdrlib/exceptions.py,sha256=pSmRPgWyGg-eyiHCgaxBD4AJxoN9ipj6VluhYFhWoTY,507
 almdrlib/region.py,sha256=cb5wd5apoHyGzEVWv0ah2VnZj8YQihXTbxsEk17Rg2c,1396
 almdrlib/session.py,sha256=XLFaxaN9dcQYAMLdVSrXsVWG2Vu-Uurdr92T0y7kFEo,13847
-almdrlib/version.py,sha256=WBNnS-vc7CzFoaXh_LvVuXOu9B5A_IpuxnreuDY3EWA,162
+almdrlib/version.py,sha256=vQ4Yr9cfeNUVc0IPsg_A-BM5CJSg2DY2xKmKSKe1qiQ,162
 almdrlib/docs/__init__.py,sha256=t2Yd43bvoyOWqYZfImyblwKbdZ68o1HXyugSOOWdwmY,978
 almdrlib/docs/service.py,sha256=ZPtaWtOvRO9Gri7h_05DHRSAkzwSve3TY3tR3hNBP_I,12309
-alertlogic_sdk_python-1.0.72.dist-info/AUTHORS.rst,sha256=avwD1APR8ks8pUPY-pdqfUDii1Pj7Ne347WC7um6VMc,168
-alertlogic_sdk_python-1.0.72.dist-info/LICENSE,sha256=ilVPENu2JmctbUXAW8ddL0lKWFGlHihXb-Y8z6-1QMU,1076
-alertlogic_sdk_python-1.0.72.dist-info/METADATA,sha256=ZWK_riJmomBVlrK7QwoyjgJ1J3-sriZ9V5O_M43Rk4c,24056
-alertlogic_sdk_python-1.0.72.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-alertlogic_sdk_python-1.0.72.dist-info/top_level.txt,sha256=LevbszFLSqdS3yOClOap4s8tc9OvBWCcPxnLaiN41PQ,9
-alertlogic_sdk_python-1.0.72.dist-info/RECORD,,
+alertlogic_sdk_python-1.0.74.dist-info/AUTHORS.rst,sha256=avwD1APR8ks8pUPY-pdqfUDii1Pj7Ne347WC7um6VMc,168
+alertlogic_sdk_python-1.0.74.dist-info/LICENSE,sha256=ilVPENu2JmctbUXAW8ddL0lKWFGlHihXb-Y8z6-1QMU,1076
+alertlogic_sdk_python-1.0.74.dist-info/METADATA,sha256=i_U0z87KeHYcG3x0ivsqV1AWa5QpuMACvSlgOwWTu8E,25029
+alertlogic_sdk_python-1.0.74.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+alertlogic_sdk_python-1.0.74.dist-info/top_level.txt,sha256=LevbszFLSqdS3yOClOap4s8tc9OvBWCcPxnLaiN41PQ,9
+alertlogic_sdk_python-1.0.74.dist-info/RECORD,,

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:

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:

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)