]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - test/rule-syntax-check.py
network: introduce Announce= in [DHCPv6PrefixDelegation]
[thirdparty/systemd.git] / test / rule-syntax-check.py
index b18f8780cbbf6d158ddb6b202922e950efd88121..658b9459a90a984fb64e2d1f33c4430542b04572 100755 (executable)
@@ -1,38 +1,36 @@
-#!/usr/bin/python
+#!/usr/bin/env python3
+# SPDX-License-Identifier: LGPL-2.1+
+#
 # Simple udev rules syntax checker
 #
-# (C) 2010 Canonical Ltd.
+# © 2010 Canonical Ltd.
 # Author: Martin Pitt <martin.pitt@ubuntu.com>
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 import re
 import sys
+import os
+from glob import glob
 
-if len(sys.argv) < 2:
-    print >> sys.stderr, 'Usage: %s <rules file> [...]' % sys.argv[0]
-    sys.exit(2)
+rules_files = sys.argv[1:]
+if not rules_files:
+    sys.exit('Specify files to test as arguments')
 
-no_args_tests = re.compile('(ACTION|DEVPATH|KERNELS?|NAME|SYMLINK|SUBSYSTEMS?|DRIVERS?|TAG|RESULT|TEST)\s*(?:=|!)=\s*"([^"]*)"$')
-args_tests = re.compile('(ATTRS?|ENV|TEST){([a-zA-Z0-9/_.*%-]+)}\s*(?:=|!)=\s*"([^"]*)"$')
-no_args_assign = re.compile('(NAME|SYMLINK|OWNER|GROUP|MODE|TAG|PROGRAM|RUN|LABEL|GOTO|WAIT_FOR|OPTIONS|IMPORT)\s*(?:\+=|:=|=)\s*"([^"]*)"$')
-args_assign = re.compile('(ATTR|ENV|IMPORT|RUN){([a-zA-Z0-9/_.*%-]+)}\s*(=|\+=)\s*"([^"]*)"$')
+quoted_string_re = r'"(?:[^\\"]|\\.)*"'
+no_args_tests = re.compile(r'(ACTION|DEVPATH|KERNELS?|NAME|SYMLINK|SUBSYSTEMS?|DRIVERS?|TAG|PROGRAM|RESULT|TEST)\s*(?:=|!)=\s*' + quoted_string_re + '$')
+# PROGRAM can also be specified as an assignment.
+program_assign = re.compile(r'PROGRAM\s*=\s*' + quoted_string_re + '$')
+args_tests = re.compile(r'(ATTRS?|ENV|CONST|TEST){([a-zA-Z0-9/_.*%-]+)}\s*(?:=|!)=\s*' + quoted_string_re + '$')
+no_args_assign = re.compile(r'(NAME|SYMLINK|OWNER|GROUP|MODE|TAG|RUN|LABEL|GOTO|OPTIONS|IMPORT)\s*(?:\+=|:=|=)\s*' + quoted_string_re + '$')
+args_assign = re.compile(r'(ATTR|ENV|IMPORT|RUN){([a-zA-Z0-9/_.*%-]+)}\s*(=|\+=)\s*' + quoted_string_re + '$')
+# Find comma-separated groups, but allow commas that are inside quoted strings.
+# Using quoted_string_re + '?' so that strings missing the last double quote
+# will still match for this part that splits on commas.
+comma_separated_group_re = re.compile(r'(?:[^,"]|' + quoted_string_re + '?)+')
 
 result = 0
 buffer = ''
-for path in sys.argv[1:]:
+for path in rules_files:
+    print('# looking at {}'.format(path))
     lineno = 0
     for line in open(path):
         lineno += 1
@@ -50,12 +48,15 @@ for path in sys.argv[1:]:
         if not line or line.startswith('#'):
             continue
 
-        for clause in line.split(','):
-            clause = clause.strip()
+        # Separator ',' is normally optional but we make it mandatory here as
+        # it generally improves the readability of the rules.
+        for clause_match in comma_separated_group_re.finditer(line):
+            clause = clause_match.group().strip()
             if not (no_args_tests.match(clause) or args_tests.match(clause) or
-                    no_args_assign.match(clause) or args_assign.match(clause)):
+                    no_args_assign.match(clause) or args_assign.match(clause) or
+                    program_assign.match(clause)):
 
-                print('Invalid line %s:%i: %s' % (path, lineno, line))
+                print('Invalid line {}:{}: {}'.format(path, lineno, line))
                 print('  clause:', clause)
                 print()
                 result = 1