chiark / gitweb /
Add automatic rules syntax check
authorMartin Pitt <martin.pitt@ubuntu.com>
Tue, 21 Sep 2010 10:45:52 +0000 (12:45 +0200)
committerMartin Pitt <martin.pitt@ubuntu.com>
Tue, 21 Sep 2010 10:45:52 +0000 (12:45 +0200)
Add test/rule-syntax-check.py, a script for checking the syntax of all udev
rules files passed as command line arguments.

Add a wrapper test/rules-test.sh which calls rule-syntax-check.py on all udev
rules that we ship, but does nothing if Python is not available. Integrate this
into make check/distcheck.

Makefile.am
test/rule-syntax-check.py [new file with mode: 0755]
test/rules-test.sh [new file with mode: 0755]

index 44cf002..f124396 100644 (file)
@@ -183,7 +183,7 @@ EXTRA_DIST += \
 # ------------------------------------------------------------------------------
 # udev tests
 # ------------------------------------------------------------------------------
-TESTS = test/udev-test.pl
+TESTS = test/udev-test.pl test/rules-test.sh
 
 check_PROGRAMS = \
        libudev/test-libudev \
@@ -619,6 +619,7 @@ CLEANFILES += \
        $(BUILT_SOURCES)
 
 EXTRA_DIST += $(TESTS)
+EXTRA_DIST += test/rule-syntax-check.py
 
 install-exec-hook: $(INSTALL_EXEC_HOOKS)
 
diff --git a/test/rule-syntax-check.py b/test/rule-syntax-check.py
new file mode 100755 (executable)
index 0000000..6cb0215
--- /dev/null
@@ -0,0 +1,64 @@
+#!/usr/bin/python
+# Simple udev rules syntax checker
+#
+# (C) 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+import re
+import sys
+
+if len(sys.argv) < 2:
+    print >> sys.stderr, 'Usage: %s <rules file> [...]' % sys.argv[0]
+    sys.exit(2)
+
+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|SYMLINK{unique}|OWNER|GROUP|MODE|TAG|PROGRAM|RUN|RUN{ignore_error}|LABEL|GOTO|WAIT_FOR|OPTIONS|IMPORT)\s*(?:\+=|:=|=)\s*"([^"]*)"$')
+args_assign = re.compile('(ATTR|ENV|IMPORT){([a-zA-Z0-9/_.*%-]+)}\s*=\s*"([^"]*)"$')
+
+result = 0
+buffer = ''
+for path in sys.argv[1:]:
+    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
+
+        for clause in line.split(','):
+            clause = clause.strip()
+            if not (no_args_tests.match(clause) or args_tests.match(clause) or
+                    no_args_assign.match(clause) or args_assign.match(clause)):
+
+                print 'Invalid line %s:%i: %s' % (path, lineno, line)   
+                print '  clause:', clause
+                print
+                result = 1
+                break
+
+sys.exit(result)
diff --git a/test/rules-test.sh b/test/rules-test.sh
new file mode 100755 (executable)
index 0000000..9d5a07c
--- /dev/null
@@ -0,0 +1,17 @@
+#!/bin/sh
+# Call the udev rule syntax checker on all rules that we ship
+#
+# (C) 2010 Canonical Ltd.
+# Author: Martin Pitt <martin.pitt@ubuntu.com>
+
+set -e
+
+[ -n "$srcdir" ] || srcdir=`dirname $0`/..
+
+# skip if we don't have python
+type python >/dev/null 2>&1 || {
+    echo "$0: No python installed, skipping udev rule syntax check"
+    exit 0
+}
+
+$srcdir/test/rule-syntax-check.py `find $srcdir/rules -type f`