cloud-radar 0.13.3a16__py3-none-any.whl → 0.14.0__py3-none-any.whl

cloud_radar/cf/unit/_template.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import json
 import re
+import uuid
 from pathlib import Path
 from typing import Any, Callable, Dict, Generator, List, Optional, Tuple, Union
 
@@ -26,8 +27,8 @@ class Template:
     NoValue: str = ""  # Not yet implemented
     Partition: str = "aws"  # Other regions not implemented
     Region: str = "us-east-1"
-    StackId: str = ""  # Not yet implemented
-    StackName: str = ""  # Not yet implemented
+    StackId: str = ""  # If left blank this will be generated
+    StackName: str = "my-cloud-radar-stack"
     URLSuffix: str = "amazonaws.com"  # Other regions not implemented
 
     def __init__(
@@ -80,6 +81,7 @@ class Template:
         self.transforms: Optional[Union[str, List[str]]] = self.template.get(
             "Transform", None
         )
+        self.allowed_functions: functions.Dispatch = self.load_allowed_functions()
 
         # All loaded, validate against any template level hooks
         # that have been configured
@@ -206,7 +208,7 @@ class Template:
             # If we get this far then we do not support this type of configuration file
             raise ValueError("Parameter file is not in a supported format")
 
-    def load_allowed_functions(self) -> functions.Dispatch:
+    def load_allowed_functions(self):
         """Loads the allowed functions for this template.
 
         Raises:
@@ -230,8 +232,9 @@ class Template:
             return {**functions.ALL_FUNCTIONS, **transform_functions}
 
         if isinstance(self.transforms, list):
-            # dict of transform functions
+
             transform_functions = {}
+
             for transform in self.transforms:
                 if transform not in functions.TRANSFORMS:
                     raise ValueError(f"Transform {transform} not supported")
@@ -248,13 +251,8 @@ class Template:
     def render_all_sections(self, template: Dict[str, Any]) -> Dict[str, Any]:
         """Solves all conditionals, references and pseudo variables for all sections"""
 
-        allowed_functions = self.load_allowed_functions()
-
         if "Conditions" in template:
-            template["Conditions"] = self.resolve_values(
-                template["Conditions"],
-                allowed_functions,
-            )
+            template["Conditions"] = self.resolve_values(template["Conditions"])
 
         template_sections = ["Resources", "Outputs"]
 
@@ -277,10 +275,7 @@ class Template:
                     if not condition_value:
                         continue
 
-                template[section][r_name] = self.resolve_values(
-                    r_value,
-                    allowed_functions,
-                )
+                template[section][r_name] = self.resolve_values(r_value)
 
         return template
 
@@ -310,6 +305,19 @@ class Template:
 
         return template
 
+    # If the StackId variable is not set, generate a value for it
+    def _get_populated_stack_id(self) -> str:
+        if not Template.StackId:
+            # Not explicitly set, generate a value
+            unique_uuid = uuid.uuid4()
+
+            return (
+                f"arn:{Template.Partition}:cloudformation:{self.Region}:"
+                f"{Template.AccountId}:stack/{Template.StackName}/{unique_uuid}"
+            )
+
+        return Template.StackId
+
     def create_stack(
         self,
         params: Optional[Dict[str, str]] = None,
@@ -318,6 +326,7 @@ class Template:
     ):
         if region:
             self.Region = region
+        self.StackId = self._get_populated_stack_id()
 
         self.render(params, parameters_file=parameters_file)
 
@@ -331,7 +340,6 @@ class Template:
     def resolve_values(  # noqa: max-complexity: 13
         self,
         data: Any,
-        allowed_func: functions.Dispatch,
     ) -> Any:
         """Recurses through a Cloudformation template. Solving all
         references and variables along the way.
@@ -351,10 +359,7 @@ class Template:
                 # This takes care of keys that not intrinsic functions,
                 #  except for the condition func
                 if "Fn::" not in key and key != "Condition":
-                    data[key] = self.resolve_values(
-                        value,
-                        allowed_func,
-                    )
+                    data[key] = self.resolve_values(value)
                     continue
 
                 # Takes care of the tricky 'Condition' key
@@ -372,21 +377,15 @@ class Template:
                         return functions.condition(self, value)
 
                     # Normal key like in an IAM role
-                    data[key] = self.resolve_values(
-                        value,
-                        allowed_func,
-                    )
+                    data[key] = self.resolve_values(value)
                     continue
 
-                if key not in allowed_func:
+                if key not in self.allowed_functions:
                     raise ValueError(f"{key} with value ({value}) not allowed here")
 
-                value = self.resolve_values(
-                    value,
-                    functions.ALLOWED_FUNCTIONS[key],
-                )
+                value = self.resolve_values(value)
 
-                funct_result = allowed_func[key](self, value)
+                funct_result = self.allowed_functions[key](self, value)
 
                 if isinstance(funct_result, str):
                     # If the result is a string then process any
@@ -397,13 +396,7 @@ class Template:
 
             return data
         elif isinstance(data, list):
-            return [
-                self.resolve_values(
-                    item,
-                    allowed_func,
-                )
-                for item in data
-            ]
+            return [self.resolve_values(item) for item in data]
         elif isinstance(data, str):
             return self.resolve_dynamic_references(data)
         else:

cloud_radar/cf/unit/functions.py

@@ -283,9 +283,7 @@ def condition(template: "Template", name: Any) -> bool:
     condition_value = template.template["Conditions"][name]
 
     if not isinstance(condition_value, bool):
-        condition_value: bool = template.resolve_values(  # type: ignore
-            condition_value, allowed_func=ALLOWED_NESTED_CONDITIONS
-        )
+        condition_value: bool = template.resolve_values(condition_value)  # type: ignore
 
     return condition_value
 
@@ -455,7 +453,18 @@ def get_att(template: "Template", values: Any) -> str:
     if resource_name not in template.template["Resources"]:
         raise KeyError(f"Fn::GetAtt - Resource {resource_name} not found in template.")
 
-    return f"{resource_name}.{att_name}"
+    # Get the resource definition
+    resource = template.template["Resources"][resource_name]
+
+    # Check if there is a value in the resource Metadata for this attribute.
+    # If the attribute requested is in the metadata, return it.
+    # Otherwise use the string value of "{resource_name}.{att_name}"
+
+    metadata = resource.get("Metadata", {})
+    cloud_radar_metadata = metadata.get("Cloud-Radar", {})
+    attribute_values = cloud_radar_metadata.get("attribute-values", {})
+
+    return attribute_values.get(att_name, f"{resource_name}.{att_name}")
 
 
 def get_azs(_t: "Template", region: Any) -> List[str]:
@@ -931,106 +940,6 @@ ALL_FUNCTIONS: Dispatch = {
     **INTRINSICS,
 }
 
-ALLOWED_NESTED_CONDITIONS: Dispatch = {
-    "Fn::FindInMap": find_in_map,
-    "Ref": ref,
-    **CONDITIONS,
-}
-
-# Cloudformation only allows certain functions to be called from inside
-# other functions. The keys are the function name and the values are the
-# functions that are allowed to be nested inside it.
-ALLOWED_FUNCTIONS: Dict[str, Dispatch] = {
-    "Fn::And": ALLOWED_NESTED_CONDITIONS,
-    "Fn::Equals": {**ALLOWED_NESTED_CONDITIONS, "Fn::Join": join, "Fn::Select": select},
-    "Fn::If": {
-        "Fn::Base64": base64,
-        "Fn::FindInMap": find_in_map,
-        "Fn::GetAtt": get_att,
-        "Fn::GetAZs": get_azs,
-        "Fn::If": if_,
-        "Fn::Join": join,
-        "Fn::Select": select,
-        "Fn::Sub": sub,
-        "Ref": ref,
-        "Fn::ImportValue": import_value,
-    },
-    "Fn::Not": ALLOWED_NESTED_CONDITIONS,
-    "Fn::Or": ALLOWED_NESTED_CONDITIONS,
-    "Condition": {},  # Only allows strings
-    "Fn::Base64": ALL_FUNCTIONS,
-    "Fn::Cidr": {
-        "Fn::Select": select,
-        "Ref": ref,
-    },
-    "Fn::FindInMap": {
-        "Fn::FindInMap": find_in_map,
-        "Ref": ref,
-    },
-    "Fn::GetAtt": {},  # This one is complicated =/
-    "Fn::GetAZs": {
-        "Ref": ref,
-    },
-    "Fn::ImportValue": {
-        "Fn::Base64": base64,
-        "Fn::FindInMap": find_in_map,
-        "Fn::If": if_,
-        "Fn::Join": join,
-        "Fn::Select": select,
-        "Fn::Split": split,
-        "Fn::Sub": sub,
-        "Ref": ref,
-    },  # Import value can't depend on resources (not implemented)
-    "Fn::Join": {
-        "Fn::Base64": base64,
-        "Fn::FindInMap": find_in_map,
-        "Fn::GetAtt": get_att,
-        "Fn::GetAZs": get_azs,
-        "Fn::If": if_,
-        "Fn::ImportValue": import_value,
-        "Fn::Join": join,
-        "Fn::Split": split,
-        "Fn::Select": select,
-        "Fn::Sub": sub,
-        "Ref": ref,
-    },
-    "Fn::Select": {
-        "Fn::FindInMap": find_in_map,
-        "Fn::GetAtt": get_att,
-        "Fn::GetAZs": get_azs,
-        "Fn::If": if_,
-        "Fn::Split": split,
-        "Ref": ref,
-    },
-    "Fn::Split": {
-        "Fn::Base64": base64,
-        "Fn::FindInMap": find_in_map,
-        "Fn::GetAtt": get_att,
-        "Fn::GetAZs": get_azs,
-        "Fn::If": if_,
-        "Fn::ImportValue": import_value,
-        "Fn::Join": join,
-        "Fn::Split": split,
-        "Fn::Select": select,
-        "Fn::Sub": sub,
-        "Ref": ref,
-    },
-    "Fn::Sub": {
-        "Fn::Base64": base64,
-        "Fn::FindInMap": find_in_map,
-        "Fn::GetAtt": get_att,
-        "Fn::GetAZs": get_azs,
-        "Fn::If": if_,
-        "Fn::ImportValue": import_value,
-        "Fn::Join": join,
-        "Fn::Select": select,
-        "Ref": ref,
-        "Fn::Sub": sub,
-    },
-    "Fn::Transform": {},  # Transform isn't fully implemented
-    "Ref": {},  # String only.
-}
-
 # Extra functions that are allowed if the template is using a transform.
 TRANSFORMS: Dict[str, Dispatch] = {
     "AWS::CodeDeployBlueGreen": {},

cloud_radar/cf/unit/test__template.py

@@ -7,40 +7,38 @@ from cloud_radar.cf.unit._template import Template
 
 def test_load_allowed_functions_no_transforms():
     template = Template({})
-    result = template.load_allowed_functions()
-    assert result == functions.ALL_FUNCTIONS
+    template.load_allowed_functions()
+    assert template.allowed_functions == functions.ALL_FUNCTIONS
 
 
 def test_load_allowed_functions_single_transform():
     template = Template({"Transform": "AWS::Serverless-2016-10-31"})
-    result = template.load_allowed_functions()
+    template.load_allowed_functions()
     expected = {
         **functions.ALL_FUNCTIONS,
         **functions.TRANSFORMS["AWS::Serverless-2016-10-31"],
     }
-    assert result == expected
+    assert template.allowed_functions == expected
 
 
 def test_load_allowed_functions_multiple_transforms():
     template = Template({"Transform": ["AWS::Serverless-2016-10-31", "AWS::Include"]})
-    result = template.load_allowed_functions()
+    template.load_allowed_functions()
     expected = {
         **functions.ALL_FUNCTIONS,
         **functions.TRANSFORMS["AWS::Serverless-2016-10-31"],
         **functions.TRANSFORMS["AWS::Include"],
     }
-    assert result == expected
+    assert template.allowed_functions == expected
 
 
 def test_load_allowed_functions_invalid_transform():
-    template = Template({"Transform": "InvalidTransform"})
+
     with pytest.raises(ValueError):
-        template.load_allowed_functions()
+        Template({"Transform": "InvalidTransform"})
 
 
 def test_load_allowed_functions_invalid_transforms():
-    template = Template(
-        {"Transform": ["AWS::Serverless-2016-10-31", "InvalidTransform"]}
-    )
+
     with pytest.raises(ValueError):
-        template.load_allowed_functions()
+        Template({"Transform": ["AWS::Serverless-2016-10-31", "InvalidTransform"]})

{cloud_radar-0.13.3a16.dist-info → cloud_radar-0.14.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: cloud-radar
-Version: 0.13.3a16
+Version: 0.14.0
 Summary: Run functional tests on cloudformation stacks.
-Home-page: https://github.com/DontShaveTheYak/cloud-radar
 License: Apache-2.0
 Keywords: aws,cloudformation,cloud-radar,testing,taskcat,cloud,radar
 Author: Levi Blaney
-Author-email: shadycuz@gmail.com
-Requires-Python: >=3.9,<3.14
+Author-email: shadycuz+dev@gmail.com
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -15,17 +14,15 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Testing
-Requires-Dist: botocore (>=1.35.36) ; python_version >= "3.13"
+Requires-Dist: botocore (>=1.35.36,<2.0.0)
 Requires-Dist: cfn-flip (>=1.3.0,<2.0.0)
-Requires-Dist: taskcat (>=0.9.41,<0.10.0)
+Requires-Dist: taskcat (>=0.9.41,<1.0.0)
+Project-URL: Changelog, https://github.com/DontShaveTheYak/cloud-radar/releases
+Project-URL: Issues, https://github.com/DontShaveTheYak/cloud-radar/issues
 Project-URL: Repository, https://github.com/DontShaveTheYak/cloud-radar
 Description-Content-Type: text/markdown
 
@@ -37,7 +34,7 @@ Description-Content-Type: text/markdown
 *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
 *** https://www.markdownguide.org/basic-syntax/#reference-style-links
 -->
-[![Python][python-shield]][pypi-url]
+[![Python][py-versions-shield]][pypi-url]
 [![Latest][version-shield]][pypi-url]
 [![Tests][test-shield]][test-url]
 [![Coverage][codecov-shield]][codecov-url]
@@ -200,8 +197,8 @@ The default values for pseudo parameters:
 | **NoValue**      | ""              |
 | **Partition**    | "aws"           |
 | Region           | "us-east-1"     |
-| **StackId**      | ""              |
-| **StackName**    | ""              |
+| StackId          | (generated based on other values)              |
+| StackName    | "my-cloud-radar-stack"              |
 | **URLSuffix**    | "amazonaws.com" |
 _Note: Bold variables are not fully implemented yet see the [Roadmap](#roadmap)_
 
@@ -242,6 +239,24 @@ dynamic_references = {
 template = Template(template_content, dynamic_references=dynamic_references)
 ```
 
+There are cases where the default behaviour of our `GetAtt` implementation may not be sufficient and you need a more accurate returned value. When unit testing there are no real AWS resources created, and cloud-radar does not attempt to realistically generate attribute values - a string is always returned. This works good enough most of the time, but there are some cases where if you are attempting to apply intrinsic functions against the attribute value it needs to be more correct. When this occurs, you can add Metadata to the template to provide test values to use.
+
+```
+Resources:
+  MediaPackageV2Channel:
+    Type: AWS::MediaPackageV2::Channel
+    Metadata:
+      Cloud-Radar:
+        attribute-values:
+        # Default behaviour of a string is not good enough here, the attribute value is expected to be a List.
+          IngestEndpointUrls:
+            - http://one.example.com
+            - http://two.example.com
+    Properties:
+      ChannelGroupName: dev_video_1
+      ChannelName: !Sub ${AWS::StackName}-MediaPackageChannel
+```
+
 A real unit testing example using Pytest can be seen [here](./tests/test_cf/test_examples/test_unit.py)
 
 </details>
@@ -338,7 +353,6 @@ A real functional testing example using Pytest can be seen [here](./tests/test_c
 ### Unit
 - Add full functionality to pseudo variables.
   * Variables like `Partition`, `URLSuffix` should change if the region changes.
-  * Variables like `StackName` and `StackId` should have a better default than ""
 - Handle References to resources that shouldn't exist.
   * It's currently possible that a `!Ref` to a Resource stays in the final template even if that resource is later removed because of a conditional.
 
@@ -374,11 +388,12 @@ Levi - [@shady_cuz](https://twitter.com/shady_cuz)
 * [Taskcat](https://aws-quickstart.github.io/taskcat/)
 * [Hypermodern Python](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/)
 * [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
-* @dhutchison - He was the first contributor to this project and finished the last couple of features to make this project complete. Thank you!
+* [David Hutchison (@dhutchison)](https://github.com/dhutchison) - He was the first contributor to this project and finished the last couple of features to make this project complete. Thank you!
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 [python-shield]: https://img.shields.io/pypi/pyversions/cloud-radar?style=for-the-badge
+[py-versions-shield]: https://img.shields.io/pypi/pyversions/cloud-radar?style=for-the-badge
 [version-shield]: https://img.shields.io/pypi/v/cloud-radar?label=latest&style=for-the-badge
 [pypi-url]: https://pypi.org/project/cloud-radar/
 [test-shield]: https://img.shields.io/github/actions/workflow/status/DontShaveTheYak/cloud-radar/test.yml?label=Tests&style=for-the-badge

{cloud_radar-0.13.3a16.dist-info → cloud_radar-0.14.0.dist-info}/RECORD

@@ -9,10 +9,10 @@ cloud_radar/cf/unit/_output.py,sha256=rhQQ4aJu06bxAoG7GOXkuOPzAmLCrTA2Ytb8rNXA4V
 cloud_radar/cf/unit/_parameter.py,sha256=AdPIqc2ggSW1VR0USF30zjphX3z1HHbGKQt8n-Kzhfo,3199
 cloud_radar/cf/unit/_resource.py,sha256=dWaR-5s6ea5mIu6Dhf1hY31Wd4WLHbHsbyxnu2Tz6QI,8512
 cloud_radar/cf/unit/_stack.py,sha256=_S0L9O7Lw-QAJDKubClp2b6UYtYfyzg272_7WQkUdo8,5785
-cloud_radar/cf/unit/_template.py,sha256=u1r1RkUPI0t8SGolWEjb3doavFwUQRaE0wOKCi_ijiI,32242
-cloud_radar/cf/unit/functions.py,sha256=XtYiEG3PZT-JjQwRls-59XKHYdw-hWH9QaOZcb9zd_Y,28719
-cloud_radar/cf/unit/test__template.py,sha256=jVPMJTn6Q0sSZ8BjRGyutuR9-NjdHdwDTVsd2kvjQbs,1491
-cloud_radar-0.13.3a16.dist-info/LICENSE.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-cloud_radar-0.13.3a16.dist-info/METADATA,sha256=6m-Hnxa1j7JZlpHSC5nxWKyNUUWvq9pS1TQ1XmFCrfE,15745
-cloud_radar-0.13.3a16.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-cloud_radar-0.13.3a16.dist-info/RECORD,,
+cloud_radar/cf/unit/_template.py,sha256=RSZjqD0FgBYMgyZb_KUkIOaO_mTODLJH9czvhZ_ii3U,32196
+cloud_radar/cf/unit/functions.py,sha256=NSJh14wJK4dmTibmGqB0aK_kAP1RFW9RjdkZZsD11tc,26332
+cloud_radar/cf/unit/test__template.py,sha256=nHc9WziIeGDo0d-rsn3HV4X7BsoKmwwHUxcp3qzuZo8,1414
+cloud_radar-0.14.0.dist-info/LICENSE.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cloud_radar-0.14.0.dist-info/METADATA,sha256=o-hK1VPCzxFr2WIZfHAM34-jmS91vz41kz9byYR9jVo,16782
+cloud_radar-0.14.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+cloud_radar-0.14.0.dist-info/RECORD,,

{cloud_radar-0.13.3a16.dist-info → cloud_radar-0.14.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.2
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any