1
diff --git a/src/lib/lib_cron.py b/src/lib/lib_cron.py
2
index be3dff9..1f30ddc 100644
3
--- a/src/lib/lib_cron.py
4
+++ b/src/lib/lib_cron.py
5
@@ -48,13 +48,13 @@ class CronHelper:
6
48
        If logrotate-cronjob config option is set to True install cronjob,
48
        If logrotate-cronjob config option is set to True install cronjob,
7
49
        otherwise cleanup.
49
        otherwise cleanup.
8
50
        """
50
        """
10
51
        clean_up_file = self.cronjob_frequency if self.cronjob_enabled else -1
51
        self.cleanup_cronjob_files()
11
52
52
12
53
        if self.cronjob_enabled is True:
53
        if self.cronjob_enabled is True:
13
54
            cronjob_path = os.path.realpath(__file__)
54
            cronjob_path = os.path.realpath(__file__)
14
55
            cron_file_path = (
55
            cron_file_path = (
15
56
                self.cronjob_base_path
56
                self.cronjob_base_path
17
57
                + self.cronjob_check_paths[clean_up_file]
57
                + self.cronjob_check_paths[self.cronjob_frequency]
18
58
                + "/"
58
                + "/"
19
59
                + self.cronjob_logrotate_cron_file
59
                + self.cronjob_logrotate_cron_file
20
60
            )
60
            )
21
@@ -73,25 +73,24 @@ class CronHelper:
22
73
            os.chmod(cron_file_path, 700)
73
            os.chmod(cron_file_path, 700)
23
74
74
24
75
            # update cron.daily schedule if logrotate-cronjob-frequency set to "daily"
75
            # update cron.daily schedule if logrotate-cronjob-frequency set to "daily"
26
76
            if self.validate_cron_conf() and self.cronjob_frequency == 1:
76
            if self.cronjob_frequency == 1 and self.validate_cron_conf():
27
77
                self.update_cron_daily_schedule()
77
                self.update_cron_daily_schedule()
28
78
        else:
29
79
            self.cleanup_etc_config()
30
78
80
47
79
        self.cleanup_cronjob(clean_up_file)
81
    def cleanup_cronjob_files(self):
48
80
82
        """Cleanup previous cronjob files."""
49
81
    def cleanup_cronjob(self, frequency=-1):
83
        for check_path in self.cronjob_check_paths:
50
82
        """Cleanup previous config."""
84
            path = os.path.join(
51
83
        if frequency == -1:
85
                self.cronjob_base_path + check_path, self.cronjob_logrotate_cron_file
52
84
            for check_path in self.cronjob_check_paths:
86
            )
53
85
                path = (
87
            if os.path.exists(path):
54
86
                    self.cronjob_base_path
88
                os.remove(path)
55
87
                    + check_path
89
56
88
                    + "/"
90
    def cleanup_etc_config(self):
57
89
                    + self.cronjob_logrotate_cron_file
91
        """Cleanup the saved config in /etc directory."""
58
90
                )
92
        if os.path.exists(self.cronjob_etc_config):
59
91
                if os.path.exists(path):
93
            os.remove(self.cronjob_etc_config)
44
92
                    os.remove(path)
45
93
            if os.path.exists(self.cronjob_etc_config):
46
94
                os.remove(self.cronjob_etc_config)
60
95
94
61
96
    def update_logrotate_etc(self):
95
    def update_logrotate_etc(self):
62
97
        """Run logrotate update config."""
96
        """Run logrotate update config."""
63
diff --git a/src/tests/functional/test_logrotate.py b/src/tests/functional/test_logrotate.py
64
index 4aa0aa6..0afbb82 100644
65
--- a/src/tests/functional/test_logrotate.py
66
+++ b/src/tests/functional/test_logrotate.py
67
@@ -112,6 +112,27 @@ async def test_configure_cron_daily(deploy_app):
68
112
    assert deploy_app.status == "active"
112
    assert deploy_app.status == "active"
69
113
113
70
114
114
71
115
async def test_reconfigure_cronjob_frequency(model, deploy_app, unit, jujutools):
72
116
    """Test reconfiguration of cronjob frequency."""
73
117
    await deploy_app.set_config({"logrotate-cronjob-frequency": "weekly"})
74
118
    await model.block_until(lambda: deploy_app.status == "active")
75
119
    config = await deploy_app.get_config()
76
120
77
121
    result = await jujutools.run_command(
78
122
        "test -f /etc/cron.weekly/charm-logrotate", unit
79
123
    )
80
124
    weekly_cronjob_exists = result["return-code"] == 0
81
125
82
126
    result = await jujutools.run_command(
83
127
        "test -f /etc/cron.daily/charm-logrotate", unit
84
128
    )
85
129
    daily_cronjob_exists = result["return-code"] == 0
86
130
87
131
    assert config["logrotate-cronjob-frequency"]["value"] == "weekly"
88
132
    assert not daily_cronjob_exists
89
133
    assert weekly_cronjob_exists
90
134
91
135
92
115
async def test_configure_override_01(model, deploy_app, jujutools, unit):
136
async def test_configure_override_01(model, deploy_app, jujutools, unit):
93
116
    """Test configuring override for the deployment (interval)."""
137
    """Test configuring override for the deployment (interval)."""
94
117
    test_path = "/etc/logrotate.d/apt"
138
    test_path = "/etc/logrotate.d/apt"
95
diff --git a/src/tests/unit/conftest.py b/src/tests/unit/conftest.py
96
index 1f15b42..9eff063 100644
97
--- a/src/tests/unit/conftest.py
98
+++ b/src/tests/unit/conftest.py
99
@@ -1,7 +1,7 @@
100
1
#!/usr/bin/python3
1
#!/usr/bin/python3
101
2
"""Configurations for tests."""
2
"""Configurations for tests."""
102
3
3
104
4
import mock
4
from unittest import mock
105
5
5
106
6
import pytest
6
import pytest
107
7
7
108
@@ -54,6 +54,12 @@ def mock_remote_unit(monkeypatch):
109
54
    monkeypatch.setattr("lib_logrotate.hookenv.remote_unit", lambda: "unit-mock/0")
54
    monkeypatch.setattr("lib_logrotate.hookenv.remote_unit", lambda: "unit-mock/0")
110
55
55
111
56
56
112
57
@pytest.fixture()
113
58
def mock_local_unit(monkeypatch):
114
59
    """Local unit mock."""
115
60
    monkeypatch.setattr("lib_logrotate.hookenv.local_unit", lambda: "unit-logrotated/0")
116
61
117
62
118
57
@pytest.fixture
63
@pytest.fixture
119
58
def mock_charm_dir(monkeypatch):
64
def mock_charm_dir(monkeypatch):
120
59
    """Charm dir mock."""
65
    """Charm dir mock."""
121
diff --git a/src/tests/unit/requirements.txt b/src/tests/unit/requirements.txt
122
index 9c685e5..3d4047b 100644
123
--- a/src/tests/unit/requirements.txt
124
+++ b/src/tests/unit/requirements.txt
125
@@ -1,5 +1,5 @@
126
1
charmhelpers
1
charmhelpers
127
2
charms.reactive
2
charms.reactive
128
3
mock
129
4
pytest
3
pytest
130
5
pytest-cov
4
pytest-cov
131
5
pytest-mock
132
6
\ No newline at end of file
6
\ No newline at end of file
133
diff --git a/src/tests/unit/test_logrotate.py b/src/tests/unit/test_logrotate.py
134
index 0c89bbc..8d329e5 100644
135
--- a/src/tests/unit/test_logrotate.py
136
+++ b/src/tests/unit/test_logrotate.py
137
@@ -1,6 +1,7 @@
138
1
"""Main unit test module."""
1
"""Main unit test module."""
139
2
140
3
import json
2
import json
141
3
import os
142
4
from textwrap import dedent
143
4
from unittest import mock
5
from unittest import mock
144
5
6
145
6
from lib_logrotate import LogrotateHelper
7
from lib_logrotate import LogrotateHelper
146
@@ -279,3 +280,72 @@ class TestCronHelper:
147
279
            cron_config.validate_cron_conf()
280
            cron_config.validate_cron_conf()
148
280
281
149
281
        assert err.type == cron_config.InvalidCronConfig
