1
diff --git a/src/lib/lib_cron.py b/src/lib/lib_cron.py
2
index 1f30ddc..f2383cc 100644
3
--- a/src/lib/lib_cron.py
4
+++ b/src/lib/lib_cron.py
5
@@ -1,7 +1,6 @@
6
1
"""Cron helper module."""
1
"""Cron helper module."""
7
2
import os
2
import os
8
3
import re
3
import re
9
4
import subprocess
10
5
4
11
6
from charmhelpers.core import hookenv
5
from charmhelpers.core import hookenv
12
7
6
13
@@ -62,15 +61,14 @@ class CronHelper:
14
62
            logrotate_unit = hookenv.local_unit()
61
            logrotate_unit = hookenv.local_unit()
15
63
            python_venv_path = os.getcwd().replace("charm", "") + ".venv/bin/python3"
62
            python_venv_path = os.getcwd().replace("charm", "") + ".venv/bin/python3"
16
64
            # upgrade to template if logic increases
63
            # upgrade to template if logic increases
17
65
            cron_file = open(cron_file_path, "w")
18
66
            cron_job = """#!/bin/bash
64
            cron_job = """#!/bin/bash
19
67
/usr/bin/sudo /usr/bin/juju-run {} "{} {}"
65
/usr/bin/sudo /usr/bin/juju-run {} "{} {}"
20
68
""".format(
66
""".format(
21
69
                logrotate_unit, python_venv_path, cronjob_path
67
                logrotate_unit, python_venv_path, cronjob_path
22
70
            )
68
            )
26
71
            cron_file.write(cron_job)
69
            with open(cron_file_path, "w") as cron_file:
27
72
            cron_file.close()
70
                cron_file.write(cron_job)
28
73
            os.chmod(cron_file_path, 700)
71
            os.chmod(cron_file_path, 0o755)
29
74
72
30
75
            # update cron.daily schedule if logrotate-cronjob-frequency set to "daily"
73
            # update cron.daily schedule if logrotate-cronjob-frequency set to "daily"
31
76
            if self.cronjob_frequency == 1 and self.validate_cron_conf():
74
            if self.cronjob_frequency == 1 and self.validate_cron_conf():
32
@@ -123,7 +121,13 @@ class CronHelper:
33
123
        else:
121
        else:
34
124
            raise RuntimeError("Unknown daily schedule type: {}".format(schedule_type))
122
            raise RuntimeError("Unknown daily schedule type: {}".format(schedule_type))
35
125
123
37
126
        cron_daily_timestamp = cron_daily_minute + " " + cron_daily_hour + "\t"
124
        cron_daily_timestamp = cron_daily_minute + " " + cron_daily_hour
38
125
        self.write_to_crontab(cron_daily_timestamp)
39
126
40
127
        return cron_daily_timestamp
41
128
42
129
    def write_to_crontab(self, cron_daily_timestamp):
43
130
        """Write daily cronjob with provided timestamp to /etc/crontab."""
44
127
        cron_pattern = re.compile(r".*\/etc\/cron.daily.*")
131
        cron_pattern = re.compile(r".*\/etc\/cron.daily.*")
45
128
        with open(r"/etc/crontab", "r") as crontab:
132
        with open(r"/etc/crontab", "r") as crontab:
46
129
            data = crontab.read()
133
            data = crontab.read()
47
@@ -132,15 +136,13 @@ class CronHelper:
48
132
        updated_cron_daily = ""
136
        updated_cron_daily = ""
49
133
        if cron_daily:
137
        if cron_daily:
50
134
            updated_cron_daily = re.sub(
138
            updated_cron_daily = re.sub(
52
135
                r"\d?\d(~\d\d)?\s\d?\d(~\d\d)?\t", cron_daily_timestamp, cron_daily[0]
139
                r"\d?\d(~\d\d)?\s\d?\d(~\d\d)?\t",
53
140
                cron_daily_timestamp + "\t",
54
141
                cron_daily[0],
55
136
            )
142
            )
63
137
            data = data.replace(cron_daily[0], updated_cron_daily)
143
            updated_data = data.replace(cron_daily[0], updated_cron_daily)
64
138
            with open(r"/tmp/crontab", "w") as crontab:
144
            with open(r"/etc/crontab", "w") as crontab:
65
139
                crontab.write(data)
145
                crontab.write(updated_data)
59
140
60
141
            subprocess.check_output(["sudo", "crontab", "-u", "root", "/tmp/crontab"])
61
142
62
143
        return updated_cron_daily
66
144
146
67
145
    def validate_cron_conf(self):
147
    def validate_cron_conf(self):
68
146
        """Block the unit and exit the hook if there is invalid configuration."""
148
        """Block the unit and exit the hook if there is invalid configuration."""
69
diff --git a/src/tests/functional/requirements.txt b/src/tests/functional/requirements.txt
70
index 6c4de97..4128a5d 100644
71
--- a/src/tests/functional/requirements.txt
72
+++ b/src/tests/functional/requirements.txt
73
@@ -7,3 +7,4 @@ mock
74
7
pytest
7
pytest
75
8
pytest-asyncio
8
pytest-asyncio
76
9
requests
9
requests
77
10
tenacity
78
diff --git a/src/tests/functional/test_logrotate.py b/src/tests/functional/test_logrotate.py
79
index 0afbb82..7088371 100644
80
--- a/src/tests/functional/test_logrotate.py
81
+++ b/src/tests/functional/test_logrotate.py
82
@@ -9,6 +9,8 @@ import pytest
83
9
9
84
10
import pytest_asyncio
10
import pytest_asyncio
85
11
11
86
12
import tenacity
87
13
88
12
pytestmark = pytest.mark.asyncio
14
pytestmark = pytest.mark.asyncio
89
13
SERIES = ["bionic", "focal", "jammy"]
15
SERIES = ["bionic", "focal", "jammy"]
90
14
16
91
@@ -118,10 +120,17 @@ async def test_reconfigure_cronjob_frequency(model, deploy_app, unit, jujutools)
92
118
    await model.block_until(lambda: deploy_app.status == "active")
120
    await model.block_until(lambda: deploy_app.status == "active")
93
119
    config = await deploy_app.get_config()
121
    config = await deploy_app.get_config()
94
120
122
99
121
    result = await jujutools.run_command(
123
    # Retry because test fails sometimes when cron file isn't ready yet
100
122
        "test -f /etc/cron.weekly/charm-logrotate", unit
124
    for attempt in tenacity.Retrying(
101
123
    )
125
        stop=tenacity.stop_after_attempt(3),
102
124
    weekly_cronjob_exists = result["return-code"] == 0
126
        wait=tenacity.wait_exponential(multiplier=1, min=2, max=10),
103
127
    ):
104
128
        with attempt:
105
129
            result = await jujutools.run_command(
106
130
                "test -f /etc/cron.weekly/charm-logrotate", unit
107
131
            )
108
132
            weekly_cronjob_exists = result["return-code"] == 0
109
133
            assert weekly_cronjob_exists
110
125
134
111
126
    result = await jujutools.run_command(
135
    result = await jujutools.run_command(
112
127
        "test -f /etc/cron.daily/charm-logrotate", unit
136
        "test -f /etc/cron.daily/charm-logrotate", unit
113
@@ -130,7 +139,6 @@ async def test_reconfigure_cronjob_frequency(model, deploy_app, unit, jujutools)
114
130
139
115
131
    assert config["logrotate-cronjob-frequency"]["value"] == "weekly"
140
    assert config["logrotate-cronjob-frequency"]["value"] == "weekly"
116
132
    assert not daily_cronjob_exists
141
    assert not daily_cronjob_exists
117
133
    assert weekly_cronjob_exists
118
134
142
119
135
143
120
136
async def test_configure_override_01(model, deploy_app, jujutools, unit):
144
async def test_configure_override_01(model, deploy_app, jujutools, unit):
121
diff --git a/src/tests/unit/test_logrotate.py b/src/tests/unit/test_logrotate.py
122
index 8d329e5..3af2c13 100644
123
--- a/src/tests/unit/test_logrotate.py
124
+++ b/src/tests/unit/test_logrotate.py
125
@@ -245,18 +245,54 @@ class TestCronHelper:
126
245
            ("unset", "25 6"),
245
            ("unset", "25 6"),
127
246
        ],
246
        ],
128
247
    )
247
    )
130
248
    def test_cron_daily_schedule(self, cron, cron_schedule, exp_pattern):
248
    def test_cron_daily_schedule(self, cron, cron_schedule, exp_pattern, mocker):
131
249
        """Test the validate and update random cron.daily schedule."""
249
        """Test the validate and update random cron.daily schedule."""
132
250
        cron_config = cron()
250
        cron_config = cron()
133
251
        cron_config.cronjob_enabled = True
251
        cron_config.cronjob_enabled = True
134
252
        cron_config.cronjob_frequency = 1
252
        cron_config.cronjob_frequency = 1
135
253
        cron_config.cron_daily_schedule = cron_schedule
253
        cron_config.cron_daily_schedule = cron_schedule
136
254
254
138
255
        assert cron_config.validate_cron_conf()
255
        mock_method = mocker.Mock()
139
256
        mocker.patch.object(cron, "write_to_crontab", new=mock_method)
140
256
257
141
257
        updated_cron_daily = cron_config.update_cron_daily_schedule()
258
        updated_cron_daily = cron_config.update_cron_daily_schedule()
142
258
259
143
260
        assert cron_config.validate_cron_conf()
144
259
        assert updated_cron_daily.split("\t")[0] == exp_pattern
261
        assert updated_cron_daily.split("\t")[0] == exp_pattern
145
262
        mock_method.assert_called_once_with(exp_pattern)
146
263
147
264
    @pytest.mark.parametrize("cron_daily_timestamp", ["00 08", "25 6", "00~50 06~07"])
148
265
    def test_write_to_crontab(self, cron, cron_daily_timestamp, mocker):
149
266
        """Test function that writes updated data to /etc/crontab."""
150
267
        cron_config = cron()
151
268
        mock_open = mocker.patch("lib_cron.open")
152
269
        mock_handle = mock_open.return_value.__enter__.return_value
153
270
        default_crontab_contents = dedent(
154
271
            """
155
272
            # some comment
156
273
            17 *\t* * * root cd / && run-parts --report /etc/cron.hourly
157
274
            25 6\t* * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )
158
275
            47 6\t* * 7 root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )
159
276
            52 6\t1 * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )
160
277
            #
161
278
            """  # noqa
162
279
        )
163
280
        updated_crontab_contents = dedent(
164
281
            f"""
165
282
            # some comment
166
283
            17 *\t* * * root cd / && run-parts --report /etc/cron.hourly
167
284
            {cron_daily_timestamp}\t* * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )
168
285
            47 6\t* * 7 root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )
169
286
            52 6\t1 * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )
170
287
            #
171
288
            """  # noqa
172
289
        )
173
290
        mock_handle.read.return_value = default_crontab_contents
174
291
        cron_config.write_to_crontab(cron_daily_timestamp)
175
292
176
293
        mock_open.assert_any_call("/etc/crontab", "r")
177
294
        mock_open.assert_any_call("/etc/crontab", "w")
178
295
        mock_handle.write.assert_called_with(updated_crontab_contents)
179
260
296
180
261
    @pytest.mark.parametrize(
297
    @pytest.mark.parametrize(
181
262
        ("cron_schedule"),
298
        ("cron_schedule"),
182
@@ -293,8 +329,7 @@ class TestCronHelper:
183
293
        )
329
        )
184
294
        mocker.patch("lib_cron.os.getcwd", return_value=mock_charm_dir)
330
        mocker.patch("lib_cron.os.getcwd", return_value=mock_charm_dir)
185
295
        mock_open = mocker.patch("lib_cron.open")
331
        mock_open = mocker.patch("lib_cron.open")
188
296
        mock_handle = mock_open.return_value
332
        mock_handle = mock_open.return_value.__enter__.return_value
187
297
189
298
        expected_files_to_be_removed = [
333
        expected_files_to_be_removed = [
190
299
            "/etc/cron.hourly/charm-logrotate",
334
            "/etc/cron.hourly/charm-logrotate",
191
300
            "/etc/cron.daily/charm-logrotate",
335
            "/etc/cron.daily/charm-logrotate",
192
@@ -322,8 +357,7 @@ class TestCronHelper:
193
322
                """  # noqa
357
                """  # noqa
194
323
            )
358
            )
195
324
        )
359
        )
198
325
        mock_handle.close.assert_called_once()
360
        mock_chmod.assert_called_once_with("/etc/cron.weekly/charm-logrotate", 0o755)
197
326
        mock_chmod.assert_called_once_with("/etc/cron.weekly/charm-logrotate", 700)
199
327
361
200
328
    def test_install_cronjob_removes_etc_config_when_cronjob_disabled(
362
    def test_install_cronjob_removes_etc_config_when_cronjob_disabled(
201
329
        self, cron, mocker
363
        self, cron, mocker
Reviewer	Review Type	Date Requested	Status
JamesLin		2023-05-19	Approve on 2023-05-19
🤖 prod-jenkaas-bootstack (community)	continuous-integration	2023-05-19	Approve on 2023-05-19
Chi Wai CHAN		2023-05-19	Needs Information on 2023-05-19
Eric Chen		2023-05-19	Approve on 2023-05-19
BootStack Reviewers		2023-05-19	Pending
BootStack Reviewers		2023-05-19	Pending
Robert Gildein		2023-05-19	Pending
Tianqi Xiao		2023-05-19	Pending
Review via email: mp+443242@code.launchpad.net