Warning: this page is out of date.
", @@ -1685,6 +1691,14 @@ def block( after=True marker="", ) + + # 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,14 +1737,23 @@ def block( cmd = None if present: if not content: - raise ValueError("'content' must be supplied when 'present' == True") + raise OperationValueError("'content' must be supplied when 'present' == True") if line: if before == after: - raise ValueError("only one of 'before' or 'after' used when 'line` is specified") + raise OperationValueError( + "only one of 'before' or 'after' used when 'line` is specified" + ) elif before != after: - raise ValueError("'line' must be supplied or 'before' and 'after' must be equal") + 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]) + 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' @@ -1738,7 +1761,12 @@ def block( stdin = "- " if ((current == []) and before) else "" # here = hex(random.randint(0, 2147483647)) here = "PYINFRAHERE" - cmd = StringCommand(f"cat {stdin}{redirect}", q_path, f"<<{here}\n{the_block}\n{here}") + 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}'" ) - cmd = StringCommand(out_prep, prog, q_path, f'$"{the_block}"', "> $OUT &&", real_out) + cmd = StringCommand( + out_prep, + prog, + q_path, + f'"{the_block}"' if not try_prevent_shell_expansion else f"'{the_block}'", + "> $OUT &&", + real_out, + ) else: - pieces = content.split("\n") - if (len(current) != len(pieces)) or ( - not all(lines[0] == lines[1] for lines in zip(pieces, current)) + 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}} f'" + f"/{mark_1}/ {{print; print x; f=0}} /{mark_2}/ {{print; f=1; next}} f'" ) cmd = StringCommand( out_prep, prog, q_path, - '$"' + content + '"', + '"' + "\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.split("\n"), + data=content, ) else: # remove the marked_block if content: diff --git a/tests/operations/files.block/add_existing_block_different_content.json b/tests/operations/files.block/add_existing_block_different_content.json index 30a359ab1..3c29332d6 100644 --- a/tests/operations/files.block/add_existing_block_different_content.json +++ b/tests/operations/files.block/add_existing_block_different_content.json @@ -12,6 +12,6 @@ } }, "commands": [ - "OUT=\"$(TMPDIR=/tmp mktemp -t pyinfra.XXXXXX)\" && awk 'BEGIN {{f=1; x=ARGV[2]; ARGV[2]=\"\"}}/# BEGIN PYINFRA BLOCK/ {print; print x; f=0} /# END PYINFRA BLOCK/ {print; f=1} f' /home/someone/something $\"should be this\" > $OUT && chmod $(stat -c %a /home/someone/something 2>/dev/null || stat -f %Lp /home/someone/something ) $OUT && (chown $(stat -c \"%U:%G\" /home/someone/something 2>/dev/null) $OUT || chown -n $(stat -f \"%u:%g\" /home/someone/something ) $OUT) && mv \"$OUT\" /home/someone/something" + "OUT=\"$(TMPDIR=/tmp mktemp -t pyinfra.XXXXXX)\" && awk 'BEGIN {{f=1; x=ARGV[2]; ARGV[2]=\"\"}}/# BEGIN PYINFRA BLOCK/ {print; print x; f=0} /# END PYINFRA BLOCK/ {print; f=1; next} f' /home/someone/something \"should be this\" > $OUT && chmod $(stat -c %a /home/someone/something 2>/dev/null || stat -f %Lp /home/someone/something ) $OUT && (chown $(stat -c \"%U:%G\" /home/someone/something 2>/dev/null) $OUT || chown -n $(stat -f \"%u:%g\" /home/someone/something ) $OUT) && mv \"$OUT\" /home/someone/something" ] } diff --git a/tests/operations/files.block/add_existing_block_different_content_and_backup.json b/tests/operations/files.block/add_existing_block_different_content_and_backup.json index 6f93b9a59..a871a98cd 100644 --- a/tests/operations/files.block/add_existing_block_different_content_and_backup.json +++ b/tests/operations/files.block/add_existing_block_different_content_and_backup.json @@ -13,6 +13,6 @@ } }, "commands": [ - "cp /home/someone/something /home/someone/something.a-timestamp && OUT=\"$(TMPDIR=/tmp mktemp -t pyinfra.XXXXXX)\" && awk 'BEGIN {{f=1; x=ARGV[2]; ARGV[2]=\"\"}}/# BEGIN PYINFRA BLOCK/ {print; print x; f=0} /# END PYINFRA BLOCK/ {print; f=1} f' /home/someone/something $\"should be this\" > $OUT && chmod $(stat -c %a /home/someone/something 2>/dev/null || stat -f %Lp /home/someone/something ) $OUT && (chown $(stat -c \"%U:%G\" /home/someone/something 2>/dev/null) $OUT || chown -n $(stat -f \"%u:%g\" /home/someone/something ) $OUT) && mv \"$OUT\" /home/someone/something" + "cp /home/someone/something /home/someone/something.a-timestamp && OUT=\"$(TMPDIR=/tmp mktemp -t pyinfra.XXXXXX)\" && awk 'BEGIN {{f=1; x=ARGV[2]; ARGV[2]=\"\"}}/# BEGIN PYINFRA BLOCK/ {print; print x; f=0} /# END PYINFRA BLOCK/ {print; f=1; next} f' /home/someone/something \"should be this\" > $OUT && chmod $(stat -c %a /home/someone/something 2>/dev/null || stat -f %Lp /home/someone/something ) $OUT && (chown $(stat -c \"%U:%G\" /home/someone/something 2>/dev/null) $OUT || chown -n $(stat -f \"%u:%g\" /home/someone/something ) $OUT) && mv \"$OUT\" /home/someone/something" ] } diff --git a/tests/operations/files.block/add_line_given_but_before_eq_after.json b/tests/operations/files.block/add_line_given_but_before_eq_after.json index 7f3e678ef..901e0a3c4 100644 --- a/tests/operations/files.block/add_line_given_but_before_eq_after.json +++ b/tests/operations/files.block/add_line_given_but_before_eq_after.json @@ -13,7 +13,7 @@ } }, "exception": { - "names": ["ValueError"], + "names": ["OperationValueError"], "message": "only one of 'before' or 'after' used when 'line` is specified" } } diff --git a/tests/operations/files.block/add_no_content_provided.json b/tests/operations/files.block/add_no_content_provided.json index 8dd61ebca..fc50d36f9 100644 --- a/tests/operations/files.block/add_no_content_provided.json +++ b/tests/operations/files.block/add_no_content_provided.json @@ -7,7 +7,7 @@ } }, "exception": { - "names": ["ValueError"], + "names": ["OperationValueError"], "message": "'content' must be supplied when 'present' == True" } } diff --git a/tests/operations/files.block/add_no_existing_block_and_no_line.json b/tests/operations/files.block/add_no_existing_block_and_no_line.json index 8e7094bbf..c32a5f6b9 100644 --- a/tests/operations/files.block/add_no_existing_block_and_no_line.json +++ b/tests/operations/files.block/add_no_existing_block_and_no_line.json @@ -12,6 +12,6 @@ } }, "commands": [ - "cat > /home/someone/something <