# Copyright (c) 2008-2012 Zmanda, Inc. All Rights Reserved.
# Copyright (c) 2013-2016 Carbonite, Inc. All Rights Reserved.
#
# 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, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Contact information: Carbonite Inc., 756 N Pastoria Ave
# Sunnyvale, CA 94086, USA, or: http://www.zmanda.com
use Test::More tests => 19;
use File::Path;
use strict;
use warnings;
use lib '@amperldir@';
use Installcheck;
use Installcheck::Config;
use Installcheck::Changer;
use Amanda::Paths;
use Amanda::Device qw( :constants );
use Amanda::Debug;
use Amanda::MainLoop;
use Amanda::Config qw( :init :getconf config_dir_relative );
use Amanda::Changer;
# set up debugging so debug output doesn't interfere with test results
Amanda::Debug::dbopen("installcheck");
Installcheck::log_test_output();
# and disable Debug's die() and warn() overrides
Amanda::Debug::disable_die_override();
my $taperoot = "$Installcheck::TMP/Amanda_Changer_Multi_test";
sub reset_taperoot {
my ($nslots) = @_;
if (-d $taperoot) {
rmtree($taperoot);
}
mkpath($taperoot);
for my $slot (1 .. $nslots) {
mkdir("$taperoot/slot$slot")
or die("Could not mkdir: $!");
mkdir("$taperoot/slot$slot/data")
or die("Could not mkdir: $!");
}
}
# Build a configuration that specifies Amanda::Changer::Multi
my $testconf = Installcheck::Config->new();
$testconf->add_changer('multi', [
tpchanger => "\"chg-multi:file:$taperoot/slot{0,1,2,3,4}\"",
changerfile => "\"changer\"",
]);
$testconf->write();
my $cfg_result = config_init($CONFIG_INIT_EXPLICIT_NAME, 'TESTCONF');
if ($cfg_result != $CFGERR_OK) {
my ($level, @errors) = Amanda::Config::config_errors();
die(join "\n", @errors);
}
reset_taperoot(5);
my $chg = Amanda::Changer->new("multi");
die($chg) if $chg->isa("Amanda::Changer::Error");
is($chg->have_inventory(), '1', "changer have inventory");
{
my @slots = ();
my @reservations = ();
my ($release, $getres, $tryreserved);
$getres = make_cb(getres => sub {
my $slot = pop @slots;
if (!defined $slot) {
return $tryreserved->();
}
$chg->load(slot => $slot,
set_current => ($slot == 5),
res_cb => make_cb(sub {
my ($err, $reservation) = @_;
ok(!$err, "no error loading slot $slot")
or diag($err);
# keep this reservation
if ($reservation) {
push @reservations, $reservation;
}
# and start on the next
$getres->();
}));
});
$tryreserved = make_cb(tryreserved => sub {
# try to load an already-reserved slot
$chg->load(slot => 3,
res_cb => sub {
my ($err, $reservation) = @_;
chg_err_like($err,
{ message => qr/Slot 3 is already in use by process/,
type => 'failed',
reason => 'volinuse' },
"error when requesting already-reserved slot");
$release->();
});
});
$release = make_cb(release => sub {
my $res = pop @reservations;
if (!defined $res) {
return Amanda::MainLoop::quit();
}
$res->release(finished_cb => sub {
my ($err) = @_;
die $err if $err;
$release->();
});
});
# start the loop
@slots = ( 1, 3, 5 );
$getres->();
Amanda::MainLoop::run();
# and try it with some different slots, just to see
@slots = ( 4, 2, 3 );
$getres->();
Amanda::MainLoop::run();
@reservations = ();
}
# check relative slot ("current" and "next") functionality
sub test_relative_slot {
my ($finished_cb) = @_;
my $slot;
my $steps = define_steps
cb_ref => \$finished_cb;
step load_current => sub {
# load the "current" slot, which should be 4
$chg->load(relative_slot => "current", res_cb => $steps->{'check_current_cb'});
};
step check_current_cb => sub {
my ($err, $res) = @_;
die $err if $err;
is ($res->{'this_slot'}, 5, "'current' is slot 5");
$slot = $res->{'this_slot'};
$res->release(finished_cb => $steps->{'released1'});
};
step released1 => sub {
my ($err) = @_;
die $err if $err;
$chg->load(relative_slot => 'next', slot => $slot,
res_cb => $steps->{'check_next_cb'});
};
step check_next_cb => sub {
my ($err, $res) = @_;
die $err if $err;
is ($res->{'this_slot'}, 1, "'next' from there is slot 1");
$res->release(finished_cb => $steps->{'released2'});
};
step released2 => sub {
my ($err) = @_;
die $err if $err;
$chg->reset(finished_cb => $steps->{'reset_finished_cb'});
};
step reset_finished_cb => sub {
my ($err) = @_;
die $err if $err;
$chg->load(relative_slot => "current", res_cb => $steps->{'check_reset_cb'});
};
step check_reset_cb => sub {
my ($err, $res) = @_;
die $err if $err;
is ($res->{'this_slot'}, 1, "after reset, 'current' is slot 1");
$res->release(finished_cb => $steps->{'released3'});
};
step released3 => sub {
my ($err) = @_;
die $err if $err;
$finished_cb->();
};
}
test_relative_slot(\&Amanda::MainLoop::quit);
Amanda::MainLoop::run();
# test loading relative_slot "next"
sub test_relative_slot_next {
my ($finished_cb) = @_;
my $steps = define_steps
cb_ref => \$finished_cb;
step load_next => sub {
$chg->load(relative_slot => "next",
res_cb => sub {
my ($err, $res) = @_;
die $err if $err;
is ($res->{'this_slot'}, 2, "loading relative slot 'next' loads the correct slot");
$steps->{'release'}->($res);
}
);
};
step release => sub {
my ($res) = @_;
$res->release(finished_cb => sub {
my ($err) = @_;
die $err if $err;
$finished_cb->();
});
};
}
test_relative_slot_next(\&Amanda::MainLoop::quit);
Amanda::MainLoop::run();
# scan the changer using except_slots
sub test_except_slots {
my ($finished_cb) = @_;
my $slot;
my %except_slots;
my $steps = define_steps
cb_ref => \$finished_cb;
step start => sub {
$chg->load(slot => "5", except_slots => { %except_slots },
res_cb => $steps->{'loaded'});
};
step loaded => sub {
my ($err, $res) = @_;
if ($err) {
if ($err->notfound) {
# this means the scan is done
return $steps->{'quit'}->();
} elsif ($err->volinuse and defined $err->{'slot'}) {
$slot = $err->{'slot'};
} else {
die $err;
}
} else {
$slot = $res->{'this_slot'};
}
$except_slots{$slot} = 1;
if ($res) {
$res->release(finished_cb => $steps->{'released'});
} else {
$steps->{'released'}->();
}
};
step released => sub {
my ($err) = @_;
die $err if $err;
$chg->load(relative_slot => 'next', slot => $slot,
except_slots => { %except_slots },
res_cb => $steps->{'loaded'});
};
step quit => sub {
is_deeply({ %except_slots }, { 5=>1, 1=>1, 2=>1, 3=>1, 4=>1 },
"scanning with except_slots works");
$finished_cb->();
};
}
test_except_slots(\&Amanda::MainLoop::quit);
Amanda::MainLoop::run();
# eject is not implemented
{
my $try_eject = make_cb('try_eject' => sub {
$chg->eject(finished_cb => make_cb(sub {
my ($err, $res) = @_;
is ($err, undef, "eject is implemented");
Amanda::MainLoop::quit();
}));
});
$try_eject->();
Amanda::MainLoop::run();
}
# check num_slots and loading by label
{
my ($update, $get_info, $load_label, $check_load_cb) = @_;
$update = make_cb('update' => sub {
$chg->update(changed => "4", finished_cb => $get_info);
});
$get_info = make_cb('get_info' => sub {
$chg->info(info_cb => $load_label, info => [ 'num_slots', 'fast_search' ]);
});
$load_label = make_cb('load_label' => sub {
my $err = shift;
my %results = @_;
die($err) if defined($err);
is_deeply({ %results },
{ num_slots => 5, fast_search => 0 },
"info() returns the correct num_slots and fast_search");
# note use of a glob metacharacter in the label name
$chg->load(label => "FOO?BAR", res_cb => $check_load_cb, set_current => 1);
});
$check_load_cb = make_cb('check_load_cb' => sub {
my ($err, $res) = @_;
die $err if $err;
is ($res->{'this_slot'}, 4, "labeled volume found in slot 4");
$res->release(finished_cb => sub {
my ($err) = @_;
die $err if $err;
Amanda::MainLoop::quit();
});
});
# label slot 4
my $dev = Amanda::Device->new("file:$taperoot/slot3");
$dev->start($Amanda::Device::ACCESS_WRITE, "FOO?BAR", undef)
or die $dev->error_or_status();
$dev->finish()
or die $dev->error_or_status();
$update->();
Amanda::MainLoop::run();
}
# inventory is pretty cool
{
my $try_inventory = make_cb('try_inventory' => sub {
$chg->inventory(inventory_cb => make_cb(sub {
my ($err, $inv) = @_;
die $err if $err;
is_deeply($inv, [
{ slot => 1, state => Amanda::Changer::SLOT_FULL,
device_status => $DEVICE_STATUS_DEVICE_ERROR,
device_error => "Error checking directory $taperoot/slot0/: No such file or directory",
f_type => undef, label => undef,
reserved => 0 },
{ slot => 2, state => Amanda::Changer::SLOT_FULL,
device_status => $DEVICE_STATUS_VOLUME_UNLABELED,
device_error => "File 0 not found",
f_type => $Amanda::Header::F_EMPTY, label => undef,
reserved => 0 },
{ slot => 3, state => Amanda::Changer::SLOT_FULL,
device_status => $DEVICE_STATUS_VOLUME_UNLABELED,
device_error => "File 0 not found",
f_type => $Amanda::Header::F_EMPTY, label => undef,
reserved => 0 },
{ slot => 4, state => Amanda::Changer::SLOT_FULL,
device_status => $DEVICE_STATUS_SUCCESS,
device_error => undef,
f_type => $Amanda::Header::F_TAPESTART, label => "FOO?BAR",
reserved => 0, current => 1 },
{ slot => 5, state => Amanda::Changer::SLOT_FULL,
device_status => $DEVICE_STATUS_VOLUME_UNLABELED,
device_error => "File 0 not found",
f_type => $Amanda::Header::F_EMPTY, label => undef,
reserved => 0 },
], "inventory finds the labeled tape");
Amanda::MainLoop::quit();
}));
});
$try_inventory->();
Amanda::MainLoop::run();
}
# check loading by label if the state is unknown
{
my ($update, $load_label, $check_load_cb) = @_;
$update = make_cb('update' => sub {
$chg->update(changed => "4=", finished_cb => $load_label);
});
$load_label = make_cb('load_label' => sub {
# note use of a glob metacharacter in the label name
$chg->load(label => "FOO?BAR", res_cb => $check_load_cb);
});
$check_load_cb = make_cb('check_load_cb' => sub {
my ($err, $res) = @_;
die("labeled volume found in slot 4") if $res;
die("bad error: $err") if $err && !$err->notfound;
ok(1, "Don't found label for unknown state slot");
Amanda::MainLoop::quit();
});
$update->();
Amanda::MainLoop::run();
}
$chg->quit();
rmtree($taperoot);