test/rule-syntax-check.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: LGPL-2.1+
   3 #
   4 # Simple udev rules syntax checker
   5 #
   6 # (C) 2010 Canonical Ltd.
   7 # Author: Martin Pitt <martin.pitt@ubuntu.com>
   8 #
   9 # systemd is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU Lesser General Public License as published by
  11 # the Free Software Foundation; either version 2.1 of the License, or
  12 # (at your option) any later version.
  13
  14 # systemd is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public License
  20 # along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21
  22 import re
  23 import sys
  24 import os
  25 from glob import glob
  26
  27 if len(sys.argv) > 1:
  28     # explicit rule file list
  29     rules_files = sys.argv[1:]
  30 else:
  31     # take them from the build dir
  32     root_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  33     rules_dir = os.path.join(os.environ.get('top_srcdir', root_dir), 'rules')
  34     if not os.path.isdir(rules_dir):
  35         sys.stderr.write('No rules files given, and %s does not exist, aborting' % rules_dir)
  36         sys.exit(2)
  37     rules_files = glob(os.path.join(rules_dir, '*.rules'))
  38
  39 no_args_tests = re.compile(r'(ACTION|DEVPATH|KERNELS?|NAME|SYMLINK|SUBSYSTEMS?|DRIVERS?|TAG|RESULT|TEST)\s*(?:=|!)=\s*"([^"]*)"$')
  40 args_tests = re.compile(r'(ATTRS?|ENV|TEST){([a-zA-Z0-9/_.*%-]+)}\s*(?:=|!)=\s*"([^"]*)"$')
  41 no_args_assign = re.compile(r'(NAME|SYMLINK|OWNER|GROUP|MODE|TAG|PROGRAM|RUN|LABEL|GOTO|OPTIONS|IMPORT)\s*(?:\+=|:=|=)\s*"([^"]*)"$')
  42 args_assign = re.compile(r'(ATTR|ENV|IMPORT|RUN){([a-zA-Z0-9/_.*%-]+)}\s*(=|\+=)\s*"([^"]*)"$')
  43
  44 result = 0
  45 buffer = ''
  46 for path in rules_files:
  47     lineno = 0
  48     for line in open(path):
  49         lineno += 1
  50
  51         # handle line continuation
  52         if line.endswith('\\\n'):
  53             buffer += line[:-2]
  54             continue
  55         else:
  56             line = buffer + line
  57             buffer = ''
  58
  59         # filter out comments and empty lines
  60         line = line.strip()
  61         if not line or line.startswith('#'):
  62             continue
  63
  64         for clause in line.split(','):
  65             clause = clause.strip()
  66             if not (no_args_tests.match(clause) or args_tests.match(clause) or
  67                     no_args_assign.match(clause) or args_assign.match(clause)):
  68
  69                 print('Invalid line %s:%i: %s' % (path, lineno, line))
  70                 print('  clause: %s' % clause)
  71                 print('')
  72                 result = 1
  73                 break
  74
  75 sys.exit(result)