cloud-radar 0.13.3a16__tar.gz → 0.14.0a1__tar.gz

{cloud_radar-0.13.3a16 → cloud_radar-0.14.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloud-radar
-Version: 0.13.3a16
+Version: 0.14.0a1
 Summary: Run functional tests on cloudformation stacks.
 Home-page: https://github.com/DontShaveTheYak/cloud-radar
 License: Apache-2.0
@@ -200,8 +200,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 +242,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 +356,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.
 

{cloud_radar-0.13.3a16 → cloud_radar-0.14.0a1}/README.md

@@ -169,8 +169,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)_
 
@@ -211,6 +211,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>
@@ -307,7 +325,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.
 

{cloud_radar-0.13.3a16 → cloud_radar-0.14.0a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cloud-radar"
-version = "0.13.3a16"
+version = "0.14.0a1"
 description = "Run functional tests on cloudformation stacks."
 readme = "README.md"
 authors = ["Levi Blaney <shadycuz@gmail.com>"]

{cloud_radar-0.13.3a16 → cloud_radar-0.14.0a1}/src/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__(
@@ -310,6 +311,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 +332,7 @@ class Template:
     ):
         if region:
             self.Region = region
+        self.StackId = self._get_populated_stack_id()
 
         self.render(params, parameters_file=parameters_file)
 

{cloud_radar-0.13.3a16 → cloud_radar-0.14.0a1}/src/cloud_radar/cf/unit/functions.py

@@ -455,7 +455,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]: