boto3-assist 0.10.0__tar.gz → 0.12.0__tar.gz

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/.vscode/settings.json

@@ -1,6 +1,6 @@
 {
-    "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true,
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
     "python.testing.unittestArgs": [
         "-v",
         "-s",
@@ -24,7 +24,7 @@
     "[python]": {
         
         "editor.formatOnSave": true,        
-        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.defaultFormatter": "ms-python.black-formatter",
     },
     
 }

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.10.0
+Version: 0.12.0
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt
 License-File: LICENSE.txt
-Classifier: License :: Other/Proprietary License
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
 Requires-Python: >=3.10
 Requires-Dist: aws-lambda-powertools
 Requires-Dist: aws-xray-sdk
@@ -23,6 +26,10 @@ Description-Content-Type: text/markdown
 
 # boto3 assist
 
+[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)
+
 This is in beta and subject to changes before it's initial 1.0.0 release
 
 This libary was created to make life a little easier when using boto3.

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/README.md

@@ -1,5 +1,9 @@
 # boto3 assist
 
+[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)
+
 This is in beta and subject to changes before it's initial 1.0.0 release
 
 This libary was created to make life a little easier when using boto3.

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/pyproject.toml

@@ -8,10 +8,14 @@ packages = ["src/boto3_assist"]
 [tool.pytest.ini_options]
 pythonpath = ["src"]
 testpaths = ["tests"]
+markers = [
+    "integration: marks tests as integration (deselect with '-m \"not integration\"')"
+]
+addopts = "-m 'not integration'"
 
 [project]
 name = "boto3_assist"
-version = "0.10.0"
+version = "0.12.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }
@@ -21,8 +25,11 @@ readme = "README.md"
 requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: Other/Proprietary License",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
     "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Topic :: Software Development"
 ]
 
 dependencies = [

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/requirements-dev.txt

@@ -19,4 +19,5 @@ pkginfo # occasionally we need to upgrade this or we can get upload errors when
 # the error may look like the following
 # ERROR    InvalidDistribution: Metadata is missing required fields: Name, Version.                                                
 #          Make sure the distribution includes the files where those fields are specified, and is using a supported                
-#          Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 2.3. 
+#          Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 2.3. 
+pytest

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/boto3session.py

@@ -27,7 +27,7 @@ class Boto3SessionManager:
         aws_region: Optional[str] = None,
         assume_role_arn: Optional[str] = None,
         assume_role_session_name: Optional[str] = None,
-        cross_account_role_arn: Optional[str] = None,
+        # cross_account_role_arn: Optional[str] = None,
         config: Optional[Config] = None,
         aws_endpoint_url: Optional[str] = None,
         aws_access_key_id: Optional[str] = None,
@@ -40,7 +40,7 @@ class Boto3SessionManager:
         self.assume_role_arn = assume_role_arn
         self.assume_role_session_name = assume_role_session_name
         self.config = config
-        self.cross_account_role_arn = cross_account_role_arn
+        # # self.cross_account_role_arn = cross_account_role_arn
         self.endpoint_url = aws_endpoint_url
         self.aws_access_key_id = aws_access_key_id
         self.aws_secret_access_key = aws_secret_access_key
@@ -57,36 +57,46 @@ class Boto3SessionManager:
 
         profile = self.aws_profile or EnvironmentVariables.AWS.profile()
         region = self.aws_region or EnvironmentVariables.AWS.region()
-        if self.assume_role_arn:
-            self.__assume_role()
-        else:
-            logger.debug("Connecting without assuming a role.")
-            self.__session = self.__get_aws_session(profile, region)
+
+        logger.debug("Connecting without assuming a role.")
+        self.__session = self.__get_aws_session(profile, region)
 
         if profile:
             print(f"Connecting with a profile: {profile}")
 
+        if self.assume_role_arn:
+            self.__assume_role()
+
     def __assume_role(self):
         """Assume an AWS IAM role."""
         try:
+            if not self.__session:
+                raise RuntimeError(
+                    "Session must be established before assuming a role."
+                )
+
             logger.debug(f"Assuming role {self.assume_role_arn}")
-            sts_client = boto3.client("sts")
+
+            sts_client = self.__session.client("sts")
             session_name = (
                 self.assume_role_session_name
                 or f"AssumeRoleSessionFor{self.service_name}"
             )
-            if not self.assume_role_arn:
-                raise ValueError("assume_role_arn is required")
+
             assumed_role_response = sts_client.assume_role(
                 RoleArn=self.assume_role_arn,
                 RoleSessionName=session_name,
             )
             credentials = assumed_role_response["Credentials"]
+
+            # Now override the session with assumed credentials
             self.__session = boto3.Session(
                 aws_access_key_id=credentials["AccessKeyId"],
                 aws_secret_access_key=credentials["SecretAccessKey"],
                 aws_session_token=credentials["SessionToken"],
+                region_name=self.aws_region,
             )
+            logger.debug("Successfully assumed role and created new session.")
 
         except Exception as e:
             logger.error(f"Error assuming role: {e}")
@@ -117,9 +127,9 @@ class Boto3SessionManager:
                     "region": self.aws_region,
                     "aws_access_key_id": tmp_access_key_id,
                     "aws_secret_access_key": tmp_secret_access_key,
-                    "aws_session_token": "*******"
-                    if self.aws_session_token is not None
-                    else "",
+                    "aws_session_token": (
+                        "*******" if self.aws_session_token is not None else ""
+                    ),
                 }
             )
             logger.debug("Creating boto3 session")

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/cloudwatch/cloudwatch_connection_tracker.py

