runtest.pl.in

#!@PERL@

use strict;
use warnings;

use Cwd;
use File::Basename;
use Getopt::Std;

chdir(dirname($0));
my $base_dir = getcwd();
use lib dirname($0)."/infrastructure";

use BoxPlatform;

my %opts;
getopts('acnTO:v', \%opts);

my $appveyor_mode = $opts{'a'};
my $cmake_build = $opts{'c'};
# Don't actually run the test, just prepare for it:
my $prepare_only = $opts{'n'};
my $timestamp_tests = $opts{'T'};
my $extra_options = $opts{'O'} || '';
my $verbose_build = $opts{'v'};

my $test_name = shift @ARGV;
my $test_mode = shift @ARGV;
my $test_src_exe;
my $test_dst_exe;

if($cmake_build)
{
	# To support different build environments (Windows/MSVC and Linux/Makefile) which
	# place compiled executables in different locations, we need to accept the name of
	# the compiled test executable as an additional command-line parameter.
	die "test name is required in cmake mode" unless $test_name;
	die "test mode is required in cmake mode" unless $test_mode;
	die "only a single test name is supported in cmake mode" if $test_name =~ /,/;
	$test_src_exe = shift @ARGV;
	die "test project source executable path is required in cmake mode" unless $test_src_exe;
	$test_dst_exe = shift @ARGV;
	die "test project destination executable name is required in cmake mode" unless $test_dst_exe;
}

$test_mode = 'debug' if not defined $test_mode or $test_mode eq '';
$test_mode = lc($test_mode);

if($test_name eq '' || ($test_mode ne 'debug' && $test_mode ne 'release'))
{
	print <<__E;
Run Test utility -- bad usage.

runtest.pl (test|ALL) [release|debug]

Mode defaults to debug.

__E
	exit(2);
}

my @results;
my $exit_code = 0;

if($test_name ne 'ALL')
{
	# run one or more specified test
	if ($test_name =~ m/,/)
	{
		foreach my $test (split m/,/, $test_name)
		{
			runtest($test);
		}
	}
	else
	{
		runtest($test_name, $test_src_exe, $test_dst_exe);
	}
}
else
{
	# run all tests
	my @tests;
	open MODULES,'modules.txt' or die "Can't open modules file";
	while(<MODULES>)
	{
		# omit bits on some platforms?
		next if m/\AEND-OMIT/;
		if(m/\AOMIT:(.+)/)
		{
			if($1 eq $build_os or $1 eq $ac_target_os)
			{
				while(<MODULES>)
				{
					last if m/\AEND-OMIT/;	
				}
			}
			next;
		}
		push @tests,$1 if m~\Atest/(\w+)\s~;
	}
	close MODULES;
	
	runtest($_) for(@tests)
}

# report results
print "--------\n",join("\n",@results),"\n";

if ($exit_code != 0)
{
	print <<__E;

One or more tests have failed in $test_mode mode. Please check the following
common causes:

* Check that no instances of bbstored or bbackupd are already running
  on this machine.
* Make sure there isn't a firewall blocking incoming or outgoing connections
  on port 2201.
* Check that there is sufficient space in the filesystem that the tests
  are being run from (at least 1 GB free).
* The backupdiff test fails if it takes too long, so it's sensitive to
  the speed of the host and your connection to it.

After checking all the above, if you still have problems please contact
us on the mailing list, boxbackup\@boxbackup.org. Thanks!
__E
}

exit $exit_code;

sub appveyor_test_status
{
	my ($test_name, $status, $duration, $message, $stdout) = @_;

	if(!$appveyor_mode)
	{
		return;
	}

	# Assume that the test was already "Added" by CMakeLists.txt.
	my $cmdline = "appveyor UpdateTest -Name $test_name -Framework Custom ".
		"-FileName \"\" -Outcome $status";
	if(defined $duration)
	{
		$cmdline .= " -Duration ".($duration * 1000);
	}

	if($message)
	{
		$cmdline .= " -ErrorMessage \"$message\"";
	}

	if(system($cmdline))
	{
		warn "AppVeyor test command failed: $cmdline";
	}
	else
	{
		print "Notified: $cmdline\n";
	}
}

