cloud-radar 0.14.1a1__py3-none-any.whl → 0.15.0__py3-none-any.whl

cloud_radar/cf/unit/_output.py

@@ -27,11 +27,12 @@ class Output(UserDict):
         Args:
             value (Any): The value to compare the output value to.
         """
-        acutal_value = self.get_value()
+        actual_value = self.get_value()
 
-        assert (
-            value == acutal_value
-        ), f"Output '{self.name}' actual value did not match input value."
+        assert value == actual_value, (
+            f"Output '{self.name}' actual value ({actual_value}) did not match"
+            f" input value ({value})."
+        )
 
     def has_export(self):
         """Check if the output has an export."""

cloud_radar/cf/unit/_template.py

@@ -232,7 +232,6 @@ class Template:
             return {**functions.ALL_FUNCTIONS, **transform_functions}
 
         if isinstance(self.transforms, list):
-
             transform_functions = {}
 
             for transform in self.transforms:
@@ -505,8 +504,14 @@ class Template:
 
         t_params: dict = self.template["Parameters"]
 
-        if set(parameters) - set(t_params):
-            raise ValueError("You passed a Parameter that was not in the Template.")
+        params_not_in_template = set(parameters) - set(t_params)
+        if params_not_in_template:
+            raise ValueError(
+                (
+                    "You supplied one or more Parameters that were not in the "
+                    f"Template - {params_not_in_template}"
+                )
+            )
 
         for p_name, p_value in t_params.items():
             if p_name in parameters:
@@ -519,7 +524,10 @@ class Template:
 
             if "Default" not in p_value:
                 raise ValueError(
-                    "Must provide values for parameters that don't have a default value."
+                    (
+                        f'Must provide values for parameter "{p_name}" '
+                        "that does not have a default value."
+                    )
                 )
 
             t_params[p_name]["Value"] = p_value["Default"]

cloud_radar/cf/unit/functions.py

@@ -459,14 +459,17 @@ def get_att(template: "Template", values: Any) -> str:
     # 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", {})
+    cloud_radar_metadata = _get_cloud_radar_metadata(resource)
     attribute_values = cloud_radar_metadata.get("attribute-values", {})
 
     return attribute_values.get(att_name, f"{resource_name}.{att_name}")
 
 
+def _get_cloud_radar_metadata(resource) -> dict:
+    metadata = resource.get("Metadata", {})
+    return metadata.get("Cloud-Radar", {})
+
+
 def get_azs(_t: "Template", region: Any) -> List[str]:
     """Solves AWS GetAZs intrinsic function.
 
@@ -857,7 +860,13 @@ def ref(template: "Template", var_name: str) -> Any:
             return param_value
 
     if var_name in template.template["Resources"]:
-        return var_name
+        # Check if there is a value in the resource Metadata for this reference.
+        # If the ref requested is in the metadata, return it.
+        # Otherwise use the string value of the logical resource name
+        cloud_radar_metadata = _get_cloud_radar_metadata(
+            template.template["Resources"][var_name]
+        )
+        return cloud_radar_metadata.get("ref", var_name)
 
     raise Exception(f"Fn::Ref - {var_name} is not a valid Resource or Parameter.")
 

{cloud_radar-0.14.1a1.dist-info → cloud_radar-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cloud-radar
-Version: 0.14.1a1
+Version: 0.15.0
 Summary: Run functional tests on cloudformation stacks.
 License: Apache-2.0
 Keywords: aws,cloudformation,cloud-radar,testing,taskcat,cloud,radar
@@ -239,7 +239,7 @@ 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.
+There are cases where the default behaviour of our `Ref` and `GetAtt` implementations 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. For `Ref` this is the logical resource name, for `GetAtt` this is `<logical resource name>.<attribute name>`. This works good enough most of the time, but there are some cases where if you are attempting to apply intrinsic functions against these value it needs to be more correct. When this occurs, you can add Metadata to the template to provide test values to use.
 
 ```
 Resources:
@@ -247,6 +247,7 @@ Resources:
     Type: AWS::MediaPackageV2::Channel
     Metadata:
       Cloud-Radar:
+        ref: arn:aws:mediapackagev2:region:AccountId:ChannelGroup/ChannelGroupName/Channel/ChannelName
         attribute-values:
         # Default behaviour of a string is not good enough here, the attribute value is expected to be a List.
           IngestEndpointUrls:
@@ -256,6 +257,7 @@ Resources:
       ChannelGroupName: dev_video_1
       ChannelName: !Sub ${AWS::StackName}-MediaPackageChannel
 ```
+If you are unable to modify the template itself, it is also possible to inject this metadata as part of the unit test. See [this test case](./tests/test_cf/test_unit/test_functions_ref.py) for an example.
 
 A real unit testing example using Pytest can be seen [here](./tests/test_cf/test_examples/test_unit.py)
 

{cloud_radar-0.14.1a1.dist-info → cloud_radar-0.15.0.dist-info}/RECORD

@@ -5,14 +5,14 @@ cloud_radar/cf/e2e/_stack.py,sha256=Qm5vQsUSUluHirTFTs_n40yI6Z8-HMZ837OvSJcyWqM,
 cloud_radar/cf/unit/__init__.py,sha256=H9iQw4PSZEW-u0Ey-Z8eZfzQ6GJ7wdxmkKE8Z09U7pU,198
 cloud_radar/cf/unit/_condition.py,sha256=e7gwcz87yF6dKl2quxmOmjzHku8OW6EWAsgbCeDMARg,711
 cloud_radar/cf/unit/_hooks.py,sha256=BzFQ2pV6Wfk9KEETTM4DU6Ue0BO1D0HdMFjRM1xo1VM,6866
-cloud_radar/cf/unit/_output.py,sha256=rhQQ4aJu06bxAoG7GOXkuOPzAmLCrTA2Ytb8rNXA4Vg,1822
+cloud_radar/cf/unit/_output.py,sha256=U036lzszMN5awuKoybqOD6GCa7z8Ad4g-mbWLx8TFR0,1865
 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=RSZjqD0FgBYMgyZb_KUkIOaO_mTODLJH9czvhZ_ii3U,32196
-cloud_radar/cf/unit/functions.py,sha256=NSJh14wJK4dmTibmGqB0aK_kAP1RFW9RjdkZZsD11tc,26332
+cloud_radar/cf/unit/_template.py,sha256=o7AnEyeuc0DUThR28W4GHO71uf1IWHKRj9FEYxMWeRU,32474
+cloud_radar/cf/unit/functions.py,sha256=l6orvpQjEHzRm_OPtxeza3U5icbujIzPUmtCrduxKAU,26796
 cloud_radar/cf/unit/test__template.py,sha256=nHc9WziIeGDo0d-rsn3HV4X7BsoKmwwHUxcp3qzuZo8,1414
-cloud_radar-0.14.1a1.dist-info/LICENSE.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-cloud_radar-0.14.1a1.dist-info/METADATA,sha256=YcVNrIsVRsSk27Th3Gb8C1z_Gl_H3JoIgtu2x2Ej8gc,16784
-cloud_radar-0.14.1a1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-cloud_radar-0.14.1a1.dist-info/RECORD,,
+cloud_radar-0.15.0.dist-info/LICENSE.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cloud_radar-0.15.0.dist-info/METADATA,sha256=dXDJ-abrwV24q0y8hnudwIGUCKfXgrXni9NE9tMEidY,17203
+cloud_radar-0.15.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+cloud_radar-0.15.0.dist-info/RECORD,,