@@ -14,4 +14,4 @@ class CloudWatchConnectionTracker(ConnectionTracker):
     """
 
     def __init__(self) -> None:
-        super().__init__("CloudWatch")
+        super().__init__()

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/cognito/cognito_utility.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import time
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Any, Optional, Literal
 
 
 from aws_lambda_powertools import Logger
@@ -130,7 +130,7 @@ class CognitoUtility(CognitoConnection):
                 is_permanent=True,
             )
 
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -185,7 +185,7 @@ class CognitoUtility(CognitoConnection):
             UserPoolId=user_pool_id, Username=user_name
         )
 
-        return response
+        return dict(response)
 
     def admin_enable_user(
         self, user_name: str, user_pool_id: str, reset_password: bool = True
@@ -271,7 +271,7 @@ class CognitoUtility(CognitoConnection):
             logger.debug(
                 f"User {email} created successfully. Confirmation code sent to {email}."
             )
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -324,11 +324,11 @@ class CognitoUtility(CognitoConnection):
         user_pool_id,
         client_name,
         id_token_time_out=60,
-        id_token_units="minutes",
+        id_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         access_token_time_out=60,
-        access_token_units="minutes",
+        access_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         refresh_token_time_out=60,
-        refresh_token_units="minutes",
+        refresh_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
     ) -> dict:
         # valid units: 'seconds'|'minutes'|'hours'|'days'
 
@@ -340,9 +340,9 @@ class CognitoUtility(CognitoConnection):
             AccessTokenValidity=access_token_time_out,
             IdTokenValidity=id_token_time_out,
             TokenValidityUnits={
-                "AccessToken": f"{access_token_units}",
-                "IdToken": f"{id_token_units}",
-                "RefreshToken": f"{refresh_token_units}",
+                "AccessToken": access_token_units,
+                "IdToken": id_token_units,
+                "RefreshToken": refresh_token_units,
             },
             # ReadAttributes=[
             #     'string',
@@ -381,18 +381,18 @@ class CognitoUtility(CognitoConnection):
             # AuthSessionValidity=123
         )
 
-        return response
+        return dict(response)
 
     def search_cognito(self, email: str, user_pool_id: str) -> dict:
         """Search cognito for an existing user"""
 
-        email = self.__format_email(email=email)
+        email = self.__format_email(email=email) or ""
         filter_string = f'email = "{email}"'
 
         # Call the admin_list_users method with the filter
         response = self.client.list_users(UserPoolId=user_pool_id, Filter=filter_string)
 
-        return response
+        return dict(response)
 
     def __set_user_attributes(self, *, user: CognitoUser) -> List[dict]:
         """

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/connection.py

@@ -30,6 +30,7 @@ class Connection:
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
         aws_end_point_url: Optional[str] = None,
+        assume_role_arn: Optional[str] = None,
     ) -> None:
         self.__aws_profile = aws_profile
         self.__aws_region = aws_region
@@ -37,7 +38,7 @@ class Connection:
         self.__aws_secret_access_key = aws_secret_access_key
         self.end_point_url = aws_end_point_url
         self.__session: Boto3SessionManager | None = None
