mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
66caa58346
add install of networkx fix aggregate to properly work with requisites fix requisite checking to not be exponential fix pkg aggregate to work when multiple states specify the same package add some type hints to state.py to make the code easier to follow fix case of pkg aggregate duplicate package.
401 lines
13 KiB
Python
401 lines
13 KiB
Python
import os
|
|
|
|
import pytest
|
|
|
|
pytestmark = [
|
|
pytest.mark.windows_whitelisted,
|
|
]
|
|
|
|
|
|
def test_replace(file, tmp_path):
|
|
"""
|
|
file.replace
|
|
"""
|
|
name = tmp_path / "testfile"
|
|
name.write_text("change_me")
|
|
|
|
ret = file.replace(name=str(name), pattern="change", repl="salt", backup=False)
|
|
assert ret.result is True
|
|
assert name.read_text() == "salt_me"
|
|
|
|
|
|
def test_replace_issue_18612(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18612:
|
|
|
|
Using 'prepend_if_not_found' or 'append_if_not_found' resulted in
|
|
an infinitely growing file as 'file.replace' didn't check beforehand
|
|
whether the changes had already been done to the file
|
|
|
|
# Case description:
|
|
|
|
The tested file contains one commented line
|
|
The commented line should be uncommented in the end, nothing else should change
|
|
"""
|
|
test_name = "test_replace_issue_18612"
|
|
path_test = tmp_path / test_name
|
|
path_test.write_text("# en_US.UTF-8")
|
|
|
|
ret = []
|
|
for _ in range(3):
|
|
ret.append(
|
|
file.replace(
|
|
name=str(path_test),
|
|
pattern="^# en_US.UTF-8$",
|
|
repl="en_US.UTF-8",
|
|
append_if_not_found=True,
|
|
)
|
|
)
|
|
|
|
# ensure, the number of lines didn't change, even after invoking 'file.replace' 3 times
|
|
# and that the replacement succeeded
|
|
assert path_test.read_text() == "en_US.UTF-8"
|
|
|
|
# ensure, all runs of 'file.replace' reported success
|
|
for item in ret:
|
|
assert item.result is True
|
|
|
|
|
|
def test_replace_issue_18612_prepend(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18612:
|
|
|
|
Using 'prepend_if_not_found' or 'append_if_not_found' resulted in
|
|
an infinitely growing file as 'file.replace' didn't check beforehand
|
|
whether the changes had already been done to the file
|
|
|
|
# Case description:
|
|
|
|
The tested file contains multiple lines not matching the pattern or replacement in any way
|
|
The replacement pattern should be prepended to the file
|
|
"""
|
|
test_name = "test_replace_issue_18612_prepend"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
ret = []
|
|
for _ in range(3):
|
|
ret.append(
|
|
file.replace(
|
|
name=str(path_test),
|
|
pattern="^# en_US.UTF-8$",
|
|
repl="en_US.UTF-8",
|
|
prepend_if_not_found=True,
|
|
)
|
|
)
|
|
|
|
# ensure, the resulting file contains the expected lines
|
|
assert path_test.read_text() == f"en_US.UTF-8\n{contents}"
|
|
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file()
|
|
assert backup_file.read_text() == contents
|
|
|
|
# ensure, all runs of 'file.replace' reported success
|
|
for item in ret:
|
|
assert item.result is True
|
|
|
|
|
|
def test_replace_issue_18612_append(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18612:
|
|
|
|
Using 'prepend_if_not_found' or 'append_if_not_found' resulted in
|
|
an infinitely growing file as 'file.replace' didn't check beforehand
|
|
whether the changes had already been done to the file
|
|
|
|
# Case description:
|
|
|
|
The tested file contains multiple lines not matching the pattern or replacement in any way
|
|
The replacement pattern should be appended to the file
|
|
"""
|
|
test_name = "test_replace_issue_18612_append"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
ret = []
|
|
for _ in range(3):
|
|
ret.append(
|
|
file.replace(
|
|
name=str(path_test),
|
|
pattern="^# en_US.UTF-8$",
|
|
repl="en_US.UTF-8",
|
|
append_if_not_found=True,
|
|
)
|
|
)
|
|
|
|
# ensure, the resulting file contains the expected lines
|
|
assert path_test.read_text() == f"{contents}\nen_US.UTF-8\n"
|
|
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file()
|
|
assert backup_file.read_text() == contents
|
|
|
|
# ensure, all runs of 'file.replace' reported success
|
|
for item in ret:
|
|
assert item.result is True
|
|
|
|
|
|
def test_replace_issue_18612_append_not_found_content(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18612:
|
|
|
|
Using 'prepend_if_not_found' or 'append_if_not_found' resulted in
|
|
an infinitely growing file as 'file.replace' didn't check beforehand
|
|
whether the changes had already been done to the file
|
|
|
|
# Case description:
|
|
|
|
The tested file contains multiple lines not matching the pattern or replacement in any way
|
|
The 'not_found_content' value should be appended to the file
|
|
"""
|
|
test_name = "test_replace_issue_18612_append_not_found_content"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
not_found_content = "THIS LINE WASN'T FOUND! SO WE'RE APPENDING IT HERE!"
|
|
|
|
ret = []
|
|
for _ in range(3):
|
|
ret.append(
|
|
file.replace(
|
|
name=str(path_test),
|
|
pattern="^# en_US.UTF-8$",
|
|
repl="en_US.UTF-8",
|
|
append_if_not_found=True,
|
|
not_found_content=not_found_content,
|
|
)
|
|
)
|
|
|
|
# ensure, the resulting file contains the expected lines
|
|
assert path_test.read_text() == f"{contents}\n{not_found_content}\n"
|
|
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file()
|
|
assert backup_file.read_text() == contents
|
|
|
|
# ensure, all runs of 'file.replace' reported success
|
|
for item in ret:
|
|
assert item.result is True
|
|
|
|
|
|
def test_replace_issue_18612_change_mid_line_with_comment(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18612:
|
|
|
|
Using 'prepend_if_not_found' or 'append_if_not_found' resulted in
|
|
an infinitely growing file as 'file.replace' didn't check beforehand
|
|
whether the changes had already been done to the file
|
|
|
|
# Case description:
|
|
|
|
The tested file contains 5 key=value pairs
|
|
The commented key=value pair #foo=bar should be changed to foo=salt
|
|
The comment char (#) in front of foo=bar should be removed
|
|
"""
|
|
test_name = "test_replace_issue_18612_change_mid_line_with_comment"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
ret = []
|
|
for _ in range(3):
|
|
ret.append(
|
|
file.replace(
|
|
name=str(path_test),
|
|
pattern="^#foo=bar($|(?=\r\n))",
|
|
repl="foo=salt",
|
|
append_if_not_found=True,
|
|
)
|
|
)
|
|
|
|
# ensure, the resulting file contains the expected lines
|
|
assert path_test.read_text() == contents.replace("#foo=bar", "foo=salt")
|
|
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file()
|
|
assert backup_file.read_text() == contents
|
|
|
|
# ensure, all runs of 'file.replace' reported success
|
|
for item in ret:
|
|
assert item.result is True
|
|
|
|
|
|
def test_replace_issue_18841_no_changes(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18841:
|
|
|
|
Using file.replace in a way which shouldn't modify the file at all
|
|
results in changed mtime of the original file and a backup file being created.
|
|
|
|
# Case description
|
|
|
|
The tested file contains multiple lines
|
|
The tested file contains a line already matching the replacement (no change needed)
|
|
The tested file's content shouldn't change at all
|
|
The tested file's mtime shouldn't change at all
|
|
No backup file should be created
|
|
"""
|
|
test_name = "test_replace_issue_18841_no_changes"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\ngoodbye world\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
# get (m|a)time of file
|
|
fstats_orig = path_test.stat()
|
|
|
|
# define how far we predate the file
|
|
age = 5 * 24 * 60 * 60
|
|
|
|
# set (m|a)time of file 5 days into the past
|
|
os.utime(str(path_test), (fstats_orig.st_mtime - age, fstats_orig.st_atime - age))
|
|
|
|
# Get stat again after we modified it
|
|
fstats_orig = path_test.stat()
|
|
|
|
ret = file.replace(
|
|
name=str(path_test),
|
|
pattern="^hello world$",
|
|
repl="goodbye world",
|
|
show_changes=True,
|
|
flags=["IGNORECASE"],
|
|
backup=False,
|
|
)
|
|
assert ret.result is True
|
|
|
|
# get (m|a)time of file
|
|
fstats_post = path_test.stat()
|
|
|
|
# ensure, the file content didn't change
|
|
assert path_test.read_text() == contents
|
|
|
|
# ensure no backup file was created
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file() is False
|
|
|
|
# ensure the file's mtime didn't change
|
|
assert fstats_post.st_mtime == fstats_orig.st_mtime
|
|
|
|
|
|
def test_replace_issue_18841_omit_backup(file, tmp_path):
|
|
"""
|
|
Test the (mis-)behaviour of file.replace as described in #18841:
|
|
|
|
Using file.replace in a way which shouldn't modify the file at all
|
|
results in changed mtime of the original file and a backup file being created.
|
|
|
|
# Case description
|
|
|
|
The tested file contains multiple lines
|
|
The tested file contains a line already matching the replacement (no change needed)
|
|
The tested file's content shouldn't change at all
|
|
The tested file's mtime shouldn't change at all
|
|
No backup file should be created, although backup=False isn't explicitly defined
|
|
"""
|
|
test_name = "test_replace_issue_18841_omit_backup"
|
|
path_test = tmp_path / test_name
|
|
contents = "#john=doe\n#foo = bar\ngoodbye world\n#foo=bar\n#blah=blub\n#some=thing"
|
|
path_test.write_text(contents)
|
|
|
|
# get (m|a)time of file
|
|
fstats_orig = path_test.stat()
|
|
|
|
# define how far we predate the file
|
|
age = 5 * 24 * 60 * 60
|
|
|
|
# set (m|a)time of file 5 days into the past
|
|
os.utime(str(path_test), (fstats_orig.st_mtime - age, fstats_orig.st_atime - age))
|
|
|
|
# Grab stat again after changing (m|a)time
|
|
# fstats_orig = path_test.stat()
|
|
|
|
ret = file.replace(
|
|
name=str(path_test),
|
|
pattern="^hello world$",
|
|
repl="goodbye world",
|
|
show_changes=True,
|
|
flags=["IGNORECASE"],
|
|
)
|
|
assert ret.result is True
|
|
|
|
# get (m|a)time of file
|
|
# fstats_post = path_test.stat()
|
|
|
|
# ensure, the file content didn't change
|
|
assert path_test.read_text() == contents
|
|
|
|
# ensure no backup file was created
|
|
backup_file = path_test.with_name(f"{path_test.name}.bak")
|
|
assert backup_file.is_file() is False
|
|
|
|
# ensure the file's mtime didn't change
|
|
# assert fstats_post.st_mtime == fstats_orig.st_mtime - age
|
|
# This is commented out because before the test was migrated, while it was
|
|
# passing, checking mtime was wrongly being done:
|
|
#
|
|
# self.assertTrue(fstats_post.st_mtime, fstats_orig.st_mtime - age)
|
|
#
|
|
# The above is ALWAYS true. Anyway, the backup file was not created, so the
|
|
# test is still valid and valuable
|
|
|
|
|
|
def test_file_replace_prerequired_issues_55775(modules, state_tree, tmp_path):
|
|
"""
|
|
Test that __prerequired__ is filter from file.replace
|
|
if __prerequired__ is not filter from file.replace an error will be raised
|
|
"""
|
|
managed_file = tmp_path / "issue-55775.txt"
|
|
sls_contents = f"""
|
|
{managed_file}:
|
|
file.managed:
|
|
- contents:
|
|
- foo
|
|
file.replace:
|
|
file.replace:
|
|
- name: {managed_file}
|
|
- pattern: 'foo'
|
|
- repl: 'bar'
|
|
- prereq:
|
|
- test no changes
|
|
- test changes
|
|
test no changes:
|
|
test.succeed_without_changes:
|
|
- name: no changes
|
|
test changes:
|
|
test.succeed_with_changes:
|
|
- name: changes
|
|
"""
|
|
with pytest.helpers.temp_file("file-replace.sls", sls_contents, state_tree):
|
|
ret = modules.state.sls("file-replace")
|
|
assert not ret.failed
|
|
for state_run in ret:
|
|
assert state_run.result is True
|
|
|
|
assert managed_file.exists()
|
|
|
|
|
|
def test_file_replace_check_cmd(modules, state_tree):
|
|
"""
|
|
Test that check_cmd works for file.replace
|
|
and those states do not run.
|
|
"""
|
|
sls_contents = """
|
|
replace_in_file:
|
|
file.replace:
|
|
- name: /tmp/test
|
|
- pattern: hi
|
|
- repl: "replacement text"
|
|
- append_if_not_found: True
|
|
- check_cmd:
|
|
- "djasjahj"
|
|
"""
|
|
with pytest.helpers.temp_file(
|
|
"file-replace-check-cmd.sls", sls_contents, state_tree
|
|
):
|
|
ret = modules.state.sls("file-replace-check-cmd")
|
|
for state_run in ret:
|
|
assert state_run.result is False
|
|
assert state_run.comment == "check_cmd determined the state failed"
|