[thirdparty/systemd.git] / test / udev-test.pl

#!/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
LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="boot_disk%n"
REPLACE, KERNEL="ttyUSB0", NAME="visor"
EOF
	},
	{
		desc     => "label test of scsi partition",
		subsys   => "block",
		devpath  => "block/sda/sda1",
		expected => "boot_disk1" ,
		conf     => <<EOF
LABEL, BUS="scsi", 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
LABEL, BUS="scsi", vendor="?IBM-ESXS", NAME="boot_disk%n-1"
LABEL, BUS="scsi", vendor="IBM-ESXS?", NAME="boot_disk%n-2"
LABEL, BUS="scsi", vendor="IBM-ES??", NAME="boot_disk%n"
LABEL, BUS="scsi", vendor="IBM-ESXSS", NAME="boot_disk%n-3"
EOF
	},
	{
		desc     => "catch device by *",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "visor/0" ,
		conf     => <<EOF
REPLACE, KERNEL="ttyUSB*", NAME="visor/%n"
EOF
	},
	{
		desc     => "catch device by ?",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "visor/0" ,
		conf     => <<EOF
REPLACE, KERNEL="ttyUSB??*", NAME="visor/%n-1"
REPLACE, KERNEL="ttyUSB??", NAME="visor/%n-2"
REPLACE, KERNEL="ttyUSB?", NAME="visor/%n"
EOF
	},
	{
		desc     => "catch device by character class",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "visor/0" ,
		conf     => <<EOF
REPLACE, KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1"
REPLACE, KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2"
REPLACE, KERNEL="ttyUSB[0-9]*", NAME="visor/%n"
EOF
	},
	{
		desc     => "replace kernel name",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "visor" ,
		conf     => <<EOF
REPLACE, KERNEL="ttyUSB0", NAME="visor"
EOF
	},
	{
		desc     => "subdirectory handling",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "sub/direct/ory/visor" ,
		conf     => <<EOF
REPLACE, 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
TOPOLOGY, 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
TOPOLOGY, BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b"
EOF
	},
	{
		desc     => "callout result substitution",
		subsys   => "block",
		devpath  => "block/sda/sda3",
		expected => "special-device-3" ,
		conf     => <<EOF
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="-special-*", NAME="%c-1-%n"
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special--*", NAME="%c-2-%n"
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-device-", NAME="%c-3-%n"
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-devic", NAME="%c-4-%n"
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-*", NAME="%c-%n"
EOF
	},
	{
		desc     => "callout program substitution",
		subsys   => "block",
		devpath  => "block/sda/sda3",
		expected => "test-0:0:0:0" ,
		conf     => <<EOF
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n test-%b", ID="test-*", NAME="%c"
EOF
	},
	{
		desc     => "devfs disk naming substitution",
		subsys   => "block",
		devpath  => "block/sda",
		expected => "lun0/disk" ,
		conf     => <<EOF
LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="lun0/%D"
EOF
	},
	{
		desc     => "devfs disk naming substitution",
		subsys   => "block",
		devpath  => "block/sda/sda2",
		expected => "lun0/part2" ,
		conf     => <<EOF
LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="lun0/%D"
EOF
	},
	{
		desc     => "callout bus type",
		subsys   => "block",
		devpath  => "block/sda",
		expected => "scsi-0:0:0:0" ,
		conf     => <<EOF
CALLOUT, BUS="usb", PROGRAM="/bin/echo -n usb-%b", ID="*", NAME="%c"
CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", ID="*", NAME="%c"
CALLOUT, BUS="foo", PROGRAM="/bin/echo -n foo-%b", ID="*", NAME="%c"
EOF
	},
	{
		desc     => "symlink creation (same directory)",
		subsys   => "tty",
		devpath  => "class/tty/ttyUSB0",
		expected => "visor0" ,
		conf     => <<EOF
REPLACE, 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
LABEL, BUS="scsi", 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
LABEL, BUS="scsi", 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
LABEL, BUS="scsi", 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
REPLACE, KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n"
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");
}


# prepare
system("rm -rf $udev_root");
mkdir($udev_root) || die "unable to create udev_root: $udev_root\n";

# test
my $error = 0;
print "\nudev-test will run ".($#tests + 1)." tests:\n\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;

foreach my $config (@tests) {
	$config->{conf} =~ m/^([A-Z]*).*/;
	my $method  = $1;

	print "TEST: $config->{desc}\n";
	print "method \'$method\' for \'$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";
	}
}

print "$error errors occured\n\n";

# cleanup
unlink($udev_db);
system("rm -rf $udev_root");
unlink($conf_tmp);
unlink($main_conf);
Commit	Line	Data
a367f04e GKH	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
f8f00338	24	my $PWD = $ENV{PWD};
a367f04e GKH	25	my $sysfs = "sys/";
	26	my $udev_bin = "../udev";
	27	my $udev_root = "udev-root/"; # !!! directory will be removed !!!
