boto3-assist 0.24.0__tar.gz → 0.26.0__tar.gz

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/.vscode/settings.json

@@ -30,7 +30,9 @@
         "addopts",
         "dateutil",
         "geekcafe",
-        "relativedelta"
+        "relativedelta",
+        "retag",
+        "retags"
     ],
     
 }

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.24.0
+Version: 0.26.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.24.0 → boto3_assist-0.26.0}/examples/dynamodb/order_example/main.py

@@ -20,7 +20,7 @@ from examples.dynamodb.services.table_service import DynamoDBTableService
 
 
 class DynamoDBExample:
-    """An example of using and debuggin DynamoDB"""
+    """An example of using and debugging DynamoDB"""
 
     def __init__(self, table_name: str) -> None:
         self.db: DynamoDB = DynamoDB()

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/pyproject.toml

@@ -15,7 +15,7 @@ addopts = "-m 'not integration'"
 
 [project]
 name = "boto3_assist"
-version = "0.24.0"
+version = "0.26.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/requirements-dev.txt

@@ -9,8 +9,10 @@ mypy_boto3_s3
 mypy_boto3_cognito_idp
 mypy_boto3_securityhub
 mypy_boto3_ssm
-moto [dynamodb2] # mocks for unit tests
-# setuptools
+mypy_boto3_ecr
+# mocks for unit tests
+moto 
+# setup-tools
 types-python-dateutil
 toml
 twine

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -352,7 +352,7 @@ class DynamoDB(DynamoDBConnection):
             if not index_name:
                 index_name = key.name
             # turn it into a key expected by dynamodb
-            key = key.key()
+            key = key.key(query_key=True)
 
         kwargs: dict = {}
 

{boto3_assist-0.24.0 → boto3_assist-0.26.0}/src/boto3_assist/dynamodb/dynamodb_index.py

@@ -171,12 +171,7 @@ class DynamoDBIndex:
             )
             return key
 
-        elif (
-            self.name == DynamoDBIndexes.PRIMARY_INDEX
-            and include_sort_key
-            # if it ends with a # we are assuming that we are doing a wild card mapping
-            and not str(self.sort_key.value).endswith("#")
-        ):
+        elif self.name == DynamoDBIndexes.PRIMARY_INDEX and include_sort_key:
             # this is a direct primary key which is used in a get call
             # this is different than query keys
             key = {}

boto3_assist-0.26.0/src/boto3_assist/erc/__init__.py

@@ -0,0 +1,64 @@
+import boto3
+from botocore.exceptions import ClientError
+from .ecr_connection import ECRConnection
+
+
+class ECR(ECRConnection):
+    pass
+
+    def retag_image(self, repository_name: str, source_tag: str, target_tag: str):
+        """
+        ReTag an ECR Image without the overhead of pulling it down, tagging and pushing.
+        Simply retags by getting the manifest, and pushing up changes.
+        Args:
+            repository_name (str):
+
+        """
+        ecr = self.client
+
+        try:
+            # 1) Get the manifest for the source tag
+            resp = ecr.batch_get_image(
+                repositoryName=repository_name,
+                imageIds=[{"imageTag": source_tag}],
+                # optional, but helps ensure you get the right manifest type:
+                acceptedMediaTypes=[
+                    "application/vnd.docker.distribution.manifest.v2+json",
+                    "application/vnd.oci.image.manifest.v1+json",
+                ],
+            )
+            images = resp.get("images", [])
+            if not images:
+                raise RuntimeError(f"No image found with tag {source_tag!r}")
+
+            manifest = images[0]["imageManifest"]
+
+            # 2) Push the same manifest under the new tag
+            put_resp = ecr.put_image(
+                repositoryName=repository_name,
+                imageManifest=manifest,
+                imageTag=target_tag,
+            )
+
+            failures = put_resp.get("failures")
+
+            if failures and len(failures) > 0:
+                raise RuntimeError(
+                    f"Failed to tag {repository_name}:{target_tag} - {failures}"
+                )
+
+            print(f"Successfully tagged {repository_name}:{target_tag}")
+            return put_resp
+
+        except ClientError as e:
+            print(
+                f"ECR error: {e.response.get('Error', {}).get('Code', 'NA')} "
+                f"- {e.response.get('Error', {}).get('Message', 'NA')}"
+            )
+            raise
+
+
+if __name__ == "__main__":
+    # Example: retag version 1.16.54 → dev
+    ecr: ECR = ECR(aws_profile="geek-cafe", aws_region="us-east-1")
+    ecr.retag_image("my-repo", "1.16.54", "dev")

boto3_assist-0.26.0/src/boto3_assist/erc/ecr_connection.py

@@ -0,0 +1,57 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional
+from typing import TYPE_CHECKING
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.connection import Connection
+
+if TYPE_CHECKING:
+    from mypy_boto3_ecr import Client
+else:
+    Client = object
+
+
+logger = Logger()
+
+
+class ECRConnection(Connection):
+    """Connection"""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        super().__init__(
+            service_name="ecr",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
+        )
+
+        self.__client: Client | None = None
+
+    @property
+    def client(self) -> Client:
+        """Client Connection"""
+        if self.__client is None:
+            self.__client = self.session.client
+
+        return self.__client
+
+    @client.setter
+    def client(self, value: Client):
+        logger.info("Setting Client")
+        self.__client = value

boto3_assist-0.26.0/src/boto3_assist/version.py

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

boto3_assist-0.26.0/tests/unit/dynamodb_tests/dynamodb_primary_key_get_test.py

@@ -0,0 +1,76 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+import moto
+from typing import Optional
+from tests.unit.dynamodb_tests.db_models.user_model import User
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from tests.unit.common.db_test_helpers import DbTestHelper
+
+
+@moto.mock_aws
+class DbQueryTest(unittest.TestCase):
+    "Serialization Tests"
+
+    def __init__(self, methodName="runTest"):
+        super().__init__(methodName)
+
+        ev: EnvironmentLoader = EnvironmentLoader()
+        # NOTE: you need to make sure the the env file below exists or you will get an error
+        ev.load_environment_file(file_name=".env.unittest")
+        self.__table_name = "mock_test_table"
+
+        self.db: DynamoDB = DynamoDB()
+
+    def setUp(self):
+        # load our test environment file to make sure we override any default AWS Environment Vars setup
+        # we don't want to accidentally connect to live environments
+        # https://docs.getmoto.org/en/latest/docs/getting_started.html
+
+        self.db: DynamoDB = self.db or DynamoDB()
+        DbTestHelper().helper_create_mock_table(self.__table_name, self.db.client)
+        print("Setup Complete")
+
+    def create_user(
+        self,
+        id: str,
+        first_name: str,
+        last_name: str,
+        email: str,
+    ) -> User:
+        user = User()
+
+        user.id = id
+        user.first_name = first_name
+        user.last_name = last_name
+        user.email = email
+
+        response = self.db.save(
+            table_name=self.__table_name, item=user, fail_if_exists=True
+        )
+        assert response["ResponseMetadata"]["HTTPStatusCode"] == 200
+        return user
+
+    def test_primary_key_get(self):
+        user: User = self.create_user(
+            id="id1",
+            first_name="first",
+            last_name="last",
+            email="email@example.com",
+        )
+
+        get_model: User = User()
+        get_model.id = user.id
+
+        get_response = self.db.get(table_name=self.__table_name, model=get_model)
+
+        assert get_response["Item"]["id"] == f"{user.id}"
+
+        user = User()
+        get_response = self.db.get(table_name=self.__table_name, model=user)
+        assert "Item" not in get_response

boto3_assist-0.24.0/src/boto3_assist/version.py

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