Merge branch 'morosi-feat' into 'master'

Add Stack and CFNProjectMain extend functions

See merge request it/e3-aws!50

Author: adanaja

src/e3/aws/troposphere/__init__.py

@@ -10,6 +10,7 @@
 
 if TYPE_CHECKING:  # all: no cover
     from typing import Union
+    from collections.abc import Iterable
     from troposphere import And, Condition, Equals, If, Not, Or
 
     ConditionFunction = Union[And, Condition, Equals, If, Not, Or]
@@ -130,6 +131,16 @@ def add(self, element: AWSObject | Construct | Stack) -> Stack:
 
         return self
 
+    def extend(self, elements: Iterable[AWSObject | Construct | Stack]) -> Stack:
+        """Add multiple Construct or AWSObject to the stack.
+
+        :param elements: see Stack.add
+        """
+        for el in elements:
+            self.add(el)
+
+        return self
+
     def add_output(self, output: Output | list[Output]) -> None:
         """Add outputs to stack template.
 
@@ -232,3 +243,10 @@ def add(self, element: AWSObject | Construct | Stack) -> Stack:
         :param element: resource to add to the stack.
         """
         return self.stack.add(element)
+
+    def extend(self, elements: list[AWSObject | Construct | Stack]) -> Stack:
+        """Add resources to project's stack.
+
+        :param elements: resources to add to the stack.
+        """
+        return self.stack.extend(elements)

tests/tests_e3_aws/troposphere/cfn_project_test.py

@@ -51,3 +51,30 @@ def test_cfn_project_main(capfd: pytest.CaptureFixture[str]) -> None:
     print(captured.out)
     with open(os.path.join(TEST_DIR, "cfn_project_test.out")) as f_out:
         assert captured.out == f_out.read()
+
+
+def test_cfn_project_main_extend(capfd: pytest.CaptureFixture[str]) -> None:
+    """Test adding resources with extend."""
+    aws_env = AWSEnv(regions=["eu-west-1"], stub=True)
+    test = MyCFNProject(
+        name="TestProject",
+        account_id="12345678",
+        stack_description="TestStack",
+        s3_bucket="cfn-test-deploy-bucket",
+        regions=["eu-west-1"],
+    )
+    test.extend(
+        [
+            Role(
+                name="TestRoleB",
+                description="TestRoleB description",
+                trust={"Service": "test"},
+            )
+        ]
+    )
+    test.execute(args=["show"], aws_env=aws_env)
+
+    captured = capfd.readouterr()
+    print(captured.out)
+    with open(os.path.join(TEST_DIR, "cfn_project_test_extend.out")) as f_out:
+        assert captured.out == f_out.read()

tests/tests_e3_aws/troposphere/cfn_project_test_extend.out

@@ -0,0 +1,36 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Description: TestStack
+Resources:
+  TestRole:
+    Properties:
+      AssumeRolePolicyDocument:
+        Statement:
+        - Action: sts:AssumeRole
+          Effect: Allow
+          Principal:
+            Service: test
+        Version: '2012-10-17'
+      Description: TestRole description
+      Path: /
+      RoleName: TestRole
+      Tags:
+      - Key: Name
+        Value: TestRole
+    Type: AWS::IAM::Role
+  TestRoleB:
+    Properties:
+      AssumeRolePolicyDocument:
+        Statement:
+        - Action: sts:AssumeRole
+          Effect: Allow
+          Principal:
+            Service: test
+        Version: '2012-10-17'
+      Description: TestRoleB description
+      Path: /
+      RoleName: TestRoleB
+      Tags:
+      - Key: Name
+        Value: TestRoleB
+    Type: AWS::IAM::Role
+

tests/tests_e3_aws/troposphere/stack/stack_test.py

@@ -49,3 +49,11 @@ def test_add_outputs() -> None:
         expected_template = json.load(fd)
 
     assert stack.export()["Resources"] == expected_template
+
+
+def test_extend() -> None:
+    """Test adding multiple construct and retrieving an AWSObject from a stack."""
+    stack = Stack("test-stack", "this is a test stack")
+    stack.extend([Bucket("my-bucket-a"), Bucket("my-bucket-b")])
+    my_bucket = stack["my-bucket-b"]
+    assert my_bucket