boto3-assist 0.11.0__tar.gz → 0.13.0__tar.gz

{boto3_assist-0.11.0 → boto3_assist-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.11.0
+Version: 0.13.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

{boto3_assist-0.11.0 → boto3_assist-0.13.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.11.0"
+version = "0.13.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

boto3_assist-0.13.0/src/boto3_assist/boto3session.py

@@ -0,0 +1,87 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional, List, Any
+import boto3
+from botocore.config import Config
+from .session_setup_mixin import SessionSetupMixin
+from .role_assumption_mixin import RoleAssumptionMixin
+
+
+class Boto3SessionManager(SessionSetupMixin, RoleAssumptionMixin):
+    def __init__(
+        self,
+        service_name: str,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        assume_role_arn: Optional[str] = None,
+        assume_role_chain: Optional[List[str]] = None,
+        assume_role_session_name: Optional[str] = None,
+        assume_role_duration_seconds: Optional[int] = 3600,
+        config: Optional[Config] = None,
+        aws_endpoint_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+        aws_session_token: Optional[str] = None,
+    ):
+        self.service_name = service_name
+        self.aws_profile = aws_profile
+        self.aws_region = aws_region
+        self.config = config
+        self.endpoint_url = aws_endpoint_url
+        self.assume_role_chain = assume_role_chain or (
+            [assume_role_arn] if assume_role_arn else []
+        )
+        self.assume_role_session_name = (
+            assume_role_session_name or f"AssumeRoleSessionFor{service_name}"
+        )
+        self.assume_role_duration_seconds = assume_role_duration_seconds
+        self.aws_access_key_id = aws_access_key_id
+        self.aws_secret_access_key = aws_secret_access_key
+        self.aws_session_token = aws_session_token
+
+        self.__session: Optional[boto3.Session] = None
+        self.__client: Any = None
+        self.__resource: Any = None
+
+        self.__initialize()
+
+    def __initialize(self):
+        base_session = self._create_base_session(
+            self.aws_profile,
+            self.aws_region,
+            self.aws_access_key_id,
+            self.aws_secret_access_key,
+            self.aws_session_token,
+        )
+
+        if self.assume_role_chain:
+            self.__session = self._assume_roles_in_chain(
+                base_session,
+                self.assume_role_chain,
+                self.assume_role_session_name,
+                self.assume_role_duration_seconds,
+                self.aws_region,
+            )
+        else:
+            self.__session = base_session
+
+    @property
+    def client(self) -> Any:
+        if not self.__client:
+            self.__client = self.__session.client(
+                self.service_name, config=self.config, endpoint_url=self.endpoint_url
+            )
+        return self.__client
+
+    @property
+    def resource(self) -> Any:
+        if not self.__resource:
+            self.__resource = self.__session.resource(
+                self.service_name, config=self.config, endpoint_url=self.endpoint_url
+            )
+        return self.__resource

{boto3_assist-0.11.0 → boto3_assist-0.13.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.11.0 → boto3_assist-0.13.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.11.0 → boto3_assist-0.13.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.13.0/src/boto3_assist/role_assumption_mixin.py

@@ -0,0 +1,38 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import boto3
+from typing import List
+
+
+class RoleAssumptionMixin:
+    def _assume_roles_in_chain(
+        self,
+        base_session: boto3.Session,
+        role_chain: List[str],
+        session_name: str,
+        duration_seconds: int,
+        region: str,
+    ) -> boto3.Session:
+        session = base_session
+
+        for role_arn in role_chain:
+            sts_client = session.client("sts")
+            response = sts_client.assume_role(
+                RoleArn=role_arn,
+                RoleSessionName=session_name,
+                DurationSeconds=duration_seconds,
+            )
+            creds = response["Credentials"]
+
+            session = boto3.Session(
+                aws_access_key_id=creds["AccessKeyId"],
+                aws_secret_access_key=creds["SecretAccessKey"],
+                aws_session_token=creds["SessionToken"],
+                region_name=region,
+            )
+
+        return session

boto3_assist-0.13.0/src/boto3_assist/session_setup_mixin.py

@@ -0,0 +1,29 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import boto3
+from typing import Optional
+
+
+class SessionSetupMixin:
+    def _create_base_session(
+        self,
+        aws_profile: Optional[str],
+        aws_region: Optional[str],
+        aws_access_key_id: Optional[str],
+        aws_secret_access_key: Optional[str],
+        aws_session_token: Optional[str],
+    ) -> boto3.Session:
+        try:
+            return boto3.Session(
+                profile_name=aws_profile,
+                region_name=aws_region,
+                aws_access_key_id=aws_access_key_id,
+                aws_secret_access_key=aws_secret_access_key,
+                aws_session_token=aws_session_token,
+            )
+        except Exception as e:
+            raise RuntimeError(f"Failed to create boto3 session: {e}") from e

boto3_assist-0.13.0/src/boto3_assist/version.py

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

boto3_assist-0.13.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()

boto3_assist-0.13.0/tests/integration/tenant.py

@@ -0,0 +1,185 @@
+"""
+Tenant Model
+"""
+
+import datetime
+from typing import Optional, Literal
+from boto3_assist.dynamodb.dynamodb_index import (
+    DynamoDBIndex,
+    DynamoDBKey,
+)
+from boto3_assist.dynamodb.dynamodb_model_base import (
+    DynamoDBModelBase,
+    exclude_from_serialization,
+)
+
+from boto3_assist.utilities.datetime_utility import DatetimeUtility
+
+
+class Tenant(DynamoDBModelBase):
+    """Database Model for the Tenant Entity"""
+
+    def __init__(
+        self,
+        id: Optional[str] = None,  # pylint: disable=w0622
+    ) -> None:
+        super().__init__()
+        self.id: Optional[str] = id
+        self.name: Optional[str] = None
+        self.email: Optional[str] = None
+        self.subscription_id: Optional[str] = None
+        self.type: Optional[str] = None
+        self.__status: Optional[str] = None
+        self.status_message: str = ""
+        self.company_name: Optional[str] = None
+        self.created_utc: datetime.datetime = DatetimeUtility.get_utc_now()
+        self.modified_utc: datetime.datetime = DatetimeUtility.get_utc_now()
+        self.reindexed_utc: Optional[datetime.datetime] = None
+        self.__onboard_utc: Optional[datetime.datetime] = None
+        self.__setup_indexes()
+
+    def __setup_indexes(self):
+        self.indexes.add_primary(
+            DynamoDBIndex(
+                index_name="primary",
+                partition_key=DynamoDBKey(
+                    attribute_name="pk",
+                    value=lambda: f"tenant#{self.id if self.id else ''}",
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="sk",
+                    value=lambda: f"tenant#{self.id if self.id else ''}",
+                ),
+            )
+        )
+
+        self.indexes.add_secondary(
+            DynamoDBIndex(
+                index_name="gsi0",
+                partition_key=DynamoDBKey(
+                    attribute_name="gsi0_pk",
+                    value="tenants#",
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="gsi0_sk",
+                    value=lambda: f"name#{self.__sort_name if self.__sort_name else ''}",
+                ),
+            )
+        )
+
+        self.indexes.add_secondary(
+            DynamoDBIndex(
+                index_name="gsi1",
+                partition_key=DynamoDBKey(
+                    attribute_name="gsi1_pk",
+                    value="tenants#",
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="gsi1_sk",
+                    value=lambda: (
+                        f"status#{self.status if self.status else ''}"
+                        f"name#{self.__sort_name if self.__sort_name else ''}"
+                    ),
+                ),
+            )
+        )
+
+        self.indexes.add_secondary(
+            DynamoDBIndex(
+                index_name="gsi2",
+                partition_key=DynamoDBKey(
+                    attribute_name="gsi2_pk",
+                    value="tenants#",
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="gsi2_sk",
+                    value=lambda: f"onboard-ts#{self.onboard_utc.timestamp() if self.onboard_utc else ''}",
+                ),
+            )
+        )
+
+    @property
+    @exclude_from_serialization
+    def modifed_date(self) -> Optional[str]:
+        """Backward compatibale db model for modified date"""
+        return str(self.modified_utc)
+
+    @modifed_date.setter
+    def modifed_date(self, value: Optional[str]) -> None:
+        v = DatetimeUtility.to_datetime_utc(value=value)
+
+        self.modified_utc = v or DatetimeUtility.get_utc_now()
+
+    @property
+    @exclude_from_serialization
+    def onboarding_date(self) -> Optional[str]:
+        """Backward compatibale db model for modified date"""
+        return str(self.onboard_utc)
+
+    @onboarding_date.setter
+    def onboarding_date(self, value: Optional[str]) -> None:
+        self.onboard_utc = DatetimeUtility.to_datetime_utc(value=value)
+
+    @property
+    @exclude_from_serialization
+    def email_address(self) -> Optional[str]:
+        """Backward compatibale db model for email address"""
+        return self.email
+
+    @email_address.setter
+    def email_address(self, value: Optional[str]) -> None:
+        self.email = value
+
+    @property
+    def onboard_utc(self) -> Optional[datetime.datetime]:
+        """The UTC date and time the user was onboarded"""
+        return DatetimeUtility.to_datetime_utc(self.__onboard_utc)
+
+    @onboard_utc.setter
+    def onboard_utc(self, value: Optional[datetime.datetime]) -> None:
+        self.__onboard_utc = DatetimeUtility.to_datetime_utc(
+            value=value, default=DatetimeUtility.get_utc_now()
+        )
+
+    @property
+    def status(self) -> Optional[Literal["enabled", "disabled", "locked"]]:
+        """The status of the tenant"""
+
+        return self.__status
+
+    @status.setter
+    def status(self, value: Optional[Literal["enabled", "disabled", "locked"]]) -> None:
+        if value is not None:
+            value = str(value).lower()
+
+        self.__status = value
+
+    @property
+    def __sort_name(self) -> Optional[str]:
+        if self.name is None:
+            return None
+        else:
+            return self.name.lower()
+
+    @property
+    def record_type(self) -> str:
+        """
+        The type of record we are storing to help load the
+        correct object at runtime if needed.
+        """
+        name = __name__.rsplit(".", maxsplit=1)[-1]
+        return name
+
+    @record_type.setter
+    def record_type(self, value: str) -> None:
+        pass
+
+    @property
+    def subscription(self) -> dict | None:
+        """The tenants current subscription - if bound to one"""
+        return self.__subscription
+
+    @subscription.setter
+    def subscription(self, value: dict) -> None:
+
+        self.__subscription = value

boto3_assist-0.13.0/tests/integration/tenant_services.py

@@ -0,0 +1,48 @@
+from typing import Optional
+from .tenant import Tenant
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+
+
+class TenantServices:
+
+    def __init__(self, db: DynamoDB, table_name: str) -> None:
+        self.db: DynamoDB = db or DynamoDB()
+        self.table_name: str = table_name
+
+    def list(
+        self,
+        *,
+        status: Optional[str] = None,
+        ascending: bool = True,
+        do_projections: bool = False,
+        strongly_consistent: bool = False,
+        start_key: Optional[dict] = None,
+    ) -> dict:
+        """
+        List all Tenants within an optional status (enabled or )
+
+        Args:
+            start_key (Optional[str]): A start key for paged results.
+            do_projections (bool, optional): Determines if we do projections or not. Defaults to False.
+
+        Returns:
+            dict: DynamoDB response dictionary
+        """
+        model: Tenant = Tenant()
+        index_name: str = "gsi0"
+        if status:
+            model.status = status
+            index_name = "gsi1"
+        key = model.get_key(index_name).key()
+        response = self.db.query_by_criteria(
+            model=model,
+            index_name=index_name,
+            key=key,
+            start_key=start_key,
+            do_projections=do_projections,
+            table_name=self.table_name,
+            strongly_consistent=strongly_consistent,
+            ascending=ascending,
+        )
+
+        return response

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dbmodels/cms/content_block.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
 from boto3_assist.utilities.string_utility import StringUtility
-from tests.dynamodb_tests.models.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.models.cms.base import BaseCMSDBModel
 
 
 class ContentBlock(BaseCMSDBModel):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dbmodels/cms/page.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 from typing import List, Dict, Any
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
 
 
 class Page(BaseCMSDBModel):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dbmodels/cms/template.py

@@ -6,7 +6,7 @@ MIT License.  See Project Root for the license information.
 
 from typing import List
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.dynamodb_tests.models.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
 
 
 class Template(BaseCMSDBModel):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dynamodb_model_base_test.py

@@ -9,7 +9,7 @@ from typing import Dict, List
 
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
-from tests.dynamodb_tests.dbmodels.user_model import User
+from tests.unit.dynamodb_tests.dbmodels.user_model import User
 
 
 class DynamoDBModelUnitTest(unittest.TestCase):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dynamodb_model_projections_test.py

@@ -7,8 +7,8 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.dynamodb_tests.dbmodels.user_model import User
-from tests.dynamodb_tests.dbmodels.simple_model import Simple
+from tests.unit.dynamodb_tests.dbmodels.user_model import User
+from tests.unit.dynamodb_tests.dbmodels.simple_model import Simple
 
 
 class DynamoDBModeProjectionlUnitTest(unittest.TestCase):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dynamodb_model_serializtion_test.py

@@ -7,8 +7,8 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.dynamodb_tests.dbmodels.user_model import User
-from tests.dynamodb_tests.dbmodels.user_required_fields_model import User as User2
+from tests.unit.dynamodb_tests.dbmodels.user_model import User
+from tests.unit.dynamodb_tests.dbmodels.user_required_fields_model import User as User2
 
 
 class DynamoDBModelSerializationUnitTest(unittest.TestCase):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/dynamodb_tests/dynamodb_moto_sorting_test.py

@@ -12,7 +12,7 @@ from mypy_boto3_dynamodb import DynamoDBClient
 
 from boto3_assist.dynamodb.dynamodb import DynamoDB
 from boto3_assist.environment_services.environment_loader import EnvironmentLoader
-from tests.dynamodb_tests.dbmodels.cms.page import Page
+from tests.unit.dynamodb_tests.dbmodels.cms.page import Page
 
 
 @moto.mock_aws

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/models_tests/serializable_model_person_test.py

@@ -7,9 +7,7 @@ MIT License.  See Project Root for the license information.
 import unittest
 from typing import Dict, List
 from boto3_assist.models.serializable_model import SerializableModel
-from tests.models_tests.models.person import Person
-
-
+from tests.unit.models_tests.models.person import Person
 
 
 class TestSerializableModel(unittest.TestCase):

{boto3_assist-0.11.0/tests → boto3_assist-0.13.0/tests/unit}/models_tests/serializable_model_user_test.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import unittest
 from typing import Dict, List, Any
 from boto3_assist.models.serializable_model import SerializableModel
-from tests.models_tests.models.user import User
+from tests.unit.models_tests.models.user import User
 
 
 class TestSerializableModel(unittest.TestCase):