test/rule-syntax-check.py

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