-
+        self.__assume_role_arn: Optional[str] = assume_role_arn
         self.__service_name: str | None = service_name
 
         if self.__service_name is None:
@@ -73,6 +74,7 @@ class Connection:
             aws_access_key_id=self.aws_access_key_id,
             aws_secret_access_key=self.aws_secret_access_key,
             aws_endpoint_url=self.end_point_url,
+            assume_role_arn=self.__assume_role_arn,
         )
 
         tracker.add(service_name=self.service_name)

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -24,7 +24,6 @@ from boto3_assist.utilities.string_utility import StringUtility
 logger = Logger()
 
 
-
 class DynamoDB(DynamoDBConnection):
     """
         DynamoDB. Wrapper for basic DynamoDB Connection and Actions
@@ -41,6 +40,7 @@ class DynamoDB(DynamoDBConnection):
         aws_end_point_url: Optional[str] = None,
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
+        assume_role_arn: Optional[str] = None,
     ) -> None:
         super().__init__(
             aws_profile=aws_profile,
@@ -48,6 +48,7 @@ class DynamoDB(DynamoDBConnection):
             aws_end_point_url=aws_end_point_url,
             aws_access_key_id=aws_access_key_id,
             aws_secret_access_key=aws_secret_access_key,
+            assume_role_arn=assume_role_arn,
         )
         self.helpers: DynamoDBHelpers = DynamoDBHelpers()
         self.log_dynamodb_item_size = (
@@ -55,7 +56,6 @@ class DynamoDB(DynamoDBConnection):
         )
         logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
 
-    
     def save(
         self,
         item: dict | DynamoDBModelBase,
@@ -169,7 +169,6 @@ class DynamoDB(DynamoDBConnection):
         call_type: str = "resource",
     ) -> Dict[str, Any]: ...
 
-    
     def get(
         self,
         key: Optional[dict] = None,
@@ -344,7 +343,6 @@ class DynamoDB(DynamoDBConnection):
     ) -> dict:
         pass
 
-    
     def delete(
         self,
         *,

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/dynamodb/dynamodb_connection.py

@@ -32,6 +32,7 @@ class DynamoDBConnection(Connection):
         aws_end_point_url: Optional[str] = None,
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
+        assume_role_arn: Optional[str] = None,
     ) -> None:
         super().__init__(
             service_name="dynamodb",
@@ -40,6 +41,7 @@ class DynamoDBConnection(Connection):
             aws_access_key_id=aws_access_key_id,
             aws_secret_access_key=aws_secret_access_key,
             aws_end_point_url=aws_end_point_url,
+            assume_role_arn=assume_role_arn,
         )
 
         self.__dynamodb_client: DynamoDBClient | None = None

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -249,6 +249,7 @@ class DynamoDBModelBase(SerializableModel):
         """
 
         value = DatetimeUtility.to_datetime_utc(value)
+        return value
 
 
 class DynamoDBSerializer:

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/s3/s3_event_data.py

@@ -15,37 +15,37 @@ class EventData:
         self.__event = event
 
     @property
-    def version(self) -> str:
+    def version(self) -> str | None:
         """Event Version"""
         return self.__event.get("version")
 
     @property
-    def id(self) -> str:
+    def id(self) -> str | None:
         """Event Id"""
         return self.__event.get("id")
 
     @property
-    def detail_type(self) -> str:
+    def detail_type(self) -> str | None:
         """Event Detail Type"""
         return self.__event.get("detail-type")
 
     @property
-    def source(self) -> str:
+    def source(self) -> str | None:
         """Event Source"""
         return self.__event.get("source")
 
     @property
-    def account(self) -> str:
+    def account(self) -> str | None:
         """Event Account"""
         return self.__event.get("account")
 
     @property
-    def time(self) -> str:
+    def time(self) -> str | None:
         """Event Time"""
         return self.__event.get("time")
 
     @property
-    def region(self) -> str:
+    def region(self) -> str | None:
         """Event Region"""
         return self.__event.get("region")
 

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/s3/s3_object.py

@@ -217,7 +217,7 @@ class S3Object:
         )
         try:
             # convert if necessary