282
        assert err.type == cron_config.InvalidCronConfig
150
283
151
284
    def test_install_cronjob(self, cron, mock_local_unit, mocker):
152
285
        """Test install cronjob method."""
153
286
        mock_charm_dir = "/mock/unit-logrotated-0/charm"
154
287
        mock_exists = mocker.patch("lib_cron.os.path.exists", return_value=True)
155
288
        mock_remove = mocker.patch("lib_cron.os.remove")
156
289
        mock_chmod = mocker.patch("lib_cron.os.chmod")
157
290
        mocker.patch(
158
291
            "lib_cron.os.path.realpath",
159
292
            return_value=os.path.join(mock_charm_dir, "lib/lib_cron.py"),
160
293
        )
161
294
        mocker.patch("lib_cron.os.getcwd", return_value=mock_charm_dir)
162
295
        mock_open = mocker.patch("lib_cron.open")
163
296
        mock_handle = mock_open.return_value
164
297
165
298
        expected_files_to_be_removed = [
166
299
            "/etc/cron.hourly/charm-logrotate",
167
300
            "/etc/cron.daily/charm-logrotate",
168
301
            "/etc/cron.weekly/charm-logrotate",
169
302
            "/etc/cron.monthly/charm-logrotate",
170
303
        ]
171
304
172
305
        cron_config = cron()
173
306
        cron_config.cronjob_enabled = True
174
307
        cron_config.cronjob_frequency = 2
175
308
        cron_config.install_cronjob()
176
309
177
310
        mock_exists.assert_has_calls(
178
311
            [mock.call(file) for file in expected_files_to_be_removed], any_order=True
179
312
        )
180
313
        mock_remove.assert_has_calls(
181
314
            [mock.call(file) for file in expected_files_to_be_removed], any_order=True
182
315
        )
183
316
        mock_open.assert_called_once_with("/etc/cron.weekly/charm-logrotate", "w")
184
317
        mock_handle.write.assert_called_once_with(
185
318
            dedent(
186
319
                """\
187
320
                #!/bin/bash
188
321
                /usr/bin/sudo /usr/bin/juju-run unit-logrotated/0 "/mock/unit-logrotated-0/.venv/bin/python3 /mock/unit-logrotated-0/charm/lib/lib_cron.py"
189
322
                """  # noqa
190
323
            )
191
324
        )
192
325
        mock_handle.close.assert_called_once()
193
326
        mock_chmod.assert_called_once_with("/etc/cron.weekly/charm-logrotate", 700)
194
327
195
328
    def test_install_cronjob_removes_etc_config_when_cronjob_disabled(
196
329
        self, cron, mocker
197
330
    ):
198
331
        """Test that all cronjob related files created upon cronjobs being disabled."""
199
332
        mock_exists = mocker.patch("lib_cron.os.path.exists", return_value=True)
200
333
        mock_remove = mocker.patch("lib_cron.os.remove")
201
334
202
335
        expected_files_to_be_removed = [
203
336
            "/etc/cron.hourly/charm-logrotate",
204
337
            "/etc/cron.daily/charm-logrotate",
205
338
            "/etc/cron.weekly/charm-logrotate",
206
339
            "/etc/cron.monthly/charm-logrotate",
207
340
            "/etc/logrotate_cronjob_config",
208
341
        ]
209
342
        cron_config = cron()
210
343
        cron_config.cronjob_enabled = False
211
344
        cron_config.install_cronjob()
212
345
213
346
        mock_exists.assert_has_calls(
214
347
            [mock.call(file) for file in expected_files_to_be_removed], any_order=True
215
348
        )
216
349
        mock_remove.assert_has_calls(
217
350
            [mock.call(file) for file in expected_files_to_be_removed], any_order=True
218
351
        )
Reviewer	Review Type	Date Requested	Status
🤖 prod-jenkaas-bootstack (community)	continuous-integration		Approve on 2023-05-05
Chi Wai CHAN		2023-05-04	Approve on 2023-05-05
Erhan Sunar (community)		2023-05-04	Approve on 2023-05-04
BootStack Reviewers		2023-05-04	Pending
Review via email: mp+442359@code.launchpad.net