Implement a proper testing framework (GSoC23)

.github/workflows/main.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [main, opensuse]
+    branches: [main, opensuse, GSoC23]
   pull_request:
     branches: [main, opensuse]
 

rpmlint/pkg.py

@@ -747,7 +747,7 @@
 
 
 # Class to provide an API to a 'fake' package, eg. for specfile-only checks
-class FakePkg(AbstractPkg):
+class FakePkg(Pkg):
     def __init__(self, name, is_source=False):
         self.name = str(name)
         self.arch = None
@@ -759,26 +759,81 @@
         self.files = {}
         self.ghost_files = {}
 
+        # header is a dictionary to mock rpm metadata
+        self.header = {
+            rpm.RPMTAG_REQUIRENAME: [],
+            rpm.RPMTAG_REQUIREFLAGS: [],
+            rpm.RPMTAG_REQUIREVERSION: [],
+            rpm.RPMTAG_CONFLICTNAME: '',
+            rpm.RPMTAG_CONFLICTFLAGS: '',
+            rpm.RPMTAG_CONFLICTVERSION: '',
+            rpm.RPMTAG_PROVIDENAME: '',
+            rpm.RPMTAG_PROVIDEFLAGS: '',
+            rpm.RPMTAG_PROVIDEVERSION: '',
+            rpm.RPMTAG_OBSOLETENAME: '',
+            rpm.RPMTAG_OBSOLETEFLAGS: '',
+            rpm.RPMTAG_OBSOLETEVERSION: '',
+            rpm.RPMTAG_RECOMMENDNAME: '',
+            rpm.RPMTAG_RECOMMENDFLAGS: '',
+            rpm.RPMTAG_RECOMMENDVERSION: '',
+            rpm.RPMTAG_SUGGESTNAME: '',
+            rpm.RPMTAG_SUGGESTFLAGS: '',
+            rpm.RPMTAG_SUGGESTVERSION: '',
+            rpm.RPMTAG_ENHANCENAME: '',
+            rpm.RPMTAG_ENHANCEFLAGS: '',
+            rpm.RPMTAG_ENHANCEVERSION: '',
+            rpm.RPMTAG_SUPPLEMENTNAME: '',
+            rpm.RPMTAG_SUPPLEMENTFLAGS: '',
+            rpm.RPMTAG_SUPPLEMENTVERSION: '',
+        }
+
     def add_file(self, path, name):
         pkgfile = PkgFile(name)
         pkgfile.path = path
         self.files[name] = pkgfile
         return pkgfile
 
-    def add_file_with_content(self, name, content, **flags):
+    def add_dir(self, path):
+        pkgdir = PkgFile(path)
+        pkgdir.magic = 'directory'
+        pkgdir.path = path
+        self.files[path] = pkgdir
+        return pkgdir
+
+    def add_file_with_content(self, name, content, real_files=False, **flags):
         """
         Add file to the FakePkg and fill the file with provided
         string content.
         """
-        basename = name.replace(os.path.sep, '_')
-        path = os.path.join(self.dir_name(), basename)
-        with open(path, 'w') as out:
-            out.write(content)
-            pkg_file = PkgFile(name)
-            pkg_file.path = path
-            for key, value in flags.items():
-                setattr(pkg_file, key, value)
-            self.files[name] = pkg_file
+        path = os.path.join(self.dir_name(), name.lstrip('/'))
+        pkg_file = PkgFile(name)
+        pkg_file.path = path
+        for key, value in flags.items():
+            setattr(pkg_file, key, value)
+        self.files[name] = pkg_file
+
+        if real_files:
+            os.makedirs(Path(path).parent, exist_ok=True)
+            with open(Path(path), 'w') as out:
+                out.write(content)
+
+    def add_header(self, header):
+        for k, v in header.items():
+            if k == 'requires':
+                for req in v:
+                    self.header[rpm.RPMTAG_REQUIRENAME].append(req)
+                    self.header[rpm.RPMTAG_REQUIREFLAGS].append(0)
+                    self.header[rpm.RPMTAG_REQUIREVERSION].append('1.0')
+                continue
+
+            key = getattr(rpm, f'RPMTAG_{k}'.upper())
+            self.header[key] = v
+
+        (self.requires, self.prereq, self.provides, self.conflicts,
+         self.obsoletes, self.recommends, self.suggests, self.enhances,
+         self.supplements) = self._gather_dep_info()
+
+        self.req_names = [x[0] for x in self.requires + self.prereq]
 
     def add_symlink_to(self, name, target):
         """

test/Testing.py

@@ -1,6 +1,6 @@
 import glob
 import os
-from pathlib import Path
+from pathlib import Path, PurePath
 import platform
 import re
 import shutil
@@ -60,3 +60,16 @@ def get_tested_spec_package(name):
     candidates = list(get_tested_path(name).parent.glob(filename))
     assert len(candidates) == 1
     return FakePkg(candidates[0])
+
+
+def get_tested_mock_package(files=None, real_files=None, header=None):
+    mockPkg = FakePkg('mockPkg')
+    if files is not None:
+        for path, file in files.items():
+            if file.get('create_dirs'):
+                for i in PurePath(path).parents[:file.get('include_dirs', -1)]:
+                    mockPkg.add_dir(str(i))
+            mockPkg.add_file_with_content(path, file.get('content'), real_files=real_files)
+    if header is not None:
+        mockPkg.add_header(header)
+    return mockPkg

test/test_binaries.py

@@ -1,9 +1,8 @@
 import pytest
 from rpmlint.checks.BinariesCheck import BinariesCheck
 from rpmlint.filter import Filter
-from rpmlint.pkg import FakePkg
 
-from Testing import CONFIG, Config, get_tested_package, IS_X86_64, TEST_CONFIG
+from Testing import CONFIG, Config, get_tested_mock_package, get_tested_package, IS_X86_64, TEST_CONFIG
 
 
 @pytest.fixture(scope='function', autouse=True)
@@ -280,11 +279,13 @@ def test_patchable_function_entry_archive(tmp_path, package, binariescheck):
     assert 'E: patchable-function-entry-in-archive /usr/lib64/libhello.a' in out
 
 
-def test_systemd_unit_file(binariescheck):
+@pytest.mark.parametrize('package', [
+    get_tested_mock_package(files={
+        '/usr/lib/systemd/system/yast-timesync.service': {'content': ''}
+    })
+])
+def test_systemd_unit_file(package, binariescheck):
     output, test = binariescheck
-    with FakePkg('fake') as pkg:
-        pkg.add_file_with_content('/usr/lib/systemd/system/yast-timesync.service', '')
-        output, test = binariescheck
-        test.check(pkg)
-        out = output.print_results(output.results)
-        assert 'only-non-binary-in-usr-lib' not in out
+    test.check(package)
+    out = output.print_results(output.results)
+    assert 'only-non-binary-in-usr-lib' not in out