sub runtest
{
	my ($t, $test_src_exe, $test_dst_exe) = @_;

	# Attempt to make this test.
	my $flag = ($test_mode eq 'release')?(BoxPlatform::make_flag('RELEASE')):'';
	my $make_res;
	my $test_dst_dir = "$test_mode/test/$t";
	my $start_time = time();

	if($cmake_build)
	{
		appveyor_test_status($t, "Running", 0);

		# Test executables have a different name on Windows to work around
		# restrictions on running different executables with the same name.
		my $test_src_dir = "test/$t";

		my @commands = (
			"cmake -E remove_directory $test_dst_dir",
			"cmake -E copy_directory $test_src_dir $test_dst_dir",
			"cmake -E copy $test_src_exe $test_dst_dir/$test_dst_exe",
			# We could do a "make install" here, to ensure that everything
			# is up to date, but it's really slow, verbose and wasteful:
			# "cmake --build infrastructure/cmake/build --target install",
		);

		# Our CMake buildsystem doesn't do anything to support testextra files
		# (Makefile syntax), so fake it.
		if (-r "$test_src_dir/testextra")
		{
			open EXTRA, "$test_src_dir/testextra"
				or die "$test_src_dir/testextra: $!";
			foreach my $line (<EXTRA>)
			{
				chomp $line;
				if ($line =~ m/^mkdir (.*)/)
				{
					push @commands, "cmake -E make_directory $test_dst_dir/$1";
				}
				elsif ($line =~ m/^rm -rf (.*)/)
				{
					push @commands, "cmake -E remove_directory $test_dst_dir/$1";
				}
				elsif ($line =~ m/^cp (.*)\*\.\* (.*)/)
				{
					my ($src, $dst) = ($1, $2);
					push @commands, "cmake -E copy_directory ".
						"$test_dst_dir/$src $test_dst_dir/$dst";
				}
				else
				{
					die "Unsupported command in ".
						"$test_src_dir/testextra: $line";
				}
			}
		}

		foreach my $command (@commands)
		{
			$make_res = system($command);
			if ($make_res != 0)
			{
				push @results, "$t: pre-test command failed: $command";
				appveyor_test_status($t, "NotRunnable", time() - $start_time,
					"pre-test command failed: $command");
				last;
			}
		}
	}
	else
	{
		my $quiet = $verbose_build ? "VERBOSE=1" : "";
		$make_res = system("cd test/$t && $make_command $quiet $flag");
		$test_dst_exe = "_test$platform_exe_ext";
	}

	if($make_res != 0)
	{
		push @results,"$t: make failed";
		appveyor_test_status($t, "NotRunnable", time() - $start_time,
			"make failed");
		$exit_code = 2;
		return;
	}

	if($prepare_only)
	{
		appveyor_test_status($t, "Skipped", time() - $start_time,
			"we are only preparing this test");
		return;
	}
	
	my $test_res;
	my $logfile = "test-$t.log";
	my $test_options = ($timestamp_tests ? "-T" : "")." ".$extra_options;

	# run it
	if($cmake_build)
	{
		# no tee.exe on Windows, so let's do it ourselves.
		open LOG, ">$logfile" or die "$logfile: $!";
		chdir("$base_dir/$test_mode/test/$t");

		open TEE, "$test_dst_exe |"
			or die "$test_dst_dir/$test_dst_exe: $!";

		while (my $line = <TEE>)
		{
			print $line;
			print LOG $line;
		}
		close LOG;
		close TEE;
		chdir($base_dir);
	}
	else
	{
		chdir($base_dir);
		$test_res = system("cd $test_mode/test/$t ; sh t 2>&1 " .
			"| tee ../../../$logfile");
	}

	# open test results
	if(open RESULTS, $logfile)
	{
		my $last;
		while(<RESULTS>)
		{
			$last = $_ if m/\w/;
		}
		close RESULTS;

		if(!defined $last)
		{
			push @results, "$t: test produced no output";
			appveyor_test_status($t, "Failed", time() - $start_time,
				"test produced no output");
			$exit_code = 1;
		}
		else
		{
			chomp $last;
			$last =~ s/\r//;
			push @results, "$t: $last";

			if ($last ne "PASSED")
			{
				$exit_code = 1;
				appveyor_test_status($t, "Failed", time() - $start_time,
					"test ended with: $last");
			}
			else
			{
				appveyor_test_status($t, "Passed", time() - $start_time);
			}
		}
	}
	else
	{
		my $cwd = getcwd();
		push @results, 
			"$t: failed to open test log file: $logfile: $! (in $cwd)";
		appveyor_test_status($t, "Inconclusive", time() - $start_time,
			"failed to open test log file: $logfile: $!");
	}
	
	# delete test results
	# unlink $logfile;
}