#!/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 reads the config, 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. # # happy testing, # Kay Sievers <kay.sievers@vrfy.org>, 2003 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 = ".udev.tdb"; my $perm = "udev.permissions"; my $main_conf = "udev-test.conf"; my $conf_tmp = "udev-test.rules"; my @tests = ( { desc => "label test of scsi disc", subsys => "block", devpath => "block/sda", expected => "boot_disk" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="boot_disk%n" KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "label test of scsi partition", subsys => "block", devpath => "block/sda/sda1", expected => "boot_disk1" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="boot_disk%n" EOF }, { desc => "label test of pattern match", subsys => "block", devpath => "block/sda/sda1", expected => "boot_disk1" , conf => <<EOF BUS="scsi", SYSFS{vendor}="?IBM-ESXS", NAME="boot_disk%n-1" BUS="scsi", SYSFS{vendor}="IBM-ESXS?", NAME="boot_disk%n-2" BUS="scsi", SYSFS{vendor}="IBM-ES??", NAME="boot_disk%n" BUS="scsi", SYSFS{vendor}="IBM-ESXSS", NAME="boot_disk%n-3" EOF }, { desc => "label test of multiple sysfs files", subsys => "block", devpath => "block/sda/sda1", expected => "boot_disk1" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", SYSFS{model}="ST336605LW !#", NAME="boot_diskX%n" BUS="scsi", SYSFS{vendor}="IBM-ESXS", SYSFS{model}="ST336605LW !#", NAME="boot_disk%n" EOF }, { desc => "label test of max sysfs files", subsys => "block", devpath => "block/sda/sda1", expected => "boot_disk1" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", SYSFS{model}="ST336605LW !#", SYSFS{scsi_level}="4", SYSFS{rev}="B245", SYSFS{type}="2", SYSFS{queue_depth}="32", NAME="boot_diskXX%n" BUS="scsi", SYSFS{vendor}="IBM-ESXS", SYSFS{model}="ST336605LW !#", SYSFS{scsi_level}="4", SYSFS{rev}="B245", SYSFS{type}="0", NAME="boot_disk%n" EOF }, { desc => "catch device by *", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor/0" , conf => <<EOF KERNEL="ttyUSB*", NAME="visor/%n" EOF }, { desc => "catch device by * - take 2", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor/0" , conf => <<EOF KERNEL="*USB1", NAME="bad" KERNEL="*USB0", NAME="visor/%n" EOF }, { desc => "catch device by ?", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor/0" , conf => <<EOF KERNEL="ttyUSB??*", NAME="visor/%n-1" KERNEL="ttyUSB??", NAME="visor/%n-2" KERNEL="ttyUSB?", NAME="visor/%n" EOF }, { desc => "catch device by character class", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor/0" , conf => <<EOF KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1" KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2" KERNEL="ttyUSB[0-9]*", NAME="visor/%n" EOF }, { desc => "replace kernel name", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor" , conf => <<EOF KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "Handle comment lines in config file (and replace kernel name)", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor" , conf => <<EOF # this is a comment KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "Handle comment lines in config file with whitespace (and replace kernel name)", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor" , conf => <<EOF # this is a comment with whitespace before the comment KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "Handle empty lines in config file (and replace kernel name)", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor" , conf => <<EOF KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "subdirectory handling", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "sub/direct/ory/visor" , conf => <<EOF KERNEL="ttyUSB0", NAME="sub/direct/ory/visor" EOF }, { desc => "place on bus of scsi partition", subsys => "block", devpath => "block/sda/sda3", expected => "first_disk3" , conf => <<EOF BUS="scsi", PLACE="0:0:0:0", NAME="first_disk%n" EOF }, { desc => "test NAME substitution chars", subsys => "block", devpath => "block/sda/sda3", expected => "Major:8:minor:3:kernelnumber:3:bus:0:0:0:0" , conf => <<EOF BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b" EOF }, { desc => "old style SYSFS_ attribute", subsys => "block", devpath => "block/sda", expected => "good" , conf => <<EOF BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="good" EOF }, { desc => "sustitution of sysfs value (%s{file})", subsys => "block", devpath => "block/sda", expected => "disk-IBM-ESXS-sda" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="disk-%s{vendor}-%k" KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "program result substitution", subsys => "block", devpath => "block/sda/sda3", expected => "special-device-3" , conf => <<EOF BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="-special-*", NAME="%c-1-%n" BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special--*", NAME="%c-2-%n" BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-device-", NAME="%c-3-%n" BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-devic", NAME="%c-4-%n" BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-*", NAME="%c-%n" EOF }, { desc => "program result substitution", subsys => "block", devpath => "block/sda/sda3", expected => "test-0:0:0:0" , conf => <<EOF BUS="scsi", PROGRAM="/bin/echo -n test-%b", RESULT="test-0:0*", NAME="%c" EOF }, { desc => "program with escaped format char (tricky: callout returns format char!)", subsys => "block", devpath => "block/sda/sda3", expected => "escape-3" , conf => <<EOF BUS="scsi", PROGRAM="/bin/echo -n escape-%%n", KERNEL="sda3", NAME="%c" EOF }, { desc => "program result substitution (numbered part of)", subsys => "block", devpath => "block/sda/sda3", expected => "link1" , conf => <<EOF BUS="scsi", PROGRAM="/bin/echo -n node link1 link2", RESULT="node *", NAME="%c{1}", SYMLINK="%c{2} %c{3}" EOF }, { desc => "invalid program for device with no bus", subsys => "tty", devpath => "class/tty/console", expected => "TTY" , conf => <<EOF BUS="scsi", PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo" KERNEL="console", NAME="TTY" EOF }, { desc => "valid program for device with no bus", subsys => "tty", devpath => "class/tty/console", expected => "foo" , conf => <<EOF PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo" KERNEL="console", NAME="TTY" EOF }, { desc => "invalid label for device with no bus", subsys => "tty", devpath => "class/tty/console", expected => "TTY" , conf => <<EOF BUS="foo", SYSFS{dev}="5:1", NAME="foo" KERNEL="console", NAME="TTY" EOF }, { desc => "valid label for device with no bus", subsys => "tty", devpath => "class/tty/console", expected => "foo" , conf => <<EOF SYSFS{dev}="5:1", NAME="foo" KERNEL="console", NAME="TTY" EOF }, { desc => "program and bus type match", subsys => "block", devpath => "block/sda", expected => "scsi-0:0:0:0" , conf => <<EOF BUS="usb", PROGRAM="/bin/echo -n usb-%b", NAME="%c" BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", NAME="%c" BUS="foo", PROGRAM="/bin/echo -n foo-%b", NAME="%c" EOF }, { desc => "symlink creation (same directory)", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor0" , conf => <<EOF KERNEL="ttyUSB[0-9]*", NAME="ttyUSB%n", SYMLINK="visor%n" EOF }, { desc => "symlink creation (relative link back)", subsys => "block", devpath => "block/sda/sda2", expected => "1/2/a/b/symlink" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="1/2/node", SYMLINK="1/2/a/b/symlink" EOF }, { desc => "symlink creation (relative link forward)", subsys => "block", devpath => "block/sda/sda2", expected => "1/2/symlink" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/symlink" EOF }, { desc => "symlink creation (relative link back and forward)", subsys => "block", devpath => "block/sda/sda2", expected => "1/2/c/d/symlink" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/c/d/symlink" EOF }, { desc => "multiple symlinks", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "second-0" , conf => <<EOF KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n" EOF }, { desc => "create all possible partitions", subsys => "block", devpath => "block/sda", expected => "boot_disk15" , conf => <<EOF BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME{all_partitions}="boot_disk" EOF }, { desc => "sysfs parent hierarchy", subsys => "tty", devpath => "class/tty/ttyUSB0", expected => "visor" , conf => <<EOF SYSFS{idProduct}="2008", NAME="visor" EOF }, { desc => "name test with ! in the name", subsys => "block", devpath => "block/rd!c0d0", expected => "rd/c0d0" , conf => <<EOF BUS="scsi", NAME="%k" KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "name test with ! in the name, but no matching rule", subsys => "block", devpath => "block/rd!c0d0", expected => "rd/c0d0" , conf => <<EOF KERNEL="ttyUSB0", NAME="visor" EOF }, { desc => "ID rule", subsys => "block", devpath => "block/sda", expected => "scsi-0:0:0:0", conf => <<EOF BUS="usb", ID="0:0:0:0", NAME="not-scsi" BUS="scsi", ID="0:0:0:1", NAME="no-match" BUS="scsi", ID=":0", NAME="short-id" BUS="scsi", ID="/0:0:0:0", NAME="no-match" BUS="scsi", ID="0:0:0:0", NAME="scsi-0:0:0:0" EOF }, { desc => "ID wildcard all", subsys => "block", devpath => "block/sda", expected => "scsi-0:0:0:0", conf => <<EOF BUS="scsi", ID="*:1", NAME="no-match" BUS="scsi", ID="*:0:1", NAME="no-match" BUS="scsi", ID="*:0:0:1", NAME="no-match" BUS="scsi", ID="*", NAME="scsi-0:0:0:0" BUS="scsi", ID="0:0:0:0", NAME="bad" EOF }, { desc => "ID wildcard partial", subsys => "block", devpath => "block/sda", expected => "scsi-0:0:0:0", conf => <<EOF BUS="scsi", ID="*:0", NAME="scsi-0:0:0:0" BUS="scsi", ID="0:0:0:0", NAME="bad" EOF }, { desc => "ID wildcard partial 2", subsys => "block", devpath => "block/sda", expected => "scsi-0:0:0:0", conf => <<EOF BUS="scsi", ID="*:0:0:0", NAME="scsi-0:0:0:0" BUS="scsi", ID="0:0:0:0", NAME="bad" EOF }, ); # set env $ENV{UDEV_TEST} = "yes"; $ENV{SYSFS_PATH} = $sysfs; $ENV{UDEV_CONFIG_FILE} = $main_conf; sub udev { my ($action, $subsys, $devpath, $config) = @_; $ENV{DEVPATH} = $devpath; # create temporary config open CONF, ">$conf_tmp" || die "unable to create config file: $conf_tmp"; print CONF $$config; close CONF; $ENV{ACTION} = $action; system("$udev_bin $subsys"); } my $error = 0; sub run_test { my ($config, $number) = @_; print "TEST $number: $config->{desc}\n"; print "device \'$config->{devpath}\' expecting node \'$config->{expected}\'\n"; udev("add", $config->{subsys}, $config->{devpath}, \$config->{conf}); if (-e "$PWD/$udev_root$config->{expected}") { print "add: ok "; } else { print "add: error\n"; system("tree $udev_root"); print "\n"; $error++; } udev("remove", $config->{subsys}, $config->{devpath}, \$config->{conf}); if ((-e "$PWD/$udev_root$config->{expected}") || (-l "$PWD/$udev_root$config->{expected}")) { print "remove: error\n\n"; system("tree $udev_root"); $error++; } else { print "remove: ok\n\n"; } } # prepare system("rm -rf $udev_root"); mkdir($udev_root) || die "unable to create udev_root: $udev_root\n"; # create initial config file open CONF, ">$main_conf" || die "unable to create config file: $main_conf"; print CONF "udev_root=\"$udev_root\"\n"; print CONF "udev_db=\"$udev_db\"\n"; print CONF "udev_rules=\"$conf_tmp\"\n"; print CONF "udev_permissions=\"$perm\"\n"; close CONF; my $test_num = 1; if ($ARGV[0]) { # only run one test $test_num = $ARGV[0]; print "udev-test will run test number $test_num only\n"; run_test($tests[$test_num-1], $test_num); } else { # test all print "\nudev-test will run ".($#tests + 1)." tests:\n\n"; foreach my $config (@tests) { run_test($config, $test_num); $test_num++; } } print "$error errors occured\n\n"; # cleanup unlink($udev_db); system("rm -rf $udev_root"); unlink($conf_tmp); unlink($main_conf);