Merge branch 'main' into opensuse

Author: danigm

configs/openSUSE/opensuse.toml

@@ -6,6 +6,10 @@ UseVarLockSubsys = false
 UseVersionInChangelog = false
 BadnessThreshold = 999
 
+# Set to true to issue a warning for ghost entries outside snapshots
+# when checking for atomic update compatibility
+AtomicCheckGhosts = false
+
 # Enabled checks for the rpmlint to be run (besides the default set)
 Checks = [
     "BashismsCheck",
@@ -24,13 +28,33 @@ Checks = [
     "SystemdTmpfilesCheck",
     "SUIDPermissionsCheck",
     "WorldWritableCheck",
+    "AtomicUpdateCheck",
 ]
 
 # List of directory prefixes that are not allowed in packages
 DisallowedDirs = [
     "/etc/NetworkManager/dispatcher.d",
 ]
 
+# Only these directories may be used by packages compatible with
+# atomic updates
+AtomicAllowedDirs = [
+    "/etc/",
+    "/usr/",
+    "/bin/",
+    "/lib/",
+    "/lib64/",
+    "/sbin/",
+    "/boot/",
+]
+
+# List of subdirectories which are disallowed for atomic updates
+# despite being within otherwise allowed directories
+AtomicDisallowedSubdirs = [
+    "/usr/local/",
+    "/boot/efi/",
+]
+
 FilterErrorTitles = [
     'cross-directory-hard-link',
 ]
@@ -83,6 +107,7 @@ Filters = [
     '^filesystem\..*: dir-or-file-in-tmp',
     '^filesystem\..*: dir-or-file-in-mnt',
     '^filesystem\..*: dir-or-file-in-home',
+    '^filesystem\..*: dir-or-file-outside-snapshot',
     '^filesystem\..*: hidden-file-or-dir /root/.gnupg',
     '^filesystem\..*: hidden-file-or-dir /root/.gnupg',
     '^filesystem\..*: hidden-file-or-dir /etc/skel/.config',

configs/openSUSE/scoring.toml

@@ -100,3 +100,7 @@ zypperplugin-file-ghost = 10
 zypperplugin-file-unauthorized = 10
 patch-macro-old-format = 10000
 logrotate-user-writable-log-dir = 10000
+
+# Set to 10000 once affected packages have been updated
+# for atomic update compatibility
+dir-or-file-outside-snapshot = 100

rpmlint/checks/AtomicUpdateCheck.py

@@ -0,0 +1,44 @@
+from rpmlint.checks.AbstractCheck import AbstractCheck
+
+
+class AtomicUpdateCheck(AbstractCheck):
+
+    """
+    Requirements for atomic updates:
+        * All files must be stored inside the snapshot, which is in our case /etc and /usr, not /var,
+          /opt, /srv, /usr/local or anything else.
+        * (Re)starting daemons is not possible.
+        * Modifying files outside of /usr and /etc is not possible.
+        * Modifications outside the snapshot have to be done via systemd-tmpfiles and systemd services.
+    This check currently only implements checking for files at illegal paths.
+    """
+
+    def __init__(self, config, output):
+        super().__init__(config, output)
+        self.check_ghosts = self.config.configuration['AtomicCheckGhosts']
+        self.allowed_dirs = self.config.configuration['AtomicAllowedDirs']
+        self.disallowed_subdirs = self.config.configuration['AtomicDisallowedSubdirs']
+
+    def check(self, pkg):
+        if pkg.is_source:
+            return
+
+        # Check for files stored outside the snapshot
+        self._check_paths(pkg, self.check_ghosts)
+
+    def _check_paths(self, pkg, check_ghosts=False):
+        for file in pkg.files.keys():
+            if file in pkg.ghost_files:
+                continue  # Ghosts are only handled if explicitly desired
+            if not (self._check_single_path(file)):
+                self.output.add_info('E', pkg, 'dir-or-file-outside-snapshot', file)
+        if check_ghosts:
+            for ghost in pkg.ghost_files:
+                if not (self._check_single_path(ghost)):
+                    self.output.add_info('W', pkg, 'ghost-outside-snapshot', ghost)
+
+    def _check_single_path(self, file):
+        return (
+            file.startswith(tuple(self.allowed_dirs)) and
+            not file.startswith(tuple(self.disallowed_subdirs))
+        )

rpmlint/cli.py

@@ -75,7 +75,7 @@ def process_lint_args(argv):
     parser.add_argument('-V', '--version', action='version', version=__version__, help='show package version and exit')
     parser.add_argument('-c', '--config', type=_validate_conf_location, help='load up additional configuration data from specified path (file or directory with *.toml files)')
     parser.add_argument('-e', '--explain', nargs='+', default='', help='provide detailed explanation for one specific message id')
-    parser.add_argument('-r', '--rpmlintrc', '--file', type=_is_file_path, help='load up specified rpmlintrc file')
+    parser.add_argument('-r', '--rpmlintrc', '--file', action='append', type=_is_file_path, help='load up specified rpmlintrc file (may be repeated)')
     parser.add_argument('-v', '--verbose', '--info', action='store_true', help='provide detailed explanations where available')
     parser.add_argument('-p', '--print-config', action='store_true', help='print the settings that are in effect when using the rpmlint')
     parser.add_argument('-i', '--installed', nargs='+', default='', help='installed packages to be validated by rpmlint')
@@ -97,16 +97,7 @@ def process_lint_args(argv):
 
     options = parser.parse_args(args=argv)
 
-    # make sure rpmlintrc exists
-    if options.rpmlintrc:
-        if not options.rpmlintrc.exists():
-            print_warning(f"User specified rpmlintrc '{options.rpmlintrc}' does not exist")
-            sys.exit(2)
-        # make it a list
-        options.rpmlintrc = [options.rpmlintrc]
-    else:
-        options.rpmlintrc = []
-    # validate all the rpmlfile options to be either file or folder
+    # validate all the rpmfile options to be either file or folder
     f_path = set()
     invalid_path = False
     for item in options.rpmfile:

rpmlint/configdefaults.toml

@@ -36,6 +36,9 @@ Filters = []
 BlockedFilters = []
 # Treshold where we should error out, by default single error is enough
 BadnessThreshold = -1
+# Set to true to issue a warning for ghost entries outside snapshots
+# when checking for atomic update compatibility
+AtomicCheckGhosts = false
 # When checking that various files that should be compressed are
 # indeed compressed, look for this filename extension
 CompressExtension = "bz2"
@@ -213,6 +216,26 @@ DisallowedDirs = [
     "/var/run",
     "/var/tmp",
 ]
+
+# Only these directories may be used by packages compatible with
+# atomic updates
+AtomicAllowedDirs = [
+    "/etc/",
+    "/usr/",
+    "/bin/",
+    "/lib/",
+    "/lib64/",
+    "/sbin/",
+    "/boot/",
+]
+
+# List of subdirectories which are disallowed for atomic updates
+# despite being within otherwise allowed directories
+AtomicDisallowedSubdirs = [
+    "/usr/local/",
+    "/boot/efi/",
+]
+
 # Standard OS groups
 StandardGroups = [
     "root",

rpmlint/descriptions/AtomicUpdateCheck.toml

@@ -0,0 +1,9 @@
+dir-or-file-outside-snapshot="""
+The package contains files outside the snapshot, e.g. outside /etc and /usr
+or inside /usr/local.
+"""
+ghost-outside-snapshot="""
+The package contains ghosts outside the snapshot, e.g. outside /etc and /usr
+or inside /usr/local. This might become an issue upon removal of this
+package, but not during installation.
+"""

rpmlint/lint.py

@@ -214,9 +214,9 @@ def _load_rpmlintrc(self):
                     pkg = pkg.parent
                 self.options['rpmlintrc'] += self._find_rpmlintrc_files(pkg)
 
-        if len(self.options['rpmlintrc']) > 1:
-            # multiple rpmlintrcs are highly undesirable
-            print_warning('There are multiple items to be loaded: {}.'.format(' '.join(map(str, self.options['rpmlintrc']))))
+            if len(self.options['rpmlintrc']) > 1:
+                # multiple rpmlintrcs are highly undesirable
+                print_warning('There are multiple items to be loaded: {}.'.format(' '.join(map(str, self.options['rpmlintrc']))))
         for rcfile in self.options['rpmlintrc']:
             self.config.load_rpmlintrc(rcfile)
 

test/test_atomic_update.py

@@ -0,0 +1,67 @@
+import pytest
+import rpm
+from rpmlint.checks.AtomicUpdateCheck import AtomicUpdateCheck
+from rpmlint.filter import Filter
+
+from Testing import CONFIG, get_tested_mock_package
+
+
+@pytest.fixture(scope='function', autouse=True)
+def atomiccheck():
+    CONFIG.info = True
+    CONFIG.configuration['AtomicCheckGhosts'] = True
+    output = Filter(CONFIG)
+    test = AtomicUpdateCheck(CONFIG, output)
+    yield output, test
+
+
+@pytest.fixture
+def output(atomiccheck):
+    output, _test = atomiccheck
+    yield output
+
+
+@pytest.fixture
+def test(atomiccheck):
+    _output, test = atomiccheck
+    yield test
+
+
+@pytest.mark.parametrize('package', [
+    get_tested_mock_package(files=('/var/lib/pipewire',)),
+    get_tested_mock_package(files=('/opt/bin/test',)),
+    get_tested_mock_package(files=('/usr/local/bin/test',)),
+    get_tested_mock_package(files=('/boot/efi/test',)),
+])
+def test_not_atomic(package, output, test):
+    test.check(package)
+    out = output.print_results(output.results)
+    assert 'E: dir-or-file-outside-snapshot' in out
+
+
+@pytest.mark.parametrize('package', [
+    get_tested_mock_package(files=('/etc/custom.config',)),
+    get_tested_mock_package(files=('/usr/lib64/libc.so',)),
+    get_tested_mock_package(files=('/usr/etc/nfs.conf',)),
+    get_tested_mock_package(files=('/bin/test',)),
+    get_tested_mock_package(files=('/sbin/test',)),
+    get_tested_mock_package(files=('/lib/libc.so',)),
+    get_tested_mock_package(files=('/lib64/libc.so',)),
+    get_tested_mock_package(files=('/boot/grub2/grub.cfg',)),
+])
+def test_atomic(package, output, test):
+    test.check(package)
+    out = output.print_results(output.results)
+    assert 'E: dir-or-file-outside-snapshot' not in out
+    assert 'W: ghost-outside-snapshot' not in out
+
+
+@pytest.mark.parametrize('package', [
+    get_tested_mock_package(files={
+        '/var/lib/pipewire/ghost_file': {'metadata': {'flags': rpm.RPMFILE_GHOST}},
+    }),
+])
+def test_not_atomic_ghost(package, output, test):
+    test.check(package)
+    out = output.print_results(output.results)
+    assert 'W: ghost-outside-snapshot' in out