-            file_obj: bytes = (
+            file_obj = (
                 file_obj.encode("utf-8") if isinstance(file_obj, str) else file_obj
             )
             self.connection.client.upload_fileobj(
@@ -658,7 +658,7 @@ class S3Object:
             Key=destination_key,
         )
 
-        return response
+        return dict(response)
 
     def move(
         self,

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/securityhub/securityhub.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import os
-from typing import Optional
+from typing import Optional, Literal
 
 from aws_lambda_powertools import Logger
 
@@ -20,7 +20,7 @@ class SecurityHub(SecurityHubConnection):
     def update_findings_status(
         self,
         region_name: str,
-        workflow_status: str,
+        workflow_status: Literal["NEW", "NOTIFIED", "RESOLVED", "SUPPRESSED"],
         note_text: Optional[str] = None,
         updated_by: Optional[str] = None,
     ):

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/utilities/serialization_utility.py

@@ -148,9 +148,11 @@ class JsonConversions:
         elif isinstance(data, list):
             # For lists, if deep conversion is enabled, process each element.
             return [
-                JsonConversions._convert_keys(item, convert_func, deep)
-                if deep
-                else item
+                (
+                    JsonConversions._convert_keys(item, convert_func, deep)
+                    if deep
+                    else item
+                )
                 for item in data
             ]
         else:
@@ -377,7 +379,10 @@ class Serialization:
             setattr(target, "__actively_serializing_data__", True)
 
         for key, value in source.items():
-            if Serialization.has_attribute(target, key):
+            if isinstance(target, dict):
+                # our target is a dictionary, so we need to handle this differently
+                target[key] = value
+            elif Serialization.has_attribute(target, key):
                 attr = getattr(target, key)
                 expected_type = type(attr)
 

{boto3_assist-0.10.0 → boto3_assist-0.12.0}/src/boto3_assist/utilities/string_utility.py

@@ -313,6 +313,7 @@ class StringUtility:
                 return True
             if value in ("false", "0", "f", "n", "no"):
                 return False
+            raise ValueError(f"Invalid boolean value: {value}")
         elif isinstance(value, int):
             return bool(value)
         elif value is None:

boto3_assist-0.12.0/src/boto3_assist/version.py

@@ -0,0 +1 @@
+__version__ = '0.12.0'

boto3_assist-0.12.0/tests/integration/cross_account_connection_test.py

@@ -0,0 +1,78 @@
+import pytest
+import os
+from typing import List
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from tests.integration.tenant_services import TenantServices
+
+
+@pytest.mark.integration
+def test_cross_account_role_assumption_with_profile():
+    responses = []
+
+    profile_name = os.getenv("AWS_PROFILE")
+
+    connections: List[dict] = [
+        {
+            "profile_name": profile_name,
+            "aws_account": "959096737760",
+            "aws_region": "us-east-1",
+            "role_name": "CrossAccountAccessRole",
+            "table_name": "db-us-east-1",
+            "enabled": False,
+        },
+        {
+            "profile_name": profile_name,
+            "aws_account": "959096737760",
+            "aws_region": "eu-west-2",
+            "role_name": "CrossAccountAccessRole",
+            "table_name": "db-eu-west-2",
+            "enabled": False,
+        },
+        {
+            "profile_name": profile_name,
+            "aws_account": "257932641017",
+            "aws_region": "us-east-1",
+            "role_name": "CrossAccountAccessRole",
+            "table_name": "aplos-nca-saas-production-demo-001-database",
+            "enabled": True,
+        },
+        {
+            "profile_name": profile_name,
+            "aws_region": "us-east-1",
+            "aws_account": "211125601483",
+            "role_name": "CrossAccountAccessRole",
+            "table_name": "aplos-nca-saas-production-app-database",
+            "enabled": True,
+        },
+    ]
+
+    for connection in connections:
+        role_arn = (
+            f"arn:aws:iam::{connection['aws_account']}:role/{connection['role_name']}"
+        )
+        if connection["enabled"]:
+            db = DynamoDB(
+                aws_profile=connection["profile_name"],
+                aws_region=connection["aws_region"],
+                assume_role_arn=role_arn,
+            )
+            ts: TenantServices = TenantServices(
+                db=db, table_name=connection["table_name"]
+            )
+            response = ts.list()
+            responses.append(response)
+            # print(response)
+        else:
+            responses.append(None)
+
+    print(len(responses))
+    assert len(responses) == 3
+
+
+def main():
+    test_cross_account_role_assumption_with_profile()
+    pass
+
+
+if __name__ == "__main__":
+    main()