models/gui.py: create an HTML file

Gui class creates, on top of the terminal output, logs in HTML file. Screenshots now can be shown alongside the test logs. Also Gui class was extented to have configurable results dir name so we can have more detailed directories in results rather than a simple timestamp.
redhat-qe-security · Mar 14, 2024 · 10947d8 · 10947d8
1 parent 7f6e1c9
commit 10947d8
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 6 deletions.
diff --git a/SCAutolib/models/gui.py b/SCAutolib/models/gui.py
@@ -1,26 +1,53 @@
+import copy
+import inspect
 import os
+from os.path import join
 from time import sleep, time
 
 import cv2
 import keyboard
 import numpy as np
 import pytesseract
 import uinput
+import logging
 
 from SCAutolib import run, logger
 from SCAutolib.enums import OSVersion
 from SCAutolib.utils import _get_os_version
 
 
+class HTMLFileHandler(logging.FileHandler):
+    """Extending FileHandler to work with HTML files."""
+
+    def __init__(
+            self, filename, mode='a', encoding=None, delay=False, errors=None):
+        """
+        A handler class which writes formatted logging records to disk HTML
+        files.
+        """
+        super(HTMLFileHandler, self).__init__(
+            filename, mode, encoding, delay, errors
+        )
+
+    def emit(self, record: logging.LogRecord) -> None:
+        """
+        Do whatever it takes to actually log the specified logging record.
+        """
+        custom_record = copy.deepcopy(record)
+        custom_record.msg = str(record.msg).rstrip().replace("\n", "<br>\n")
+        return super().emit(custom_record)
+
+
 class Screen:
     """Captures the screenshots."""
 
-    def __init__(self, directory: str):
+    def __init__(self, directory: str, html_file: str = None):
         """Init method
         :param directory: Path to directory, where the screenshots
             will be saved.
         """
         self.directory = directory
+        self.html_file = html_file
         self.screenshot_num = 1
 
     def screenshot(self, timeout: float = 30):
@@ -52,6 +79,13 @@ def screenshot(self, timeout: float = 30):
         if not captured:
             raise Exception('Could not capture screenshot within timeout.')
 
+        if self.html_file:
+            with open(self.html_file, 'a') as fp:
+                fp.write(
+                    f"<img src=\"screenshots/{self.screenshot_num}.png\" "
+                    f"alt=\"screenshot number {self.screenshot_num}\">"
+                )
+
         self.screenshot_num += 1
         return filename
 
@@ -224,37 +258,81 @@ def wrapper(self, *args, **kwargs):
 class GUI:
     """Represents the GUI and allows controlling the system under test."""
 
-    def __init__(self, wait_time: float = 5):
+    def __init__(self, wait_time: float = 5, res_dir_name: str = None):
         """Initializes the GUI of system under test.
 
         :param wait_time: Time to wait after each action
+        :param custom_dir_name: Provide a custom name of the results dir under
+        /tmp/SC-tests/. The default is `timestamp`_`caller func's name`.
         """
 
         self.wait_time = wait_time
         self.gdm_init_time = 10
         # Create the directory for screenshots
-        self.screenshot_directory = '/tmp/SC-tests/' + str(int(time()))
+        if res_dir_name:
+            self.html_directory = '/tmp/SC-tests/' + res_dir_name
+        else:
+            calling_func = inspect.stack()[1][3]
+            self.html_directory = '/tmp/SC-tests/' + str(int(time()))
+            self.html_directory += "_" + calling_func
+
+        self.screenshot_directory = self.html_directory + "/screenshots"
+        # will create both dirs
         os.makedirs(self.screenshot_directory, exist_ok=True)
 
+        self.html_file = join(self.html_directory, "index.html")
+        with open(self.html_file, 'w') as fp:
+            fp.write(
+                "<html lang=\"en\">\n"
+                "<head>\n"
+                "<meta charset=\"UTF-8\">\n"
+                "<meta name=\"viewport\" content=\"width=device-width, "
+                "initial-scale=1.0\">\n"
+                "<title>Test Results</title>\n"
+                "</head>\n"
+                "<body style=\"background-color:#000\">\n"
+            )
+
+        fmt = "<span style=\"color:white;\">"
+        fmt += "%(name)s:%(module)s.%(funcName)s.%(lineno)d </span>"
+        fmt += "<span style=\"color:royalblue;\">[%(levelname)s] </span>"
+        fmt += "<span style=\"color:limegreen;\">%(message)s</span>"
+        self.fileHandler = HTMLFileHandler(self.html_file)
+        self.fileHandler.setLevel(logging.DEBUG)
+        self.fileHandler.setFormatter(
+            logging.Formatter("<p>" + fmt + "</p>")
+        )
+
         self.mouse = Mouse()
 
         # workaround for keyboard library
         # otherwise the first character is not sent
         keyboard.send('enter')
 
     def __enter__(self):
-        self.screen = Screen(self.screenshot_directory)
+        self.screen = Screen(self.screenshot_directory, self.html_file)
         # By restarting gdm, the system gets into defined state
         run(['systemctl', 'restart', 'gdm'], check=True)
         # Cannot screenshot before gdm starts displaying
         # This would break the display
         sleep(self.gdm_init_time)
 
+        logger.addHandler(self.fileHandler)
+
         return self
 
     def __exit__(self, type, value, traceback):
         run(['systemctl', 'stop', 'gdm'], check=True)
 
+        with open(self.html_file, 'a') as fp:
+            fp.write(
+                "</body>\n"
+                "</html>\n"
+            )
+
+        logger.removeHandler(self.fileHandler)
+        logger.info(f"HTML file with results created in {self.html_directory}.")
+
     @action_decorator
     @log_decorator
     def click_on(self, key: str, timeout: float = 30):
@@ -416,4 +494,4 @@ def check_home_screen(self, polarity: bool = True):
             check_str = 'Activities'
 
         func = getattr(self, func_str)
-        func(check_str)
+        func(check_str, timeout=20)
diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@
 
 setup(
     name="SCAutolib",
-    version="3.2.1",
+    version="3.2.2",
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',