oeqa: runtime: Clean setup/tear down function on weston and logrotate
cover oeqa: runtime: Clean setup/tear down function on weston and logrotate
This was discussed on my previous series, introducing a new error on SSH connection failure during tests: setup and tear down functions should only do simple operations and not try to interact with the target.
---
Mathieu Dubois-Briand (3):
oeqa: runtime: logrotate: Fix typos and add comments
oeqa: runtime: logrotate: Remove setup and tear down methods
oeqa: runtime: weston: Remove tear down method
meta/lib/oeqa/runtime/cases/logrotate.py | 99 +++++++++++++++++--------------- meta/lib/oeqa/runtime/cases/weston.py | 5 +- 2 files changed, 53 insertions(+), 51 deletions(-)
---
base-commit: 3fc1fa77dae8d138c9a0bf47172d978812b593b3
change-id: 20251013-mathieu-test-clean-setup-6eec6fcc734d
Best regards,
Signature · 1 line
Mathieu Dubois-Briand <[email protected]>
PATCH 1/3 oeqa: runtime: logrotate: Fix typos and add comments
--- meta/lib/oeqa/runtime/cases/logrotate.py | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-)
meta/lib/oeqa/runtime/cases/logrotate.py +16 -15
@@ -20,55 +20,56 @@ class LogrotateTest(OERuntimeTestCase): @classmethod def tearDownClass(cls): - cls.tc.target.run('mv -f $HOME/wtmp.oeqabak /etc/logrotate.d/wtmp && rm -rf /var/log//logrotate_dir', ignore_ssh_fails=True) + cls.tc.target.run('mv -f $HOME/wtmp.oeqabak /etc/logrotate.d/wtmp && rm -rf /var/log/logrotate_dir', ignore_ssh_fails=True) cls.tc.target.run('rm -rf /var/log/logrotate_testfile && rm -rf /etc/logrotate.d/logrotate_testfile', ignore_ssh_fails=True) @OETestDepends(['ssh.SSHTest.test_ssh']) @OEHasPackage(['logrotate']) def test_logrotate_wtmp(self): - # /var/log/wtmp may not always exist initially, so use touch to ensure it is present status, output = self.target.run('touch /var/log/wtmp') msg = ('Could not create/update /var/log/wtmp with touch') self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('mkdir /var/log//logrotate_dir') + # Create a folder to store rotated file and add the corresponding + # configuration option + status, output = self.target.run('mkdir /var/log/logrotate_dir') msg = ('Could not create logrotate_dir. Output: %s' % output) self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('echo "create \n olddir /var/log//logrotate_dir \n include /etc/logrotate.d/wtmp" > /tmp/logrotate-test.conf') + status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/wtmp" > /tmp/logrotate-test.conf') msg = ('Could not write to /tmp/logrotate-test.conf') self.assertEqual(status, 0, msg = msg) - + + # Call logrotate -f to force the rotation immediately # If logrotate fails to rotate the log, view the verbose output of logrotate to see what prevented it _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test.conf') - status, _ = self.target.run('find /var/log//logrotate_dir -type f | grep wtmp.1') + status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep wtmp.1') msg = ("logrotate did not successfully rotate the wtmp log. Output from logrotate -vf: \n%s" % (logrotate_output)) self.assertEqual(status, 0, msg = msg) - + @OETestDepends(['logrotate.LogrotateTest.test_logrotate_wtmp']) def test_logrotate_newlog(self): - status, output = self.target.run('echo "oeqa logrotate test file" > /var/log/logrotate_testfile') msg = ('Could not create logrotate test file in /var/log') self.assertEqual(status, 0, msg = msg) - - status, output = self.target.run('echo "/var/log/logrotate_testfile {\n missingok \n monthly \n rotate 1" > /etc/logrotate.d/logrotate_testfile') + + # Create a new configuration file dedicated to a /var/log/logrotate_testfile + status, output = self.target.run('echo "/var/log/logrotate_testfile {\n missingok \n monthly \n rotate 1}" > /etc/logrotate.d/logrotate_testfile') msg = ('Could not write to /etc/logrotate.d/logrotate_testfile') self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('echo "create \n olddir /var/log//logrotate_dir \n include /etc/logrotate.d/logrotate_testfile" > /tmp/logrotate-test2.conf') + status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/logrotate_testfile" > /tmp/logrotate-test2.conf') msg = ('Could not write to /tmp/logrotate_test2.conf') self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('find /var/log//logrotate_dir -type f | grep logrotate_testfile.1') + status, output = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') msg = ('A rotated log for logrotate_testfile is already present in logrotate_dir') self.assertEqual(status, 1, msg = msg) + # Call logrotate -f to force the rotation immediately # If logrotate fails to rotate the log, view the verbose output of logrotate instead of just listing the files in olddir _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test2.conf') - status, _ = self.target.run('find /var/log//logrotate_dir -type f | grep logrotate_testfile.1') + status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') msg = ('logrotate did not successfully rotate the logrotate_test log. Output from logrotate -vf: \n%s' % (logrotate_output)) self.assertEqual(status, 0, msg = msg) - -
Signature · 1 line
2.47.3
PATCH 2/3 oeqa: runtime: logrotate: Remove setup and tear down methods
In reply to Mathieu Dubois-BriandSetup and tear down methods are executed even when the tests are disabled. This lead to SSH being used to run commands on the target, and as it might fail when no SSH server is present, we had to use ignore_ssh_fails=True here.
Instead, run cleanup tasks in tests themselves and remove the tear down method.
Also, the wtmp configuration file is not modified since the test was modified a few years ago: there is no need to backup and restore it.
--- meta/lib/oeqa/runtime/cases/logrotate.py | 100 ++++++++++++++++--------------- 1 file changed, 52 insertions(+), 48 deletions(-)
meta/lib/oeqa/runtime/cases/logrotate.py +52 -48
@@ -12,64 +12,68 @@ from oeqa.core.decorator.depends import OETestDepends from oeqa.runtime.decorator.package import OEHasPackage class LogrotateTest(OERuntimeTestCase): - - @classmethod - def setUpClass(cls): - cls.tc.target.run('cp /etc/logrotate.d/wtmp $HOME/wtmp.oeqabak', - ignore_ssh_fails=True) - - @classmethod - def tearDownClass(cls): - cls.tc.target.run('mv -f $HOME/wtmp.oeqabak /etc/logrotate.d/wtmp && rm -rf /var/log/logrotate_dir', ignore_ssh_fails=True) - cls.tc.target.run('rm -rf /var/log/logrotate_testfile && rm -rf /etc/logrotate.d/logrotate_testfile', ignore_ssh_fails=True) - @OETestDepends(['ssh.SSHTest.test_ssh']) @OEHasPackage(['logrotate']) def test_logrotate_wtmp(self): - # /var/log/wtmp may not always exist initially, so use touch to ensure it is present - status, output = self.target.run('touch /var/log/wtmp') - msg = ('Could not create/update /var/log/wtmp with touch') - self.assertEqual(status, 0, msg = msg) + try: + # /var/log/wtmp may not always exist initially, so use touch to ensure it is present + status, output = self.target.run('touch /var/log/wtmp') + msg = ('Could not create/update /var/log/wtmp with touch') + self.assertEqual(status, 0, msg = msg) - # Create a folder to store rotated file and add the corresponding - # configuration option - status, output = self.target.run('mkdir /var/log/logrotate_dir') - msg = ('Could not create logrotate_dir. Output: %s' % output) - self.assertEqual(status, 0, msg = msg) + # Create a folder to store rotated file and add the corresponding + # configuration option + status, output = self.target.run('mkdir /var/log/logrotate_dir') + msg = ('Could not create logrotate_dir. Output: %s' % output) + self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/wtmp" > /tmp/logrotate-test.conf') - msg = ('Could not write to /tmp/logrotate-test.conf') - self.assertEqual(status, 0, msg = msg) + status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/wtmp" > /tmp/logrotate-test.conf') + msg = ('Could not write to /tmp/logrotate-test.conf') + self.assertEqual(status, 0, msg = msg) - # Call logrotate -f to force the rotation immediately - # If logrotate fails to rotate the log, view the verbose output of logrotate to see what prevented it - _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test.conf') - status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep wtmp.1') - msg = ("logrotate did not successfully rotate the wtmp log. Output from logrotate -vf: \n%s" % (logrotate_output)) - self.assertEqual(status, 0, msg = msg) + # Call logrotate -f to force the rotation immediately + # If logrotate fails to rotate the log, view the verbose output of logrotate to see what prevented it + _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test.conf') + status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep wtmp.1') + msg = ("logrotate did not successfully rotate the wtmp log. Output from logrotate -vf: \n%s" % (logrotate_output)) + self.assertEqual(status, 0, msg = msg) + + finally: + # Clean files created in the test + self.target.run('rm -rf /var/log/logrotate_dir') @OETestDepends(['logrotate.LogrotateTest.test_logrotate_wtmp']) def test_logrotate_newlog(self): - status, output = self.target.run('echo "oeqa logrotate test file" > /var/log/logrotate_testfile') - msg = ('Could not create logrotate test file in /var/log') - self.assertEqual(status, 0, msg = msg) + try: + status, output = self.target.run('echo "oeqa logrotate test file" > /var/log/logrotate_testfile') + msg = ('Could not create logrotate test file in /var/log') + self.assertEqual(status, 0, msg = msg) + + # Create a new configuration file dedicated to a /var/log/logrotate_testfile + status, output = self.target.run('echo "/var/log/logrotate_testfile {\n missingok \n monthly \n rotate 1}" > /etc/logrotate.d/logrotate_testfile') + msg = ('Could not write to /etc/logrotate.d/logrotate_testfile') + self.assertEqual(status, 0, msg = msg) + + status, output = self.target.run('mkdir /var/log/logrotate_dir') + msg = ('Could not create logrotate_dir. Output: %s' % output) + self.assertEqual(status, 0, msg = msg) - # Create a new configuration file dedicated to a /var/log/logrotate_testfile - status, output = self.target.run('echo "/var/log/logrotate_testfile {\n missingok \n monthly \n rotate 1}" > /etc/logrotate.d/logrotate_testfile') - msg = ('Could not write to /etc/logrotate.d/logrotate_testfile') - self.assertEqual(status, 0, msg = msg) + status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/logrotate_testfile" > /tmp/logrotate-test2.conf') + msg = ('Could not write to /tmp/logrotate_test2.conf') + self.assertEqual(status, 0, msg = msg) - status, output = self.target.run('echo "create \n olddir /var/log/logrotate_dir \n include /etc/logrotate.d/logrotate_testfile" > /tmp/logrotate-test2.conf') - msg = ('Could not write to /tmp/logrotate_test2.conf') - self.assertEqual(status, 0, msg = msg) + status, output = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') + msg = ('A rotated log for logrotate_testfile is already present in logrotate_dir') + self.assertEqual(status, 1, msg = msg) - status, output = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') - msg = ('A rotated log for logrotate_testfile is already present in logrotate_dir') - self.assertEqual(status, 1, msg = msg) + # Call logrotate -f to force the rotation immediately + # If logrotate fails to rotate the log, view the verbose output of logrotate instead of just listing the files in olddir + _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test2.conf') + status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') + msg = ('logrotate did not successfully rotate the logrotate_test log. Output from logrotate -vf: \n%s' % (logrotate_output)) + self.assertEqual(status, 0, msg = msg) - # Call logrotate -f to force the rotation immediately - # If logrotate fails to rotate the log, view the verbose output of logrotate instead of just listing the files in olddir - _, logrotate_output = self.target.run('logrotate -vf /tmp/logrotate-test2.conf') - status, _ = self.target.run('find /var/log/logrotate_dir -type f | grep logrotate_testfile.1') - msg = ('logrotate did not successfully rotate the logrotate_test log. Output from logrotate -vf: \n%s' % (logrotate_output)) - self.assertEqual(status, 0, msg = msg) + finally: + # Clean files created in the test + self.target.run('rm -rf /var/log/logrotate_dir') + self.target.run('rm -rf /var/log/logrotate_testfile && rm -rf /etc/logrotate.d/logrotate_testfile')
Signature · 1 line
2.47.3
PATCH 3/3 oeqa: runtime: weston: Remove tear down method
In reply to Mathieu Dubois-BriandTear down method is executed even when the tests are disabled. This lead to SSH being used to run commands on the target, and as it might fail when no SSH server is present, we had to use ignore_ssh_fails=True here.
Instead, remove log file just before it is created: it will remain on the target after the test is run, but this should be acceptable.
--- meta/lib/oeqa/runtime/cases/weston.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-)
meta/lib/oeqa/runtime/cases/weston.py +1 -4
@@ -14,10 +14,6 @@ import time class WestonTest(OERuntimeTestCase): weston_log_file = '/tmp/weston-2.log' - @classmethod - def tearDownClass(cls): - cls.tc.target.run('rm %s' % cls.weston_log_file, ignore_ssh_fails=True) - @OETestDepends(['ssh.SSHTest.test_ssh']) @OEHasPackage(['weston']) def test_weston_running(self):
@@ -36,6 +32,7 @@ class WestonTest(OERuntimeTestCase): return 'export XDG_RUNTIME_DIR=/run/user/`id -u weston`; export WAYLAND_DISPLAY=wayland-1; %s' % cmd def run_weston_init(self): + self.target.run('rm -f %s' % self.weston_log_file) if 'systemd' in self.tc.td['VIRTUAL-RUNTIME_init_manager']: self.target.run('systemd-run --collect --unit=weston-ptest.service --uid=0 -p PAMName=login -p TTYPath=/dev/tty6 -E XDG_RUNTIME_DIR=/tmp -E WAYLAND_DISPLAY=wayland-0 /usr/bin/weston --socket=wayland-1 --log=%s' % self.weston_log_file) else:
Signature · 1 line
2.47.3