template_analyze.in 7.22 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2006, 2007 University of Utah and the Flux Group.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# All rights reserved.
#
use English;
use strict;
use Getopt::Std;
use POSIX qw(isatty setsid);
use POSIX qw(strftime);
use Errno qw(EDQUOT);
use Data::Dumper;

#
# Setup analysis of a template record.
#
# Exit codes are important; they tell the web page what has happened so
# it can say something useful to the user. Fatal errors are mostly done
# with die(), but expected errors use this routine. At some point we will
# use the DB to communicate the actual error.
#
# $status < 0 - Fatal error. Something went wrong we did not expect.
# $status = 0 - Everything okay.
# $status > 0 - Expected error. User not allowed for some reason. 
# 
sub usage()
{
    print(STDERR
30
	  "Usage: template_analyze [-q] [-s] [-r runidx] -i <exptidx> <guid/vers>\n".
31 32 33 34 35 36
	  "switches and arguments:\n".
	  "-q           - be less chatty\n".
	  "-i <exptidx> - Experiment index to work on\n".
	  "<guid/vers>  - GUID and version\n");
    exit(-1);
}
37
my $optlist	 = "qi:dr:";
38 39 40 41 42
my %options      = ();
my $quiet        = 0;
my $debug        = 0;
my $eid;
my $exptidx;
43
my $runidx;
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
my $guid;
my $version;

#
# Configure variables
#
my $TB		= "@prefix@";
my $EVENTSYS	= @EVENTSYS@;
my $TBOPS	= "@TBOPSEMAIL@";
my $TBLOGS	= "@TBLOGSEMAIL@";
my $TBDOCBASE	= "@TBDOCBASE@";
my $TBBASE	= "@TBBASE@";
my $CONTROL     = "@USERNODE@";
my $checkquota  = "$TB/sbin/checkquota";
my $dbcontrol   = "$TB/sbin/opsdb_control";

# Locals
my $template;
my $instance;
my $archive_tag;

# Protos
sub ParseArgs();
sub fatal($$);
sub cleanup();

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use libtblog;
77
use libaudit;
78
use Template;
79
use User;
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

# In libdb
my $projroot = PROJROOT();

#
# Turn off line buffering on output
#
$| = 1;

#
# Set umask for start/swap. We want other members in the project to be
# able to swap/end experiments, so the log and intermediate files need
# to be 664 since some are opened for append.
#
umask(0002);

#
# Untaint the path
#
# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Verify user and get his DB uid.
#
106 107 108 109 110 111
#
# Verify user and get his DB uid and other info for later.
#
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
112
}
113
my $user_uid   = $this_user->uid();
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

# Now parse arguments.
ParseArgs();

# Temporary
libArchive::setdebug($debug);

#
# Grab template info and do access check.
#
$template = Template->Lookup($guid, $version);

if (!defined($template)) {
    tbdie("Experiment template $guid/$version does not exist!");
}
129 130 131

my $project = $template->GetProject();
if (! $project->AccessCheck($this_user, TB_PROJECT_READINFO)) {
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    tberror("You do not have permission to export template $guid/$version");
    exit(1);
}
my $pid = $template->pid();
my $gid = $template->gid();

$instance = Template::Instance->LookupByExptidx($exptidx);
if (!defined($instance)) {
    fatal(-1, "Could not get instance record for experiment $exptidx!");
}

if ($instance->ArchiveTag(\$archive_tag) < 0) {
    fatal(-1, "Could not get current archive tag for instance $exptidx!");
}

147
if (system("$checkquota $user_uid") != 0) {
148 149
    tberror("You are over your disk quota on $CONTROL; ".
	    "please login there and cleanup!");
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    exit(1);
}

# Get the the runs.
my %runlist;
$instance->RunList(\%runlist) == 0
    or fatal(-1, "Could not get runlist for $instance");

#
# It is an error to analyze an instance with no runs; it sorta implies
# the the initial run is still active.
#
if (! keys(%runlist)) {
    tberror("There are no experiment runs in instance $instance!");
    exit(1);
}

#
# Checkout to the project tree.
#
my $checkout = "$projroot/$pid/export/$guid/$version/$exptidx";

# Cleanup existing goo.
if (-e $checkout) {
    system("/bin/rm -rf $checkout");
}
system("mkdir -p $checkout") == 0
    or fatal(-1, "Could not mkdir $checkout");