36043f84	28	my $udev_db = ".udev.tdb";
a367f04e	29	my $perm = "udev.permissions";
72ffa78d GKH	30	my $main_conf = "udev-test.conf";
72ffa78d GKH	31	my $conf_tmp = "udev-test.rules";
a367f04e GKH	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	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="boot_disk%n"
3d150dfb	42	REPLACE, KERNEL="ttyUSB0", NAME="visor"
a367f04e GKH	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	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="boot_disk%n"
83be97ba KS	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	LABEL, BUS="scsi", vendor="?IBM-ESXS", NAME="boot_disk%n-1"
	61	LABEL, BUS="scsi", vendor="IBM-ESXS?", NAME="boot_disk%n-2"
	62	LABEL, BUS="scsi", vendor="IBM-ES??", NAME="boot_disk%n"
	63	LABEL, BUS="scsi", vendor="IBM-ESXSS", NAME="boot_disk%n-3"
0db6d4cc KS	64	EOF
	65	},
	66	{
9f1da361	67	desc => "catch device by *",
0db6d4cc KS	68	subsys => "tty",
	69	devpath => "class/tty/ttyUSB0",
	70	expected => "visor/0" ,
	71	conf => <<EOF
	72	REPLACE, KERNEL="ttyUSB*", NAME="visor/%n"
9f1da361 KS	73	EOF
	74	},
	75	{
	76	desc => "catch device by ?",
	77	subsys => "tty",
	78	devpath => "class/tty/ttyUSB0",
	79	expected => "visor/0" ,
	80	conf => <<EOF
	81	REPLACE, KERNEL="ttyUSB??*", NAME="visor/%n-1"
	82	REPLACE, KERNEL="ttyUSB??", NAME="visor/%n-2"
	83	REPLACE, KERNEL="ttyUSB?", NAME="visor/%n"
	84	EOF
	85	},
	86	{
	87	desc => "catch device by character class",
	88	subsys => "tty",
	89	devpath => "class/tty/ttyUSB0",
	90	expected => "visor/0" ,
	91	conf => <<EOF
	92	REPLACE, KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1"
	93	REPLACE, KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2"
	94	REPLACE, KERNEL="ttyUSB[0-9]*", NAME="visor/%n"
a367f04e GKH	95	EOF
	96	},
	97	{
	98	desc => "replace kernel name",
	99	subsys => "tty",
	100	devpath => "class/tty/ttyUSB0",
	101	expected => "visor" ,
	102	conf => <<EOF
	103	REPLACE, KERNEL="ttyUSB0", NAME="visor"
5499d319 KS	104	EOF
	105	},
	106	{
	107	desc => "subdirectory handling",
	108	subsys => "tty",
	109	devpath => "class/tty/ttyUSB0",
	110	expected => "sub/direct/ory/visor" ,
	111	conf => <<EOF
	112	REPLACE, KERNEL="ttyUSB0", NAME="sub/direct/ory/visor"
a367f04e GKH	113	EOF
	114	},
	115	{
	116	desc => "place on bus of scsi partition",
	117	subsys => "block",
	118	devpath => "block/sda/sda3",
	119	expected => "first_disk3" ,
	120	conf => <<EOF
	121	TOPOLOGY, BUS="scsi", PLACE="0:0:0:0", NAME="first_disk%n"
	122	EOF
	123	},
	124	{
	125	desc => "test NAME substitution chars",
	126	subsys => "block",
	127	devpath => "block/sda/sda3",
	128	expected => "Major:8:minor:3:kernelnumber:3:bus:0:0:0:0" ,
	129	conf => <<EOF
	130	TOPOLOGY, BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b"
	131	EOF
	132	},
	133	{
9f1da361	134	desc => "callout result substitution",
a367f04e GKH	135	subsys => "block",
	136	devpath => "block/sda/sda3",
	137	expected => "special-device-3" ,
	138	conf => <<EOF
	139	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="-special-*", NAME="%c-1-%n"
	140	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special--*", NAME="%c-2-%n"
	141	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-device-", NAME="%c-3-%n"
	142	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-devic", NAME="%c-4-%n"
	143	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n special-device", ID="special-*", NAME="%c-%n"
f3b04a2e GKH	144	EOF
	145	},
	146	{
f8f00338	147	desc => "callout program substitution",
f3b04a2e GKH	148	subsys => "block",
	149	devpath => "block/sda/sda3",
	150	expected => "test-0:0:0:0" ,
	151	conf => <<EOF
	152	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n test-%b", ID="test-*", NAME="%c"
36043f84 GKH	153	EOF
	154	},
	155	{
	156	desc => "devfs disk naming substitution",
	157	subsys => "block",
	158	devpath => "block/sda",
	159	expected => "lun0/disk" ,
	160	conf => <<EOF
	161	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="lun0/%D"
	162	EOF
	163	},
	164	{
	165	desc => "devfs disk naming substitution",
	166	subsys => "block",
	167	devpath => "block/sda/sda2",
	168	expected => "lun0/part2" ,
	169	conf => <<EOF
	170	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="lun0/%D"
772558f4 GKH	171	EOF
	172	},
	173	{
	174	desc => "callout bus type",
	175	subsys => "block",
	176	devpath => "block/sda",
	177	expected => "scsi-0:0:0:0" ,
	178	conf => <<EOF
	179	CALLOUT, BUS="usb", PROGRAM="/bin/echo -n usb-%b", ID="*", NAME="%c"
	180	CALLOUT, BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", ID="*", NAME="%c"
	181	CALLOUT, BUS="foo", PROGRAM="/bin/echo -n foo-%b", ID="*", NAME="%c"
3d150dfb KS	182	EOF
	183	},
	184	{
	185	desc => "symlink creation (same directory)",
	186	subsys => "tty",
	187	devpath => "class/tty/ttyUSB0",
	188	expected => "visor0" ,
	189	conf => <<EOF
	190	REPLACE, KERNEL="ttyUSB[0-9]*", NAME="ttyUSB%n", SYMLINK="visor%n"
	191	EOF
	192	},
	193	{
	194	desc => "symlink creation (relative link back)",
	195	subsys => "block",
	196	devpath => "block/sda/sda2",
	197	expected => "1/2/a/b/symlink" ,
	198	conf => <<EOF
	199	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="1/2/node", SYMLINK="1/2/a/b/symlink"
	200	EOF
	201	},
	202	{
	203	desc => "symlink creation (relative link forward)",
	204	subsys => "block",
	205	devpath => "block/sda/sda2",
	206	expected => "1/2/symlink" ,
	207	conf => <<EOF
	208	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/symlink"
	209	EOF
	210	},
	211	{
	212	desc => "symlink creation (relative link back and forward)",
	213	subsys => "block",
	214	devpath => "block/sda/sda2",
	215	expected => "1/2/c/d/symlink" ,
	216	conf => <<EOF
	217	LABEL, BUS="scsi", vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/c/d/symlink"
4763256c KS	218	EOF
	219	},
	220	{
	221	desc => "multiple symlinks",
	222	subsys => "tty",
	223	devpath => "class/tty/ttyUSB0",
	224	expected => "second-0" ,
	225	conf => <<EOF
	226	REPLACE, KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n"
a367f04e GKH	227	EOF
	228	},
	229	);
	230
	231	# set env
	232	$ENV{UDEV_TEST} = "yes";
	233	$ENV{SYSFS_PATH} = $sysfs;
