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 * - take 2",
  97                 subsys   => "tty",
  98                 devpath  => "class/tty/ttyUSB0",
  99                 expected => "visor/0" ,
 100                 conf     => <<EOF
 101 KERNEL="*USB1", NAME="bad"
 102 KERNEL="*USB0", NAME="visor/%n"
 103 EOF
 104         },
 105         {
 106                 desc     => "catch device by ?",
 107                 subsys   => "tty",
 108                 devpath  => "class/tty/ttyUSB0",
 109                 expected => "visor/0" ,
 110                 conf     => <<EOF
 111 KERNEL="ttyUSB??*", NAME="visor/%n-1"
 112 KERNEL="ttyUSB??", NAME="visor/%n-2"
 113 KERNEL="ttyUSB?", NAME="visor/%n"
 114 EOF
 115         },
 116         {
 117                 desc     => "catch device by character class",
 118                 subsys   => "tty",
 119                 devpath  => "class/tty/ttyUSB0",
 120                 expected => "visor/0" ,
 121                 conf     => <<EOF
 122 KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1"
 123 KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2"
 124 KERNEL="ttyUSB[0-9]*", NAME="visor/%n"
 125 EOF
 126         },
 127         {
 128                 desc     => "replace kernel name",
 129                 subsys   => "tty",
 130                 devpath  => "class/tty/ttyUSB0",
 131                 expected => "visor" ,
 132                 conf     => <<EOF
 133 KERNEL="ttyUSB0", NAME="visor"
 134 EOF
 135         },
 136         {
 137                 desc     => "Handle comment lines in config file (and replace kernel name)",
 138                 subsys   => "tty",
 139                 devpath  => "class/tty/ttyUSB0",
 140                 expected => "visor" ,
 141                 conf     => <<EOF
 142 # this is a comment
 143 KERNEL="ttyUSB0", NAME="visor"
 144
 145 EOF
 146         },
 147         {
 148                 desc     => "Handle comment lines in config file with whitespace (and replace kernel name)",
 149                 subsys   => "tty",
 150                 devpath  => "class/tty/ttyUSB0",
 151                 expected => "visor" ,
 152                 conf     => <<EOF
 153  # this is a comment with whitespace before the comment
 154 KERNEL="ttyUSB0", NAME="visor"
 155
 156 EOF
 157         },
 158         {
 159                 desc     => "Handle empty lines in config file (and replace kernel name)",
 160                 subsys   => "tty",
 161                 devpath  => "class/tty/ttyUSB0",
 162                 expected => "visor" ,
 163                 conf     => <<EOF
 164
 165 KERNEL="ttyUSB0", NAME="visor"
 166
 167 EOF
 168         },
 169         {
 170                 desc     => "subdirectory handling",
 171                 subsys   => "tty",
 172                 devpath  => "class/tty/ttyUSB0",
 173                 expected => "sub/direct/ory/visor" ,
 174                 conf     => <<EOF
 175 KERNEL="ttyUSB0", NAME="sub/direct/ory/visor"
 176 EOF
 177         },
 178         {
 179                 desc     => "place on bus of scsi partition",
 180                 subsys   => "block",
 181                 devpath  => "block/sda/sda3",
 182                 expected => "first_disk3" ,
 183                 conf     => <<EOF
 184 BUS="scsi", PLACE="0:0:0:0", NAME="first_disk%n"
 185 EOF
 186         },
 187         {
 188                 desc     => "test NAME substitution chars",
 189                 subsys   => "block",
 190                 devpath  => "block/sda/sda3",
 191                 expected => "Major:8:minor:3:kernelnumber:3:bus:0:0:0:0" ,
 192                 conf     => <<EOF
 193 BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b"
 194 EOF
 195         },
 196         {
 197                 desc     => "select sysfs attribute by SYSFS{vendor}",
 198                 subsys   => "block",
 199                 devpath  => "block/sda",
 200                 expected => "disk-IBM-ESXS-sda" ,
 201                 conf     => <<EOF
 202 BUS="scsi", SYSFS{vendor}="IBM-ESXS", NAME="disk-%s{vendor}-%k"
 203 KERNEL="ttyUSB0", NAME="visor"
 204 EOF
 205         },
 206         {
 207                 desc     => "sustitution of sysfs value (%s{file})",
 208                 subsys   => "block",
 209                 devpath  => "block/sda",
 210                 expected => "disk-IBM-ESXS-sda" ,
 211                 conf     => <<EOF
 212 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="disk-%s{vendor}-%k"
 213 KERNEL="ttyUSB0", NAME="visor"
 214 EOF
 215         },
 216         {
 217                 desc     => "program result substitution",
 218                 subsys   => "block",
 219                 devpath  => "block/sda/sda3",
 220                 expected => "special-device-3" ,
 221                 conf     => <<EOF
 222 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="-special-*", NAME="%c-1-%n"
 223 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special--*", NAME="%c-2-%n"
 224 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-device-", NAME="%c-3-%n"
 225 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-devic", NAME="%c-4-%n"
 226 BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-*", NAME="%c-%n"
 227 EOF
 228         },
 229         {
 230                 desc     => "program result substitution",
 231                 subsys   => "block",
 232                 devpath  => "block/sda/sda3",
 233                 expected => "test-0:0:0:0" ,
 234                 conf     => <<EOF
 235 BUS="scsi", PROGRAM="/bin/echo -n test-%b", RESULT="test-0:0*", NAME="%c"
 236 EOF
 237         },
 238         {
 239                 desc     => "program with escaped format char (tricky: callout returns format char!)",
 240                 subsys   => "block",
 241                 devpath  => "block/sda/sda3",
 242                 expected => "escape-3" ,
 243                 conf     => <<EOF
 244 BUS="scsi", PROGRAM="/bin/echo -n escape-%%n", KERNEL="sda3", NAME="%c"
 245 EOF
 246         },
 247         {
 248                 desc     => "program result substitution (numbered part of)",
 249                 subsys   => "block",
 250                 devpath  => "block/sda/sda3",
 251                 expected => "link1" ,
 252                 conf     => <<EOF
 253 BUS="scsi", PROGRAM="/bin/echo -n node link1 link2", RESULT="node *", NAME="%1c", SYMLINK="%2c %3c"
 254 EOF
 255         },
 256         {
 257                 desc     => "invalid program for device with no bus",
 258                 subsys   => "tty",
 259                 devpath  => "class/tty/console",
 260                 expected => "TTY" ,
 261                 conf     => <<EOF
 262 BUS="scsi", PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
 263 KERNEL="console", NAME="TTY"
 264 EOF
 265         },
 266         {
 267                 desc     => "valid program for device with no bus",
 268                 subsys   => "tty",
 269                 devpath  => "class/tty/console",
 270                 expected => "foo" ,
 271                 conf     => <<EOF
 272 PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
 273 KERNEL="console", NAME="TTY"
 274 EOF
 275         },
 276         {
 277                 desc     => "invalid label for device with no bus",
 278                 subsys   => "tty",
 279                 devpath  => "class/tty/console",
 280                 expected => "TTY" ,
 281                 conf     => <<EOF
 282 BUS="foo", SYSFS_dev="5:1", NAME="foo"
 283 KERNEL="console", NAME="TTY"
 284 EOF
 285         },
 286         {
 287                 desc     => "valid label for device with no bus",
 288                 subsys   => "tty",
 289                 devpath  => "class/tty/console",
 290                 expected => "foo" ,
 291                 conf     => <<EOF
 292 SYSFS_dev="5:1", NAME="foo"
 293 KERNEL="console", NAME="TTY"
 294 EOF
 295         },
 296         {
 297                 desc     => "program and bus type match",
 298                 subsys   => "block",
 299                 devpath  => "block/sda",
 300                 expected => "scsi-0:0:0:0" ,
 301                 conf     => <<EOF
 302 BUS="usb", PROGRAM="/bin/echo -n usb-%b", NAME="%c"
 303 BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", NAME="%c"
 304 BUS="foo", PROGRAM="/bin/echo -n foo-%b", NAME="%c"
 305 EOF
 306         },
 307         {
 308                 desc     => "symlink creation (same directory)",
 309                 subsys   => "tty",
 310                 devpath  => "class/tty/ttyUSB0",
 311                 expected => "visor0" ,
 312                 conf     => <<EOF
 313 KERNEL="ttyUSB[0-9]*", NAME="ttyUSB%n", SYMLINK="visor%n"
 314 EOF
 315         },
 316         {
 317                 desc     => "symlink creation (relative link back)",
 318                 subsys   => "block",
 319                 devpath  => "block/sda/sda2",
 320                 expected => "1/2/a/b/symlink" ,
 321                 conf     => <<EOF
 322 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/node", SYMLINK="1/2/a/b/symlink"
 323 EOF
 324         },
 325         {
 326                 desc     => "symlink creation (relative link forward)",
 327                 subsys   => "block",
 328                 devpath  => "block/sda/sda2",
 329                 expected => "1/2/symlink" ,
 330                 conf     => <<EOF
 331 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/symlink"
 332 EOF
 333         },
 334         {
 335                 desc     => "symlink creation (relative link back and forward)",
 336                 subsys   => "block",
 337                 devpath  => "block/sda/sda2",
 338                 expected => "1/2/c/d/symlink" ,
 339                 conf     => <<EOF
 340 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/c/d/symlink"
 341 EOF
 342         },
 343         {
 344                 desc     => "multiple symlinks",
 345                 subsys   => "tty",
 346                 devpath  => "class/tty/ttyUSB0",
 347                 expected => "second-0" ,
 348                 conf     => <<EOF
 349 KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n"
 350 EOF
 351         },
 352         {
 353                 desc     => "create all possible partitions",
 354                 subsys   => "block",
 355                 devpath  => "block/sda",
 356                 expected => "boot_disk15" ,
 357                 conf     => <<EOF
 358 BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME{all_partitions}="boot_disk"
 359 EOF
 360         },
 361         {
 362                 desc     => "sysfs parent hierarchy",
 363                 subsys   => "tty",
 364                 devpath  => "class/tty/ttyUSB0",
 365                 expected => "visor" ,
 366                 conf     => <<EOF
 367 SYSFS_idProduct="2008", NAME="visor"
 368 EOF
 369         },
 370         {
 371                 desc     => "name test with ! in the name",
 372                 subsys   => "block",
 373                 devpath  => "block/rd!c0d0",
 374                 expected => "rd/c0d0" ,
 375                 conf     => <<EOF
 376 BUS="scsi", NAME="%k"
 377 KERNEL="ttyUSB0", NAME="visor"
 378 EOF
 379         },
 380         {
 381                 desc     => "name test with ! in the name, but no matching rule",
 382                 subsys   => "block",
 383                 devpath  => "block/rd!c0d0",
 384                 expected => "rd/c0d0" ,
 385                 conf     => <<EOF
 386 KERNEL="ttyUSB0", NAME="visor"
 387 EOF
 388         },
 389         {
 390                 desc     => "ID rule",
 391                 subsys   => "block",
 392                 devpath  => "block/sda",
 393                 expected => "scsi-0:0:0:0",
 394                 conf     => <<EOF
 395 BUS="usb", ID="0:0:0:0", NAME="not-scsi"
 396 BUS="scsi", ID="0:0:0:1", NAME="no-match"
 397 BUS="scsi", ID=":0", NAME="short-id"
 398 BUS="scsi", ID="/0:0:0:0", NAME="no-match"
 399 BUS="scsi", ID="0:0:0:0", NAME="scsi-0:0:0:0"
 400 EOF
 401         },
 402         {
 403                 desc     => "ID wildcard all",
 404                 subsys   => "block",
 405                 devpath  => "block/sda",
 406                 expected => "scsi-0:0:0:0",
 407                 conf     => <<EOF
 408 BUS="scsi", ID="*:1", NAME="no-match"
 409 BUS="scsi", ID="*:0:1", NAME="no-match"
 410 BUS="scsi", ID="*:0:0:1", NAME="no-match"
 411 BUS="scsi", ID="*", NAME="scsi-0:0:0:0"
 412 BUS="scsi", ID="0:0:0:0", NAME="bad"
 413 EOF
 414         },
 415         {
 416                 desc     => "ID wildcard partial",
 417                 subsys   => "block",
 418                 devpath  => "block/sda",
 419                 expected => "scsi-0:0:0:0",
 420                 conf     => <<EOF
 421 BUS="scsi", ID="*:0", NAME="scsi-0:0:0:0"
 422 BUS="scsi", ID="0:0:0:0", NAME="bad"
 423 EOF
 424         },
 425         {
 426                 desc     => "ID wildcard partial 2",
 427                 subsys   => "block",
 428                 devpath  => "block/sda",
 429                 expected => "scsi-0:0:0:0",
 430                 conf     => <<EOF
 431 BUS="scsi", ID="*:0:0:0", NAME="scsi-0:0:0:0"
 432 BUS="scsi", ID="0:0:0:0", NAME="bad"
 433 EOF
 434         },
 435 );
 436
 437 # set env
 438 $ENV{UDEV_TEST} = "yes";
 439 $ENV{SYSFS_PATH} = $sysfs;
 440 $ENV{UDEV_CONFIG_FILE} = $main_conf;
 441
 442
 443 sub udev {
 444         my ($action, $subsys, $devpath, $config) = @_;
 445
 446         $ENV{DEVPATH} = $devpath;
 447
 448         # create temporary config
 449         open CONF, ">$conf_tmp" || die "unable to create config file: $conf_tmp";
 450         print CONF $$config;
 451         close CONF;
 452
 453         $ENV{ACTION} = $action;
 454         system("$udev_bin $subsys");
 455 }
 456
 457 my $error = 0;
 458
 459 sub run_test {
 460         my ($config, $number) = @_;
 461
 462         print "TEST $number: $config->{desc}\n";
 463         print "device \'$config->{devpath}\' expecting node \'$config->{expected}\'\n";
 464
 465         udev("add", $config->{subsys}, $config->{devpath}, \$config->{conf});
 466         if (-e "$PWD/$udev_root$config->{expected}") {
 467                 print "add: ok    ";
 468         } else {
 469                 print "add: error\n";
 470                 system("tree $udev_root");
 471                 print "\n";
 472                 $error++;
 473         }
 474
 475         udev("remove", $config->{subsys}, $config->{devpath}, \$config->{conf});
 476         if ((-e "$PWD/$udev_root$config->{expected}") ||
 477             (-l "$PWD/$udev_root$config->{expected}")) {
 478                 print "remove: error\n\n";
 479                 system("tree $udev_root");
 480                 $error++;
 481         } else {
 482                 print "remove: ok\n\n";
 483         }
 484 }
 485
 486 # prepare
 487 system("rm -rf $udev_root");
 488 mkdir($udev_root) || die "unable to create udev_root: $udev_root\n";
 489
 490 # create initial config file
 491 open CONF, ">$main_conf" || die "unable to create config file: $main_conf";
 492 print CONF "udev_root=\"$udev_root\"\n";
 493 print CONF "udev_db=\"$udev_db\"\n";
 494 print CONF "udev_rules=\"$conf_tmp\"\n";
 495 print CONF "udev_permissions=\"$perm\"\n";
 496 close CONF;
 497
 498 my $test_num = 1;
 499
 500 if ($ARGV[0]) {
 501         # only run one test
 502         $test_num = $ARGV[0];
 503         print "udev-test will run test number $test_num only\n";
 504
 505         run_test($tests[$test_num-1], $test_num);
 506 } else {
 507         # test all
 508         print "\nudev-test will run ".($#tests + 1)." tests:\n\n";
 509
 510         foreach my $config (@tests) {
 511                 run_test($config, $test_num);
 512                 $test_num++;
 513
 514         }
 515 }
 516
 517 print "$error errors occured\n\n";
 518
 519 # cleanup
 520 unlink($udev_db);
 521 system("rm -rf $udev_root");
 522 unlink($conf_tmp);
 523 unlink($main_conf);
 524