test/udev-test.pl

   1 #!/usr/bin/perl
   2
   3 # udev-test
   4 #
   5 # Provides automated testing of the udev binary.
   6 # The whole test is self contained in this file, except the matching sysfs tree.
   7 # Simply extend the @tests array, to add a new test variant.
   8 #
   9 # Every test is driven by its own temporary config file.
  10 # This program prepares the environment, creates the config and calls udev.
  11 #
  12 # udev reads the config, looks at the provided sysfs and
  13 # first creates and then removes the device node.
  14 # After creation and removal the result is checked against the
  15 # expected value and the result is printed.
  16 #
  17 # happy testing,
  18 # Kay Sievers <kay.sievers@vrfy.org>, 2003
  19
  20
  21 use warnings;
  22 use strict;
  23
  24 my $PWD = $ENV{PWD};
  25 my $sysfs     = "sys/";
  26 my $udev_bin  = "../udev";
  27 my $udev_root = "udev-root/"; # !!! directory will be removed !!!
  28 my $udev_db   = ".udev.tdb";
  29 my $perm      = "udev.permissions";
  30 my $main_conf = "udev-test.conf";
  31 my $conf_tmp  = "udev-test.rules";
  32
  33
  34 my @tests = (
  35         {
  36                 desc     => "label test of scsi disc",
  37                 subsys   => "block",
  38                 devpath  => "block/sda",
  39                 expected => "boot_disk" ,
  40                 conf     => <<EOF
  41 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="boot_disk%n"
  42 KERNEL="ttyUSB0", NAME="visor"
  43 EOF
  44         },
  45         {
  46                 desc     => "label test of scsi partition",
  47                 subsys   => "block",
  48                 devpath  => "block/sda/sda1",
  49                 expected => "boot_disk1" ,
  50                 conf     => <<EOF
  51 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="boot_disk%n"
  52 EOF
  53         },
  54         {
  55                 desc     => "label test of pattern match",
  56                 subsys   => "block",
  57                 devpath  => "block/sda/sda1",
  58                 expected => "boot_disk1" ,
  59                 conf     => <<EOF
  60 BUS="scsi", SYSFS_vendor="?IBM-ESXS", NAME="boot_disk%n-1"
  61 BUS="scsi", SYSFS_vendor="IBM-ESXS?", NAME="boot_disk%n-2"
  62 BUS="scsi", SYSFS_vendor="IBM-ES??", NAME="boot_disk%n"
  63 BUS="scsi", SYSFS_vendor="IBM-ESXSS", NAME="boot_disk%n-3"
  64 EOF
  65         },
  66         {
  67                 desc     => "label test of multiple sysfs files",
  68                 subsys   => "block",
  69                 devpath  => "block/sda/sda1",
  70                 expected => "boot_disk1" ,
  71                 conf     => <<EOF
  72 BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW   !#", NAME="boot_diskX%n"
  73 BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW    !#", NAME="boot_disk%n"
  74 EOF
  75         },
  76         {
  77                 desc     => "label test of max sysfs files",
  78                 subsys   => "block",
  79                 devpath  => "block/sda/sda1",
  80                 expected => "boot_disk1" ,
  81                 conf     => <<EOF
  82 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"
  83 BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW    !#", SYSFS_scsi_level="4", SYSFS_rev="B245", SYSFS_type="0", NAME="boot_disk%n"
  84 EOF
  85         },
  86         {
  87                 desc     => "catch device by *",
  88                 subsys   => "tty",
  89                 devpath  => "class/tty/ttyUSB0",
  90                 expected => "visor/0" ,
  91                 conf     => <<EOF
  92 KERNEL="ttyUSB*", NAME="visor/%n"
  93 EOF
  94         },
  95         {
  96                 desc     => "catch device by ?",
  97                 subsys   => "tty",
  98                 devpath  => "class/tty/ttyUSB0",
  99                 expected => "visor/0" ,
 100                 conf     => <<EOF
 101 KERNEL="ttyUSB??*", NAME="visor/%n-1"
 102 KERNEL="ttyUSB??", NAME="visor/%n-2"
 103 KERNEL="ttyUSB?", NAME="visor/%n"
 104 EOF
 105         },
 106         {
 107                 desc     => "catch device by character class",
 108                 subsys   => "tty",
 109                 devpath  => "class/tty/ttyUSB0",
 110                 expected => "visor/0" ,
 111                 conf     => <<EOF
 112 KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1"
 113 KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2"
 114 KERNEL="ttyUSB[0-9]*", NAME="visor/%n"
 115 EOF
 116         },
 117         {
 118                 desc     => "replace kernel name",
 119                 subsys   => "tty",
 120                 devpath  => "class/tty/ttyUSB0",
 121                 expected => "visor" ,
 122                 conf     => <<EOF
 123 KERNEL="ttyUSB0", NAME="visor"
 124 EOF
 125         },
 126         {
 127                 desc     => "Handle comment lines in config file (and replace kernel name)",
 128                 subsys   => "tty",
 129                 devpath  => "class/tty/ttyUSB0",
 130                 expected => "visor" ,
 131                 conf     => <<EOF
 132 # this is a comment
 133 KERNEL="ttyUSB0", NAME="visor"
 134
 135 EOF
 136         },
 137         {
 138                 desc     => "Handle comment lines in config file with whitespace (and replace kernel name)",
 139                 subsys   => "tty",
 140                 devpath  => "class/tty/ttyUSB0",
 141                 expected => "visor" ,
 142                 conf     => <<EOF
 143  # this is a comment with whitespace before the comment
 144 KERNEL="ttyUSB0", NAME="visor"
 145
 146 EOF
 147         },
 148         {
 149                 desc     => "Handle empty lines in config file (and replace kernel name)",
 150                 subsys   => "tty",
 151                 devpath  => "class/tty/ttyUSB0",
 152                 expected => "visor" ,
 153                 conf     => <<EOF
 154
 155 KERNEL="ttyUSB0", NAME="visor"
 156
 157 EOF
 158         },
 159         {
 160                 desc     => "subdirectory handling",
 161                 subsys   => "tty",
 162                 devpath  => "class/tty/ttyUSB0",
 163                 expected => "sub/direct/ory/visor" ,
 164                 conf     => <<EOF
 165 KERNEL="ttyUSB0", NAME="sub/direct/ory/visor"
 166 EOF
 167         },
 168         {
 169                 desc     => "place on bus of scsi partition",
 170                 subsys   => "block",
 171                 devpath  => "block/sda/sda3",
 172                 expected => "first_disk3" ,
 173                 conf     => <<EOF
 174 BUS="scsi", PLACE="0:0:0:0", NAME="first_disk%n"
 175 EOF
 176         },
 177         {
 178                 desc     => "test NAME substitution chars",
 179                 subsys   => "block",
 180                 devpath  => "block/sda/sda3",
 181                 expected => "Major:8:minor:3:kernelnumber:3:bus:0:0:0:0" ,
 182                 conf     => <<EOF
 183 BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b"
 184 EOF
 185         },
 186         {
 187                 desc     => "program result substitution",
 188                 subsys   => "block",
 189                 devpath  => "block/sda/sda3",
 190                 expected => "special-device-3" ,
 191                 conf     => <<EOF
 192 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="-special-*", NAME="%c-1-%n"
 193 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special--*", NAME="%c-2-%n"
 194 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-device-", NAME="%c-3-%n"
 195 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-devic", NAME="%c-4-%n"
 196 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-*", NAME="%c-%n"
 197 EOF
 198         },
 199         {
 200                 desc     => "program result substitution",
 201                 subsys   => "block",
 202                 devpath  => "block/sda/sda3",
 203                 expected => "test-0:0:0:0" ,
 204                 conf     => <<EOF
 205 BUS="scsi", PROGRAM="/bin/echo -n test-%b", RESULT="test-0:0*", NAME="%c"
 206 EOF
 207         },
 208         {
 209                 desc     => "program with escaped format char (tricky: callout returns format char!)",
 210                 subsys   => "block",
 211                 devpath  => "block/sda/sda3",
 212                 expected => "escape-3" ,
 213                 conf     => <<EOF
 214 BUS="scsi", PROGRAM="/bin/echo -n escape-%%n", KERNEL="sda3", NAME="%c"
 215 EOF
 216         },
 217         {
 218                 desc     => "program result substitution (numbered part of)",
 219                 subsys   => "block",
 220                 devpath  => "block/sda/sda3",
 221                 expected => "link1" ,
 222                 conf     => <<EOF
 223 BUS="scsi", PROGRAM="/bin/echo -n node link1 link2", RESULT="node *", NAME="%1c", SYMLINK="%2c %3c"
 224 EOF
 225         },
 226         {
 227                 desc     => "invalid program for device with no bus",
 228                 subsys   => "tty",
 229                 devpath  => "class/tty/console",
 230                 expected => "TTY" ,
 231                 conf     => <<EOF
 232 BUS="scsi", PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
 233 KERNEL="console", NAME="TTY"
 234 EOF
 235         },
 236         {
 237                 desc     => "valid program for device with no bus",
 238                 subsys   => "tty",
 239                 devpath  => "class/tty/console",
 240                 expected => "foo" ,
 241                 conf     => <<EOF
 242 PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
 243 KERNEL="console", NAME="TTY"
 244 EOF
 245         },
 246         {
 247                 desc     => "invalid label for device with no bus",
 248                 subsys   => "tty",
 249                 devpath  => "class/tty/console",
 250                 expected => "TTY" ,
 251                 conf     => <<EOF
 252 BUS="foo", SYSFS_dev="5:1", NAME="foo"
 253 KERNEL="console", NAME="TTY"
 254 EOF
 255         },
 256         {
 257                 desc     => "valid label for device with no bus",
 258                 subsys   => "tty",
 259                 devpath  => "class/tty/console",
 260                 expected => "foo" ,
 261                 conf     => <<EOF
 262 SYSFS_dev="5:1", NAME="foo"
 263 KERNEL="console", NAME="TTY"
 264 EOF
 265         },
 266         {
 267                 desc     => "program and bus type match",
 268                 subsys   => "block",
 269                 devpath  => "block/sda",
 270                 expected => "scsi-0:0:0:0" ,
 271                 conf     => <<EOF
 272 BUS="usb", PROGRAM="/bin/echo -n usb-%b", NAME="%c"
 273 BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", NAME="%c"
 274 BUS="foo", PROGRAM="/bin/echo -n foo-%b", NAME="%c"
 275 EOF
 276         },
 277         {
 278                 desc     => "symlink creation (same directory)",
 279                 subsys   => "tty",
 280                 devpath  => "class/tty/ttyUSB0",
 281                 expected => "visor0" ,
 282                 conf     => <<EOF
 283 KERNEL="ttyUSB[0-9]*", NAME="ttyUSB%n", SYMLINK="visor%n"
 284 EOF
 285         },
 286         {
 287                 desc     => "symlink creation (relative link back)",
 288                 subsys   => "block",
 289                 devpath  => "block/sda/sda2",
 290                 expected => "1/2/a/b/symlink" ,
 291                 conf     => <<EOF
 292 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/node", SYMLINK="1/2/a/b/symlink"
 293 EOF
 294         },
 295         {
 296                 desc     => "symlink creation (relative link forward)",
 297                 subsys   => "block",
 298                 devpath  => "block/sda/sda2",
 299                 expected => "1/2/symlink" ,
 300                 conf     => <<EOF
 301 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/symlink"
 302 EOF
 303         },
 304         {
 305                 desc     => "symlink creation (relative link back and forward)",
 306                 subsys   => "block",
 307                 devpath  => "block/sda/sda2",
 308                 expected => "1/2/c/d/symlink" ,
 309                 conf     => <<EOF
 310 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/c/d/symlink"
 311 EOF
 312         },
 313         {
 314                 desc     => "multiple symlinks",
 315                 subsys   => "tty",
 316                 devpath  => "class/tty/ttyUSB0",
 317                 expected => "second-0" ,
 318                 conf     => <<EOF
 319 KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n"
 320 EOF
 321         },
 322 );
 323
 324 # set env
 325 $ENV{UDEV_TEST} = "yes";
 326 $ENV{SYSFS_PATH} = $sysfs;
 327 $ENV{UDEV_CONFIG_FILE} = $main_conf;
 328
 329
 330 sub udev {
 331         my ($action, $subsys, $devpath, $config) = @_;
 332
 333         $ENV{DEVPATH} = $devpath;
 334
 335         # create temporary config
 336         open CONF, ">$conf_tmp" || die "unable to create config file: $conf_tmp";
 337         print CONF $$config;
 338         close CONF;
 339
 340         $ENV{ACTION} = $action;
 341         system("$udev_bin $subsys");
 342 }
 343
 344
 345 # prepare
 346 system("rm -rf $udev_root");
 347 mkdir($udev_root) || die "unable to create udev_root: $udev_root\n";
 348
 349 # test
 350 my $error = 0;
 351 print "\nudev-test will run ".($#tests + 1)." tests:\n\n";
 352
 353 # create initial config file
 354 open CONF, ">$main_conf" || die "unable to create config file: $main_conf";
 355 print CONF "udev_root=\"$udev_root\"\n";
 356 print CONF "udev_db=\"$udev_db\"\n";
 357 print CONF "udev_rules=\"$conf_tmp\"\n";
 358 print CONF "udev_permissions=\"$perm\"\n";
 359 close CONF;
 360
 361 foreach my $config (@tests) {
 362         print "TEST: $config->{desc}\n";
 363         print "device \'$config->{devpath}\' expecting node \'$config->{expected}\'\n";
 364
 365         udev("add", $config->{subsys}, $config->{devpath}, \$config->{conf});
 366         if (-e "$PWD/$udev_root$config->{expected}") {
 367                 print "add: ok    ";
 368         } else {
 369                 print "add: error\n";
 370                 system("tree $udev_root");
 371                 print "\n";
 372                 $error++;
 373         }
 374
 375         udev("remove", $config->{subsys}, $config->{devpath}, \$config->{conf});
 376         if ((-e "$PWD/$udev_root$config->{expected}") ||
 377             (-l "$PWD/$udev_root$config->{expected}")) {
 378                 print "remove: error\n\n";
 379                 system("tree $udev_root");
 380                 $error++;
 381         } else {
 382                 print "remove: ok\n\n";
 383         }
 384 }
 385
 386 print "$error errors occured\n\n";
 387
 388 # cleanup
 389 unlink($udev_db);
 390 system("rm -rf $udev_root");
 391 unlink($conf_tmp);
 392 unlink($main_conf);
 393