3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 2 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <https://www.gnu.org/licenses/>.
26 # Cleanup environment from variables that pollute the test runs.
27 delete $ENV{DPKG_MAINTSCRIPT_PACKAGE};
28 delete $ENV{DPKG_MAINTSCRIPT_ARCH};
30 my $srcdir = $ENV{srcdir} || '.';
31 my $builddir = $ENV{builddir} || '.';
32 my $tmpdir = 't.tmp/dpkg_divert';
33 my $admindir = File::Spec->rel2abs("$tmpdir/admindir");
34 my $testdir = File::Spec->rel2abs("$tmpdir/testdir");
36 my @dd = ("$builddir/../src/dpkg-divert");
39 plan skip_all => 'dpkg-divert not available';
46 # On FreeBSD «rm -rf» cannot traverse a directory with mode 000.
47 system("test -d $testdir/nadir && rmdir $testdir/nadir");
48 system("rm -rf $tmpdir && mkdir -p $testdir");
49 system("mkdir -p $admindir/updates");
50 system("rm -f $admindir/status && touch $admindir/status");
51 system("rm -rf $admindir/info && mkdir -p $admindir/info");
54 sub install_diversions {
56 open(my $db_fh, '>', "$admindir/diversions")
57 or die "cannot create $admindir/diversions";
58 print { $db_fh } $txt;
62 sub install_filelist {
63 my ($pkg, $arch, @files) = @_;
64 open(my $fileslist_fh, '>', "$admindir/info/$pkg.list")
65 or die "cannot create $admindir/info/$pkg.list";
66 for my $file (@files) {
67 print { $fileslist_fh } "$file\n";
70 # Only installed packages have their files list considered.
71 open(my $status_fh, '>>', "$admindir/status")
72 or die "cannot append to $admindir/status";
73 print { $status_fh } <<"EOF";
75 Status: install ok installed
86 my ($prog, $args, %opts) = @_;
89 spawn(exec => [@$prog, @$args], wait_child => 1, nocheck => 1,
90 to_pipe => \$output, error_to_pipe => \$error, %opts);
92 if ($opts{expect_failure}) {
93 ok($? != 0, "@$args should fail");
95 ok($? == 0, "@$args should not fail");
98 if (defined $opts{expect_stdout}) {
99 my (@output) = <$output>;
100 my (@expect) = split(/^/, $opts{expect_stdout});
101 if (defined $opts{expect_sorted_stdout}) {
102 @output = sort @output;
103 @expect = sort @expect;
105 is(join('', @output), join('', @expect), "@$args stdout");
107 if (defined $opts{expect_stdout_like}) {
108 like(file_slurp($output), $opts{expect_stdout_like}, "@$args stdout");
110 if (defined $opts{expect_stderr}) {
111 is(file_slurp($error), $opts{expect_stderr}, "@$args stderr");
113 if (defined $opts{expect_stderr_like}) {
114 like(file_slurp($error), $opts{expect_stderr_like}, "@$args stderr");
122 my ($params, %opts) = @_;
123 call([@dd, '--admindir', $admindir], $params, %opts);
126 sub call_divert_sort {
127 my ($params, %opts) = @_;
128 $opts{expect_sorted_stdout} = 1;
129 call_divert($params, %opts);
132 sub diversions_pack {
136 ## no critic (ControlStructures::ProhibitCStyleForLoops)
137 for (my ($i) = 0; $i < $#data; $i += 3) {
138 push @data_packed, [ @data[$i .. $i + 2] ];
141 my @list = sort { $a->[0] cmp $b->[0] } @data_packed;
147 my (@expected) = split /^/, shift;
148 open(my $db_fh, '<', "$admindir/diversions")
149 or die "cannot open $admindir/diversions";
150 my (@contents) = <$db_fh>;
153 my (@expected_pack) = diversions_pack(@expected);
154 my (@contents_pack) = diversions_pack(@contents);
156 is_deeply(\@contents_pack, \@expected_pack, 'diversions contents');
163 note('Command line parsing testing');
165 my $usagere = qr/.*Usage.*dpkg-divert.*Commands.*Options.*/s;
167 sub call_divert_badusage {
168 my ($args, $err) = @_;
169 call_divert($args, expect_failure => 1, expect_stderr_like => $err);
172 call_divert(['--help'], expect_stdout_like => $usagere,
173 expect_stderr => '');
174 call_divert(['--version'], expect_stdout_like => qr/.*dpkg-divert.*free software.*/s,
175 expect_stderr => '');
177 call_divert_badusage(['--jachsmitbju'], qr/unknown option/);
178 call_divert_badusage(['--add', '--remove'], qr/(conflicting|two).*remove.*add.*/s);
179 call_divert_badusage(['--divert'], qr/(takes a value|needs.*argument)/);
180 call_divert_badusage(['--divert', 'foo'], qr/absolute/);
181 call_divert_badusage(['--divert', "/foo\nbar"], qr/newline/);
182 call_divert_badusage(['--package'], qr/(takes a value|needs.*argument)/);
183 call_divert_badusage(['--package', "foo\nbar"], qr/newline/);
185 install_diversions('');
187 call_divert_badusage(['--add',], qr/needs a single argument/);
188 call_divert_badusage(['--add', 'foo'], qr/absolute/);
189 call_divert_badusage(['--add', "/foo\nbar"], qr/newline/);
190 call_divert_badusage(['--add', "$testdir"], qr/director(y|ies)/);
191 call_divert_badusage(['--add', '--divert', 'bar', '/foo/bar'], qr/absolute/);
192 call_divert_badusage(['--remove'], qr/needs a single argument/);
193 call_divert_badusage(['--remove', 'foo'], qr/absolute/);
194 call_divert_badusage(['--remove', "/foo\nbar"], qr/newline/);
195 call_divert_badusage(['--listpackage'], qr/needs a single argument/);
196 call_divert_badusage(['--listpackage', 'foo'], qr/absolute/);
197 call_divert_badusage(['--listpackage', "/foo\nbar"], qr/newline/);
198 call_divert_badusage(['--truename'], qr/needs a single argument/);
199 call_divert_badusage(['--truename', 'foo'], qr/absolute/);
200 call_divert_badusage(['--truename', "/foo\nbar"], qr/newline/);
201 call([@dd, '--admindir'], [],
202 expect_failure => 1, expect_stderr_like => qr/(takes a value|needs.*argument)/);
206 note('Querying information from diverts db (empty one)');
208 install_diversions('');
210 call_divert_sort(['--list'], expect_stdout => '', expect_stderr => '');
211 call_divert_sort(['--list', '*'], expect_stdout => '', expect_stderr => '');
212 call_divert_sort(['--list', 'baz'], expect_stdout => '', expect_stderr => '');
216 note('Querying information from diverts db (1)');
218 install_diversions(<<'EOF');
222 /usr/share/man/man1/sh.1.gz
223 /usr/share/man/man1/sh.distrib.1.gz
230 my $di_dash = "diversion of /bin/sh to /bin/sh.distrib by dash\n";
231 my $di_dashman = "diversion of /usr/share/man/man1/sh.1.gz to /usr/share/man/man1/sh.distrib.1.gz by dash\n";
232 my $di_nm = "diversion of /usr/bin/nm to /usr/bin/nm.single by binutils-multiarch\n";
234 my $all_di = $di_dash . $di_dashman . $di_nm;
236 call_divert_sort(['--list'], expect_stdout => $all_di, expect_stderr => '');
237 call_divert_sort(['--list', '*'], expect_stdout => $all_di, expect_stderr => '');
238 call_divert_sort(['--list', ''], expect_stdout => '', expect_stderr => '');
240 call_divert_sort(['--list', '???????'], expect_stdout => $di_dash, expect_stderr => '');
241 call_divert_sort(['--list', '*/sh'], expect_stdout => $di_dash, expect_stderr => '');
242 call_divert_sort(['--list', '/bin/*'], expect_stdout => $di_dash, expect_stderr => '');
243 call_divert_sort(['--list', 'binutils-multiarch'], expect_stdout => $di_nm, expect_stderr => '');
244 call_divert_sort(['--list', '/bin/sh'], expect_stdout => $di_dash, expect_stderr => '');
245 call_divert_sort(['--list', '--', '/bin/sh'], expect_stdout => $di_dash, expect_stderr => '');
246 call_divert_sort(['--list', '/usr/bin/nm.single'], expect_stdout => $di_nm, expect_stderr => '');
247 call_divert_sort(['--list', '/bin/sh', '/usr/share/man/man1/sh.1.gz'], expect_stdout => $di_dash . $di_dashman,
248 expect_stderr => '');
252 note('Querying information from diverts db (2)');
254 install_diversions(<<'EOF');
263 call_divert(['--listpackage', 'foo', 'bar'], expect_failure => 1);
264 call_divert(['--listpackage', '/bin/sh'], expect_stdout => "dash\n", expect_stderr => '');
265 call_divert(['--listpackage', '/bin/true'], expect_stdout => "LOCAL\n", expect_stderr => '');
266 call_divert(['--listpackage', '/bin/false'], expect_stdout => '', expect_stderr => '');
268 call_divert(['--truename', '/bin/sh'], expect_stdout => "/bin/sh.distrib\n", expect_stderr => '');
269 call_divert(['--truename', '/bin/sh.distrib'], expect_stdout => "/bin/sh.distrib\n", expect_stderr => '');
270 call_divert(['--truename', '/bin/something'], expect_stdout => "/bin/something\n", expect_stderr => '');
274 note('Adding diversion');
276 my $diversions_added_foo_local = <<"EOF";
282 install_diversions('');
284 system("touch $testdir/foo");
285 call_divert(['--rename', '--add', "$testdir/foo"],
286 expect_stdout_like => qr{
287 Adding.*local.*diversion.*
289 \Q$testdir\E/foo.distrib
291 expect_stderr => '');
292 ok(-e "$testdir/foo.distrib", 'foo diverted');
293 ok(!-e "$testdir/foo", 'foo diverted');
294 diversions_eq($diversions_added_foo_local);
298 note('Adding diversion (2)');
300 install_diversions('');
302 system("touch $testdir/foo");
303 call_divert(['--add', "$testdir/foo"],
304 expect_stdout_like => qr{
305 Adding.*local.*diversion.*
307 \Q$testdir\E/foo.distrib
309 expect_stderr => '');
310 ok(!-e "$testdir/foo.distrib", 'foo diverted');
311 ok(-e "$testdir/foo", 'foo diverted');
312 diversions_eq($diversions_added_foo_local);
316 note('Adding diversion (3)');
318 install_diversions('');
320 system("touch $testdir/foo");
321 call_divert(['--quiet', '--rename', '--add', "$testdir/foo"],
322 expect_stdout => '', expect_stderr => '');
323 ok(-e "$testdir/foo.distrib", 'foo diverted');
324 ok(!-e "$testdir/foo", 'foo diverted');
325 diversions_eq($diversions_added_foo_local);
329 note('Adding diversion (4)');
331 install_diversions('');
332 system("touch $testdir/foo");
333 call_divert(['--quiet', '--rename', '--test', "$testdir/foo"],
334 expect_stdout => '', expect_stderr => '');
335 ok(-e "$testdir/foo", 'foo not diverted');
336 ok(!-e "$testdir/foo.distrib", 'foo diverted');
341 note('Adding diversion (5)');
343 install_diversions('');
344 call_divert(['--quiet', '--rename', "$testdir/foo"],
345 expect_stdout => '', expect_stderr => '');
346 ok(!-e "$testdir/foo", 'foo does not exist');
347 ok(!-e "$testdir/foo.distrib", 'foo was not created out of thin air');
351 note('Adding diversion (6)');
353 install_diversions('');
354 system("touch $testdir/foo");
355 call_divert(['--quiet', '--local', '--rename', "$testdir/foo"],
356 expect_stdout => '', expect_stderr => '');
358 ok(-e "$testdir/foo.distrib", 'foo diverted');
359 ok(!-e "$testdir/foo", 'foo diverted');
360 diversions_eq($diversions_added_foo_local);
364 note('Adding diversion (7)');
366 install_diversions('');
367 call_divert(['--quiet', '--rename', '--package', 'bash', "$testdir/foo"],
368 expect_stdout => '', expect_stderr => '');
369 diversions_eq(<<"EOF");
375 note('Adding diversion (8)');
377 install_diversions('');
378 system("touch $testdir/foo; ln $testdir/foo $testdir/foo.distrib");
379 call_divert(['--rename', "$testdir/foo"]);
380 diversions_eq($diversions_added_foo_local);
381 ok(!-e "$testdir/foo", 'foo diverted');
382 ok(-e "$testdir/foo.distrib", 'foo diverted');
386 note('Adding diversion (9)');
388 install_diversions('');
389 system("touch $testdir/foo $testdir/foo.distrib");
390 call_divert(['--rename', "$testdir/foo"], expect_failure => 1,
391 expect_stderr_like => qr/overwriting/);
396 note('Adding second diversion');
398 install_diversions('');
399 call_divert(["$testdir/foo"]);
401 call_divert(["$testdir/foo"], expect_stdout_like => qr/Leaving/);
402 call_divert(['--quiet', "$testdir/foo"], expect_stdout => '');
403 call_divert(['--divert', "$testdir/foo.bar", "$testdir/foo"],
404 expect_failure => 1, expect_stderr_like => qr/clashes/);
405 call_divert(['--package', 'foobar', "$testdir/foo"], expect_failure => 1,
406 expect_stderr_like => qr/clashes/);
407 call_divert(['--divert', "$testdir/foo.distrib", "$testdir/bar"],
408 expect_failure => 1, expect_stderr_like => qr/clashes/);
409 call_divert(["$testdir/foo.distrib"],
410 expect_failure => 1, expect_stderr_like => qr/clashes/);
411 call_divert(['--divert', "$testdir/foo", "$testdir/bar"],
412 expect_failure => 1, expect_stderr_like => qr/clashes/);
416 note('Adding third diversion');
418 install_diversions('');
419 call_divert(["$testdir/foo"]);
420 call_divert(["$testdir/bar"]);
422 call_divert(['--quiet', "$testdir/foo"], expect_stdout => '');
423 call_divert(['--package', 'foobar', "$testdir/bar"], expect_failure => 1,
424 expect_stderr_like => qr/clashes/);
428 note('Adding diversion in non-existing directory');
430 install_diversions('');
432 call_divert(['--quiet', '--rename', '--add', "$testdir/zoo/foo"],
433 expect_stderr => '', expect_stdout => '');
434 diversions_eq(<<"EOF");
436 $testdir/zoo/foo.distrib
442 note('Adding diversion of file owned by --package');
444 install_filelist('coreutils', 'i386', "$testdir/foo");
445 install_diversions('');
446 system("touch $testdir/foo");
448 call_divert(['--quiet', '--rename', '--add', '--package', 'coreutils', "$testdir/foo"],
449 expect_stderr => '', expect_stdout => '');
450 ok(-e "$testdir/foo", 'foo not renamed');
451 ok(!-e "$testdir/foo.distrib", 'foo renamed');
452 diversions_eq(<<"EOF");
460 note('Remove diversions');
462 install_diversions('');
464 call_divert(['--remove', '/bin/sh'], expect_stdout_like => qr/No diversion/, expect_stderr => '');
465 call_divert(['--remove', '--quiet', '/bin/sh'], expect_stdout => '', expect_stderr => '');
469 note('Remove diversion (2)');
471 install_diversions('');
472 call_divert(["$testdir/foo"]);
473 call_divert(["$testdir/bar"]);
474 call_divert(["$testdir/baz"]);
476 call_divert(['--divert', "$testdir/foo.my", '--remove', "$testdir/foo"],
477 expect_failure => 1, expect_stderr_like => qr/mismatch on divert-to/);
478 call_divert(['--package', 'baz', '--remove', "$testdir/foo"],
479 expect_failure => 1, expect_stderr_like => qr/mismatch on package/);
480 call_divert(['--package', 'baz', '--divert', "$testdir/foo.my", '--remove', "$testdir/foo"],
481 expect_failure => 1, expect_stderr_like => qr/mismatch on (package|divert-to)/);
483 call_divert(['--divert', "$testdir/foo.distrib", '--remove', "$testdir/foo"],
484 expect_stdout_like => qr{Removing.*\Q$testdir\E/foo});
485 diversions_eq(<<"EOF");
496 note('Remove diversion (3)');
498 install_diversions('');
500 call_divert(["$testdir/foo"]);
501 call_divert(["$testdir/bar"]);
502 call_divert(["$testdir/baz"]);
504 call_divert(['--remove', "$testdir/bar"],
505 expect_stdout_like => qr{Removing.*\Q$testdir\E/bar});
506 diversions_eq(<<"EOF");
517 note('Remove diversion (4)');
519 install_diversions('');
521 call_divert(["$testdir/foo"]);
522 call_divert(["$testdir/bar"]);
523 call_divert(['--package', 'bash', "$testdir/baz"]);
525 call_divert(['--quiet', '--package', 'bash', '--remove', "$testdir/baz"],
526 expect_stdout => '', expect_stderr => '');
527 diversions_eq(<<"EOF");
538 note('Remove diversion(5)');
540 install_diversions('');
541 system("touch $testdir/foo");
542 call_divert(['--rename', "$testdir/foo"]);
544 call_divert(['--test', '--rename', '--remove', "$testdir/foo"],
545 expect_stdout_like => qr{Removing.*\Q$testdir\E/foo}, expect_stderr => '');
546 ok(-e "$testdir/foo.distrib", 'foo diversion not removed');
547 ok(!-e "$testdir/foo", 'foo diversion not removed');
548 diversions_eq($diversions_added_foo_local);
550 call_divert(['--quiet', '--rename', '--remove', "$testdir/foo"],
551 expect_stdout => '', expect_stderr => '');
552 ok(-e "$testdir/foo", 'foo diversion removed');
553 ok(!-e "$testdir/foo.distrib", 'foo diversion removed');
558 note('Corrupted diversions db handling');
561 skip 'running as root or similar', 3, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
563 # An inexistent diversions db file should not be considered a failure,
564 # but a failure to open it should be.
565 install_diversions('');
566 system("chmod 000 $admindir/diversions");
567 call_divert_sort(['--list'], expect_failure => 1,
568 expect_stderr_like => qr/(cannot|failed).*open/, expect_stdout => '');
569 system("chmod 644 $admindir/diversions");
572 install_diversions(<<'EOF');
576 call_divert_sort(['--list'], expect_failure => 1,
577 expect_stderr_like => qr/(corrupt|unexpected end of file)/,
578 expect_stdout => '');
580 install_diversions(<<'EOF');
585 call_divert_sort(['--list'], expect_failure => 1,
586 expect_stderr_like => qr/(corrupt|unexpected end of file)/,
587 expect_stdout => '');
592 skip 'running as root or similar', 10, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
594 note('R/O directory');
596 install_diversions('');
597 system("mkdir $testdir/rodir && touch $testdir/rodir/foo $testdir/bar && chmod 500 $testdir/rodir");
598 call_divert(['--rename', '--add', "$testdir/rodir/foo"],
599 expect_failure => 1, expect_stderr_like => qr/error/);
600 call_divert(['--rename', '--divert', "$testdir/rodir/bar", '--add', "$testdir/bar"],
601 expect_failure => 1, expect_stderr_like => qr/error/);
604 system("chmod 755 $testdir/rodir");
607 note('Unavailable file');
609 install_diversions('');
610 system("mkdir $testdir/nadir && chmod 000 $testdir/nadir");
611 call_divert(['--rename', '--add', "$testdir/nadir/foo"],
612 expect_failure => 1, expect_stderr_like => qr/Permission denied/);
613 system("touch $testdir/foo");
614 call_divert(['--rename', '--divert', "$testdir/nadir/foo", '--add', "$testdir/foo"],
615 expect_failure => 1, expect_stderr_like => qr/Permission denied/);
621 note('Errors during saving diversions db');
623 install_diversions('');
626 skip 'running as root or similar', 4, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
628 system("chmod 500 $admindir");
629 call_divert(["$testdir/foo"], expect_failure => 1, expect_stderr_like => qr/create.*new/);
631 system("chmod 755 $admindir");
634 skip 'device /dev/full is not available', 2 if not -c '/dev/full';
636 system("ln -s /dev/full $admindir/diversions-new");
637 call_divert(["$testdir/foo"], expect_failure => 1,
638 expect_stderr_like => qr/(write|flush|close).*new/);
642 system("rm -f $admindir/diversions-new; mkdir $admindir/diversions-old");
643 call_divert(["$testdir/foo"], expect_failure => 1, expect_stderr_like => qr/remov.*old/);