manifest.yml version validation is fragile

aws-solutions / aws-control-tower-customizations

The Customizations for AWS Control Tower solution combines AWS Control Tower and other highly-available, trusted AWS services to help customers more quickly set up a secure, multi-account AWS environment using AWS best practices.

https://docs.aws.amazon.com/controltower/latest/userguide/cfct-overview.html

Apache License 2.0

360 stars 205 forks source link

manifest.yml version validation is fragile #59

Closed dkewley-uci closed 3 years ago

dkewley-uci commented 3 years ago

The code in v2.0.0 validation/run-validation.sh that validates the manifest.yml schema version is fragile, and prone to reporting ERROR: Invalid manifest schema version. in conditions that it should be able to accept.

This validation only succeeds if the following conditions hold:

this line is the only line in the file containing the string 'version'
this line has exactly two words, in one of the following forms (e.g. without a valid YAML comment postpended):
- version: 2020-01-01
- version: 2021-03-15

tomjmarch commented 3 years ago

+1. I hit this error when trying to deploy the "s3-versioning-enabled" config rule. Because it contains the string "version" it would fail validation.

groverlalit commented 3 years ago

Thanks for raising this concern. This is already on our backlog and we plan to ship the fix in the next release.

groverlalit commented 3 years ago

This change was released in v2.1.0.