# Use the logonly option to audit so that we get a record mailed.
LogStart(0);

#
# Now dump a checkout of the dbdata directory for each run, in its own
# directory. 
#
foreach my $name (keys(%runlist)) {
    my $rowref = $runlist{$name};
188 189
    my $idx    = $rowref->{"idx"};
    my $dir    = "$checkout/run${idx}";
190
    my $subdir = "dbdata/";
191
    my $tag    = $rowref->{"ending_archive_tag"};
192
    my $dbdump = "$dir/$subdir/dbdump.gz";
193 194 195 196

    # This could happen if template is still instantiated (last run).
    next
	if (!defined($tag) || $tag eq "");
197 198 199 200

    # A specific run?
    next
	if (defined($runidx) && $runidx != $idx);
201 202 203 204 205 206 207 208 209 210
	
    system("mkdir -p $dir") == 0
	or fatal(-1, "Could not mkdir $dir");

    print "Checking out files from archive using tag $tag ...\n";
    
    libArchive::TBCheckoutExperimentArchivebyExptIDX($exptidx, $dir,
						     $tag, $subdir) == 0 or
        fatal(-1, "Could not checkout $tag to $dir");

211
    if (! -e "$dbdump") {
212
	$subdir = "exp/dbdata/";
213
	$dbdump = "$dir/$subdir/dbdump.gz";
214 215 216 217 218
	
	libArchive::TBCheckoutExperimentArchivebyExptIDX($exptidx, $dir,
							 $tag, $subdir) == 0 or
            fatal(-1, "Could not checkout $tag to $dir");
    }
219 220 221
    if (! -e "$dbdump") {
	fatal(-1, "Could not find the dbdump file in the archive!");
    }
222

223 224 225
    #
    # Now we need to create a DB on ops to hold the DB dump.
    #
226
    my $dbname = "${guid},${version}," . $instance->idx() . ",$idx";
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

    if (system("$dbcontrol deltempdb $dbname")) {
	fatal(-1, "$dbcontrol deltempdb failed!");
    }
    if (system("$dbcontrol addtempdb $pid $gid $dbname")) {
	fatal(-1, "$dbcontrol addtempdb failed!");
    }

    #
    # Load it up.
    #
    if (system("$dbcontrol loadtempdb $dbname $dbdump")) {
	fatal(-1, "$dbcontrol loadtempdb failed!");
    }
}
LogEnd();
exit(0);

#
# Parse command arguments. Once we return from getopts, all that are
# left are the required arguments.
#
sub ParseArgs()
{
    if (! getopts($optlist, \%options)) {
	usage();
    }

    if (@ARGV != 1) {
	usage();
    }
    
    #
    # Pick up guid/version first and untaint.
    #
    my $tmp = shift(@ARGV);

    if ($tmp =~ /^([\w]*)\/([\d]*)$/) {
	$guid = $1;
	$version = $2;
    }
    else {
	tbdie("Bad data in argument: $tmp");
    }

    if (defined($options{"i"})) {
	$exptidx = $options{"i"};
    
	if (! TBcheck_dbslot($exptidx, "default", "int",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper experiment index!");
	}
	# real check.
	if ($exptidx =~ /^([\w]*)$/) {
	    $exptidx = $1;
	}
	else {
	    tbdie("Bad data in argument: $exptidx");
	}
    }
    else {
	tbdie("You must supply the -i option!");
    }

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    if (defined($options{"r"})) {
	$runidx = $options{"r"};
    
	if (! TBcheck_dbslot($exptidx, "default", "int",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper run index!");
	}
	# real check.
	if ($runidx =~ /^([\w]*)$/) {
	    $runidx = $1;
	}
	else {
	    tbdie("Bad data in argument: $runidx");
	}
    }
    
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    if (defined($options{"q"})) {
	$quiet = 1;
    }
    if (defined($options{"d"})) {
	$debug = 2;
    }
}

#
# Cleanup the mess.
#
sub cleanup()
{
    if (defined($checkout) && -e $checkout) {
	system("/bin/rm -rf $checkout");
    }
}

sub fatal($$)
{
    my ($errorstat, $msg) = @_;
    
    tberror $msg;
    tbinfo "Cleaning up and exiting with status $errorstat ...";

    exit($errorstat);
}