Merge pull request #1221 from Bastian-Krause/bst/barebox-loglevel

driver/bareboxdriver: silence barebox in _await_prompt() and unsilence on boot()

Author: jluebbe

CHANGES.rst

@@ -56,6 +56,8 @@ Breaking changes in 23.1
   slightly. ``-vv`` is now an alias for ``--log-cli-level=INFO`` (effectively
   unchanged), ``-vvv`` is an alias for ``--log-cli-level=CONSOLE``, and
   ``-vvvv`` is an alias for ``--log-cli-level=DEBUG``.
+- The `BareboxDriver` now remembers the log level, sets it to ``0`` on initial
+  activation/reset and recovers it on ``boot()``.
 
 Known issues in 23.1
 ~~~~~~~~~~~~~~~~~~~~

labgrid/driver/bareboxdriver.py

@@ -42,6 +42,8 @@ def __attrs_post_init__(self):
         super().__attrs_post_init__()
         self.logger = logging.getLogger(f"{self}:{self.target}")
         self._status = 0
+        # barebox' default log level, used as fallback if no log level can be saved
+        self.saved_log_level = 7
 
     def on_activate(self):
         """Activate the BareboxDriver
@@ -186,6 +188,18 @@ def _await_prompt(self):
 
         self._check_prompt()
 
+        # remember barebox' log level - we don't expect to be interrupted here
+        # by pollers because no hardware interaction is triggered by echo, so
+        # it should be safe to use the usual shell wrapper via _run()
+        stdout, _, exitcode = self._run("echo $global.loglevel")
+        [saved_log_level] = stdout
+        if exitcode == 0 and saved_log_level.isnumeric():
+            self.saved_log_level = saved_log_level
+
+        # silence barebox, the driver can get confused by asynchronous messages
+        # logged to the console otherwise
+        self._run("global.loglevel=0")
+
     @Driver.check_active
     def await_boot(self):
         """Wait for the initial Linux version string to verify we successfully
@@ -199,6 +213,9 @@ def boot(self, name: str):
 
         Args:
             name (str): name of the entry to boot"""
+        # recover saved log level
+        self._run(f"global.loglevel={self.saved_log_level}")
+
         if name:
             self.console.sendline(f"boot -v {name}")
         else:

tests/test_bareboxdriver.py

@@ -19,7 +19,10 @@ def test_create(self):
     def test_barebox_run(self, target_with_fakeconsole, mocker):
         t = target_with_fakeconsole
         d = BareboxDriver(t, "barebox")
-        d = t.get_driver(BareboxDriver)
+        d = t.get_driver(BareboxDriver, activate=False)
+        # mock for d._run('echo $global.loglevel')
+        d._run = mocker.MagicMock(return_value=(['7'], [], 0))
+        t.activate(d)
         d._run = mocker.MagicMock(return_value=(['success'], [], 0))
         res = d.run_check("test")
         assert res == ['success']
@@ -29,7 +32,10 @@ def test_barebox_run(self, target_with_fakeconsole, mocker):
     def test_barebox_run_error(self, target_with_fakeconsole, mocker):
         t = target_with_fakeconsole
         d = BareboxDriver(t, "barebox")
-        d = t.get_driver(BareboxDriver)
+        d = t.get_driver(BareboxDriver, activate=False)
+        # mock for d._run('echo $global.loglevel')
+        d._run = mocker.MagicMock(return_value=(['7'], [], 0))
+        t.activate(d)
         d._run = mocker.MagicMock(return_value=(['error'], [], 1))
         with pytest.raises(ExecutionError):
             res = d.run_check("test")