StackGuardian / StackGuardian/tirith
Reject unknown parameter if provided by the user (usually caused by typos)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
Users usually have a typo in their policy's provider_args for example. Like terraform_plan's referenced_by usually typo'ed by the user to references_by. The current behavior when such typos is happening is tirith will continue to run as usual. We need to add a mechanism to reject the unknown parameters so that the user knows that the parameter is not needed and thus can be removed (which also makes tirith policies that are written by the user cleaner and more readable)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the policy provider_args handling for terraform_plan, using the referenced_by and references_by example to trace how parameters are accepted. The work is done when unknown parameters are rejected and the user is told which parameter is invalid, with coverage for the typo case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, terraform
- Domain
- backend, devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100