Ignore var-naming[pattern] to foreign role vars #4230
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The changes to the utils.py's _rolepath were to enable the function to handle fully qualified collection names (FQCNs). Otherwise, the function would be unable to parse the role name from the FQCN returning basedir as the role_path. This can result in additional files with violations being returned by the _look_for_role_files function.
84c9539 to
ddfa6ca
Compare
audgirka
approved these changes
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4095.
When working on this issue, I ran into another bug when writing a test case to test my solution to the issue. The bug I ran into was when running a test case that would lint a playbook from
./examples/playbooksthat contained ainclude_role/import_roletask with a FQCN role as its argument. I noticed that the test case would pick up violations from other lintables that I didn't specify as an argument to myrunnerinstance. I suspect this is because_rolepathcurrently doesn't handle FQCNs, which results in thebasedirbeing returned and can cause_look_for_role_filesto return additional unexpected files. This can be seen when runningpytest test/test_utils.py::test_find_children_in_playbookfrom another fork branch I made to showcase this https://github.com/cavcrosby/ansible-lint/tree/ignore-foreign-role-vars-revert-utils. The changes to fix said bug are consolidated intoutils.py.To add, said bug probably won't affect an end user unless they purposefully contain violations in their Ansible yaml like in the case of
ansible-lint. That said, I would think we would want to address this for development purposes.