test/rule-syntax-check.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: LGPL-2.1-or-later
   3 #
   4 # Simple udev rules syntax checker
   5 #
   6 # © 2010 Canonical Ltd.
   7 # Author: Martin Pitt <martin.pitt@ubuntu.com>
   8
   9 import re
  10 import sys
  11
  12 rules_files = sys.argv[1:]
  13 if not rules_files:
  14     sys.exit('Specify files to test as arguments')
  15
  16 quoted_string_re = r'"(?:[^\\"]|\\.)*"'
  17 no_args_tests = re.compile(r'(ACTION|DEVPATH|KERNELS?|NAME|SYMLINK|SUBSYSTEMS?|DRIVERS?|TAG|PROGRAM|RESULT|TEST)\s*(?:=|!)=\s*' + quoted_string_re + '$')
  18 # PROGRAM can also be specified as an assignment.
  19 program_assign = re.compile(r'PROGRAM\s*=\s*' + quoted_string_re + '$')
  20 args_tests = re.compile(r'(ATTRS?|ENV|CONST|TEST){([a-zA-Z0-9/_.*%-]+)}\s*(?:=|!)=\s*' + quoted_string_re + '$')
  21 no_args_assign = re.compile(r'(NAME|SYMLINK|OWNER|GROUP|MODE|TAG|RUN|LABEL|GOTO|OPTIONS|IMPORT)\s*(?:\+=|:=|=)\s*' + quoted_string_re + '$')
  22 args_assign = re.compile(r'(ATTR|ENV|IMPORT|RUN){([a-zA-Z0-9/_.*%-]+)}\s*(=|\+=)\s*' + quoted_string_re + '$')
  23 # Find comma-separated groups, but allow commas that are inside quoted strings.
  24 # Using quoted_string_re + '?' so that strings missing the last double quote
  25 # will still match for this part that splits on commas.
  26 comma_separated_group_re = re.compile(r'(?:[^,"]|' + quoted_string_re + '?)+')
  27
  28 result = 0
  29 buffer = ''
  30 for path in rules_files:
  31     print('# looking at {}'.format(path))
  32     lineno = 0
  33     for line in open(path):
  34         lineno += 1
  35
  36         # handle line continuation
  37         if line.endswith('\\\n'):
  38             buffer += line[:-2]
  39             continue
  40         else:
  41             line = buffer + line
  42             buffer = ''
  43
  44         # filter out comments and empty lines
  45         line = line.strip()
  46         if not line or line.startswith('#'):
  47             continue
  48
  49         # Separator ',' is normally optional but we make it mandatory here as
  50         # it generally improves the readability of the rules.
  51         for clause_match in comma_separated_group_re.finditer(line):
  52             clause = clause_match.group().strip()
  53             if not (no_args_tests.match(clause) or args_tests.match(clause) or
  54                     no_args_assign.match(clause) or args_assign.match(clause) or
  55                     program_assign.match(clause)):
  56
  57                 print('Invalid line {}:{}: {}'.format(path, lineno, line))
  58                 print('  clause:', clause)
  59                 print()
  60                 result = 1
  61                 break
  62
  63 sys.exit(result)