files.Block: fixed couple of bugs, added try_prevent_shell_expansion and support for content: list[str]
#1030
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ | |
| FileUploadCommand, | ||
| OperationError, | ||
| OperationTypeError, | ||
| OperationValueError, | ||
| QuoteString, | ||
| RsyncCommand, | ||
| StringCommand, | ||
|
|
@@ -1614,6 +1615,7 @@ def block( | |
| line=None, | ||
| backup=False, | ||
| escape_regex_characters=False, | ||
| try_prevent_shell_expansion=False, | ||
| before=False, | ||
| after=False, | ||
| marker=None, | ||
|
|
@@ -1631,6 +1633,7 @@ def block( | |
| + line: regex before or after which the content should be added if it doesn't exist. | ||
| + backup: whether to backup the file (see ``files.line``). Default False. | ||
| + escape_regex_characters: whether to escape regex characters from the matching line | ||
| + try_prevent_shell_expansion: tries to prevent shell expanding by values like `$` | ||
| + marker: the base string used to mark the text. Default is ``# {mark} PYINFRA BLOCK`` | ||
| + begin: the value for ``{mark}`` in the marker before the content. Default is ``BEGIN`` | ||
| + end: the value for ``{mark}`` in the marker after the content. Default is ``END`` | ||
|
|
@@ -1647,12 +1650,15 @@ def block( | |
|
|
||
| Removal ignores ``content`` and ``line`` | ||
|
|
||
| Preventing shell expansion works by wrapping the content in '`' before passing to `awk`. | ||
| WARNING: This will break if the content contains raw single quotes. | ||
|
|
||
| **Examples:** | ||
|
|
||
| .. code:: python | ||
|
|
||
| # add entry to /etc/host | ||
| files.block( | ||
| name="add IP address for red server", | ||
| path="/etc/hosts", | ||
| content="10.0.0.1 mars-one", | ||
|
|
@@ -1661,7 +1667,7 @@ def block( | |
| ) | ||
|
|
||
| # have two entries in /etc/host | ||
| files.block( | ||
|
There was a problem hiding this comment. |
||
| name="add IP address for red server", | ||
| path="/etc/hosts", | ||
| content="10.0.0.1 mars-one\\n10.0.0.2 mars-two", | ||
|
|
@@ -1670,21 +1676,29 @@ def block( | |
| ) | ||
|
|
||
| # remove marked entry from /etc/hosts | ||
| files.block( | ||
| name="remove all 10.* addresses from /etc/hosts", | ||
| path="/etc/hosts", | ||
| present=False | ||
| ) | ||
|
|
||
| # add out of date warning to web page | ||
| files.block( | ||
| name="add out of date warning to web page", | ||
| path="/var/www/html/something.html", | ||
| content= "<p>Warning: this page is out of date.</p>", | ||
| regex=".*<body>.*", | ||
| after=True | ||
| marker="<!-- {mark} PYINFRA BLOCK -->", | ||
| ) | ||
|
|
||
| # put complex alias into .zshrc | ||
| files.block( | ||
| path="/home/user/.zshrc", | ||
| content="eval $(thefuck -a)", | ||
| try_prevent_shell_expansion=True, | ||
| marker="## {mark} ALIASES ##" | ||
| ) | ||
| """ | ||
|
|
||
| logger.warning("The `files.block` operation is currently in beta!") | ||
|
|
@@ -1723,22 +1737,36 @@ def block( | |
| cmd = None | ||
| if present: | ||
| if not content: | ||
| raise OperationValueError("'content' must be supplied when 'present' == True") | ||
| if line: | ||
| if before == after: | ||
| raise OperationValueError( | ||
| "only one of 'before' or 'after' used when 'line` is specified" | ||
| ) | ||
| elif before != after: | ||
| raise OperationValueError( | ||
| "'line' must be supplied or 'before' and 'after' must be equal" | ||
| ) | ||
| if isinstance(content, str): | ||
| # convert string to list of lines | ||
| content = content.split("\n") | ||
| if try_prevent_shell_expansion and any("'" in line for line in content): | ||
| logger.warning("content contains single quotes, shell expansion prevention may fail") | ||
|
|
||
| the_block = "\n".join([mark_1, *content, mark_2]) | ||
|
|
||
| if (current is None) or ((current == []) and (before == after)): | ||
| # a) no file or b) file but no markers and we're adding at start or end. Both use 'cat' | ||
| redirect = ">" if (current is None) else ">>" | ||
| stdin = "- " if ((current == []) and before) else "" | ||
| # here = hex(random.randint(0, 2147483647)) | ||
| here = "PYINFRAHERE" | ||
| cmd = StringCommand( | ||
| f"cat {stdin}{redirect}", | ||
| q_path, | ||
| f"<<{here}" if not try_prevent_shell_expansion else f"<<'{here}'", | ||
| f"\n{the_block}\n{here}", | ||
| ) | ||
| elif current == []: # markers not found and have a pattern to match (not start or end) | ||
| regex = adjust_regex(line, escape_regex_characters) | ||
| print_before = "{ print }" if before else "" | ||
|
|
@@ -1748,21 +1776,29 @@ def block( | |
| f"{print_after} f!=1 && /{regex}/ {{ print x; f=1}} " | ||
| f"END {{if (f==0) print ARGV[2] }} {print_before}'" | ||
| ) | ||
|
There was a problem hiding this comment. ... |
||
| cmd = StringCommand( | ||
| out_prep, | ||
| prog, | ||
| q_path, | ||
| f'"{the_block}"' if not try_prevent_shell_expansion else f"'{the_block}'", | ||
| "> $OUT &&", | ||
| real_out, | ||
| ) | ||
| else: | ||
| if (len(current) != len(content)) or ( | ||
| not all(lines[0] == lines[1] for lines in zip(content, current)) | ||
| ): # marked_block found but text is different | ||
| prog = ( | ||
| 'awk \'BEGIN {{f=1; x=ARGV[2]; ARGV[2]=""}}' | ||
| f"/{mark_1}/ {{print; print x; f=0}} /{mark_2}/ {{print; f=1; next}} f'" | ||
|
There was a problem hiding this comment. #1031 |
||
| ) | ||
| cmd = StringCommand( | ||
| out_prep, | ||
| prog, | ||
| q_path, | ||
|
There was a problem hiding this comment.
|
||
| '"' + "\n".join(content) + '"' | ||
| if not try_prevent_shell_expansion | ||
| else "'" + "\n".join(content) + "'", | ||
| "> $OUT &&", | ||
| real_out, | ||
| ) | ||
|
|
@@ -1774,7 +1810,7 @@ def block( | |
| host.create_fact( | ||
| Block, | ||
| kwargs={"path": path, "marker": marker, "begin": begin, "end": end}, | ||
| data=content, | ||
| ) | ||
| else: # remove the marked_block | ||
| if content: | ||
|
|
||
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
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
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
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
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#1029
helps with mentioned issue