summaryrefslogtreecommitdiffstats
path: root/src/t/dpkg_divert.t
diff options
context:
space:
mode:
Diffstat (limited to 'src/t/dpkg_divert.t')
-rw-r--r--src/t/dpkg_divert.t648
1 files changed, 648 insertions, 0 deletions
diff --git a/src/t/dpkg_divert.t b/src/t/dpkg_divert.t
new file mode 100644
index 0000000..b24f885
--- /dev/null
+++ b/src/t/dpkg_divert.t
@@ -0,0 +1,648 @@
+#!/usr/bin/perl
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+use strict;
+use warnings;
+
+use Test::More;
+
+use File::Spec;
+
+use Dpkg::File;
+use Dpkg::IPC;
+
+# Cleanup environment from variables that pollute the test runs.
+delete $ENV{DPKG_MAINTSCRIPT_PACKAGE};
+delete $ENV{DPKG_MAINTSCRIPT_ARCH};
+
+my $srcdir = $ENV{srcdir} || '.';
+my $builddir = $ENV{builddir} || '.';
+my $tmpdir = 't.tmp/dpkg_divert';
+my $admindir = File::Spec->rel2abs("$tmpdir/admindir");
+my $testdir = File::Spec->rel2abs("$tmpdir/testdir");
+
+my @dd = ("$builddir/../src/dpkg-divert");
+
+if (! -x "@dd") {
+ plan skip_all => 'dpkg-divert not available';
+ exit(0);
+}
+
+plan tests => 257;
+
+sub cleanup {
+ # On FreeBSD «rm -rf» cannot traverse a directory with mode 000.
+ system("test -d $testdir/nadir && rmdir $testdir/nadir");
+ system("rm -rf $tmpdir && mkdir -p $testdir");
+ system("mkdir -p $admindir/updates");
+ system("rm -f $admindir/status && touch $admindir/status");
+ system("rm -rf $admindir/info && mkdir -p $admindir/info");
+}
+
+sub install_diversions {
+ my ($txt) = @_;
+ open(my $db_fh, '>', "$admindir/diversions")
+ or die "cannot create $admindir/diversions";
+ print { $db_fh } $txt;
+ close($db_fh);
+}
+
+sub install_filelist {
+ my ($pkg, $arch, @files) = @_;
+ open(my $fileslist_fh, '>', "$admindir/info/$pkg.list")
+ or die "cannot create $admindir/info/$pkg.list";
+ for my $file (@files) {
+ print { $fileslist_fh } "$file\n";
+ }
+ close($fileslist_fh);
+ # Only installed packages have their files list considered.
+ open(my $status_fh, '>>', "$admindir/status")
+ or die "cannot append to $admindir/status";
+ print { $status_fh } <<"EOF";
+Package: $pkg
+Status: install ok installed
+Version: 0
+Architecture: $arch
+Maintainer: dummy
+Description: dummy
+
+EOF
+ close($status_fh);
+}
+
+sub call {
+ my ($prog, $args, %opts) = @_;
+
+ my ($output, $error);
+ spawn(exec => [@$prog, @$args], wait_child => 1, nocheck => 1,
+ to_pipe => \$output, error_to_pipe => \$error, %opts);
+
+ if ($opts{expect_failure}) {
+ ok($? != 0, "@$args should fail: $?");
+ } else {
+ ok($? == 0, "@$args should not fail: $?");
+ }
+
+ my @output = <$output>;
+ my @error = <$error>;
+ note("stdout <<<@output>>>");
+ note("stderr <<<@error>>>");
+
+ if (defined $opts{expect_stdout}) {
+ my (@expect) = split(/^/, $opts{expect_stdout});
+ if (defined $opts{expect_sorted_stdout}) {
+ @output = sort @output;
+ @expect = sort @expect;
+ }
+ is(join('', @output), join('', @expect), "@$args stdout");
+ }
+ if (defined $opts{expect_stdout_like}) {
+ like("@output", $opts{expect_stdout_like}, "@$args stdout");
+ }
+ if (defined $opts{expect_stderr}) {
+ is("@error", $opts{expect_stderr}, "@$args stderr");
+ }
+ if (defined $opts{expect_stderr_like}) {
+ like("@error", $opts{expect_stderr_like}, "@$args stderr");
+ }
+
+ close($output);
+ close($error);
+}
+
+sub call_divert {
+ my ($params, %opts) = @_;
+ call([@dd, '--admindir', $admindir], $params, %opts);
+}
+
+sub call_divert_sort {
+ my ($params, %opts) = @_;
+ $opts{expect_sorted_stdout} = 1;
+ call_divert($params, %opts);
+}
+
+sub diversions_pack {
+ my (@data) = @_;
+ my @data_packed;
+
+ ## no critic (ControlStructures::ProhibitCStyleForLoops)
+ for (my ($i) = 0; $i < $#data; $i += 3) {
+ push @data_packed, [ @data[$i .. $i + 2] ];
+ }
+ ## use critic
+ my @list = sort { $a->[0] cmp $b->[0] } @data_packed;
+
+ return @list;
+}
+
+sub diversions_eq {
+ my (@expected) = split /^/, shift;
+ open(my $db_fh, '<', "$admindir/diversions")
+ or die "cannot open $admindir/diversions";
+ my (@contents) = <$db_fh>;
+ close($db_fh);
+
+ my (@expected_pack) = diversions_pack(@expected);
+ my (@contents_pack) = diversions_pack(@contents);
+
+ is_deeply(\@contents_pack, \@expected_pack, 'diversions contents');
+}
+
+### Tests
+
+cleanup();
+
+note('Command line parsing testing');
+
+my $usagere = qr/.*Usage.*dpkg-divert.*Commands.*Options.*/s;
+
+sub call_divert_badusage {
+ my ($args, $err) = @_;
+ call_divert($args, expect_failure => 1, expect_stderr_like => $err);
+}
+
+call_divert(['--help'], expect_stdout_like => $usagere,
+ expect_stderr => '');
+call_divert(['--version'], expect_stdout_like => qr/.*dpkg-divert.*free software.*/s,
+ expect_stderr => '');
+
+call_divert_badusage(['--jachsmitbju'], qr/unknown option/);
+call_divert_badusage(['--add', '--remove'], qr/(conflicting|two).*remove.*add.*/s);
+call_divert_badusage(['--divert'], qr/(takes a value|needs.*argument)/);
+call_divert_badusage(['--divert', 'foo'], qr/absolute/);
+call_divert_badusage(['--divert', "/foo\nbar"], qr/newline/);
+call_divert_badusage(['--package'], qr/(takes a value|needs.*argument)/);
+call_divert_badusage(['--package', "foo\nbar"], qr/newline/);
+
+install_diversions('');
+
+call_divert_badusage(['--add',], qr/needs a single argument/);
+call_divert_badusage(['--add', 'foo'], qr/absolute/);
+call_divert_badusage(['--add', "/foo\nbar"], qr/newline/);
+call_divert_badusage(['--add', "$testdir"], qr/director(y|ies)/);
+call_divert_badusage(['--add', '--divert', 'bar', '/foo/bar'], qr/absolute/);
+call_divert_badusage(['--remove'], qr/needs a single argument/);
+call_divert_badusage(['--remove', 'foo'], qr/absolute/);
+call_divert_badusage(['--remove', "/foo\nbar"], qr/newline/);
+call_divert_badusage(['--listpackage'], qr/needs a single argument/);
+call_divert_badusage(['--listpackage', 'foo'], qr/absolute/);
+call_divert_badusage(['--listpackage', "/foo\nbar"], qr/newline/);
+call_divert_badusage(['--truename'], qr/needs a single argument/);
+call_divert_badusage(['--truename', 'foo'], qr/absolute/);
+call_divert_badusage(['--truename', "/foo\nbar"], qr/newline/);
+call([@dd, '--admindir'], [],
+ expect_failure => 1, expect_stderr_like => qr/(takes a value|needs.*argument)/);
+
+cleanup();
+
+note('Querying information from diverts db (empty one)');
+
+install_diversions('');
+
+call_divert_sort(['--list'], expect_stdout => '', expect_stderr => '');
+call_divert_sort(['--list', '*'], expect_stdout => '', expect_stderr => '');
+call_divert_sort(['--list', 'baz'], expect_stdout => '', expect_stderr => '');
+
+cleanup();
+
+note('Querying information from diverts db (1)');
+
+install_diversions(<<'EOF');
+/bin/sh
+/bin/sh.distrib
+dash
+/usr/share/man/man1/sh.1.gz
+/usr/share/man/man1/sh.distrib.1.gz
+dash
+/usr/bin/nm
+/usr/bin/nm.single
+binutils-multiarch
+EOF
+
+my $di_dash = "diversion of /bin/sh to /bin/sh.distrib by dash\n";
+my $di_dashman = "diversion of /usr/share/man/man1/sh.1.gz to /usr/share/man/man1/sh.distrib.1.gz by dash\n";
+my $di_nm = "diversion of /usr/bin/nm to /usr/bin/nm.single by binutils-multiarch\n";
+
+my $all_di = $di_dash . $di_dashman . $di_nm;
+
+call_divert_sort(['--list'], expect_stdout => $all_di, expect_stderr => '');
+call_divert_sort(['--list', '*'], expect_stdout => $all_di, expect_stderr => '');
+call_divert_sort(['--list', ''], expect_stdout => '', expect_stderr => '');
+
+call_divert_sort(['--list', '???????'], expect_stdout => $di_dash, expect_stderr => '');
+call_divert_sort(['--list', '*/sh'], expect_stdout => $di_dash, expect_stderr => '');
+call_divert_sort(['--list', '/bin/*'], expect_stdout => $di_dash, expect_stderr => '');
+call_divert_sort(['--list', 'binutils-multiarch'], expect_stdout => $di_nm, expect_stderr => '');
+call_divert_sort(['--list', '/bin/sh'], expect_stdout => $di_dash, expect_stderr => '');
+call_divert_sort(['--list', '--', '/bin/sh'], expect_stdout => $di_dash, expect_stderr => '');
+call_divert_sort(['--list', '/usr/bin/nm.single'], expect_stdout => $di_nm, expect_stderr => '');
+call_divert_sort(['--list', '/bin/sh', '/usr/share/man/man1/sh.1.gz'], expect_stdout => $di_dash . $di_dashman,
+ expect_stderr => '');
+
+cleanup();
+
+note('Querying information from diverts db (2)');
+
+install_diversions(<<'EOF');
+/bin/sh
+/bin/sh.distrib
+dash
+/bin/true
+/bin/true.coreutils
+:
+EOF
+
+call_divert(['--listpackage', 'foo', 'bar'], expect_failure => 1);
+call_divert(['--listpackage', '/bin/sh'], expect_stdout => "dash\n", expect_stderr => '');
+call_divert(['--listpackage', '/bin/true'], expect_stdout => "LOCAL\n", expect_stderr => '');
+call_divert(['--listpackage', '/bin/false'], expect_stdout => '', expect_stderr => '');
+
+call_divert(['--truename', '/bin/sh'], expect_stdout => "/bin/sh.distrib\n", expect_stderr => '');
+call_divert(['--truename', '/bin/sh.distrib'], expect_stdout => "/bin/sh.distrib\n", expect_stderr => '');
+call_divert(['--truename', '/bin/something'], expect_stdout => "/bin/something\n", expect_stderr => '');
+
+cleanup();
+
+note('Adding diversion');
+
+my $diversions_added_foo_local = <<"EOF";
+$testdir/foo
+$testdir/foo.distrib
+:
+EOF
+
+install_diversions('');
+
+system("touch $testdir/foo");
+call_divert(['--rename', '--add', "$testdir/foo"],
+ expect_stdout_like => qr{
+ Adding.*local.*diversion.*
+ \Q$testdir\E/foo.*
+ \Q$testdir\E/foo.distrib
+ }x,
+ expect_stderr => '');
+ok(-e "$testdir/foo.distrib", 'foo diverted');
+ok(!-e "$testdir/foo", 'foo diverted');
+diversions_eq($diversions_added_foo_local);
+
+cleanup();
+
+note('Adding diversion (2)');
+
+install_diversions('');
+
+system("touch $testdir/foo");
+call_divert(['--no-rename', '--add', "$testdir/foo"],
+ expect_stdout_like => qr{
+ Adding.*local.*diversion.*
+ \Q$testdir\E/foo.*
+ \Q$testdir\E/foo.distrib
+ }x,
+ expect_stderr => '');
+ok(!-e "$testdir/foo.distrib", 'foo diverted');
+ok(-e "$testdir/foo", 'foo diverted');
+diversions_eq($diversions_added_foo_local);
+
+cleanup();
+
+note('Adding diversion (3)');
+
+install_diversions('');
+
+system("touch $testdir/foo");
+call_divert(['--quiet', '--rename', '--add', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+ok(-e "$testdir/foo.distrib", 'foo diverted');
+ok(!-e "$testdir/foo", 'foo diverted');
+diversions_eq($diversions_added_foo_local);
+
+cleanup();
+
+note('Adding diversion (4)');
+
+install_diversions('');
+system("touch $testdir/foo");
+call_divert(['--quiet', '--rename', '--test', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+ok(-e "$testdir/foo", 'foo not diverted');
+ok(!-e "$testdir/foo.distrib", 'foo diverted');
+diversions_eq('');
+
+cleanup();
+
+note('Adding diversion (5)');
+
+install_diversions('');
+call_divert(['--quiet', '--rename', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+ok(!-e "$testdir/foo", 'foo does not exist');
+ok(!-e "$testdir/foo.distrib", 'foo was not created out of thin air');
+
+cleanup();
+
+note('Adding diversion (6)');
+
+install_diversions('');
+system("touch $testdir/foo");
+call_divert(['--quiet', '--local', '--rename', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+
+ok(-e "$testdir/foo.distrib", 'foo diverted');
+ok(!-e "$testdir/foo", 'foo diverted');
+diversions_eq($diversions_added_foo_local);
+
+cleanup();
+
+note('Adding diversion (7)');
+
+install_diversions('');
+call_divert(['--quiet', '--rename', '--package', 'bash', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+diversions_eq(<<"EOF");
+$testdir/foo
+$testdir/foo.distrib
+bash
+EOF
+
+note('Adding diversion (8)');
+
+install_diversions('');
+system("touch $testdir/foo; ln $testdir/foo $testdir/foo.distrib");
+call_divert(['--rename', "$testdir/foo"]);
+diversions_eq($diversions_added_foo_local);
+ok(!-e "$testdir/foo", 'foo diverted');
+ok(-e "$testdir/foo.distrib", 'foo diverted');
+
+cleanup();
+
+note('Adding diversion (9)');
+
+install_diversions('');
+system("touch $testdir/foo $testdir/foo.distrib");
+call_divert(['--rename', "$testdir/foo"], expect_failure => 1,
+ expect_stderr_like => qr/overwriting/);
+diversions_eq('');
+
+cleanup();
+
+note('Adding second diversion');
+
+install_diversions('');
+call_divert(["$testdir/foo"]);
+
+call_divert(["$testdir/foo"], expect_stdout_like => qr/Leaving/);
+call_divert(['--quiet', "$testdir/foo"], expect_stdout => '');
+call_divert(['--divert', "$testdir/foo.bar", "$testdir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/clashes/);
+call_divert(['--package', 'foobar', "$testdir/foo"], expect_failure => 1,
+ expect_stderr_like => qr/clashes/);
+call_divert(['--divert', "$testdir/foo.distrib", "$testdir/bar"],
+ expect_failure => 1, expect_stderr_like => qr/clashes/);
+call_divert(["$testdir/foo.distrib"],
+ expect_failure => 1, expect_stderr_like => qr/clashes/);
+call_divert(['--divert', "$testdir/foo", "$testdir/bar"],
+ expect_failure => 1, expect_stderr_like => qr/clashes/);
+
+cleanup();
+
+note('Adding third diversion');
+
+install_diversions('');
+call_divert(["$testdir/foo"]);
+call_divert(["$testdir/bar"]);
+
+call_divert(['--quiet', "$testdir/foo"], expect_stdout => '');
+call_divert(['--package', 'foobar', "$testdir/bar"], expect_failure => 1,
+ expect_stderr_like => qr/clashes/);
+
+cleanup();
+
+note('Adding diversion in non-existing directory');
+
+install_diversions('');
+
+call_divert(['--quiet', '--rename', '--add', "$testdir/zoo/foo"],
+ expect_stderr => '', expect_stdout => '');
+diversions_eq(<<"EOF");
+$testdir/zoo/foo
+$testdir/zoo/foo.distrib
+:
+EOF
+
+cleanup();
+
+note('Adding diversion of file owned by --package');
+
+install_filelist('coreutils', 'i386', "$testdir/foo");
+install_diversions('');
+system("touch $testdir/foo");
+
+call_divert(['--quiet', '--rename', '--add', '--package', 'coreutils', "$testdir/foo"],
+ expect_stderr => '', expect_stdout => '');
+ok(-e "$testdir/foo", 'foo not renamed');
+ok(!-e "$testdir/foo.distrib", 'foo renamed');
+diversions_eq(<<"EOF");
+$testdir/foo
+$testdir/foo.distrib
+coreutils
+EOF
+
+cleanup();
+
+note('Remove diversions');
+
+install_diversions('');
+
+call_divert(['--no-rename', '--remove', '/bin/sh'], expect_stdout_like => qr/No diversion/, expect_stderr => '');
+call_divert(['--no-rename', '--remove', '--quiet', '/bin/sh'], expect_stdout => '', expect_stderr => '');
+
+cleanup();
+
+note('Remove diversion (2)');
+
+install_diversions('');
+call_divert(["$testdir/foo"]);
+call_divert(["$testdir/bar"]);
+call_divert(["$testdir/baz"]);
+
+call_divert(['--divert', "$testdir/foo.my", '--remove', "$testdir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/mismatch on divert-to/);
+call_divert(['--package', 'baz', '--remove', "$testdir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/mismatch on package/);
+call_divert(['--package', 'baz', '--divert', "$testdir/foo.my", '--remove', "$testdir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/mismatch on (package|divert-to)/);
+
+call_divert(['--divert', "$testdir/foo.distrib", '--remove', "$testdir/foo"],
+ expect_stdout_like => qr{Removing.*\Q$testdir\E/foo});
+diversions_eq(<<"EOF");
+$testdir/bar
+$testdir/bar.distrib
+:
+$testdir/baz
+$testdir/baz.distrib
+:
+EOF
+
+cleanup();
+
+note('Remove diversion (3)');
+
+install_diversions('');
+
+call_divert(["$testdir/foo"]);
+call_divert(["$testdir/bar"]);
+call_divert(["$testdir/baz"]);
+
+call_divert(['--remove', "$testdir/bar"],
+ expect_stdout_like => qr{Removing.*\Q$testdir\E/bar});
+diversions_eq(<<"EOF");
+$testdir/foo
+$testdir/foo.distrib
+:
+$testdir/baz
+$testdir/baz.distrib
+:
+EOF
+
+cleanup();
+
+note('Remove diversion (4)');
+
+install_diversions('');
+
+call_divert(["$testdir/foo"]);
+call_divert(["$testdir/bar"]);
+call_divert(['--package', 'bash', "$testdir/baz"]);
+
+call_divert(['--no-rename', '--quiet', '--package', 'bash',
+ '--remove', "$testdir/baz"],
+ expect_stdout => '', expect_stderr => '');
+diversions_eq(<<"EOF");
+$testdir/foo
+$testdir/foo.distrib
+:
+$testdir/bar
+$testdir/bar.distrib
+:
+EOF
+
+cleanup();
+
+note('Remove diversion(5)');
+
+install_diversions('');
+system("touch $testdir/foo");
+call_divert(['--rename', "$testdir/foo"]);
+
+call_divert(['--test', '--rename', '--remove', "$testdir/foo"],
+ expect_stdout_like => qr{Removing.*\Q$testdir\E/foo}, expect_stderr => '');
+ok(-e "$testdir/foo.distrib", 'foo diversion not removed');
+ok(!-e "$testdir/foo", 'foo diversion not removed');
+diversions_eq($diversions_added_foo_local);
+
+call_divert(['--quiet', '--rename', '--remove', "$testdir/foo"],
+ expect_stdout => '', expect_stderr => '');
+ok(-e "$testdir/foo", 'foo diversion removed');
+ok(!-e "$testdir/foo.distrib", 'foo diversion removed');
+diversions_eq('');
+
+cleanup();
+
+note('Corrupted diversions db handling');
+
+SKIP: {
+ skip 'running as root or similar', 3, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
+
+ # An inexistent diversions db file should not be considered a failure,
+ # but a failure to open it should be.
+ install_diversions('');
+ system("chmod 000 $admindir/diversions");
+ call_divert_sort(['--list'], expect_failure => 1,
+ expect_stderr_like => qr/(cannot|failed).*open/, expect_stdout => '');
+ system("chmod 644 $admindir/diversions");
+}
+
+install_diversions(<<'EOF');
+/bin/sh
+EOF
+
+call_divert_sort(['--list'], expect_failure => 1,
+ expect_stderr_like => qr/(corrupt|unexpected end of file)/,
+ expect_stdout => '');
+
+install_diversions(<<'EOF');
+/bin/sh
+bash
+EOF
+
+call_divert_sort(['--list'], expect_failure => 1,
+ expect_stderr_like => qr/(corrupt|unexpected end of file)/,
+ expect_stdout => '');
+
+cleanup();
+
+SKIP: {
+ skip 'running as root or similar', 10, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
+
+ note('R/O directory');
+
+ install_diversions('');
+ system("mkdir $testdir/rodir && touch $testdir/rodir/foo $testdir/bar && chmod 500 $testdir/rodir");
+ call_divert(['--rename', '--add', "$testdir/rodir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/error/);
+ call_divert(['--rename', '--divert', "$testdir/rodir/bar", '--add', "$testdir/bar"],
+ expect_failure => 1, expect_stderr_like => qr/error/);
+ diversions_eq('');
+
+ system("chmod 755 $testdir/rodir");
+ cleanup();
+
+ note('Unavailable file');
+
+ install_diversions('');
+ system("mkdir $testdir/nadir && chmod 000 $testdir/nadir");
+ call_divert(['--rename', '--add', "$testdir/nadir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/Permission denied/);
+ system("touch $testdir/foo");
+ call_divert(['--rename', '--divert', "$testdir/nadir/foo", '--add', "$testdir/foo"],
+ expect_failure => 1, expect_stderr_like => qr/Permission denied/);
+ diversions_eq('');
+
+ cleanup();
+}
+
+note('Errors during saving diversions db');
+
+install_diversions('');
+
+SKIP: {
+ skip 'running as root or similar', 4, if (defined($ENV{FAKEROOTKEY}) or $> == 0);
+
+ system("chmod 500 $admindir");
+ call_divert(["$testdir/foo"], expect_failure => 1, expect_stderr_like => qr/create.*new/);
+
+ system("chmod 755 $admindir");
+
+ SKIP: {
+ skip 'device /dev/full is not available', 2 if not -c '/dev/full';
+
+ system("ln -s /dev/full $admindir/diversions-new");
+ call_divert(["$testdir/foo"], expect_failure => 1,
+ expect_stderr_like => qr/(write|flush|close).*new/);
+ }
+}
+
+system("rm -f $admindir/diversions-new; mkdir $admindir/diversions-old");
+call_divert(["$testdir/foo"], expect_failure => 1, expect_stderr_like => qr/remov.*old/);