squash:new implementation

Author: skycastlelily

tmt/steps/finish/__init__.py

@@ -226,7 +226,7 @@ def go(self, force: bool = False) -> None:
 
         # Stop and remove provisioned guests
         for guest in self.plan.provision.guests():
-            guest.fetch_logs(lognames=guest.lognames)
+            guest.fetch_logs(guest_logs=guest.guest_logs)
             guest.stop()
             guest.remove()
 

tmt/steps/provision/__init__.py

@@ -8,6 +8,7 @@
 import re
 import secrets
 import shlex
+import shutil
 import signal as _signal
 import string
 import subprocess
@@ -56,6 +57,7 @@
     ProvisionError,
     ShellScript,
     configure_constant,
+    create_directory,
     effective_workdir_root,
 )
 
@@ -952,6 +954,19 @@ def show(
             logger.info(key_to_option(key).replace('-', ' '), printable_value, color='green')
 
 
+@container
+class GuestLog:
+    name: str
+
+    def fetch(self) -> Optional[str]:
+        """
+        Fetch and return content of a log.
+
+        :returns: content of the log, or ``None`` if the log cannot be retrieved.
+        """
+        raise NotImplementedError
+
+
 class Guest(tmt.utils.Common):
     """
     Guest provisioned for test execution
@@ -993,6 +1008,8 @@ 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]
@@ -1090,12 +1107,6 @@ def scripts_path(self) -> Path:
             else tmt.steps.execute.DEFAULT_SCRIPTS_DEST_DIR
         )
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-
-        return []
-
     @classmethod
     def options(cls, how: Optional[str] = None) -> list[tmt.options.ClickOptionDecoratorType]:
         """
@@ -1681,7 +1692,7 @@ def store_log(self, path: Path, content: str, logname: Optional[str] = None) ->
             raise tmt.utils.GeneralError('Log path is a directory but log name is not defined.')
 
     def fetch_logs(
-        self, dirpath: Optional[Path] = None, lognames: Optional[list[str]] = None
+        self, dirpath: Optional[Path] = None, guest_logs: Optional[list[GuestLog]] = None
     ) -> None:
         """
         Get log content and save it to a directory.
@@ -1691,14 +1702,20 @@ def fetch_logs(
         :param lognames: name list of logs need to be handled. If not set, all guest logs
             would be collected, as reported by :py:attr:`lognames`.
         """
-        lognames = lognames or self.lognames
-        dirpath = dirpath or self.workdir or Path.cwd()
-        for logname in lognames:
-            content = self.acquire_log(logname)
+
+        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
+            )
+        for log in guest_logs:
+            content = log.fetch()
             if content:
-                self.store_log(dirpath, content, logname)
+                self.store_log(dirpath, content, log.name)
             else:
-                self.store_log(dirpath, '', logname)
+                self.store_log(dirpath, '', log.name)
 
 
 @container
@@ -2696,6 +2713,28 @@ 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/artemis.py

@@ -493,11 +493,6 @@ def is_ready(self) -> bool:
         #        return True if self.guest is not None
         return self.primary_address is not None
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def _create(self) -> None:
         environment: dict[str, Any] = {
             'hw': {'arch': self.arch},

tmt/steps/provision/connect.py

@@ -85,11 +85,6 @@ class GuestConnect(tmt.steps.provision.GuestSsh):
     soft_reboot: Optional[ShellScript]
     hard_reboot: Optional[ShellScript]
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def reboot(
         self,
         hard: bool = False,

tmt/steps/provision/local.py

@@ -32,11 +32,6 @@ def is_ready(self) -> bool:
 
         return True
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def _run_ansible(
         self,
         playbook: tmt.steps.provision.AnsibleApplicable,
@@ -185,17 +180,6 @@ def pull(
         Nothing to be done to pull workdir
         """
 
-    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.
-        """
-        if logname == 'dmesg':
-            return self.execute(Command('dmesg')).stdout
-        return None
-
 
 @tmt.steps.provides_method('local')
 class ProvisionLocal(tmt.steps.provision.ProvisionPlugin[ProvisionLocalData]):

tmt/steps/provision/mrack.py

@@ -1186,11 +1186,6 @@ def is_ready(self) -> bool:
         except mrack.errors.MrackError:
             return False
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def _create(self, tmt_name: str) -> None:
         """
         Create beaker job xml request and submit it to Beaker hub
@@ -1290,6 +1285,11 @@ def get_new_state() -> GuestInspectType:
                     raise ProvisionError('Failed to create, provisioning failed.')
 
                 if state == 'Reserved':
+                    for key in response["logs"]:
+                        self.guest_logs.append(
+                            GuestLogBeaker(self, key.replace('.log', ''), response["logs"][key])
+                        )
+                    self.guest_logs.append(GuestLogBeaker(self, 'dmesg'))
                     return current
 
                 raise tmt.utils.WaitingIncompleteError
@@ -1463,3 +1463,22 @@ def guest(self) -> Optional[GuestBeaker]:
         """
 
         return self._guest
+
+
+@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
+
+    def fetch(self) -> Optional[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

tmt/steps/provision/podman.py

@@ -128,11 +128,6 @@ def is_ready(self) -> bool:
         )
         return str(cmd_output.stdout).strip() == 'true'
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def wake(self) -> None:
         """
         Wake up the guest

tmt/steps/provision/testcloud.py

@@ -715,11 +715,6 @@ def is_coreos(self) -> bool:
         # Is this a CoreOS?
         return bool(re.search('coreos|rhcos', self.image.lower()))
 
-    @property
-    def lognames(self) -> list[str]:
-        """Return name list of logs the guest could provide."""
-        return []
-
     def _get_url(self, url: str, message: str) -> requests.Response:
         """
         Get url, retry when fails, return response