]> git.ipfire.org Git - thirdparty/systemd.git/blame - test/udev-test.pl
[PATCH] Adding '%s' format specifier to NAME and SYMLINK
[thirdparty/systemd.git] / test / udev-test.pl
CommitLineData
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
21use warnings;
22use strict;
23
f8f00338 24my $PWD = $ENV{PWD};
a367f04e
GKH
25my $sysfs = "sys/";
26my $udev_bin = "../udev";
27my $udev_root = "udev-root/"; # !!! directory will be removed !!!
36043f84 28my $udev_db = ".udev.tdb";
a367f04e 29my $perm = "udev.permissions";
72ffa78d
GKH
30my $main_conf = "udev-test.conf";
31my $conf_tmp = "udev-test.rules";
a367f04e
GKH
32
33
34my @tests = (
35 {
36 desc => "label test of scsi disc",
37 subsys => "block",
38 devpath => "block/sda",
39 expected => "boot_disk" ,
40 conf => <<EOF
ac28b86d
KS
41BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="boot_disk%n"
42KERNEL="ttyUSB0", NAME="visor"
a367f04e
GKH
43EOF
44 },
45 {
46 desc => "label test of scsi partition",
47 subsys => "block",
48 devpath => "block/sda/sda1",
49 expected => "boot_disk1" ,
50 conf => <<EOF
ac28b86d 51BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="boot_disk%n"
83be97ba
KS
52EOF
53 },
54 {
55 desc => "label test of pattern match",
56 subsys => "block",
57 devpath => "block/sda/sda1",
58 expected => "boot_disk1" ,
59 conf => <<EOF
ac28b86d
KS
60BUS="scsi", SYSFS_vendor="?IBM-ESXS", NAME="boot_disk%n-1"
61BUS="scsi", SYSFS_vendor="IBM-ESXS?", NAME="boot_disk%n-2"
62BUS="scsi", SYSFS_vendor="IBM-ES??", NAME="boot_disk%n"
63BUS="scsi", SYSFS_vendor="IBM-ESXSS", NAME="boot_disk%n-3"
358c8c20
GKH
64EOF
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
ac28b86d
KS
72BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW !#", NAME="boot_diskX%n"
73BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW !#", NAME="boot_disk%n"
358c8c20
GKH
74EOF
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
ac28b86d
KS
82BUS="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"
83BUS="scsi", SYSFS_vendor="IBM-ESXS", SYSFS_model="ST336605LW !#", SYSFS_scsi_level="4", SYSFS_rev="B245", SYSFS_type="0", NAME="boot_disk%n"
0db6d4cc
KS
84EOF
85 },
86 {
9f1da361 87 desc => "catch device by *",
0db6d4cc
KS
88 subsys => "tty",
89 devpath => "class/tty/ttyUSB0",
90 expected => "visor/0" ,
91 conf => <<EOF
ac28b86d 92KERNEL="ttyUSB*", NAME="visor/%n"
2e317184
GKH
93EOF
94 },
95 {
96 desc => "catch device by * - take 2",
97 subsys => "tty",
98 devpath => "class/tty/ttyUSB0",
99 expected => "visor/0" ,
100 conf => <<EOF
101KERNEL="*USB1", NAME="bad"
102KERNEL="*USB0", NAME="visor/%n"
9f1da361
KS
103EOF
104 },
105 {
106 desc => "catch device by ?",
107 subsys => "tty",
108 devpath => "class/tty/ttyUSB0",
109 expected => "visor/0" ,
110 conf => <<EOF
ac28b86d
KS
111KERNEL="ttyUSB??*", NAME="visor/%n-1"
112KERNEL="ttyUSB??", NAME="visor/%n-2"
113KERNEL="ttyUSB?", NAME="visor/%n"
9f1da361
KS
114EOF
115 },
116 {
117 desc => "catch device by character class",
118 subsys => "tty",
119 devpath => "class/tty/ttyUSB0",
120 expected => "visor/0" ,
121 conf => <<EOF
ac28b86d
KS
122KERNEL="ttyUSB[A-Z]*", NAME="visor/%n-1"
123KERNEL="ttyUSB?[0-9]", NAME="visor/%n-2"
124KERNEL="ttyUSB[0-9]*", NAME="visor/%n"
a367f04e
GKH
125EOF
126 },
127 {
128 desc => "replace kernel name",
129 subsys => "tty",
130 devpath => "class/tty/ttyUSB0",
131 expected => "visor" ,
132 conf => <<EOF
ac28b86d 133KERNEL="ttyUSB0", NAME="visor"
281ff00a
GKH
134EOF
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
ac28b86d 143KERNEL="ttyUSB0", NAME="visor"
281ff00a
GKH
144
145EOF
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
ac28b86d 154KERNEL="ttyUSB0", NAME="visor"
281ff00a
GKH
155
156EOF
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
ac28b86d 165KERNEL="ttyUSB0", NAME="visor"
281ff00a 166
5499d319
KS
167EOF
168 },
169 {
170 desc => "subdirectory handling",
171 subsys => "tty",
172 devpath => "class/tty/ttyUSB0",
173 expected => "sub/direct/ory/visor" ,
174 conf => <<EOF
ac28b86d 175KERNEL="ttyUSB0", NAME="sub/direct/ory/visor"
a367f04e
GKH
176EOF
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
ac28b86d 184BUS="scsi", PLACE="0:0:0:0", NAME="first_disk%n"
a367f04e
GKH
185EOF
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
ac28b86d 193BUS="scsi", PLACE="0:0:0:0", NAME="Major:%M:minor:%m:kernelnumber:%n:bus:%b"
a27cd06c
KS
194EOF
195 },
196 {
197 desc => "sustitution of sysfs value (%s{file})",
198 subsys => "block",
199 devpath => "block/sda",
200 expected => "disk-IBM-ESXS-sda" ,
201 conf => <<EOF
202BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="disk-%s{vendor}-%k"
203KERNEL="ttyUSB0", NAME="visor"
a367f04e
GKH
204EOF
205 },
206 {
ac28b86d 207 desc => "program result substitution",
a367f04e
GKH
208 subsys => "block",
209 devpath => "block/sda/sda3",
210 expected => "special-device-3" ,
211 conf => <<EOF
ac28b86d
KS
212BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="-special-*", NAME="%c-1-%n"
213BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special--*", NAME="%c-2-%n"
214BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-device-", NAME="%c-3-%n"
215BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-devic", NAME="%c-4-%n"
216BUS="scsi", PROGRAM="/bin/echo -n special-device", RESULT="special-*", NAME="%c-%n"
f3b04a2e
GKH
217EOF
218 },
219 {
ac28b86d 220 desc => "program result substitution",
f3b04a2e
GKH
221 subsys => "block",
222 devpath => "block/sda/sda3",
223 expected => "test-0:0:0:0" ,
224 conf => <<EOF
ac28b86d 225BUS="scsi", PROGRAM="/bin/echo -n test-%b", RESULT="test-0:0*", NAME="%c"
8ffb636f
KS
226EOF
227 },
228 {
229 desc => "program with escaped format char (tricky: callout returns format char!)",
230 subsys => "block",
231 devpath => "block/sda/sda3",
232 expected => "escape-3" ,
233 conf => <<EOF
234BUS="scsi", PROGRAM="/bin/echo -n escape-%%n", KERNEL="sda3", NAME="%c"
b1c5e333
KS
235EOF
236 },
237 {
ac28b86d 238 desc => "program result substitution (numbered part of)",
b1c5e333
KS
239 subsys => "block",
240 devpath => "block/sda/sda3",
241 expected => "link1" ,
242 conf => <<EOF
ac28b86d 243BUS="scsi", PROGRAM="/bin/echo -n node link1 link2", RESULT="node *", NAME="%1c", SYMLINK="%2c %3c"
8ff8bbba
GKH
244EOF
245 },
246 {
ac28b86d 247 desc => "invalid program for device with no bus",
8ff8bbba
GKH
248 subsys => "tty",
249 devpath => "class/tty/console",
250 expected => "TTY" ,
251 conf => <<EOF
ac28b86d
KS
252BUS="scsi", PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
253KERNEL="console", NAME="TTY"
1d936fbc
GKH
254EOF
255 },
256 {
ac28b86d 257 desc => "valid program for device with no bus",
1d936fbc
GKH
258 subsys => "tty",
259 devpath => "class/tty/console",
260 expected => "foo" ,
261 conf => <<EOF
ac28b86d
KS
262PROGRAM="/bin/echo -n foo", RESULT="foo", NAME="foo"
263KERNEL="console", NAME="TTY"
64682333
GKH
264EOF
265 },
266 {
267 desc => "invalid label for device with no bus",
268 subsys => "tty",
269 devpath => "class/tty/console",
270 expected => "TTY" ,
271 conf => <<EOF
ac28b86d
KS
272BUS="foo", SYSFS_dev="5:1", NAME="foo"
273KERNEL="console", NAME="TTY"
64682333
GKH
274EOF
275 },
276 {
277 desc => "valid label for device with no bus",
278 subsys => "tty",
279 devpath => "class/tty/console",
280 expected => "foo" ,
281 conf => <<EOF
ac28b86d
KS
282SYSFS_dev="5:1", NAME="foo"
283KERNEL="console", NAME="TTY"
772558f4
GKH
284EOF
285 },
286 {
ac28b86d 287 desc => "program and bus type match",
772558f4
GKH
288 subsys => "block",
289 devpath => "block/sda",
290 expected => "scsi-0:0:0:0" ,
291 conf => <<EOF
ac28b86d
KS
292BUS="usb", PROGRAM="/bin/echo -n usb-%b", NAME="%c"
293BUS="scsi", PROGRAM="/bin/echo -n scsi-%b", NAME="%c"
294BUS="foo", PROGRAM="/bin/echo -n foo-%b", NAME="%c"
3d150dfb
KS
295EOF
296 },
297 {
298 desc => "symlink creation (same directory)",
299 subsys => "tty",
300 devpath => "class/tty/ttyUSB0",
301 expected => "visor0" ,
302 conf => <<EOF
ac28b86d 303KERNEL="ttyUSB[0-9]*", NAME="ttyUSB%n", SYMLINK="visor%n"
3d150dfb
KS
304EOF
305 },
306 {
307 desc => "symlink creation (relative link back)",
308 subsys => "block",
309 devpath => "block/sda/sda2",
310 expected => "1/2/a/b/symlink" ,
311 conf => <<EOF
ac28b86d 312BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/node", SYMLINK="1/2/a/b/symlink"
3d150dfb
KS
313EOF
314 },
315 {
316 desc => "symlink creation (relative link forward)",
317 subsys => "block",
318 devpath => "block/sda/sda2",
319 expected => "1/2/symlink" ,
320 conf => <<EOF
ac28b86d 321BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/symlink"
3d150dfb
KS
322EOF
323 },
324 {
325 desc => "symlink creation (relative link back and forward)",
326 subsys => "block",
327 devpath => "block/sda/sda2",
328 expected => "1/2/c/d/symlink" ,
329 conf => <<EOF
ac28b86d 330BUS="scsi", SYSFS_vendor="IBM-ESXS", NAME="1/2/a/b/node", SYMLINK="1/2/c/d/symlink"
4763256c
KS
331EOF
332 },
333 {
334 desc => "multiple symlinks",
335 subsys => "tty",
336 devpath => "class/tty/ttyUSB0",
337 expected => "second-0" ,
338 conf => <<EOF
ac28b86d 339KERNEL="ttyUSB0", NAME="visor", SYMLINK="first-%n second-%n third-%n"
724257d9
GKH
340EOF
341 },
342 {
343 desc => "sysfs parent heirachy",
344 subsys => "tty",
345 devpath => "class/tty/ttyUSB0",
346 expected => "visor" ,
347 conf => <<EOF
348SYSFS_idProduct="2008", NAME="visor"
f0142622
GKH
349EOF
350 },
351 {
352 desc => "name test with ! in the name",
353 subsys => "block",
354 devpath => "block/rd!c0d0",
355 expected => "rd/c0d0" ,
356 conf => <<EOF
357BUS="scsi", NAME="%k"
358KERNEL="ttyUSB0", NAME="visor"
b9fc973b
GKH
359EOF
360 },
361 {
362 desc => "name test with ! in the name, but no matching rule",
363 subsys => "block",
364 devpath => "block/rd!c0d0",
365 expected => "rd/c0d0" ,
366 conf => <<EOF
367KERNEL="ttyUSB0", NAME="visor"
a367f04e
GKH
368EOF
369 },
370);
371
372# set env
373$ENV{UDEV_TEST} = "yes";
374$ENV{SYSFS_PATH} = $sysfs;
72ffa78d 375$ENV{UDEV_CONFIG_FILE} = $main_conf;
a367f04e
GKH
376
377
378sub udev {
379 my ($action, $subsys, $devpath, $config) = @_;
380
381 $ENV{DEVPATH} = $devpath;
a367f04e
GKH
382
383 # create temporary config
384 open CONF, ">$conf_tmp" || die "unable to create config file: $conf_tmp";
385 print CONF $$config;
386 close CONF;
387
388 $ENV{ACTION} = $action;
389 system("$udev_bin $subsys");
390}
391
e5fbfe0a 392my $error = 0;
72ffa78d 393
2e317184
GKH
394sub run_test {
395 my ($config, $number) = @_;
396
397 print "TEST $number: $config->{desc}\n";
ac28b86d 398 print "device \'$config->{devpath}\' expecting node \'$config->{expected}\'\n";
a367f04e
GKH
399
400 udev("add", $config->{subsys}, $config->{devpath}, \$config->{conf});
401 if (-e "$PWD/$udev_root$config->{expected}") {
402 print "add: ok ";
403 } else {
404 print "add: error\n";
405 system("tree $udev_root");
406 print "\n";
407 $error++;
a367f04e
GKH
408 }
409
410 udev("remove", $config->{subsys}, $config->{devpath}, \$config->{conf});
3d150dfb
KS
411 if ((-e "$PWD/$udev_root$config->{expected}") ||
412 (-l "$PWD/$udev_root$config->{expected}")) {
a367f04e
GKH
413 print "remove: error\n\n";
414 system("tree $udev_root");
415 $error++;
416 } else {
417 print "remove: ok\n\n";
418 }
419}
420
2e317184
GKH
421# prepare
422system("rm -rf $udev_root");
423mkdir($udev_root) || die "unable to create udev_root: $udev_root\n";
424
425# create initial config file
426open CONF, ">$main_conf" || die "unable to create config file: $main_conf";
427print CONF "udev_root=\"$udev_root\"\n";
428print CONF "udev_db=\"$udev_db\"\n";
429print CONF "udev_rules=\"$conf_tmp\"\n";
430print CONF "udev_permissions=\"$perm\"\n";
431close CONF;
432
433my $test_num = 1;
434
435if ($ARGV[0]) {
436 # only run one test
437 $test_num = $ARGV[0];
438 print "udev-test will run test number $test_num only\n";
439
b9fc973b 440 run_test($tests[$test_num-1], $test_num);
2e317184
GKH
441} else {
442 # test all
443 print "\nudev-test will run ".($#tests + 1)." tests:\n\n";
444
445 foreach my $config (@tests) {
446 run_test($config, $test_num);
447 $test_num++;
448
449 }
450}
451
a367f04e
GKH
452print "$error errors occured\n\n";
453
454# cleanup
36043f84 455unlink($udev_db);
a367f04e
GKH
456system("rm -rf $udev_root");
457unlink($conf_tmp);
72ffa78d 458unlink($main_conf);
a367f04e 459