SCAutolib 3.1.2__tar.gz → 3.3.2__tar.gz

{SCAutolib-3.1.2/SCAutolib.egg-info → scautolib-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SCAutolib
-Version: 3.1.2
+Version: 3.3.2
 Summary: Python library for automation tests of smart cards using virtualization.
 Home-page: https://github.com/redhat-qe-security/SCAutolib
 Author: Pavel Yadlouski
@@ -25,8 +25,8 @@ Requires-Dist: pytest>=7
 Requires-Dist: schema>=0.7
 Requires-Dist: python_freeipa>=1.0
 Requires-Dist: pexpect>=4
+Requires-Dist: distro>=1.5.0
 Provides-Extra: graphical
-Requires-Dist: python-uinput; extra == "graphical"
 Requires-Dist: opencv-python; extra == "graphical"
 Requires-Dist: pandas; extra == "graphical"
 Requires-Dist: numpy; extra == "graphical"

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/controller.py

@@ -12,10 +12,11 @@ from SCAutolib import (logger, run, LIB_DIR, LIB_BACKUP, LIB_DUMP,
 from SCAutolib.models import CA, file, user, card, authselect as auth
 from SCAutolib.models.file import File, OpensslCnf
 from SCAutolib.models.CA import BaseCA
-from SCAutolib.enums import (OSVersion, CardType, UserType)
+from SCAutolib.enums import (CardType, UserType)
 from SCAutolib.utils import (_check_selinux, _gen_private_key,
-                             _get_os_version, _install_packages,
-                             _check_packages, dump_to_json, ca_factory)
+                             _install_packages, _check_packages,
+                             dump_to_json, ca_factory)
+from SCAutolib.isDistro import isDistro
 
 
 class Controller:
@@ -144,7 +145,8 @@ class Controller:
                   LIB_DUMP_CARDS):
             d.mkdir(exist_ok=True)
 
-        packages = ["opensc", "httpd", "sssd", "sssd-tools", "gnutls-utils"]
+        packages = ["opensc", "httpd", "sssd", "sssd-tools", "gnutls-utils",
+                    "openssl", "nss-tools"]
         if gdm:
             packages.append("gdm")
 
@@ -157,7 +159,11 @@ class Controller:
                 for c in self.lib_conf["cards"]):
             packages += ["pcsc-lite-ccid", "pcsc-lite", "virt_cacard",
                          "vpcd", "softhsm"]
