squash:update

Author: skycastlelily

tmt/steps/provision/__init__.py

@@ -8,7 +8,6 @@
 import re
 import secrets
 import shlex
-import shutil
 import signal as _signal
 import string
 import subprocess
@@ -57,7 +56,6 @@
     ProvisionError,
     ShellScript,
     configure_constant,
-    create_directory,
     effective_workdir_root,
 )
 
@@ -981,14 +979,33 @@ def show(
 class GuestLog:
     name: str
 
-    def fetch(self) -> Optional[str]:
+    def fetch(self) -> str:
         """
         Fetch and return content of a log.
 
         :returns: content of the log, or ``None`` if the log cannot be retrieved.
         """
         raise NotImplementedError
 
+    def store(self, path: Path, logname: Optional[str] = None) -> None:
+        """
+        Save log content to a file.
+
+        :param path: a path to save into, could be a directory
+            or a file path.
+        :param content: content of the log.
+        :param logname: name of the log, if not set, logpath
+            is supposed to be a file path.
+        """
+        # if path is file path
+        if not path.is_dir():
+            path.write_text(self.fetch())
+        # if path is a directory
+        elif logname:
+            (path / logname).write_text(self.fetch())
+        else:
+            raise tmt.utils.GeneralError('Log path is a directory but log name is not defined.')
+
 
 class Guest(tmt.utils.Common):
     """
@@ -1031,8 +1048,6 @@ def get_data_class(cls) -> type[GuestData]:
     #: Guest topology hostname or IP address for guest/guest communication.
     topology_address: Optional[str] = None
 
-    guest_logs: list[GuestLog] = []
-
     become: bool
 
     hardware: Optional[tmt.hardware.Hardware]
@@ -1058,6 +1073,7 @@ def __init__(
         """
         Initialize guest data
         """
+        self.guest_logs: list[GuestLog] = []
 
         super().__init__(logger=logger, parent=parent, name=name)
         self.load(data)
@@ -1719,33 +1735,12 @@ def essential_requires(cls) -> list['tmt.base.Dependency']:
 
         return []
 
-    def acquire_log(self, logname: str) -> Optional[str]:
-        """
-        Fetch and return content of a log.
-
-        :param logname: name of the log.
-        :returns: content of the log, or ``None`` if the log cannot be retrieved.
-        """
-        raise NotImplementedError
-
-    def store_log(self, path: Path, content: str, logname: Optional[str] = None) -> None:
+    @property
+    def logdir(self) -> Optional[Path]:
         """
-        Save log content to a file.
-
-        :param path: a path to save into, could be a directory
-            or a file path.
-        :param content: content of the log.
-        :param logname: name of the log, if not set, logpath
-            is supposed to be a file path.
+        Path to store logs
         """
-        # if path is file path
-        if not path.is_dir():
-            path.write_text(content)
-        # if path is a directory
-        elif logname:
-            (path / logname).write_text(content)
-        else:
-            raise tmt.utils.GeneralError('Log path is a directory but log name is not defined.')
+        return self.workdir / 'logs' if self.workdir else None
 
     def fetch_logs(
         self, dirpath: Optional[Path] = None, guest_logs: Optional[list[GuestLog]] = None
@@ -1761,17 +1756,11 @@ def fetch_logs(
 
         guest_logs = guest_logs or self.guest_logs or []
 
-        dirpath = dirpath or (self.workdir / 'logs' if self.workdir else None) or Path.cwd()
-        if self.workdir and dirpath == self.workdir / 'logs':
-            create_directory(
-                path=self.workdir / 'logs', name='logs workdir', quiet=True, logger=self._logger
-            )
+        dirpath = dirpath or self.logdir or Path.cwd()
+        if dirpath == self.logdir:
+            self.logdir.mkdir(parents=True, exist_ok=True)
         for log in guest_logs:
-            content = log.fetch()
-            if content:
-                self.store_log(dirpath, content, log.name)
-            else:
-                self.store_log(dirpath, '', log.name)
+            log.store(dirpath, log.name)
 
 
 @container
@@ -2809,28 +2798,6 @@ def show(self, keys: Optional[list[str]] = None) -> None:
             if hardware:
                 echo(tmt.utils.format('hardware', tmt.utils.dict_to_yaml(hardware.to_spec())))
 
-    def prune(self, logger: tmt.log.Logger) -> None:
-        """Do not prune logs"""
-        if self.workdir is None:
-            return
-
-        logs_dir = self.workdir / 'logs'
-        if logs_dir.exists():
-            for member in self.workdir.iterdir():
-                if member.name == "logs":
-                    logger.debug(f"Preserve '{member.relative_to(self.workdir)}'.", level=3)
-                    continue
-                logger.debug(f"Remove '{member}'.", level=3)
-                try:
-                    if member.is_file() or member.is_symlink():
-                        member.unlink()
-                    else:
-                        shutil.rmtree(member)
-                except OSError as error:
-                    logger.warning(f"Unable to remove '{member}': {error}")
-        else:
-            super().prune(logger)
-
 
 @container
 class ProvisionTask(tmt.queue.GuestlessTask[None]):

tmt/steps/provision/mrack.py

@@ -1287,9 +1287,12 @@ def get_new_state() -> GuestInspectType:
                 if state == 'Reserved':
                     for key in response["logs"]:
                         self.guest_logs.append(
-                            GuestLogBeaker(self, key.replace('.log', ''), response["logs"][key])
+                            GuestLogBeaker(key.replace('.log', ''), self, response["logs"][key])
                         )
-                    self.guest_logs.append(GuestLogBeaker(self, 'dmesg'))
+                    # console.log contains dmesg, and accessible even when the system is dead.
+                    self.guest_logs.append(
+                        GuestLogBeaker('dmesg', self, response["logs"]["console.log"])
+                    )
                     return current
 
                 raise tmt.utils.WaitingIncompleteError
@@ -1483,18 +1486,14 @@ def guest(self) -> Optional[GuestBeaker]:
 
 @container
 class GuestLogBeaker(tmt.steps.provision.GuestLog):
-    def __init__(self, guest: GuestBeaker, name: str, url: Optional[str] = None) -> None:
-        self.name = name
-        self.url = url
-        self.guest = guest
+    guest: GuestBeaker
+    url: str
 
-    def fetch(self) -> Optional[str]:
+    def fetch(self) -> str:
         """
         Fetch and return content of a log.
 
         :returns: content of the log, or ``None`` if the log cannot be retrieved.
         """
 
-        if self.name == 'dmesg':
-            return self.guest.execute(Command('dmesg')).stdout
-        return tmt.utils.get_url_content(self.url) if self.url else None
+        return tmt.utils.get_url_content(self.url) if self.url else ''