fix: Add support for Fn::ForEach replicated resources #845

LaikaN57 · 2025-01-16T08:05:57Z

Overview

Fixes: #846

 _            _             _   
| |_ __ _ ___| | _____ __ _| |_ 
| __/ _` / __| |/ / __/ _` | __|
| || (_| \__ \   < (_| (_| | |_ 
 \__\__,_|___/_|\_\___\__,_|\__|
                                


version 0.9.55
Not in terminal, reprint now using normal build-in print function.

[WARN   ] : No stacks were created... skipping cleanup.
[ERROR  ] : TypeError list indices must be integers or slices, not str
Traceback (most recent call last):
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_cli.py", line 46, in main
    cli.run()
    ~~~~~~~^^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_cli_core.py", line 316, in run
    return getattr(command(), subcommand)(**args)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_cli_modules/test.py", line 166, in run
    with test:
         ^^^^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/testing/base_test.py", line 58, in __enter__
    raise ex
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/testing/base_test.py", line 55, in __enter__
    self.run()
    ~~~~~~~~^^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/testing/_cfn_test.py", line 83, in run
    templates = self.config.get_templates()
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_config.py", line 416, in get_templates
    templates[test_name] = Template(
                           ~~~~~~~~^
        template_path=self.project_root / test.template,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<2 lines>...
        template_cache=tcat_template_cache,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_cfn/template.py", line 69, in __init__
    self._find_children()
    ~~~~~~~~~~~~~~~~~~~^^
  File "/Users/akennedy/src/[REDACTED]/.venv/lib/python3.13/site-packages/taskcat/_cfn/template.py", line 158, in _find_children
    if resource["Type"] == "AWS::CloudFormation::Stack":
       ~~~~~~~~^^^^^^^^
TypeError: list indices must be integers or slices, not str

Adds support for Fn::ForEach replicated resources.

This fixes a crash bug when you are using a Fn::ForEach in the Resources section of a template.

It also adds the ability for taskcat to inspect inside of a Fn::ForEach in the Resources section of a template to see if there are any replicates resources that are of Type: AWS::Cloudformation::Stack so we can add those as children as well.

Fn::ForEach replicated resources example

Testing/Steps taken to ensure quality

I tested the alternative version with a large RDS stack containing multiple RDS instances deployed via a Fn::ForEach block and it also deploys other resource that are of Type: AWS::Cloudformation::Stack (outside of the Fn::ForEach block).

I have yet to test the proposed fix.

Notes

Alternatively, we could just ignore Fn::ForEach blocks entirely like this.

        for resource in self.template["Resources"].keys():
            if "Fn::ForEach::" in resource:
                continue
            resource = self.template["Resources"][resource]

Testing Instructions

Create a template with a nested stack inside of a Fn::ForEach block in the Resources section
Ensure the nested stack is tracked in the report (?)

taskcat/_cfn/template.py

LaikaN57 · 2025-01-16T17:09:55Z

taskcat/_cfn/template.py

+                    if replicated_resource["Type"] == "AWS::CloudFormation::Stack":
+                        child_name = self._template_url_to_path(
+                            template_url=replicated_resource["Properties"][
+                                "TemplateURL"
+                            ],
+                        )
+                        # print(child_name)
+                        if child_name:
+                            # for child_url in child_name:
+                            children.add(child_name)


Stolen from below.

taskcat/_cfn/template.py

LaikaN57 · 2025-01-16T22:11:26Z

@andrew-glenn I would be more than happy to add unit tests as well. I am just a bit confused about the appropriate file to modify to add my tests (or alternatively, what dir and file naming I should use). Any advice is appreciated!

andrew-glenn · 2025-01-16T22:14:09Z

@LaikaN57 that would be most appreciated. I'm setting a reminder to follow up on this tomorrow. I wanted to quickly acknowledge your offer even though I don't have the bandwidth to respond further today

LaikaN57 · 2025-01-16T22:16:32Z

(for tracking, AWS Case #173701840400885)

andrew-glenn · 2025-01-16T22:33:12Z

I found some surprise bandwidth!

I think putting your unit tests in https://github.com/aws-ia/taskcat/blob/main/tests/test_cfn_template.py is adequate. From my perspective it'd just be a second testclass and then the happy-path and sad-path templates would go under tests/data/template-foreach or something similar.

aws-ia-automator-prod · 2025-01-17T01:50:03Z

Static analysis has failed. Please review and take action as appropriate.

LaikaN57 · 2025-01-17T01:52:47Z

I added a test case by just copying and modifying the existing test case as it seemed to generally test for what we want to look for in the Fn::ForEach tests as well.

diff -bur tests/data/nested-fail/.taskcat.yml tests/data/fn-foreach-resource-fail/.taskcat.yml
--- tests/data/nested-fail/.taskcat.yml 2025-01-16 00:25:03
+++ tests/data/fn-foreach-resource-fail/.taskcat.yml    2025-01-16 17:43:32
@@ -1,7 +1,7 @@
 ---
 project:
   owner: owner@company.com
-  name: nested-fail
+  name: fn-foreach-resource-fail
   regions:
     - us-east-1
     - us-west-2
diff -bur tests/data/nested-fail/templates/test.template.yaml tests/data/fn-foreach-resource-fail/templates/test.template.yaml
--- tests/data/nested-fail/templates/test.template.yaml 2025-01-16 00:25:03
+++ tests/data/fn-foreach-resource-fail/templates/test.template.yaml    2025-01-16 17:54:24
@@ -1,4 +1,5 @@
 AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::LanguageExtensions
 Metadata:
   taskcat:
     project:
@@ -12,13 +13,19 @@
     Default: aws-quickstart
     Type: String
   QSS3KeyPrefix:
-    Default: nested-fail/
+    Default: fn-foreach-resource-fail/
     Type: String
 Resources:
-  ChildStack:
+  Fn::ForEach::ChildStackX:
+    - Identifier
+    - - "1"
+    - ChildStack${Identifier}:
         Type: AWS::CloudFormation::Stack
         Properties:
           TemplateURL: !Sub 'https://${QSS3BucketName}.s3.amazonaws.com/${QSS3KeyPrefix}templates/test.template_middle.yaml'
           Parameters:
             QSS3KeyPrefix: !Ref QSS3KeyPrefix
             QSS3BucketName: !Ref QSS3BucketName
+          Tags:
+            - Key: child-stack-foreach-id
+              Value: !Sub "id-${Identifier}"
diff -bur tests/data/nested-fail/templates/test.template_middle.yaml tests/data/fn-foreach-resource-fail/templates/test.template_middle.yaml
--- tests/data/nested-fail/templates/test.template_middle.yaml  2025-01-16 00:25:03
+++ tests/data/fn-foreach-resource-fail/templates/test.template_middle.yaml     2025-01-16 17:54:20
@@ -1,16 +1,23 @@
 AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::LanguageExtensions
 Parameters:
   QSS3BucketName:
     Default: aws-quickstart
     Type: String
   QSS3KeyPrefix:
-    Default: nested-fail/
+    Default: fn-foreach-resource-fail/
     Type: String
 Resources:
-  ChildStack:
+  Fn::ForEach::ChildStackX:
+    - Identifier
+    - - "1"
+    - ChildStack${Identifier}:
         Type: AWS::CloudFormation::Stack
         Properties:
           TemplateURL: !Sub 'https://${QSS3BucketName}.s3.amazonaws.com/${QSS3KeyPrefix}templates/test.template_inner.yaml'
+          Tags:
+            - Key: child-stack-foreach-id
+              Value: !Sub "id-${Identifier}"
   Middle2Stack:
     Type: AWS::CloudFormation::Stack
     Properties:
diff -bur tests/data/nested-fail/templates/test.template_middle2.yaml tests/data/fn-foreach-resource-fail/templates/test.template_middle2.yaml
--- tests/data/nested-fail/templates/test.template_middle2.yaml 2025-01-16 00:25:03
+++ tests/data/fn-foreach-resource-fail/templates/test.template_middle2.yaml    2025-01-16 17:43:32
@@ -4,7 +4,7 @@
     Default: aws-quickstart
     Type: String
   QSS3KeyPrefix:
-    Default: nested-fail/
+    Default: fn-foreach-resource-fail/
     Type: String
 Resources:
   ChildStack:
diff -bur tests/data/nested-fail/templates/test.template_middle3.yaml tests/data/fn-foreach-resource-fail/templates/test.template_middle3.yaml
--- tests/data/nested-fail/templates/test.template_middle3.yaml 2025-01-16 00:25:03
+++ tests/data/fn-foreach-resource-fail/templates/test.template_middle3.yaml    2025-01-16 17:43:32
@@ -4,7 +4,7 @@
     Default: aws-quickstart
     Type: String
   QSS3KeyPrefix:
-    Default: nested-fail/
+    Default: fn-foreach-resource-fail/
     Type: String
 Resources:
   ChildStack:

andrew-glenn · 2025-01-17T02:10:26Z

/do-e2e-tests

aws-ia-automator-prod · 2025-01-17T02:10:38Z

End to end test has been scheduled

aws-ia-automator-prod · 2025-01-17T02:12:26Z

E2E tests in progress

aws-ia-automator-prod

E2E tests completed successfully

andrew-glenn · 2025-01-17T02:17:53Z

@LaikaN57 I assumed you were done since linting was happy and you added a test case.

Please confirm and I'll give this a review over coffee in the morning. Generally I'm encouraged because linting and integ is happy.

LaikaN57 · 2025-01-17T02:33:03Z

tests/test_cfn_template.py

@@ -14,3 +14,17 @@ def test_init(self):
        template = templates["taskcat-json"]
        self.assertEqual(1, len(template.children))
        self.assertEqual(4, len(template.descendents))
+
+
+class TestCfnTemplateForEachResource(unittest.TestCase):


This is essentially a copy-paste of the above but we just change out the dataset we are running against.

Sorry if this is rudimentary. I am not a great test writer and defaulted back to just pattern matching. However, I do believe we have pretty complete coverage sans the implicit else on the if child_name statement.

LaikaN57 · 2025-01-17T02:34:25Z

@andrew-glenn yup, im happy if ur happy!

andrew-glenn · 2025-01-17T11:05:32Z

I'm merging this in. A new release should be cut later today.

fix: Add support for Fn::ForEach replicated resources

db8a8f6

LaikaN57 requested review from jaymccon, andrew-glenn, tonynv and tlindsay42 as code owners January 16, 2025 08:05

LaikaN57 added 4 commits January 16, 2025 00:26

fix: black

b2afca2

fix: flake8

ae3863e

fix: update-region-mappings

016c7af

fix: pylint-local

04a1a7e

LaikaN57 commented Jan 16, 2025

View reviewed changes

taskcat/_cfn/template.py Outdated Show resolved Hide resolved

LaikaN57 commented Jan 16, 2025

View reviewed changes

taskcat/_cfn/template.py Outdated Show resolved Hide resolved

fix: move hard coded value to const

80a1342

LaikaN57 added 2 commits January 16, 2025 15:25

fix: If Fn::Foreach, skip AWS::CFN::Stack block

9620c9d

chore: Add test case

50143cd

fix: Add lang ext transform

90b5bf3

aws-ia-automator-prod bot approved these changes Jan 17, 2025

View reviewed changes

LaikaN57 commented Jan 17, 2025

View reviewed changes

andrew-glenn approved these changes Jan 17, 2025

View reviewed changes

andrew-glenn merged commit fc5fcff into aws-ia:main Jan 17, 2025
4 checks passed

LaikaN57 deleted the fix-res-fnforeach branch January 17, 2025 18:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Add support for Fn::ForEach replicated resources #845

fix: Add support for Fn::ForEach replicated resources #845

LaikaN57 commented Jan 16, 2025 •

edited

Loading

LaikaN57 Jan 16, 2025

LaikaN57 commented Jan 16, 2025

andrew-glenn commented Jan 16, 2025

LaikaN57 commented Jan 16, 2025

andrew-glenn commented Jan 16, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

LaikaN57 commented Jan 17, 2025 •

edited

Loading

andrew-glenn commented Jan 17, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

aws-ia-automator-prod bot left a comment

andrew-glenn commented Jan 17, 2025

LaikaN57 Jan 17, 2025 •

edited

Loading

LaikaN57 commented Jan 17, 2025

andrew-glenn commented Jan 17, 2025

fix: Add support for Fn::ForEach replicated resources #845

fix: Add support for Fn::ForEach replicated resources #845

Conversation

LaikaN57 commented Jan 16, 2025 • edited Loading

Overview

Testing/Steps taken to ensure quality

Notes

Testing Instructions

LaikaN57 Jan 16, 2025

Choose a reason for hiding this comment

LaikaN57 commented Jan 16, 2025

andrew-glenn commented Jan 16, 2025

LaikaN57 commented Jan 16, 2025

andrew-glenn commented Jan 16, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

LaikaN57 commented Jan 17, 2025 • edited Loading

andrew-glenn commented Jan 17, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

aws-ia-automator-prod bot commented Jan 17, 2025

aws-ia-automator-prod bot left a comment

Choose a reason for hiding this comment

andrew-glenn commented Jan 17, 2025

LaikaN57 Jan 17, 2025 • edited Loading

Choose a reason for hiding this comment

LaikaN57 commented Jan 17, 2025

andrew-glenn commented Jan 17, 2025

LaikaN57 commented Jan 16, 2025 •

edited

Loading

LaikaN57 commented Jan 17, 2025 •

edited

Loading

LaikaN57 Jan 17, 2025 •

edited

Loading