[Enhancement] Show full path to file

[nathanpeck]

Is your feature request related to a problem? Please describe.

When I run cfn-guard against a directory path full of many files it is hard to tell which file is the source of an error.

For example:

cfn-guard validate --data ./pattern/**/files/*.yml --rules ./lint/guard

I am running the linter against all files with the .yml extension across a range of paths. There are multiple files with the same name in each subpath.

The output of the linter just shows:

cluster.yml Status = FAIL
FAILED rules
task-execution-role.guard/iam_policies_with_ecs_trust_policy_have_condition    FAIL

I know the error is in a file named cluster.yml, but which cluster.yml in which path?

Describe the solution you'd like

Compare to the output from cfn-lint:

E3001 Invalid or unsupported Type AWS::IAM::Rol for resource ECSTaskExecutionRole in us-east-1
./pattern/ecs-example-iam-roles/files/ecs-task-execution-role.yml:3:5

Because cfn-lint shows the full path to the file it is very easy for me to locate the file that needs a fix.

[Nr18]

When I started using cfn-guard a few years ago you could only feed it one file. Back then I created https://github.com/nr18/cfn-guard-test it tests a set of test files against a set of rules. Just like the cfn-guard tool does today. But back then I implemented the display of what rule got triggered for the error.

This way you could tell what caused the execution to fail.

Tltr; I think this is a good addition

[joshfried-aws]

Hi @nathanpeck, thanks for the suggestion! This seems like a really convenient enhancement, we will track this and update the issue as we make progress.

@Nr18 thanks for sharing your tool, we love to see how users are building upon guard helping it to meet their specific needs.

[dannyvassallo]

Hello @nathanpeck & @Nr18,

This has been updated. Thank you for the suggestion!

Closing the issue.