-            run("dnf -y copr enable jjelen/vsmartcard")
+            extra_args = ""
+            if isDistro(['rhel', 'centos'], version='10'):
+                # TODO: use better approach later
+                extra_args = " centos-stream-10-x86_64"
+            run("dnf -y copr enable jjelen/vsmartcard{0}".format(extra_args))
 
         # Add IPA packages if needed
         if any([u["user_type"] != UserType.local
@@ -175,7 +181,14 @@ class Controller:
             raise exceptions.SCAutolibException(msg)
 
         if graphical:
-            run(['dnf', 'groupinstall', 'Server with GUI', '-y'])
+            if not isDistro('fedora'):
+                run(['dnf', 'groupinstall', 'Server with GUI', '-y',
+                     '--allowerasing'])
+                run(['pip', 'install', 'python-uinput'])
+            else:
+                # Fedora doesn't have server with GUI group so installed gdm
+                # manually and also python3-uinput should be installed from RPM
+                run(['dnf', 'install', 'gdm', 'python3-uinput', '-y'])
             # disable subscription message
             run(['systemctl', '--global', 'mask',
                  'org.gnome.SettingsDaemon.Subscription.target'])
@@ -184,8 +197,14 @@ class Controller:
             self.dconf_file.save()
             run('dconf update')
 
-        run(['dnf', 'groupinstall', "Smart Card Support", '-y'])
-        logger.debug("Smart Card Support group in installed.")
+        if not isDistro('fedora'):
+            run(['dnf', 'groupinstall', "Smart Card Support", '-y',
+                 '--allowerasing'])
+            logger.debug("Smart Card Support group in installed.")
+        else:
+            # Fedora requires rsyslog as well
+            run(['dnf', 'install', 'opensc', 'pcsc-lite-ccid', 'rsyslog', '-y'])
+            run(['systemctl', 'start', 'rsyslog'])
 
         self.sssd_conf.create()
         self.sssd_conf.save()
@@ -430,6 +449,9 @@ class Controller:
                 cache_file.unlink()
         logger.debug("Removed opensc file cache")
 
+        # file only created in graphical mode that is why it is removed.
+        self.dconf_file.remove()
+
         self.sssd_conf.restore()
         pcscd_service = File("/usr/lib/systemd/system/pcscd.service")
         pcscd_service.restore()
@@ -514,13 +536,12 @@ class Controller:
 
         :return: name of the IPA client package for current Linux
         """
-        os_version = _get_os_version()
-        if os_version not in (OSVersion.RHEL_9, OSVersion.CentOS_9):
+        if isDistro(['rhel', 'centos'], version='8'):
             run("dnf module enable -y idm:DL1")
             run("dnf install @idm:DL1 -y")
             logger.debug("idm:DL1 module is installed")
 
-        if os_version == OSVersion.Fedora:
+        if isDistro('fedora'):
             return ["freeipa-client"]
         else:
             return ["ipa-client"]

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/enums.py

@@ -1,15 +1,17 @@
 from enum import Enum, auto
 
 
-class OSVersion(Enum):
+class OSVersion(int, Enum):
     """
     Enumeration for Linux versions. Used for more convenient checks.
     """
     Fedora = 1
-    RHEL_9 = 2
-    RHEL_8 = 3
-    CentOS_8 = 4
-    CentOS_9 = 5
+    RHEL_8 = 2
+    RHEL_9 = 3
+    RHEL_10 = 4
+    CentOS_8 = 5
+    CentOS_9 = 6
+    CentOS_10 = 7
 
 
 class CardType(str, Enum):

scautolib-3.3.2/SCAutolib/isDistro.py

@@ -0,0 +1,50 @@
+"""
+This module provides a function (isDistro) that helps us identify the os
+of the system and configure the system accordingly.
+"""
+
+import distro
+from typing import Union
+
+
+def isDistro(oses: Union[str, list], version: str = None) -> bool:
+    cur_id = distro.id().lower()
+    cur_name = distro.name().lower()
+
+    if isinstance(oses, str):
+        results = (oses in cur_id) or (oses in cur_name)
+    else:
+        results = False
+        for item in oses:
+            if not isinstance(item, str):
+                continue
+            item = item.lower()
+            results = results or (item in cur_id) or (item in cur_name)
+
+    if results is False:
+        return False
+
+    if version:
+        cur_major = int(distro.major_version())
+        cur_minor = int(distro.minor_version()) if distro.minor_version() else 0
+
+        if version[0] in ('<', '=', '>'):
+            if version[1] == '=':
+                op = version[:2]
+                version = version[2:]
+            else:
+                op = version[0] if version[0] != '=' else '=='
+                version = version[1:]
+        else:
+            op = '=='
+
+        parts = version.split('.')
+        major = int(parts[0])
+        minor = int(parts[1]) if len(parts) > 1 else None
+
+        if major == cur_major and minor:
+            return eval("{0} {1} {2}".format(cur_minor, op, minor))
+        else:
+            return eval("{0} {1} {2}".format(cur_major, op, major))
+
+    return True

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/models/CA.py

@@ -66,12 +66,13 @@ class BaseCA:
             root_cert = f_cert.read()
 
         if self._ca_pki_db.exists():
+            with self._ca_pki_db.open() as f:
+                with self._ca_original_path.open('w') as backup:
+                    backup.write(f.read())
             # Check if current CA cert is already present in the sssd auth db
             with self._ca_pki_db.open("a+") as f:
                 f.seek(0)
                 data = f.read()
-                with self._ca_original_path.open('w') as backup:
-                    backup.write(data)
                 if root_cert not in data:
                     f.write(root_cert)
         else:

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/models/file.py

@@ -26,6 +26,7 @@ import json
 
 from SCAutolib import logger, TEMPLATES_DIR, LIB_BACKUP, LIB_DUMP_CONFS, run
 from SCAutolib.exceptions import SCAutolibException
+from SCAutolib.isDistro import isDistro
 
 
 class File:
@@ -81,6 +82,16 @@ class File:
             with self._template.open() as t:
                 self._default_parser.read_file(t)
 
+    def remove(self):
+        """
+        Removes the file if it exists.
+        """
+        if self._conf_file.exists():
+            self._conf_file.unlink()
+            logger.debug(
+                f"Removed file {self._conf_file}."
+            )
+
     def set(self, key: str, value: Union[int, str, bool], section: str = None,
             separator: str = "="):
         """
@@ -247,6 +258,10 @@ class File:
             logger.debug(
                 f"File {self._conf_file} is restored to {original_path}"
             )
+        else:
+            logger.debug(
+                f"File {self._conf_file} was not backed up. Nothing to do."
+            )
 
 
 class SSSDConf(File):
@@ -263,7 +278,6 @@ class SSSDConf(File):
     runtimes.
     """
     __instance = None
-    _template = Path(TEMPLATES_DIR, "sssd.conf")
     _conf_file = Path("/etc/sssd/sssd.conf")
     _backup_original = None
     _backup_default = LIB_BACKUP.joinpath('default-sssd.conf')
@@ -284,6 +298,12 @@ class SSSDConf(File):
             return
         self.__initialized = True
 
+        if isDistro(['rhel', 'centos'], version='<=9') \
+                or isDistro(['fedora'], version='<39'):
+            self._template = TEMPLATES_DIR.joinpath("sssd.conf-8or9")
+        else:
+            self._template = TEMPLATES_DIR.joinpath("sssd.conf-10")
+
         # _default_parser object stores default content of config file
         self._default_parser = ConfigParser()
         # avoid problems with inserting some 'specific' values

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/models/gui.py

@@ -1,4 +1,7 @@
+import copy
+import inspect
 import os
+from os.path import join
 from time import sleep, time
 
 import cv2
@@ -6,19 +9,44 @@ import keyboard
 import numpy as np
 import pytesseract
 import uinput
+import logging
 
 from SCAutolib import run, logger
+from SCAutolib.isDistro import isDistro
+
+
+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):
@@ -50,13 +78,19 @@ class Screen:
         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
 
 
 class Mouse:
-    """Controls the mouse of the system under test
-    """
+    """Controls the mouse of the system under test"""
 
     def __init__(self):
         run(['modprobe', 'uinput'], check=True)
@@ -223,18 +257,51 @@ def log_decorator(func):
 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
@@ -242,18 +309,29 @@ class GUI:
         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):
@@ -385,3 +463,33 @@ class GUI:
             if selection.sum() != 0:
                 raise Exception(f"The key='{key}' was found "
                                 f"in the screenshot {screenshot}")
+
+    @log_decorator
+    def check_home_screen(self, polarity: bool = True):
+        """
+        Check for the home screen to determine if user is logged in
+
+        If OS version is defined as Fedora, we set the text for which to
+        search to "tosearch" instead of the original "Activities". In later
+        versions of Fedora, "Activities" text is no longer visible. "tosearch"
+        should be visible on the login screen as the search bar is still
+        present.
+
+        After defining polarity and the string to check, run the appropriate
+        function with the string to search for.
+
+        :param polarity: Define whether to search for presence or absence of
+            string indicating home screen is displayed.
+        """
+        if polarity is True:
+            func_str = 'assert_text'
+        else:
+            func_str = 'assert_no_text'
+
+        if isDistro('fedora'):
+            check_str = 'tosearch'
+        else:
+            check_str = 'Activities'
+
+        func = getattr(self, func_str)
+        func(check_str, timeout=20)

scautolib-3.3.2/SCAutolib/templates/sssd.conf-10

@@ -0,0 +1,18 @@
+[sssd]
+debug_level = 9
+services = nss, pam, ssh, sudo
+domains = shadowutils
+certificate_verification = no_ocsp
+
+[nss]
+debug_level = 9
+
+[pam]
+debug_level = 9
+pam_cert_auth = True
+
+[domain/shadowutils]
+debug_level = 9
+id_provider = proxy
+proxy_lib_name = files
+local_auth_policy = only

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib/utils.py

@@ -10,7 +10,6 @@ from pathlib import Path
 
 from SCAutolib import (run, logger, TEMPLATES_DIR, LIB_DUMP_USERS, LIB_DUMP_CAS,
                        LIB_DUMP_CARDS)
-from SCAutolib.enums import OSVersion
 from SCAutolib.exceptions import SCAutolibException
 from SCAutolib.models.CA import LocalCA, BaseCA, CustomCA, IPAServerCA
 from SCAutolib.models.card import Card
@@ -58,28 +57,6 @@ def _gen_private_key(key_path: Path):
             encryption_algorithm=serialization.NoEncryption()))
 
 
-def _get_os_version():
-    """
-    Find Linux version. Available version: RHEL 8, RHEL 9, Fedora.
-    :return: Enum with OS version
-    """
-    with open('/etc/redhat-release', "r") as f:
-        cnt = f.read()
-
-    if "Red Hat Enterprise Linux release 9" in cnt:
-        return OSVersion.RHEL_9
-    elif "Red Hat Enterprise Linux release 8" in cnt:
-        return OSVersion.RHEL_8
-    elif "Fedora" in cnt:
-        return OSVersion.Fedora
-    elif "CentOS Stream release 8" in cnt:
-        return OSVersion.CentOS_8
-    elif "CentOS Stream release 9" in cnt:
-        return OSVersion.CentOS_9
-    else:
-        raise SCAutolibException("OS is not detected.")
-
-
 def _install_packages(packages):
     """
     Install given packages and log package version

{SCAutolib-3.1.2 → scautolib-3.3.2/SCAutolib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SCAutolib
-Version: 3.1.2
+Version: 3.3.2
 Summary: Python library for automation tests of smart cards using virtualization.
 Home-page: https://github.com/redhat-qe-security/SCAutolib
 Author: Pavel Yadlouski
@@ -25,8 +25,8 @@ Requires-Dist: pytest>=7
 Requires-Dist: schema>=0.7
 Requires-Dist: python_freeipa>=1.0
 Requires-Dist: pexpect>=4
+Requires-Dist: distro>=1.5.0
 Provides-Extra: graphical
-Requires-Dist: python-uinput; extra == "graphical"
 Requires-Dist: opencv-python; extra == "graphical"
 Requires-Dist: pandas; extra == "graphical"
 Requires-Dist: numpy; extra == "graphical"

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ SCAutolib/cli_commands.py
 SCAutolib/controller.py
 SCAutolib/enums.py
 SCAutolib/exceptions.py
+SCAutolib/isDistro.py
 SCAutolib/utils.py
 SCAutolib.egg-info/PKG-INFO
 SCAutolib.egg-info/SOURCES.txt
@@ -27,7 +28,8 @@ SCAutolib/models/user.py
 SCAutolib/templates/ca.cnf
 SCAutolib/templates/gnome_disable_welcome
 SCAutolib/templates/softhsm2.conf
-SCAutolib/templates/sssd.conf
+SCAutolib/templates/sssd.conf-10
+SCAutolib/templates/sssd.conf-8or9
 SCAutolib/templates/user.cnf
 SCAutolib/templates/virt_cacard.service
 SCAutolib/templates/virtcacard.cil

{SCAutolib-3.1.2 → scautolib-3.3.2}/SCAutolib.egg-info/requires.txt

@@ -7,9 +7,9 @@ pytest>=7
 schema>=0.7
 python_freeipa>=1.0
 pexpect>=4
+distro>=1.5.0
 
 [graphical]
-python-uinput
 opencv-python
 pandas
 numpy

{SCAutolib-3.1.2 → scautolib-3.3.2}/requirements.txt

@@ -7,3 +7,4 @@ pytest>=7
 schema>=0.7
 python_freeipa>=1.0
 pexpect>=4
+distro>=1.5.0

{SCAutolib-3.1.2 → scautolib-3.3.2}/setup.py

@@ -15,7 +15,6 @@ with readme.open() as f:
     long_description = f.read()
 
 graphical_reqs = [
-    'python-uinput',
     'opencv-python',
     'pandas',
     'numpy',
@@ -25,7 +24,7 @@ graphical_reqs = [
 
 setup(
     name="SCAutolib",
-    version="3.1.2",
+    version="3.3.2",
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',