| Message ID | 20210211220146.2525771-6-crosa@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Python / Acceptance Tests: improve logging | expand |
Hi, On 2/11/21 7:01 PM, Cleber Rosa wrote: > Logs can be very important to debug issues, and currently QEMUMachine > instances will remove logs that are created under the temporary > directories. > > With this change, the stdout and stderr generated by the QEMU process > started by QEMUMachine will always be kept along the test results > directory. > > Signed-off-by: Cleber Rosa <crosa@redhat.com> > --- > python/qemu/machine.py | 16 ++++++++++++++-- > tests/acceptance/avocado_qemu/__init__.py | 3 ++- > 2 files changed, 16 insertions(+), 3 deletions(-) > > diff --git a/python/qemu/machine.py b/python/qemu/machine.py > index b379fcbe72..1f4119e2b4 100644 > --- a/python/qemu/machine.py > +++ b/python/qemu/machine.py > @@ -89,7 +89,8 @@ class QEMUMachine: > socket_scm_helper: Optional[str] = None, > sock_dir: Optional[str] = None, > drain_console: bool = False, > - console_log: Optional[str] = None): > + console_log: Optional[str] = None, > + log_dir: Optional[str] = None): > ''' > Initialize a QEMUMachine > > @@ -103,6 +104,7 @@ class QEMUMachine: > @param sock_dir: where to create socket (defaults to base_temp_dir) > @param drain_console: (optional) True to drain console socket to buffer > @param console_log: (optional) path to console log file > + @param log_dir: where to create and keep log files "(optional) where to create and keep (...)". You could also say it defaults to the temp dir, thus logs aren't kept guaranteed. Otherwise, Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com> > @note: Qemu process is not started until launch() is used. > ''' > # Direct user configuration > @@ -114,6 +116,7 @@ class QEMUMachine: > self._name = name or "qemu-%d" % os.getpid() > self._base_temp_dir = base_temp_dir > self._sock_dir = sock_dir or self._base_temp_dir > + self._log_dir = log_dir > self._socket_scm_helper = socket_scm_helper > > if monitor_address is not None: > @@ -303,7 +306,7 @@ class QEMUMachine: > return args > > def _pre_launch(self) -> None: > - self._qemu_log_path = os.path.join(self.temp_dir, self._name + ".log") > + self._qemu_log_path = os.path.join(self.log_dir, self._name + ".log") > self._qemu_log_file = open(self._qemu_log_path, 'wb') > > if self._console_set: > @@ -752,3 +755,12 @@ class QEMUMachine: > self._temp_dir = tempfile.mkdtemp(prefix="qemu-machine-", > dir=self._base_temp_dir) > return self._temp_dir > + > + @property > + def log_dir(self) -> str: > + """ > + Returns a directory to be used for writing logs > + """ > + if self._log_dir is None: > + return self.temp_dir > + return self._log_dir > diff --git a/tests/acceptance/avocado_qemu/__init__.py b/tests/acceptance/avocado_qemu/__init__.py > index 94b78fd7c8..ac9be1eb66 100644 > --- a/tests/acceptance/avocado_qemu/__init__.py > +++ b/tests/acceptance/avocado_qemu/__init__.py > @@ -173,9 +173,10 @@ class Test(avocado.Test): > def _new_vm(self, name, *args): > self._sd = tempfile.TemporaryDirectory(prefix="avo_qemu_sock_") > vm = QEMUMachine(self.qemu_bin, base_temp_dir=self.workdir, > - sock_dir=self._sd.name) > + sock_dir=self._sd.name, log_dir=self.logdir) > self.log.debug('QEMUMachine "%s" created', name) > self.log.debug('QEMUMachine "%s" temp_dir: %s', name, vm.temp_dir) > + self.log.debug('QEMUMachine "%s" log_dir: %s', name, vm.log_dir) > if args: > vm.add_args(*args) > return vm
diff --git a/python/qemu/machine.py b/python/qemu/machine.py index b379fcbe72..1f4119e2b4 100644 --- a/python/qemu/machine.py +++ b/python/qemu/machine.py @@ -89,7 +89,8 @@ class QEMUMachine: socket_scm_helper: Optional[str] = None, sock_dir: Optional[str] = None, drain_console: bool = False, - console_log: Optional[str] = None): + console_log: Optional[str] = None, + log_dir: Optional[str] = None): ''' Initialize a QEMUMachine @@ -103,6 +104,7 @@ class QEMUMachine: @param sock_dir: where to create socket (defaults to base_temp_dir) @param drain_console: (optional) True to drain console socket to buffer @param console_log: (optional) path to console log file + @param log_dir: where to create and keep log files @note: Qemu process is not started until launch() is used. ''' # Direct user configuration @@ -114,6 +116,7 @@ class QEMUMachine: self._name = name or "qemu-%d" % os.getpid() self._base_temp_dir = base_temp_dir self._sock_dir = sock_dir or self._base_temp_dir + self._log_dir = log_dir self._socket_scm_helper = socket_scm_helper if monitor_address is not None: @@ -303,7 +306,7 @@ class QEMUMachine: return args def _pre_launch(self) -> None: - self._qemu_log_path = os.path.join(self.temp_dir, self._name + ".log") + self._qemu_log_path = os.path.join(self.log_dir, self._name + ".log") self._qemu_log_file = open(self._qemu_log_path, 'wb') if self._console_set: @@ -752,3 +755,12 @@ class QEMUMachine: self._temp_dir = tempfile.mkdtemp(prefix="qemu-machine-", dir=self._base_temp_dir) return self._temp_dir + + @property + def log_dir(self) -> str: + """ + Returns a directory to be used for writing logs + """ + if self._log_dir is None: + return self.temp_dir + return self._log_dir diff --git a/tests/acceptance/avocado_qemu/__init__.py b/tests/acceptance/avocado_qemu/__init__.py index 94b78fd7c8..ac9be1eb66 100644 --- a/tests/acceptance/avocado_qemu/__init__.py +++ b/tests/acceptance/avocado_qemu/__init__.py @@ -173,9 +173,10 @@ class Test(avocado.Test): def _new_vm(self, name, *args): self._sd = tempfile.TemporaryDirectory(prefix="avo_qemu_sock_") vm = QEMUMachine(self.qemu_bin, base_temp_dir=self.workdir, - sock_dir=self._sd.name) + sock_dir=self._sd.name, log_dir=self.logdir) self.log.debug('QEMUMachine "%s" created', name) self.log.debug('QEMUMachine "%s" temp_dir: %s', name, vm.temp_dir) + self.log.debug('QEMUMachine "%s" log_dir: %s', name, vm.log_dir) if args: vm.add_args(*args) return vm
Logs can be very important to debug issues, and currently QEMUMachine instances will remove logs that are created under the temporary directories. With this change, the stdout and stderr generated by the QEMU process started by QEMUMachine will always be kept along the test results directory. Signed-off-by: Cleber Rosa <crosa@redhat.com> --- python/qemu/machine.py | 16 ++++++++++++++-- tests/acceptance/avocado_qemu/__init__.py | 3 ++- 2 files changed, 16 insertions(+), 3 deletions(-)