Handle guest logs

Fetch log content,save it to provided location or current dir

Author: skycastlelily

tmt/steps/finish/__init__.py

@@ -189,6 +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.stop()
             guest.remove()
 

tmt/steps/provision/__init__.py

@@ -625,6 +625,11 @@ def is_ready(self) -> bool:
 
         raise NotImplementedError
 
+    @property
+    def logs(self) -> list[str]:
+
+        raise NotImplementedError
+
     @classmethod
     def options(cls, how: Optional[str] = None) -> list[tmt.options.ClickOptionDecoratorType]:
         """ Prepare command line options related to guests """
@@ -1103,6 +1108,42 @@ def requires(cls) -> list['tmt.base.Dependency']:
         """ All requirements of the guest implementation """
         return []
 
+    def acquire_log(self, log_name: str) -> Optional[str]:
+        """fetch and return content of a requested 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:
+            log_path.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_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)
+            else:
+                self.debug(f'no content in {log_name}')
+
 
 @dataclasses.dataclass
 class GuestSshData(GuestData):

tmt/steps/provision/artemis.py

@@ -496,6 +496,10 @@ def is_ready(self) -> bool:
         #        return True if self.guest is not None
         return self.guest is not None
 
+    @property
+    def logs(self) -> list[str]:
+        return []
+
     def _create(self) -> None:
         environment: dict[str, Any] = {
             'hw': {

tmt/steps/provision/connect.py

@@ -69,6 +69,10 @@ class GuestConnect(tmt.steps.provision.GuestSsh):
     soft_reboot: Optional[ShellScript]
     hard_reboot: Optional[ShellScript]
 
+    @property
+    def logs(self) -> list[str]:
+        return []
+
     def reboot(
             self,
             hard: bool = False,

tmt/steps/provision/local.py

@@ -26,6 +26,10 @@ def is_ready(self) -> bool:
         """ Local is always ready """
         return True
 
+    @property
+    def logs(self) -> list[str]:
+        return ['dmesg']
+
     def _run_ansible(
             self,
             playbook: Path,
@@ -133,6 +137,12 @@ def pull(
             extend_options: Optional[list[str]] = None) -> None:
         """ Nothing to be done to pull workdir """
 
+    def acquire_log(self, log_name: str) -> Optional[str]:
+        """fetch and return content of a requested log"""
+        if log_name == '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

@@ -604,6 +604,10 @@ def is_ready(self) -> bool:
         except mrack.errors.MrackError:
             return False
 
+    @property
+    def logs(self) -> list[str]:
+        return []
+
     def _create(self, tmt_name: str) -> None:
         """ Create beaker job xml request and submit it to Beaker hub """
 

tmt/steps/provision/podman.py

@@ -113,6 +113,10 @@ def is_ready(self) -> bool:
             ))
         return str(cmd_output.stdout).strip() == 'true'
 
+    @property
+    def logs(self) -> list[str]:
+        return []
+
     def wake(self) -> None:
         """ Wake up the guest """
         self.debug(

tmt/steps/provision/testcloud.py

@@ -361,6 +361,10 @@ def is_ready(self) -> bool:
             except libvirt.libvirtError:
                 return False
 
+    @property
+    def logs(self) -> list[str]:
+        return []
+
     def _get_url(self, url: str, message: str) -> requests.Response:
         """ Get url, retry when fails, return response """