Handle guest logs

Author: skycastlelily

tmt/steps/finish/__init__.py

@@ -189,7 +189,7 @@ def go(self, force: bool = False) -> None:
 
         # Stop and remove provisioned guests
         for guest in self.plan.provision.guests():
-            guest.handle_guest_logs(logs=guest.logs)
+            guest.handle_guest_logs(log_names=guest.log_names)
             guest.stop()
             guest.remove()
 

tmt/steps/provision/__init__.py

@@ -626,9 +626,10 @@ def is_ready(self) -> bool:
         raise NotImplementedError
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
 
-        raise NotImplementedError
+        return []
 
     @classmethod
     def options(cls, how: Optional[str] = None) -> list[tmt.options.ClickOptionDecoratorType]:
@@ -1109,38 +1110,55 @@ def requires(cls) -> list['tmt.base.Dependency']:
         return []
 
     def acquire_log(self, log_name: str) -> Optional[str]:
-        """fetch and return content of a requested log"""
+        """
+        Fetch and return content of a log.
+        :param log_name: name of the log.
+        :returns: content of the log.
+        """
         raise NotImplementedError
 
     def store_log(
             self,
             log_path: Path,
             log_content: str,
             log_name: Optional[str] = None) -> None:
-        """save log content and return the path"""
-        if log_name:
-            # if log_path contains log file name
-            if log_path.is_dir():
-                log_path.write_text(log_content)
-            else:
-                (log_path / log_name).write_text(log_content)
-        else:
+        """
+        Save log content to a file.
+        :param log_path: a path to save into,could be a directory
+        or a file path.
+        :param log_content: content of the log.
+        :param log_name: name of the log, if not set, log_path
+        is supposed to be '/dev/null' or  a file path.
+        """
+        # if log_path is file path or /dev/null
+        if not log_path.is_dir() or str(log_path) == '/dev/null':
             log_path.write_text(log_content)
+        # log_path is a directory
+        else:
+            if log_name:
+                name_str = log_name
+            else:
+                name_str = 'tmt-guestlog-' + \
+                    datetime.datetime.now(datetime.timezone.utc).strftime("%Y%m%d%H%M%S")
+                self.warn(f'log_name is not set, using file name:{name_str}')
+            (log_path / name_str).write_text(log_content)
 
     def handle_guest_logs(self,
                           log_path: Optional[Path] = None,
-                          logs: Optional[list[str]] = None) -> None:
-        """get log content and save it to the workdir/provision/,
-        list the log dir in guests.yaml"""
-        logs = logs or []
-        log_path = log_path or self.workdir
-        for log_name in logs:
+                          log_names: Optional[list[str]] = None) -> None:
+        """
+        Get log content and save it to a directory.
+        :param log_path: a directory to save into.If not set,self.workdir
+        or Path.cwd() will be used.
+        :param log_names: name list of logs need to be handled.If not set,
+        self.log_names will be used.
+        """
+        log_names = log_names or self.log_names
+        log_path = log_path or self.workdir or Path.cwd()
+        for log_name in log_names:
             log_content = self.acquire_log(log_name)
             if log_content:
-                if log_path:
-                    self.store_log(log_path, log_content, log_name)
-                else:
-                    self.store_log(Path.cwd(), log_content, log_name)
+                self.store_log(log_path, log_content, log_name)
             else:
                 self.debug(f'no content in {log_name}')
 

tmt/steps/provision/artemis.py

@@ -497,7 +497,8 @@ def is_ready(self) -> bool:
         return self.guest is not None
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return []
 
     def _create(self) -> None:

tmt/steps/provision/connect.py

@@ -70,7 +70,8 @@ class GuestConnect(tmt.steps.provision.GuestSsh):
     hard_reboot: Optional[ShellScript]
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return []
 
     def reboot(

tmt/steps/provision/local.py

@@ -27,7 +27,8 @@ def is_ready(self) -> bool:
         return True
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return ['dmesg']
 
     def _run_ansible(
@@ -138,7 +139,11 @@ def pull(
         """ Nothing to be done to pull workdir """
 
     def acquire_log(self, log_name: str) -> Optional[str]:
-        """fetch and return content of a requested log"""
+        """
+        Fetch and return content of a log.
+        :param log_name: name of the log.
+        :returns: content of the log.
+        """
         if log_name == 'dmesg':
             return self.execute(Command('dmesg')).stdout
         return None

tmt/steps/provision/mrack.py

@@ -605,7 +605,8 @@ def is_ready(self) -> bool:
             return False
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return []
 
     def _create(self, tmt_name: str) -> None:

tmt/steps/provision/podman.py

@@ -114,7 +114,8 @@ def is_ready(self) -> bool:
         return str(cmd_output.stdout).strip() == 'true'
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return []
 
     def wake(self) -> None:

tmt/steps/provision/testcloud.py

@@ -362,7 +362,8 @@ def is_ready(self) -> bool:
                 return False
 
     @property
-    def logs(self) -> list[str]:
+    def log_names(self) -> list[str]:
+        """Return name list of logs the guest could provide."""
         return []
 
     def _get_url(self, url: str, message: str) -> requests.Response: