#!/usr/bin/perl # udev-test # # Provides automated testing of the udev binary. # The whole test is self contained in this file, except the matching sysfs tree. # Simply extend the @tests array, to add a new test variant. # # Every test is driven by its own temporary config file. # This program prepares the environment, creates the config and calls udev. # # udev parses the rules, looks at the provided sysfs and # first creates and then removes the device node. # After creation and removal the result is checked against the # expected value and the result is printed. # # Kay Sievers , 2003 # Leann Ogasawara , 2004 use warnings; use strict; my $PWD = $ENV{PWD}; my $sysfs = "sys/"; my $udev_bin = "../udev"; my $udev_root = "udev-root/"; # !!! directory will be removed !!! my $udev_db = ".udevdb"; my $udev_conf = "udev-test.conf"; my $udev_rules = "udev-test.rules"; # uncomment following line to run udev with valgrind. # Should make this a runtime option to the script someday... #my $udev_bin = "valgrind --tool=memcheck --leak-check=yes ../udev"; my @tests = ( { desc => "label test of scsi disc", subsys => "block", devpath => "/block/sda", exp_name => "boot_disk" , rules => < "label test of scsi partition", subsys => "block", devpath => "/block/sda/sda1", exp_name => "boot_disk1" , rules => < "label test of pattern match", subsys => "block", devpath => "/block/sda/sda1", exp_name => "boot_disk1" , rules => < "label test of multiple sysfs files", subsys => "block", devpath => "/block/sda/sda1", exp_name => "boot_disk1" , rules => < "label test of max sysfs files", subsys => "block", devpath => "/block/sda/sda1", exp_name => "boot_disk1" , rules => < "catch device by *", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor/0" , rules => < "catch device by * - take 2", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor/0" , rules => < "catch device by ?", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor/0" , rules => < "catch device by character class", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor/0" , rules => < "replace kernel name", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "Handle comment lines in config file (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "Handle comment lines in config file with whitespace (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "Handle whitespace only lines (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "whitespace" , rules => < "Handle empty lines in config file (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "Handle backslashed multi lines in config file (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "preserve backslashes, if they are not for a newline", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "aaa", rules => < "Handle stupid backslashed multi lines in config file (and replace kernel name)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "subdirectory handling", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "sub/direct/ory/visor" , rules => < "place on bus of scsi partition", subsys => "block", devpath => "/block/sda/sda3", exp_name => "first_disk3" , rules => < "test NAME substitution chars", subsys => "block", devpath => "/block/sda/sda3", exp_name => "Major:8:minor:3:kernelnumber:3:bus:0:0:0:0" , rules => < "test NAME substitution chars (with length limit)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "M8-m3-n3-b0:0-sIBM" , rules => < "sustitution of sysfs value (%s{file})", subsys => "block", devpath => "/block/sda", exp_name => "disk-IBM-ESXS-sda" , rules => < "program result substitution", subsys => "block", devpath => "/block/sda/sda3", exp_name => "special-device-3" , rules => < "program result substitution (no argument should be subsystem)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "subsys_block" , rules => < "program result substitution (newline removal)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "newline_removed" , rules => < "program result substitution", subsys => "block", devpath => "/block/sda/sda3", exp_name => "test-0:0:0:0" , rules => < "program with escaped format char (tricky: callout returns format char!)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "escape-3" , rules => < "program with lots of arguments", subsys => "block", devpath => "/block/sda/sda3", exp_name => "foo9" , rules => < "program with subshell", subsys => "block", devpath => "/block/sda/sda3", exp_name => "bar9" , rules => < "program arguments combined with apostrophes", subsys => "block", devpath => "/block/sda/sda3", exp_name => "foo7" , rules => < "characters before the %c{N} substitution", subsys => "block", devpath => "/block/sda/sda3", exp_name => "my-foo9" , rules => < "substitute the second to last argument", subsys => "block", devpath => "/block/sda/sda3", exp_name => "my-foo8" , rules => < "invalid program for device with no bus", subsys => "tty", devpath => "/class/tty/console", exp_name => "TTY" , rules => < "valid program for device with no bus", subsys => "tty", devpath => "/class/tty/console", exp_name => "foo" , rules => < "invalid label for device with no bus", subsys => "tty", devpath => "/class/tty/console", exp_name => "TTY" , rules => < "valid label for device with no bus", subsys => "tty", devpath => "/class/tty/console", exp_name => "foo" , rules => < "program and bus type match", subsys => "block", devpath => "/block/sda", exp_name => "scsi-0:0:0:0" , rules => < "create all possible partitions", subsys => "block", devpath => "/block/sda", exp_name => "boot_disk15" , rules => < "sysfs parent hierarchy", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor" , rules => < "name test with ! in the name", subsys => "block", devpath => "/block/rd!c0d0", exp_name => "rd/c0d0" , rules => < "name test with ! in the name, but no matching rule", subsys => "block", devpath => "/block/rd!c0d0", exp_name => "rd/c0d0" , rules => < "name test with ! in the name for a partition", subsys => "block", devpath => "/block/cciss!c0d0/cciss!c0d0p1", exp_name => "cciss/c0d0p1" , rules => < "ID rule", subsys => "block", devpath => "/block/sda", exp_name => "scsi-0:0:0:0", rules => < "ID wildcard all", subsys => "block", devpath => "/block/sda", exp_name => "scsi-0:0:0:0", rules => < "ID wildcard partial", subsys => "block", devpath => "/block/sda", exp_name => "scsi-0:0:0:0", rules => < "ID wildcard partial 2", subsys => "block", devpath => "/block/sda", exp_name => "scsi-0:0:0:0", rules => < "ignore SYSFS attribute whitespace", subsys => "block", devpath => "/block/sda", exp_name => "ignored", rules => < "do not ignore SYSFS attribute whitespace", subsys => "block", devpath => "/block/sda", exp_name => "matched-with-space", rules => < "permissions USER=bad GROUP=name", subsys => "tty", devpath => "/class/tty/tty33", exp_name => "tty33", exp_perms => "0:0:0660", rules => < "permissions OWNER=5000", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => "5000::0660", rules => < "permissions GROUP=100", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => ":100:0660", rules => < "textual user id", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => "nobody::0660", rules => < "textual group id", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => ":daemon:0660", rules => < "textual user/group id", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => "root:mail:0660", rules => < "permissions MODE=0777", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => "::0777", rules => < "permissions OWNER=5000 GROUP=100 MODE=0777", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_perms => "5000:100:0777", rules => < "permissions OWNER to 5000", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "5000::", rules => < "permissions GROUP to 100", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => ":100:0660", rules => < "permissions MODE to 0060", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "::0060", rules => < "permissions OWNER, GROUP, MODE", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "5000:100:0777", rules => < "permissions only rule", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "5000:100:0777", rules => < "multiple permissions only rule", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "3000:4000:0777", rules => < "permissions only rule with override at NAME rule", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "ttyUSB0", exp_perms => "3000:8000:0777", rules => < "major/minor number test", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_majorminor => "8:0", rules => < "big minor number test", subsys => "i2c-dev", devpath => "/class/i2c-dev/i2c-300", exp_name => "node", exp_majorminor => "89:300", rules => < "big major number test", subsys => "i2c-dev", devpath => "/class/i2c-dev/i2c-fake1", exp_name => "node", exp_majorminor => "4095:1", rules => < "big major and big minor number test", subsys => "i2c-dev", devpath => "/class/i2c-dev/i2c-fake2", exp_name => "node", exp_majorminor => "4094:89999", rules => < "multiple symlinks with format char", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "symlink2-ttyUSB0", exp_target => "ttyUSB0", rules => < "symlink creation (same directory)", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "visor0", exp_target => "ttyUSB0", rules => < "symlink creation (relative link forward)", subsys => "block", devpath => "/block/sda/sda2", exp_name => "1/2/symlink" , exp_target => "a/b/node", rules => < "symlink creation (relative link back and forward)", subsys => "block", devpath => "/block/sda/sda2", exp_name => "1/2/c/d/symlink" , exp_target => "../../a/b/node", rules => < "multiple symlinks", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "second-0" , exp_target => "visor" , rules => < "symlink only rule", subsys => "block", devpath => "/block/sda", exp_name => "symlink-only2", exp_target => "link", rules => < "symlink name '.'", subsys => "block", devpath => "/block/sda", exp_name => ".", exp_target => "link", exp_add_error => "yes", exp_rem_error => "yes", rules => < "symlink node to itself", subsys => "tty", devpath => "/class/tty/tty0", exp_name => "link", exp_target => "link", exp_rem_error => "yes", option => "clean", rules => < "symlink %n substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "symlink0", exp_target => "ttyUSB0", rules => < "symlink %k substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "symlink-ttyUSB0", exp_target => "ttyUSB0", rules => < "symlink %M:%m substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "major-188:0", exp_target => "ttyUSB0", rules => < "symlink %b substitution", subsys => "block", devpath => "/block/sda", exp_name => "symlink-0:0:0:0", exp_target => "node", rules => < "symlink %c substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "test", exp_target => "ttyUSB0", rules => < "symlink %c{N} substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "test", exp_target => "ttyUSB0", rules => < "symlink %c{N+} substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "this", exp_target => "ttyUSB0", rules => < "symlink only rule with %c{N+}", subsys => "block", devpath => "/block/sda", exp_name => "test", exp_target => "link", rules => < "symlink %s{filename} substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "188:0", exp_target => "ttyUSB0", rules => < "symlink %Ns{filename} substitution", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "188", exp_target => "ttyUSB0", rules => < "symlink with '%' in name", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "percent%sign", exp_target => "ttyUSB0", rules => < "symlink with '%' in name", subsys => "tty", devpath => "/class/tty/ttyUSB0", exp_name => "%ttyUSB0_name", exp_target => "ttyUSB0", rules => < "program result substitution (numbered part of)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "link1", exp_target => "node", rules => < "program result substitution (numbered part of+)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "link4", exp_target => "node", rules => < "enumeration char test (single test)", subsys => "block", devpath => "/block/sda", exp_name => "cdrom", rules => < "enumeration char test sequence 1/5 (keep)", subsys => "block", devpath => "/block/sda", exp_name => "cdrom", option => "keep", rules => < "enumeration char test sequence 2/5 (keep)", subsys => "block", devpath => "/block/sda/sda1", exp_name => "enum", option => "keep", rules => < "enumeration char test sequence 3/5 (keep)", subsys => "block", devpath => "/block/sda/sda2", exp_name => "cdrom1", option => "keep", rules => < "enumeration char test sequence 4/5 (keep)", subsys => "block", devpath => "/block/sda/sda3", exp_name => "enum1", option => "keep", rules => < "enumeration char test sequence 5/5 (clean)", subsys => "block", devpath => "/block/sda/sda4", exp_name => "cdrom2", option => "clean", rules => < "enumeration char test after cleanup (single test)", subsys => "block", devpath => "/block/sda", exp_name => "cdrom", rules => < "ignore rule test", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_add_error => "yes", rules => < "all_partitions, option-only rule", subsys => "block", devpath => "/block/sda", exp_name => "node6", rules => < "all_partitions, option-only rule (fail on partition)", subsys => "block", devpath => "/block/sda/sda1", exp_name => "node6", exp_add_error => "yes", rules => < "ignore remove event test", subsys => "block", devpath => "/block/sda", exp_name => "node", exp_rem_error => "yes", rules => < "ignore remove event test (with all partitions)", subsys => "block", devpath => "/block/sda", exp_name => "node14", exp_rem_error => "yes", option => "clean", rules => < "SUBSYSTEM match test", subsys => "block", devpath => "/block/sda", exp_name => "node", rules => < "DRIVER match test", subsys => "block", devpath => "/block/sda", exp_name => "node", rules => < "temporary node creation test", subsys => "block", devpath => "/block/sda", exp_name => "node", rules => < "devpath substitution test", subsys => "block", devpath => "/block/sda", exp_name => "sda", rules => < "parent node name substitution test sequence 1/2 (keep)", subsys => "block", devpath => "/block/sda", exp_name => "main_device", option => "keep", rules => < "parent node name substitution test sequence 2/2 (clean)", subsys => "block", devpath => "/block/sda/sda1", exp_name => "main_device-part-1", option => "clean", rules => < "udev_root substitution", subsys => "block", devpath => "/block/sda/sda1", exp_name => "start-udev-root-end", rules => < "last_rule option", subsys => "block", devpath => "/block/sda/sda1", exp_name => "last", rules => < "negation KERNEL!=", subsys => "block", devpath => "/block/sda/sda1", exp_name => "match", rules => < "negation SUBSYSTEM!=", subsys => "block", devpath => "/block/sda/sda1", exp_name => "not-anything", rules => < "negation PROGRAM!= exit code", subsys => "block", devpath => "/block/sda/sda1", exp_name => "nonzero-program", rules => < "test for whitespace between the operator", subsys => "block", devpath => "/block/sda/sda1", exp_name => "true", rules => < "ENV{} test", subsys => "block", devpath => "/block/sda/sda1", exp_name => "true", rules => < "ENV{} test", subsys => "block", devpath => "/block/sda/sda1", exp_name => "true", rules => < "untrusted string sanitize", subsys => "block", devpath => "/block/sda/sda1", exp_name => "sane", rules => < "read sysfs value from device down in the chain", subsys => "block", devpath => "/class/tty/ttyUSB0", exp_name => "serial-0000:00:09.0", rules => < "match against empty key string", subsys => "block", devpath => "/block/sda", exp_name => "ok", rules => < "check ACTION value", subsys => "block", devpath => "/block/sda", exp_name => "ok", rules => < "apply NAME only once", subsys => "block", devpath => "/block/sda", exp_name => "link", exp_target => "ok", rules => < "test RUN key", subsys => "block", devpath => "/block/sda", exp_name => "testsymlink", exp_target => "ok", exp_rem_error => "yes", option => "clean", rules => < "test RUN key and DEVNAME", subsys => "block", devpath => "/block/sda", exp_name => "testsymlink", exp_target => "ok", exp_rem_error => "yes", option => "clean", rules => < "test RUN key remove", subsys => "block", devpath => "/block/sda", exp_name => "testsymlink2", exp_target => "ok2", rules => <$udev_rules" || die "unable to create rules file: $udev_rules"; print CONF $$rules; close CONF; $ENV{ACTION} = $action; system("$udev_bin $subsys"); } my $error = 0; sub permissions_test { my($rules, $uid, $gid, $mode) = @_; my $wrong = 0; my $userid; my $groupid; $rules->{exp_perms} =~ m/^(.*):(.*):(.*)$/; if ($1 ne "") { if (defined(getpwnam($1))) { $userid = int(getpwnam($1)); } else { $userid = $1; } if ($uid != $userid) { $wrong = 1; } } if ($2 ne "") { if (defined(getgrnam($2))) { $groupid = int(getgrnam($2)); } else { $groupid = $2; } if ($gid != $groupid) { $wrong = 1; } } if ($3 ne "") { if (($mode & 07777) != oct($3)) { $wrong = 1; }; } if ($wrong == 0) { print "permissions: ok\n"; } else { printf " expected permissions are: %s:%s:%#o\n", $1, $2, oct($3); printf " created permissions are : %i:%i:%#o\n", $uid, $gid, $mode & 07777; print "permissions: error\n"; $error++; } } sub major_minor_test { my($rules, $rdev) = @_; my $major = ($rdev >> 8) & 0xfff; my $minor = ($rdev & 0xff) | (($rdev >> 12) & 0xfff00); my $wrong = 0; $rules->{exp_majorminor} =~ m/^(.*):(.*)$/; if ($1 ne "") { if ($major != $1) { $wrong = 1; }; } if ($2 ne "") { if ($minor != $2) { $wrong = 1; }; } if ($wrong == 0) { print "major:minor: ok\n"; } else { printf " expected major:minor is: %i:%i\n", $1, $2; printf " created major:minor is : %i:%i\n", $major, $minor; print "major:minor: error\n"; $error++; } } sub symlink_test { my ($rules) = @_; my $output = `ls -l $PWD/$udev_root$rules->{exp_name}`; if ($output =~ m/(.*)-> (.*)/) { if ($2 eq $rules->{exp_target}) { print "symlink: ok\n"; } else { print " expected symlink from: \'$rules->{exp_name}\' to \'$rules->{exp_target}\'\n"; print " created symlink from: \'$rules->{exp_name}\' to \'$2\'\n"; print "symlink: error"; if ($rules->{exp_add_error}) { print " as expected\n"; } else { print "\n"; $error++; } } } else { print " expected symlink from: \'$rules->{exp_name}\' to \'$rules->{exp_target}\'\n"; print "symlink: not created"; if ($rules->{exp_add_error}) { print " as expected\n"; } else { print "\n"; $error++; } } } sub run_test { my ($rules, $number) = @_; print "TEST $number: $rules->{desc}\n"; if ($rules->{exp_target}) { print "device \'$rules->{devpath}\' expecting symlink '$rules->{exp_name}' to node \'$rules->{exp_target}\'\n"; } else { print "device \'$rules->{devpath}\' expecting node \'$rules->{exp_name}\'\n"; } udev("add", $rules->{subsys}, $rules->{devpath}, \$rules->{rules}); if ((-e "$PWD/$udev_root$rules->{exp_name}") || (-l "$PWD/$udev_root$rules->{exp_name}")) { my ($dev, $ino, $mode, $nlink, $uid, $gid, $rdev, $size, $atime, $mtime, $ctime, $blksize, $blocks) = stat("$PWD/$udev_root$rules->{exp_name}"); if (defined($rules->{exp_perms})) { permissions_test($rules, $uid, $gid, $mode); } if (defined($rules->{exp_majorminor})) { major_minor_test($rules, $rdev); } if (defined($rules->{exp_target})) { symlink_test($rules); } print "add: ok\n"; } else { print "add: error"; if ($rules->{exp_add_error}) { print " as expected\n"; } else { print "\n"; system("tree $udev_root"); print "\n"; $error++; } } if (defined($rules->{option}) && $rules->{option} eq "keep") { print "\n\n"; return; } udev("remove", $rules->{subsys}, $rules->{devpath}, \$rules->{rules}); if ((-e "$PWD/$udev_root$rules->{exp_name}") || (-l "$PWD/$udev_root$rules->{exp_name}")) { print "remove: error"; if ($rules->{exp_rem_error}) { print " as expected\n"; } else { print "\n"; system("tree $udev_root"); print "\n"; $error++; } } else { print "remove: ok\n"; } print "\n"; if (defined($rules->{option}) && $rules->{option} eq "clean") { system("rm -rf $udev_db"); system("rm -rf $udev_root"); mkdir($udev_root) || die "unable to create udev_root: $udev_root\n"; } } # only run if we have root permissions # due to mknod restrictions if (!($<==0)) { print "Must have root permissions to run properly.\n"; exit; } # prepare system("rm -rf $udev_root"); mkdir($udev_root) || die "unable to create udev_root: $udev_root\n"; # create config file open CONF, ">$udev_conf" || die "unable to create config file: $udev_conf"; print CONF "udev_root=\"$udev_root\"\n"; print CONF "udev_db=\"$udev_db\"\n"; print CONF "udev_rules=\"$udev_rules\"\n"; close CONF; my $test_num = 1; if ($ARGV[0]) { # only run one test $test_num = $ARGV[0]; if (defined($tests[$test_num-1]->{desc})) { print "udev-test will run test number $test_num only:\n\n"; run_test($tests[$test_num-1], $test_num); } else { print "test does not exist.\n"; } } else { # test all print "\nudev-test will run ".($#tests + 1)." tests:\n\n"; foreach my $rules (@tests) { run_test($rules, $test_num); $test_num++; } } print "$error errors occured\n\n"; # cleanup system("rm -rf $udev_db"); system("rm -rf $udev_root"); unlink($udev_rules); unlink($udev_conf);