TaskCat Config Generator #820
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tbulding
requested review from
aws-ia-ci,
jaymccon,
andrew-glenn and
tonynv
as code owners
andrew-glenn
requested changes
Mar 27, 2024
taskcat/project_config/tc_config.py
Outdated
Comment on lines
77
to
100
| if self.create_overrides_file: | ||
| m = open(f'{self.project_root_path}/.taskcat_overrides.yml', | ||
| "w+", | ||
| encoding="utf-8") | ||
| p_overrides = [] | ||
| p_blanks = [] | ||
| p_default = [] | ||
| for p in parameters: | ||
| if parameters[p] == 'OVERRIDE': | ||
| p_overrides.append(f'{p}: OVERRIDE\r\n') | ||
| elif parameters[p] == '': | ||
| p_blanks.append(f'{p}: ""\r\n') | ||
| else: | ||
| p_default.append(f'{p}: {parameters[p]}\r\n') | ||
| p_overrides.sort() | ||
| p_blanks.sort() | ||
| p_default.sort() | ||
| m.write("# OVERRIDES\r\n") | ||
| m.write(''.join(p_overrides)) | ||
| m.write("# BLANKS\r\n") | ||
| m.write(''.join(p_blanks)) | ||
| m.write("# DEFAULTS\r\n") | ||
| m.write(''.join(p_default)) | ||
| m.close() |
There was a problem hiding this comment.
Why? If there's no config, there's nothing to overwrite; In my mind, the intended purposes of this feature is to generate a basic config given a template;
If a parameter has a default value, use that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This change adds the ability to generate the .taskcat.yml config file based on a CloudFormation template. The tool can generate the configuration file with verbose information (-v) about the parameters.(This information is taken from the CFN)
The tool also offers the option to generate a .taskcat_overrides.yml file (-c). The tool attempts to populate empty values based on the parameter name.
Testing/Steps taken to ensure quality
How did you validate the changes in this PR?
I ran the tool against a 15 different Quick Start projects.
Notes
Optional. Caveats, Alternatives, Other relevant information.
Testing Instructions
To test this PR you will need to install Taskcat From the Originating fork. Clone the Forked repo, and from the root of the repo run:
python setup.py install
Once taskcat is installed you can run it against an existing template with: