Add warning when using an empty regexp in lineinfile #42013
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
ansibot
added
affects_2.7
abadger
reviewed
Jun 27, 2018
| @@ -480,12 +480,17 @@ def main(): | |||
| regexp = params['regexp'] | |||
| line = params.get('line', None) | |||
|
|
|||
| if regexp == '': | |||
| module.warn( | |||
| 'The regular expression is empty, which will match every line in the file.' | |||
There was a problem hiding this comment.
I think we need to say "empty string". We also may want to give an alternative for people who actually do want to match every line in the file.
There was a problem hiding this comment.
What do you mean by "give an alternative"? This warning could be annoying to someone who does want this capability, and I don't want to encourage folks to disable warnings with noisy error messages.
There was a problem hiding this comment.
Give an example of a regex to use if they really want to match every line. (I think "^" would do it and be efficient). We could also give an example of unsetting it but that isn't as succinctly written.
There was a problem hiding this comment.
Ah, that's perfect! I see what you're saying.
abadger
reviewed
Jun 27, 2018
| @@ -717,37 +717,3 @@ | |||
| assert: | |||
| that: | |||
| - result.stat.checksum == 'eca8d8ea089d4ea57a3b87d4091599ca8b60dfd2' | |||
There was a problem hiding this comment.
Keeping tests (but updating if the results have changed) seems like a good idea. Then it's an additional clue that the behaviour was meant to be this way.
|
Also, I think we want a changelog for this? (And maybe a porting guide?) |
ansibot
removed
the
needs_triage
samdoran
force-pushed
the
issue/29443/empty-string-regexp-v2
branch
from
5cd76fe
to
66e41e5
Compare
Offer an equivalent regexp that won't trigger the warning. Update tests to match new warning.
achinthagunasekara
approved these changes
Jun 28, 2018
samdoran
added a commit
to samdoran/ansible
that referenced
this pull request
Jul 2, 2018
* Revert "Account for empty string regexp in lineinfile (ansible#41451)" This reverts commit 4b5b4a7. * Use context managers for interacting with files * Store line and regexp parameters in a variable * Add warning when regexp is an empty string * Remove '=' from error messages * Update warning message and add changelog * Add tests * Improve warning message Offer an equivalent regexp that won't trigger the warning. Update tests to match new warning. * Add porting guide entry for lineinfile change # Conflicts: # docs/docsite/rst/porting_guides/porting_guide_2.7.rst # lib/ansible/modules/files/lineinfile.py # test/integration/targets/lineinfile/tasks/main.yml
samdoran
added a commit
to samdoran/ansible
that referenced
this pull request
Jul 3, 2018
* Revert "Account for empty string regexp in lineinfile (ansible#41451)" This reverts commit 4b5b4a7. * Use context managers for interacting with files * Store line and regexp parameters in a variable * Add warning when regexp is an empty string * Remove '=' from error messages * Update warning message and add changelog * Add tests * Improve warning message Offer an equivalent regexp that won't trigger the warning. Update tests to match new warning. * Add porting guide entry for lineinfile change (cherry picked from commit fb55038)
nitzmahone
pushed a commit
that referenced
this pull request
Jul 5, 2018
* Revert "Account for empty string regexp in lineinfile (#41451)" This reverts commit 4b5b4a7. * Use context managers for interacting with files * Store line and regexp parameters in a variable * Add warning when regexp is an empty string * Remove '=' from error messages * Update warning message and add changelog * Add tests * Improve warning message Offer an equivalent regexp that won't trigger the warning. Update tests to match new warning. * Add porting guide entry for lineinfile change (cherry picked from commit fb55038)
mattclay
pushed a commit
that referenced
this pull request
Jul 9, 2018
* Add warning when using an empty regexp in lineinfile (#42013) * Revert "Account for empty string regexp in lineinfile (#41451)" This reverts commit 4b5b4a7. * Use context managers for interacting with files * Store line and regexp parameters in a variable * Add warning when regexp is an empty string * Remove '=' from error messages * Update warning message and add changelog * Add tests * Improve warning message Offer an equivalent regexp that won't trigger the warning. Update tests to match new warning. * Add porting guide entry for lineinfile change # Conflicts: # docs/docsite/rst/porting_guides/porting_guide_2.7.rst # lib/ansible/modules/files/lineinfile.py # test/integration/targets/lineinfile/tasks/main.yml * Add porting guide info
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
Reverts #41451 and adds a warning instead.
See #29443 for reasoning behind this change.
ISSUE TYPE
COMPONENT NAME
lineinfile.pyANSIBLE VERSION