72ffa78d	234	$ENV{UDEV_CONFIG_FILE} = $main_conf;
a367f04e GKH	235
	236
	237	sub udev {
	238	my ($action, $subsys, $devpath, $config) = @_;
	239
	240	$ENV{DEVPATH} = $devpath;
a367f04e GKH	241
	242	# create temporary config
	243	open CONF, ">$conf_tmp" \|\| die "unable to create config file: $conf_tmp";
	244	print CONF $$config;
	245	close CONF;
	246
	247	$ENV{ACTION} = $action;
	248	system("$udev_bin $subsys");
	249	}
	250
	251
	252	# prepare
	253	system("rm -rf $udev_root");
	254	mkdir($udev_root) \|\| die "unable to create udev_root: $udev_root\n";
	255
	256	# test
e5fbfe0a	257	my $error = 0;
a367f04e GKH	258	print "\nudev-test will run ".($#tests + 1)." tests:\n\n";
a367f04e GKH	259
72ffa78d GKH	260	# create initial config file
	261	open CONF, ">$main_conf" \|\| die "unable to create config file: $main_conf";
	262	print CONF "udev_root=\"$udev_root\"\n";
	263	print CONF "udev_db=\"$udev_db\"\n";
	264	print CONF "udev_rules=\"$conf_tmp\"\n";
	265	print CONF "udev_permissions=\"$perm\"\n";
	266	close CONF;
	267
a367f04e GKH	268	foreach my $config (@tests) {
	269	$config->{conf} =~ m/^([A-Z])./;
	270	my $method = $1;
	271
	272	print "TEST: $config->{desc}\n";
	273	print "method \'$method\' for \'$config->{devpath}\' expecting node \'$config->{expected}\'\n";
	274
	275	udev("add", $config->{subsys}, $config->{devpath}, \$config->{conf});
	276	if (-e "$PWD/$udev_root$config->{expected}") {
	277	print "add: ok ";
	278	} else {
	279	print "add: error\n";
	280	system("tree $udev_root");
	281	print "\n";
	282	$error++;
a367f04e GKH	283	}
	284
	285	udev("remove", $config->{subsys}, $config->{devpath}, \$config->{conf});
3d150dfb KS	286	if ((-e "$PWD/$udev_root$config->{expected}") \|\|
3d150dfb KS	287	(-l "$PWD/$udev_root$config->{expected}")) {
a367f04e GKH	288	print "remove: error\n\n";
	289	system("tree $udev_root");
	290	$error++;
	291	} else {
	292	print "remove: ok\n\n";
	293	}
	294	}
	295
	296	print "$error errors occured\n\n";
	297
	298	# cleanup
36043f84	299	unlink($udev_db);
a367f04e GKH	300	system("rm -rf $udev_root");
a367f04e GKH	301	unlink($conf_tmp);
72ffa78d	302	unlink($main_conf);
a367f04e	303