mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-21 19:29:05 +00:00
[PR #11764/e9110811 backport][stable-12] logrotate: fix parameter and config file validation and more (#11856)
logrotate: fix parameter and config file validation and more (#11764)
* fix(logrotate): add missing defaults and parameter validation declarations
- Add default="present" to state parameter
- Add default="/etc/logrotate.d" to config_dir parameter
- Add required_by declarations for shred and compression parameters
* fix(logrotate): fix runtime validation bugs, remove duplicate checks
- Fix shred_cycles TypeError when value is None
- Fix enabled=None handling in get_config_path
- Remove duplicate runtime mutually_exclusive checks
- Add runtime boolean truthiness checks
- Add 'create' parameter format validation
- Remove stale test method
* fix(logrotate): restructure file operations, validate before write
- Write content to tmpdir temp file, validate, then atomic move to destination.
- Wrap all os.remove() calls in try/except with fail_json on error
- Wrap all module.atomic_move() calls in try/except with fail_json on error
- Also add self.mock_module.tmpdir = self.test_dir to test setUp for new code path
* docs(logrotate): update DOCUMENTATION block
- Add 'default: present' to state option
- Add 'default: /etc/logrotate.d' to config_dir option
* feat(logrotate): add optional backup parameter
* chore: add logrotate fixes changelog fragment
* chore(changelog/logrotate): use present tense singular
* fix(logrotate): handle trailing spaces in create param
* refactor(logrotate): remove redundant checks
These are already handled by `required_if` statements in the module spec
* refactor(logrotate): use tempfile to create temporary file
* refactor(logrotate): remove redundant `bool()` casts on `target_enabled`
`target_enabled` is guaranteed to be bool by this point. It's either the module param (typed bool) or falls back to `current_enabled` (also bool). The `bool()` wraps are no-ops.
* refactor(logrotate): remove unused `self.config_file` attribute
* refactor(logrotate): remove dead `any_state` parameter from `read_existing_config`
* fix(logrotate): raise error instead of falling through on enabled-state rename failures
* refactor(logrotate): tighten `get_config_path` sig to bool
`None` callers are removed now so this is safe
* test(logrotate): remove stale open mock assertion after tempfile refactor
* style(logrotate): format file
* chore(logrotate): add missing `version_added` attribute
* fix(logrotate): clean up temp file
* fix(logrotate): remove redundant temp file cleanup
* refactor(logrotate): Use dict subscript to access required backup param
* fix(logrotate): fix: only remove old config file when path differs from target
* fix(logrotate): update logrotate_bin type hint to str
* feat(logrotate): add backup file handling when removing old config
* style(logrotate): format file
* test(logrotate): add missing backup default to `_setup_module_params`
* test(logrotate): fix incorrect `os.remove` assertion in update test
* refactor(logrotate): remove unnecessary `to_native()` call
* refactor(logrotate): replace str quotes with !r
* fix(logrotate): change backup default back to true
* fix(logrotate): raise error when `shred_cycle`s is set with `shred=false`
* docs(logrotate): clarify `shred_cycles` behaviour
* fix(logrotate): remove to_native calls for exception messages
* docs(logrotate): improve `config_dir` param description
* refactor(logrotate): simplify backup file assignment logic
* style(logrotate): format file
* docs(logrotate): improve config_map description
---------
(cherry picked from commit e911081102)
Co-authored-by: tigattack <10629864+tigattack@users.noreply.github.com>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot]
GitHub
parent
956fc075ef
commit
2873d439c3
3 changed files with 317 additions and 379 deletions
|
|
@ -51,6 +51,8 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
self.mock_module.atomic_move = Mock()
|
||||
self.mock_module.warn = Mock()
|
||||
self.mock_module.run_command = Mock(return_value=(0, "", ""))
|
||||
self.mock_module.backup_local = Mock(return_value=None)
|
||||
self.mock_module.tmpdir = self.test_dir
|
||||
self.mock_ansible_basic.AnsibleModule.return_value = self.mock_module
|
||||
self.config_dir = os.path.join(self.test_dir, "logrotate.d")
|
||||
os.makedirs(self.config_dir, exist_ok=True)
|
||||
|
|
@ -80,6 +82,7 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
"date_format": "-%Y%m%d",
|
||||
"shared_scripts": False,
|
||||
"enabled": True,
|
||||
"backup": True,
|
||||
}
|
||||
default_params.update(params)
|
||||
self.mock_module.params = default_params
|
||||
|
|
@ -99,18 +102,15 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()) as mock_file:
|
||||
with patch("os.chmod") as mock_chmod:
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("config_file", result)
|
||||
self.assertIn("config_content", result)
|
||||
self.assertEqual(result["enabled_state"], True)
|
||||
mock_file.assert_called_once()
|
||||
mock_chmod.assert_called_once()
|
||||
with patch("os.chmod") as mock_chmod:
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("config_file", result)
|
||||
self.assertIn("config_content", result)
|
||||
self.assertEqual(result["enabled_state"], True)
|
||||
mock_chmod.assert_called_once()
|
||||
|
||||
def test_update_existing_configuration(self):
|
||||
"""Test updating an existing logrotate configuration."""
|
||||
|
|
@ -138,14 +138,13 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("builtins.open", mock_open(read_data=existing_content)):
|
||||
with patch("os.remove") as mock_remove:
|
||||
with patch("os.chmod") as mock_chmod:
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("14", result["config_content"])
|
||||
mock_remove.assert_called()
|
||||
mock_chmod.assert_called_once()
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("14", result["config_content"])
|
||||
mock_remove.assert_not_called()
|
||||
mock_chmod.assert_called_once()
|
||||
|
||||
def test_remove_configuration(self):
|
||||
"""Test removing a logrotate configuration."""
|
||||
|
|
@ -191,10 +190,9 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.chmod"):
|
||||
mock_file_write = mock_open()
|
||||
with patch("builtins.open", mock_file_write):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertEqual(result["enabled_state"], False)
|
||||
self.assertTrue(result["config_file"].endswith(".disabled"))
|
||||
|
|
@ -222,13 +220,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.remove"):
|
||||
with patch("os.chmod"):
|
||||
self.mock_module.atomic_move = Mock()
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertEqual(result["enabled_state"], True)
|
||||
self.assertFalse(result["config_file"].endswith(".disabled"))
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertEqual(result["enabled_state"], True)
|
||||
self.assertFalse(result["config_file"].endswith(".disabled"))
|
||||
|
||||
def test_validation_missing_paths(self):
|
||||
"""Test validation when paths are missing for new configuration."""
|
||||
|
|
@ -251,27 +248,6 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_validation_size_and_max_size_exclusive(self):
|
||||
"""Test validation when both size and max_size are specified."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(size="100M", max_size="200M")
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return False
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_check_mode(self):
|
||||
"""Test that no changes are made in check mode."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
|
@ -289,11 +265,10 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_generate_config_with_scripts(self):
|
||||
"""Test generating configuration with pre/post scripts."""
|
||||
|
|
@ -317,17 +292,16 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("prerotate", content)
|
||||
self.assertIn("postrotate", content)
|
||||
self.assertIn("firstaction", content)
|
||||
self.assertIn("lastaction", content)
|
||||
self.assertIn("systemctl reload test", content)
|
||||
self.assertIn("echo 'Pre-rotation'", content)
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("prerotate", content)
|
||||
self.assertIn("postrotate", content)
|
||||
self.assertIn("firstaction", content)
|
||||
self.assertIn("lastaction", content)
|
||||
self.assertIn("systemctl reload test", content)
|
||||
self.assertIn("echo 'Pre-rotation'", content)
|
||||
|
||||
def test_compression_methods(self):
|
||||
"""Test different compression methods."""
|
||||
|
|
@ -349,18 +323,17 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
if method != "gzip":
|
||||
self.assertIn(f"compresscmd /usr/bin/{method}", content)
|
||||
if method == "zstd" or method == "lz4":
|
||||
self.assertIn(f"uncompresscmd /usr/bin/{method} -d", content)
|
||||
else:
|
||||
uncompress_cmd = f"{method}un{method}"
|
||||
self.assertIn(f"uncompresscmd /usr/bin/{uncompress_cmd}", content)
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
if method != "gzip":
|
||||
self.assertIn(f"compresscmd /usr/bin/{method}", content)
|
||||
if method == "zstd" or method == "lz4":
|
||||
self.assertIn(f"uncompresscmd /usr/bin/{method} -d", content)
|
||||
else:
|
||||
uncompress_cmd = f"{method}un{method}"
|
||||
self.assertIn(f"uncompresscmd /usr/bin/{uncompress_cmd}", content)
|
||||
|
||||
def test_size_based_rotation(self):
|
||||
"""Test size-based rotation configuration."""
|
||||
|
|
@ -379,13 +352,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("size 100M", content)
|
||||
self.assertNotIn("daily", content)
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("size 100M", content)
|
||||
self.assertNotIn("daily", content)
|
||||
|
||||
def test_logrotate_not_installed(self):
|
||||
"""Test error when logrotate is not installed."""
|
||||
|
|
@ -460,12 +432,11 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("builtins.open", mock_file_read):
|
||||
with patch("os.remove"):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("/var/log/app1/*.log", result["config_content"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.assertIn("/var/log/app1/*.log", result["config_content"])
|
||||
|
||||
def test_no_delay_compress_parameter(self):
|
||||
"""Test no_delay_compress parameter."""
|
||||
|
|
@ -484,13 +455,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("nodelaycompress", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("nodelaycompress", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_shred_and_shred_cycles_parameters(self):
|
||||
"""Test shred and shred_cycles parameters."""
|
||||
|
|
@ -509,14 +479,13 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("shred", content)
|
||||
self.assertIn("shredcycles 3", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("shred", content)
|
||||
self.assertIn("shredcycles 3", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_copy_parameter(self):
|
||||
"""Test copy parameter."""
|
||||
|
|
@ -535,14 +504,13 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("copy", content)
|
||||
self.assertNotIn("copytruncate", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("copy", content)
|
||||
self.assertNotIn("copytruncate", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_rename_copy_parameter(self):
|
||||
"""Test rename_copy parameter."""
|
||||
|
|
@ -561,13 +529,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("renamecopy", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("renamecopy", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_min_size_parameter(self):
|
||||
"""Test min_size parameter."""
|
||||
|
|
@ -586,13 +553,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("minsize 100k", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("minsize 100k", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_date_yesterday_parameter(self):
|
||||
"""Test date_yesterday parameter."""
|
||||
|
|
@ -611,14 +577,13 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("dateext", content)
|
||||
self.assertIn("dateyesterday", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("dateext", content)
|
||||
self.assertIn("dateyesterday", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_create_old_dir_parameter(self):
|
||||
"""Test create_old_dir parameter."""
|
||||
|
|
@ -637,14 +602,13 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("olddir /var/log/archives", content)
|
||||
self.assertIn("createolddir", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("olddir /var/log/archives", content)
|
||||
self.assertIn("createolddir", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_start_parameter(self):
|
||||
"""Test start parameter."""
|
||||
|
|
@ -663,13 +627,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("start 1", content)
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("start 1", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_syslog_parameter(self):
|
||||
"""Test syslog parameter."""
|
||||
|
|
@ -688,55 +651,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("syslog", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_validation_copy_and_copy_truncate_exclusive(self):
|
||||
"""Test validation when both copy and copy_truncate are specified."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(copy=True, copy_truncate=True)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return False
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_validation_copy_and_rename_copy_exclusive(self):
|
||||
"""Test validation when both copy and rename_copy are specified."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(copy=True, rename_copy=True)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return False
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertIn("syslog", content)
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
def test_validation_shred_cycles_positive(self):
|
||||
"""Test validation when shred_cycles is not positive."""
|
||||
|
|
@ -780,27 +700,6 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_validation_old_dir_and_no_old_dir_exclusive(self):
|
||||
"""Test validation when both old_dir and no_old_dir are specified."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(old_dir="/var/log/archives", no_old_dir=True)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return False
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_all_new_parameters_together(self):
|
||||
"""Test all new parameters together in one configuration."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
|
@ -834,74 +733,28 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertTrue(result["changed"])
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
content = result["config_content"]
|
||||
self.assertTrue(result["changed"])
|
||||
|
||||
self.assertIn("nodelaycompress", content)
|
||||
self.assertIn("shred", content)
|
||||
self.assertIn("shredcycles 3", content)
|
||||
self.assertIn("copy", content)
|
||||
self.assertIn("minsize 100k", content)
|
||||
self.assertIn("dateext", content)
|
||||
self.assertIn("dateyesterday", content)
|
||||
self.assertIn("olddir /var/log/archives", content)
|
||||
self.assertIn("createolddir", content)
|
||||
self.assertIn("start 1", content)
|
||||
self.assertIn("syslog", content)
|
||||
self.assertIn("nodelaycompress", content)
|
||||
self.assertIn("shred", content)
|
||||
self.assertIn("shredcycles 3", content)
|
||||
self.assertIn("copy", content)
|
||||
self.assertIn("minsize 100k", content)
|
||||
self.assertIn("dateext", content)
|
||||
self.assertIn("dateyesterday", content)
|
||||
self.assertIn("olddir /var/log/archives", content)
|
||||
self.assertIn("createolddir", content)
|
||||
self.assertIn("start 1", content)
|
||||
self.assertIn("syslog", content)
|
||||
|
||||
lines = [line.strip() for line in content.split("\n")]
|
||||
self.assertNotIn("copytruncate", lines)
|
||||
self.assertNotIn("renamecopy", lines)
|
||||
self.assertNotIn("delaycompress", lines)
|
||||
|
||||
def test_parameter_interactions(self):
|
||||
"""Test interactions between related parameters."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(old_dir="/var/log/archives", no_old_dir=True)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return False
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
self._setup_module_params(copy=True, rename_copy=True)
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
self._setup_module_params(copy=True, copy_truncate=True)
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
|
||||
with self.assertRaises(Exception) as context:
|
||||
config.apply()
|
||||
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
lines = [line.strip() for line in content.split("\n")]
|
||||
self.assertNotIn("copytruncate", lines)
|
||||
self.assertNotIn("renamecopy", lines)
|
||||
self.assertNotIn("delaycompress", lines)
|
||||
|
||||
def test_size_format_validation(self):
|
||||
"""Test validation of size format parameters."""
|
||||
|
|
@ -924,12 +777,11 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
|
||||
result = config.apply()
|
||||
self.assertIn(f"size {size}", result["config_content"])
|
||||
result = config.apply()
|
||||
self.assertIn(f"size {size}", result["config_content"])
|
||||
|
||||
invalid_sizes = ["100kb", "M100", "1.5G", "abc", "100 MB"]
|
||||
|
||||
|
|
@ -975,12 +827,11 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
|
||||
result = config.apply()
|
||||
self.assertIn(f"maxsize {size}", result["config_content"])
|
||||
result = config.apply()
|
||||
self.assertIn(f"maxsize {size}", result["config_content"])
|
||||
|
||||
invalid_sizes = ["100kb", "M100", "1.5G", "abc", "100 MB"]
|
||||
|
||||
|
|
@ -1005,6 +856,68 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
|
||||
self.assertIn("fail_json called", str(context.exception))
|
||||
|
||||
def test_backup_disabled_skips_backup(self):
|
||||
"""Test that backup is not created when backup parameter is False."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(rotate_count=14, backup=False)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
existing_content = """/var/log/test/*.log {
|
||||
daily
|
||||
rotate 7
|
||||
compress
|
||||
}"""
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return True
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open(read_data=existing_content)):
|
||||
with patch("os.remove"):
|
||||
with patch("os.chmod"):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.mock_module.backup_local.assert_not_called()
|
||||
self.assertNotIn("backup_file", result)
|
||||
|
||||
def test_backup_enabled_by_default(self):
|
||||
"""Test that backup is created by default."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
||||
self._setup_module_params(rotate_count=14)
|
||||
config_path = os.path.join(self.config_dir, "test")
|
||||
expected_backup_path = config_path + ".20260101_120000"
|
||||
self.mock_module.backup_local = Mock(return_value=expected_backup_path)
|
||||
existing_content = """/var/log/test/*.log {
|
||||
daily
|
||||
rotate 7
|
||||
compress
|
||||
}"""
|
||||
|
||||
def exists_side_effect(path):
|
||||
if path == self.config_dir:
|
||||
return True
|
||||
elif path == config_path:
|
||||
return True
|
||||
return False
|
||||
|
||||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open(read_data=existing_content)):
|
||||
with patch("os.remove"):
|
||||
with patch("os.chmod"):
|
||||
logrotate_bin = self.mock_module.get_bin_path.return_value
|
||||
config = logrotate.LogrotateConfig(self.mock_module, logrotate_bin)
|
||||
result = config.apply()
|
||||
self.assertTrue(result["changed"])
|
||||
self.mock_module.backup_local.assert_called_once_with(config_path)
|
||||
self.assertEqual(result["backup_file"], expected_backup_path)
|
||||
|
||||
def test_logrotate_bin_used_in_apply(self):
|
||||
"""Test that logrotate binary path is used in apply method."""
|
||||
from ansible_collections.community.general.plugins.modules import logrotate
|
||||
|
|
@ -1026,13 +939,12 @@ class TestLogrotateConfig(unittest.TestCase):
|
|||
with patch("os.path.exists", side_effect=exists_side_effect):
|
||||
with patch("builtins.open", mock_open()):
|
||||
with patch("os.chmod"):
|
||||
with patch.object(logrotate.LogrotateConfig, "_backup_config", create=True):
|
||||
config = logrotate.LogrotateConfig(self.mock_module, test_logrotate_path)
|
||||
config.apply()
|
||||
config = logrotate.LogrotateConfig(self.mock_module, test_logrotate_path)
|
||||
config.apply()
|
||||
|
||||
self.mock_module.run_command.assert_called_once()
|
||||
call_args = self.mock_module.run_command.call_args[0][0]
|
||||
self.assertEqual(call_args[0], test_logrotate_path)
|
||||
self.mock_module.run_command.assert_called_once()
|
||||
call_args = self.mock_module.run_command.call_args[0][0]
|
||||
self.assertEqual(call_args[0], test_logrotate_path)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue