1#
2# SPDX-License-Identifier: MIT
3#
4
5# This test should cover https://bugzilla.yoctoproject.org/tr_show_case.cgi?case_id=289 testcase
6# Note that the image under test must have logrotate installed
7
8from oeqa.runtime.case import OERuntimeTestCase
9from oeqa.core.decorator.depends import OETestDepends
10from oeqa.runtime.decorator.package import OEHasPackage
11
12class LogrotateTest(OERuntimeTestCase):
13
14    @classmethod
15    def setUpClass(cls):
16        cls.tc.target.run('cp /etc/logrotate.d/wtmp $HOME/wtmp.oeqabak')
17
18    @classmethod
19    def tearDownClass(cls):
20        cls.tc.target.run('mv -f $HOME/wtmp.oeqabak /etc/logrotate.d/wtmp && rm -rf /var/log//logrotate_dir')
21        cls.tc.target.run('rm -rf /var/log/logrotate_testfile && rm -rf /etc/logrotate.d/logrotate_testfile')
22
23    @OETestDepends(['ssh.SSHTest.test_ssh'])
24    @OEHasPackage(['logrotate'])
25    def test_logrotate_wtmp(self):
26
27        # /var/log/wtmp may not always exist initially, so use touch to ensure it is present
28        status, output = self.target.run('touch /var/log/wtmp')
29        msg = ('Could not create/update /var/log/wtmp with touch')
30        self.assertEqual(status, 0, msg = msg)
31
32        status, output = self.target.run('mkdir /var/log//logrotate_dir')
33        msg = ('Could not create logrotate_dir. Output: %s' % output)
34        self.assertEqual(status, 0, msg = msg)
35
36        status, output = self.target.run('echo "create \n olddir /var/log//logrotate_dir \n include /etc/logrotate.d/wtmp" > /tmp/logrotate-test.conf')
37        msg = ('Could not write to /tmp/logrotate-test.conf')
38        self.assertEqual(status, 0, msg = msg)
39
40        # If logrotate fails to rotate the log, view the verbose output of logrotate to see what prevented it
41        _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test.conf')
42        status, _ = self.target.run('find /var/log//logrotate_dir -type f | grep wtmp.1')
43        msg = ("logrotate did not successfully rotate the wtmp log. Output from logrotate -vf: \n%s" % (logrotate_output))
44        self.assertEqual(status, 0, msg = msg)
45
46    @OETestDepends(['logrotate.LogrotateTest.test_logrotate_wtmp'])
47    def test_logrotate_newlog(self):
48
49        status, output = self.target.run('echo "oeqa logrotate test file" > /var/log/logrotate_testfile')
50        msg = ('Could not create logrotate test file in /var/log')
51        self.assertEqual(status, 0, msg = msg)
52
53        status, output = self.target.run('echo "/var/log/logrotate_testfile {\n missingok \n monthly \n rotate 1" > /etc/logrotate.d/logrotate_testfile')
54        msg = ('Could not write to /etc/logrotate.d/logrotate_testfile')
55        self.assertEqual(status, 0, msg = msg)
56
57        status, output = self.target.run('echo "create \n olddir /var/log//logrotate_dir \n include /etc/logrotate.d/logrotate_testfile" > /tmp/logrotate-test2.conf')
58        msg = ('Could not write to /tmp/logrotate_test2.conf')
59        self.assertEqual(status, 0, msg = msg)
60
61        status, output = self.target.run('find /var/log//logrotate_dir -type f | grep logrotate_testfile.1')
62        msg = ('A rotated log for logrotate_testfile is already present in logrotate_dir')
63        self.assertEqual(status, 1, msg = msg)
64
65        # If logrotate fails to rotate the log, view the verbose output of logrotate instead of just listing the files in olddir
66        _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test2.conf')
67        status, _ = self.target.run('find /var/log//logrotate_dir -type f | grep logrotate_testfile.1')
68        msg = ('logrotate did not successfully rotate the logrotate_test log. Output from logrotate -vf: \n%s' % (logrotate_output))
69        self.assertEqual(status, 0, msg = msg)
70
71
72