TmpFilesCheck.py

# File          : TmpFilesCheck.py
# Package       : rpmlint
# Author        : Ludwig Nussel
# Created on    : Wed Sep 03 10:36 2014
# Purpose       : Check systemd created tmpfiles are included in filelist

import re
import os.path

from Filter import addDetails, printWarning
import AbstractCheck
import stat
import rpm


class TmpFilesCheck(AbstractCheck.AbstractCheck):
    '''Check systemd created tmpfiles are included in filelist'''

    def __init__(self):
        AbstractCheck.AbstractCheck.__init__(self, "TmpFilesCheck")
        self._spec_file = None

    def check(self, pkg):
        if pkg.isSource():
            return

        # file names handled by systemd-tmpfiles
        tmp_files = set()
        postin = pkg[rpm.RPMTAG_POSTIN]
        prein = pkg[rpm.RPMTAG_PREIN]

        # see tmpfiles.d(5)
        interesting_types = ('f', 'F', 'w', 'd', 'D', 'p', 'L', 'c', 'b')

        for fn, pkgfile in pkg.files().items():
            if not fn.startswith('/usr/lib/tmpfiles.d/'):
                continue
            if not stat.S_ISREG(pkgfile.mode):
                printWarning(pkg, "tmpfile-not-regular-file", fn)
                continue

            basename = os.path.basename(fn)
            pattern = re.compile(
                r'systemd-tmpfiles --create .*%s' % re.escape(basename))
            if (not postin or not pattern.search(postin)) and \
                    (not prein or not pattern.search(prein)):
                printWarning(pkg,
                             'postin-without-tmpfile-creation', fn)

            with open(pkgfile.path) as inputf:
                for line in inputf:
                    # skip comments
                    line = line.split('#')[0].split('\n')[0]
                    line = line.lstrip()
                    if not len(line):
                        continue
                    line = re.split(r'\s+', line)
                    # format is
                    # Type Path        Mode UID  GID  Age Argument
                    # we only need type and path
                    if len(line) < 3:
                        continue
                    t = line[0]
                    p = line[1]
                    if t.endswith('!'):
                        t = t[:-1]
                    if t not in interesting_types:
                        continue

                    tmp_files.add(p)

                    if p not in pkg.files():
                        printWarning(pkg, "tmpfile-not-in-filelist", p)
                        continue
                    if not pkg.files()[p].is_ghost:
                        printWarning(pkg, "tmpfile-not-ghost", p)

        # now check remaining ghost files that are not already
        # handled by systemd-tmpfiles
        ghost_files = set(pkg.ghostFiles()) - tmp_files
        if ghost_files:
            for f in ghost_files:
                if f in pkg.missingOkFiles():
                    continue
                if not postin and not prein:
                    printWarning(pkg, 'ghost-files-without-postin')
                if (not postin or f not in postin) and \
                        (not prein or f not in prein):
                    printWarning(pkg,
                                 'postin-without-ghost-file-creation', f)


check = TmpFilesCheck()

addDetails(
'postin-without-ghost-file-creation',
'''A file tagged as ghost is not created during %prein nor during %postin.''',

'postin-without-tmpfile-creation',
'''Please use the %tmpfiles_create macro in %post for each of your
tmpfiles.d files''',

'tmpfile-not-regular-file',
'''files in tmpfiles.d need to be regular files''',

'tmpfile-not-in-filelist',
'''please add the specified file to your %files section as %ghost so
users can easily query who created the file, it gets uninstalled on
package removal and finally other rpmlint checks see it''',

'tmpfile-not-ghost',
'''the specified file is not marked as %ghost although created at
runtime via tmpfiles mechanism.'''
)
# vim: sw=4 et