Skip to contentSkip to conversation

oeqa: runtime: Clean setup/tear down function on weston and logrotate

PATCH New Mathieu Dubois-Briand 1 participant 3 messages Oct 16, 2025

lore
Share & tools
lore
#0 lore raw

v2 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.

---
Changes in v2:
- Use addCleanup() method to remove files. I clearly prefer this version
for the logrotate tests. I'm not so sure about the weston tests, as
some file is expected to be kept across tests in some situation and so
lead to some strange logic in my changes.
- Link to v1: https://lore.kernel.org/r/[email protected]

---
Mathieu Dubois-Briand (2):
oeqa: runtime: logrotate: Remove setup and tear down methods
oeqa: runtime: weston: Remove tear down method

 meta/lib/oeqa/runtime/cases/logrotate.py | 19 ++++++++-----------
 meta/lib/oeqa/runtime/cases/weston.py    |  9 +++++----
 2 files changed, 13 insertions(+), 15 deletions(-)

---
base-commit: d098b35cfc3098448bd81245f9593fcd728e4b20
change-id: 20251013-mathieu-test-clean-setup-6eec6fcc734d

Best regards,

Signature · 1 line
Mathieu Dubois-Briand <[email protected]>
#1 lore raw

PATCH v2 1/2 oeqa: runtime: logrotate: Remove setup and tear down methods

Setup 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 | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)
meta/lib/oeqa/runtime/cases/logrotate.py +8 -11
index 0d4b9ac60baa..9fe1170226c8 100644
@@ -12,17 +12,6 @@ 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):
@@ -33,6 +22,7 @@ class LogrotateTest(OERuntimeTestCase):
 
         # Create a folder to store rotated file and add the corresponding
         # configuration option
+        self.addCleanup(self.target.run, 'rm -rf /var/log/logrotate_dir')
         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)
@@ -55,10 +45,17 @@ class LogrotateTest(OERuntimeTestCase):
         self.assertEqual(status, 0, msg = msg)
 
         # Create a new configuration file dedicated to a /var/log/logrotate_testfile
+        self.addCleanup(self.target.run, 'rm -f /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)
 
+        self.addCleanup(self.target.run, 'rm -rf /var/log/logrotate_dir')
+        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)
+
+        self.addCleanup(self.target.run, 'rm -f /etc/logrotate.d/logrotate_testfile')
         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)
Signature · 1 line
2.47.3
#2 lore raw

PATCH v2 2/2 oeqa: runtime: weston: Remove tear down method

In reply to Mathieu Dubois-Briand

Tear 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 | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
meta/lib/oeqa/runtime/cases/weston.py +5 -4
index e2cecffe8353..b0dccee73bf4 100644
@@ -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):
@@ -67,6 +63,10 @@ class WestonTest(OERuntimeTestCase):
         existing_wl_processes = self.get_processes_of('weston-desktop-shell', 'existing')
         existing_weston_processes = self.get_processes_of('weston', 'existing')
 
+        # weston log file should be removed, except if test_weston_supports_xwayland() test has to be run.
+        if 'x11' not in self.td.get('DISTRO_FEATURES'):
+            self.addCleanup(self.target.run, 'rm -f %s' % self.weston_log_file)
+
         weston_thread = threading.Thread(target=self.run_weston_init)
         weston_thread.start()
         new_wl_processes, try_cnt = self.get_new_wayland_processes(existing_wl_processes)
@@ -83,6 +83,7 @@ class WestonTest(OERuntimeTestCase):
     @skipIfNotFeature('x11', 'Test requires x11 to be in DISTRO_FEATURES')
     @OEHasPackage(['weston'])
     def test_weston_supports_xwayland(self):
+        self.addCleanup(self.target.run, 'rm -f %s' % self.weston_log_file)
         cmd ='cat %s | grep "xserver listening on display"' % self.weston_log_file
         status, output = self.target.run(cmd)
         msg = ('xwayland does not appear to be running')
Signature · 1 line
2.47.3