summaryrefslogtreecommitdiffstats
path: root/test/rule-syntax-check.py
diff options
context:
space:
mode:
Diffstat (limited to '')
-rwxr-xr-xtest/rule-syntax-check.py63
1 files changed, 63 insertions, 0 deletions
diff --git a/test/rule-syntax-check.py b/test/rule-syntax-check.py
new file mode 100755
index 0000000..ec1c75a
--- /dev/null
+++ b/test/rule-syntax-check.py
@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: LGPL-2.1-or-later
+#
+# Simple udev rules syntax checker
+#
+# © 2010 Canonical Ltd.
+# Author: Martin Pitt <martin.pitt@ubuntu.com>
+
+import re
+import sys
+
+rules_files = sys.argv[1:]
+if not rules_files:
+ sys.exit('Specify files to test as arguments')
+
+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 rules_files:
+ print('# looking at {}'.format(path))
+ lineno = 0
+ for line in open(path):
+ lineno += 1
+
+ # handle line continuation
+ if line.endswith('\\\n'):
+ buffer += line[:-2]
+ continue
+ else:
+ line = buffer + line
+ buffer = ''
+
+ # filter out comments and empty lines
+ line = line.strip()
+ if not line or line.startswith('#'):
+ continue
+
+ # 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) or
+ program_assign.match(clause)):
+
+ print('Invalid line {}:{}: {}'.format(path, lineno, line))
+ print(' clause:', clause)
+ print()
+ result = 1
+ break
+
+sys.exit(result)