You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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 validTestToken
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.
The text was updated successfully, but these errors were encountered: