Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validation does not cover all tokens #152

Open
mshriver opened this issue Dec 1, 2020 · 0 comments
Open

Validation does not cover all tokens #152

mshriver opened this issue Dec 1, 2020 · 0 comments

Comments

@mshriver
Copy link
Member

mshriver commented Dec 1, 2020

It appears, through use in robottelo, that testimony does not validate all tokens defined in docblocks, validating the compiled/squashed tokens only.

If your configuration includes choice options for a token like :TestToken:, and you define a module level docblock token value that is invalid, that token value is not validated if all classes/functions within the module specify a valid TestToken value.

I think that the validation should cover all docblock tokens, before they're compiled/squashed at the function level. Using testimony to assist with code review through CI validation of the docblocks will miss potential typos at these higher scopes.

I can provide a PR updating the unit tests to demonstrate this behavior if you would like, but I thought it best to start an issue to discuss this behavior before making any code changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant