feat: implements the `container_value` rule #142

claymcleod · 2024-07-25T20:43:48Z

This pull request adds a new rule to wdl-lint.

Rule Name: ContainerValue

This rule is intended to implement the mutable_container and immutable_container_not_tagged baseline lint rules (link). In so doing, it was an exploration in implementing various wrappers within the AST that were built from existing AST nodes (rather than cast from SyntaxNodes). I also added in a few checks related to cointainers that seemed logical to me, namely:

container arrays with zero elements are ambiguous and should be replaced with something concrete.
container arrays with one element should be replaced with a single, literal string.
container arrays with the special 'any' container designator (*) are ambiguous, as you're both indicating that a set of specific containers should be used and that any container can be used. As such, it should be avoided.

Additionally, I fixed a small bug ("oversight"?) I discovered in the MissingRuntime lint while developing this: MissingRuntime should only be flagging things for WDL v1.1 or earlier, as the runtime section was deprecated in favor of requirements in WDL v1.2.

Before submitting this PR, please make sure:

You have added a few sentences describing the PR here.
You have added yourself or the appropriate individual as the assignee.
You have added at least one relevant code reviewer to the PR.
Your code builds clean without any errors or warnings.
You have added an entry to the relevant CHANGELOG.md (see
"keep a changelog" for more information).
Your commit messages follow the conventional commit style.

Rule specific checks:

You have added the rule as an entry within RULES.md.
You have added the rule to the rules() function in wdl-lint/src/lib.rs.
You have added a test case in wdl-lint/tests/lints that covers every
possible diagnostic emitted for the rule within the file where the rule
is implemented.
If you have implemented a new Visitor callback, you have also
overridden that callback method for the special Validator
(wdl-ast/src/validation.rs) and LintVisitor
(wdl-lint/src/visitor.rs) visitors. These are required to ensure the new
visitor callback will execute.
You have run wdl-gauntlet --refresh to ensure that there are no
unintended changes to the baseline configuration file (Gauntlet.toml).
You have run wdl-gauntlet --refresh --arena to ensure that all of the
rules added/removed are now reflected in the baseline configuration file
(Arena.toml).

wdl-lint/tests/lints.rs

wdl-lint/src/rules/comment_whitespace.rs

wdl-lint/src/rules/deprecated_object.rs

wdl-lint/src/rules/missing_runtime.rs

wdl-lint/RULES.md

wdl-ast/examples/explore_requirements.rs

wdl-ast/src/v1/expr.rs

wdl-ast/src/v1/task/common/container/value.rs

Arena.toml

wdl-lint/src/rules/container_value.rs

wdl-lint/src/rules/missing_runtime.rs

wdl-ast/examples/explore_requirements.rs

wdl-ast/examples/explore_runtime.rs

wdl-ast/src/v1/task/common/container/value.rs

wdl-lint/src/rules/container_value.rs

claymcleod

This should be ready for review again.

adthrasher

Looks good, pending @a-frantz's comments.

claymcleod force-pushed the feat/container-tags branch 5 times, most recently from ed91471 to 46840ec Compare July 26, 2024 04:38

claymcleod requested review from adthrasher, peterhuene and a-frantz July 26, 2024 13:52

claymcleod self-assigned this Jul 26, 2024