selftest/selftesthelpers.py: Share configuration variable, strip whitespace.
[nivanova/samba-autobuild/.git] / selftest / selftest.pl
index 254c347b807a4c3fe03d18ecf2efaee9f904f7df..b50853e54d3a5fad2aba2319b2b6d1479864089d 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 # Bootstrap Samba and run a number of tests against it.
-# Copyright (C) 2005-2009 Jelmer Vernooij <jelmer@samba.org>
+# Copyright (C) 2005-2010 Jelmer Vernooij <jelmer@samba.org>
 # Copyright (C) 2007-2009 Stefan Metzmacher <metze@samba.org>
 
 # This program is free software; you can redistribute it and/or modify
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-=pod
-
-=head1 NAME
-
-selftest - Samba test runner
-
-=head1 SYNOPSIS
-
-selftest --help
-
-selftest [--srcdir=DIR] [--builddir=DIR] [--exeext=EXT][--target=samba4|samba3|win|kvm] [--socket-wrapper] [--quick] [--exclude=FILE] [--include=FILE] [--one] [--prefix=prefix] [--testlist=FILE] [TESTS]
-
-=head1 DESCRIPTION
-
-A simple test runner. TESTS is a regular expression with tests to run.
-
-=head1 OPTIONS
-
-=over 4
-
-=item I<--help>
-
-Show list of available options.
-
-=item I<--srcdir=DIR>
-
-Source directory.
-
-=item I<--builddir=DIR>
-
-Build directory.
-
-=item I<--exeext=EXT>
-
-Executable extention
-
-=item I<--prefix=DIR>
-
-Change directory to run tests in. Default is 'st'.
-
-=item I<--target samba4|samba3|win|kvm>
-
-Specify test target against which to run. Default is 'samba4'.
-
-=item I<--quick>
-
-Run only a limited number of tests. Intended to run in about 30 seconds on 
-moderately recent systems.
-               
-=item I<--socket-wrapper>
-
-Use socket wrapper library for communication with server. Only works 
-when the server is running locally.
-
-Will prevent TCP and UDP ports being opened on the local host but 
-(transparently) redirects these calls to use unix domain sockets.
-
-=item I<--exclude>
-
-Specify a file containing a list of tests that should be skipped. Possible 
-candidates are tests that segfault the server, flip or don't end. 
-
-=item I<--include>
-
-Specify a file containing a list of tests that should be run. Same format 
-as the --exclude flag.
-
-Not includes specified means all tests will be run.
-
-=item I<--one>
-
-Abort as soon as one test fails.
-
-=item I<--testlist>
-
-Load a list of tests from the specified location.
-
-=back
-
-=head1 ENVIRONMENT
-
-=over 4
-
-=item I<SMBD_VALGRIND>
-
-=item I<TORTURE_MAXTIME>
-
-=item I<VALGRIND>
-
-=item I<TLS_ENABLED>
-
-=item I<srcdir>
-
-=back
-
-=head1 LICENSE
-
-selftest is licensed under the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>.
-
-=head1 AUTHOR
-
-Jelmer Vernooij
-
-=cut
-
 use strict;
 
 use FindBin qw($RealBin $Script);
@@ -135,13 +30,14 @@ use SocketWrapper;
 
 eval {
 require Time::HiRes;
+Time::HiRes->import("time");
 };
-unless ($@) {
-       use Time::HiRes qw(time);
+if ($@) {
+       print "You don't have Time::Hires installed !\n";
 }
 
 my $opt_help = 0;
-my $opt_target = "samba4";
+my $opt_target = "samba";
 my $opt_quick = 0;
 my $opt_socket_wrapper = 0;
 my $opt_socket_wrapper_pcap = undef;
@@ -149,23 +45,29 @@ my $opt_socket_wrapper_keep_pcap = undef;
 my $opt_one = 0;
 my @opt_exclude = ();
 my @opt_include = ();
-my $opt_verbose = 0;
-my $opt_image = undef;
 my $opt_testenv = 0;
+my $opt_list = 0;
 my $ldap = undef;
 my $opt_resetup_env = undef;
-my $opt_bindir = undef;
+my $opt_binary_mapping = "";
 my $opt_load_list = undef;
 my @testlists = ();
 
 my $srcdir = ".";
-my $builddir = ".";
-my $exeext = "";
+my $bindir = "./bin";
 my $prefix = "./st";
 
 my @includes = ();
 my @excludes = ();
 
+sub pipe_handler {
+       my $sig = shift @_;
+       print STDERR "Exiting early because of SIGPIPE.\n";
+       exit(1);
+}
+
+$SIG{PIPE} = \&pipe_handler;
+
 sub find_in_list($$)
 {
        my ($list, $fullname) = @_;
@@ -244,11 +146,11 @@ sub run_testsuite($$$$$)
        if ($? == -1) {
                Subunit::progress_pop();
                Subunit::end_testsuite($name, "error", "Unable to run $cmd: $!");
-               return 0;
+               exit(1);
        } elsif ($? & 127) {
                Subunit::end_testsuite($name, "error",
                        sprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127),  ($? & 128) ? 'with' : 'without'));
-               return 0;
+               exit(1);
        }
 
        my $exitcode = $? >> 8;
@@ -290,33 +192,28 @@ Usage: $Script [OPTIONS] TESTNAME-REGEX
 
 Generic options:
  --help                     this help page
- --target=samba[34]|win|kvm Samba version to target
- --testlist=FILE           file to read available tests from
+ --target=samba[3]|win      Samba version to target
+ --testlist=FILE            file to read available tests from
 
 Paths:
  --prefix=DIR               prefix to run tests in [st]
  --srcdir=DIR               source directory [.]
- --builddir=DIR             output directory [.]
- --exeext=EXT               executable extention []
+ --bindir=DIR               binaries directory [./bin]
 
 Target Specific:
- --socket-wrapper-pcap     save traffic to pcap directories
+ --socket-wrapper-pcap      save traffic to pcap directories
  --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that 
                             failed
  --socket-wrapper           enable socket wrapper
- --bindir=PATH              path to target binaries
 
 Samba4 Specific:
  --ldap=openldap|fedora-ds  back samba onto specified ldap server
 
-Kvm Specific:
- --image=PATH               path to KVM image
-
 Behaviour:
  --quick                    run quick overall test
  --one                      abort when the first test fails
- --verbose                  be verbose
- --analyse-cmd CMD          command to run after each test
+ --testenv                  run a shell in the requested test environment
+ --list                     list available tests
 ";
        exit(0);
 }
@@ -333,22 +230,22 @@ my $result = GetOptions (
                'exclude=s' => \@opt_exclude,
                'include=s' => \@opt_include,
                'srcdir=s' => \$srcdir,
-               'builddir=s' => \$builddir,
-               'exeext=s' => \$exeext,
-               'verbose' => \$opt_verbose,
+               'bindir=s' => \$bindir,
                'testenv' => \$opt_testenv,
+               'list' => \$opt_list,
                'ldap:s' => \$ldap,
                'resetup-environment' => \$opt_resetup_env,
-               'bindir:s' => \$opt_bindir,
-               'image=s' => \$opt_image,
                'testlist=s' => \@testlists,
                'load-list=s' => \$opt_load_list,
+                'binary-mapping=s' => \$opt_binary_mapping
            );
 
 exit(1) if (not $result);
 
 ShowHelp() if ($opt_help);
 
+die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
+
 # we want unbuffered output
 $| = 1;
 
@@ -363,7 +260,6 @@ unless (defined($ENV{VALGRIND})) {
 # make all our python scripts unbuffered
 $ENV{PYTHONUNBUFFERED} = 1;
 
-my $bindir = ($opt_bindir or "$builddir/bin");
 my $bindir_abs = abs_path($bindir);
 
 # Backwards compatibility:
@@ -387,12 +283,20 @@ $prefix =~ s+/$++;
 
 die("using an empty prefix isn't allowed") unless $prefix ne "";
 
-#Ensure we have the test prefix around
-mkdir($prefix, 0777) unless -d $prefix;
+# Ensure we have the test prefix around.
+#
+# We need restrictive
+# permissions on this as some subdirectories in this tree will have
+# wider permissions (ie 0777) and this would allow other users on the
+# host to subvert the test process.
+mkdir($prefix, 0700) unless -d $prefix;
+chmod 0700, $prefix;
 
 my $prefix_abs = abs_path($prefix);
+my $tmpdir_abs = abs_path("$prefix/tmp");
+mkdir($tmpdir_abs, 0777) unless -d $tmpdir_abs;
+
 my $srcdir_abs = abs_path($srcdir);
-my $builddir_abs = abs_path($builddir);
 
 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
@@ -402,14 +306,11 @@ $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
 $ENV{PREFIX_ABS} = $prefix_abs;
 $ENV{SRCDIR} = $srcdir;
 $ENV{SRCDIR_ABS} = $srcdir_abs;
-$ENV{BUILDDIR} = $builddir;
-$ENV{BUILDDIR_ABS} = $builddir_abs;
-$ENV{EXEEXT} = $exeext;
+$ENV{BINDIR} = $bindir_abs;
 
 my $tls_enabled = not $opt_quick;
 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
-$ENV{LDB_MODULES_PATH} = "$bindir_abs/modules/ldb";
-$ENV{LD_SAMBA_MODULE_PATH} = "$bindir_abs/modules";
+
 sub prefix_pathvar($$)
 {
        my ($name, $newpath) = @_;
@@ -436,63 +337,51 @@ my $socket_wrapper_dir;
 if ($opt_socket_wrapper) {
        $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix_abs/w", $opt_socket_wrapper_pcap);
        print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
-} else {
+} elsif (not $opt_list) {
         unless ($< == 0) { 
-                print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
+                warn("not using socket wrapper, but also not running as root. Will not be able to listen on proper ports");
         }
 }
 
 my $target;
 my $testenv_default = "none";
 
-if ($opt_target eq "samba4") {
-       $testenv_default = "all";
-       require target::Samba4;
-       $target = new Samba4($bindir, $ldap, "$srcdir/setup", $exeext);
-} elsif ($opt_target eq "samba3") {
-       if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
-               die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'.  Exiting....");
-       }
-       $testenv_default = "member";
-       require target::Samba3;
-       $target = new Samba3($bindir);
-} elsif ($opt_target eq "win") {
-       die("Windows tests will not run with socket wrapper enabled.") 
-               if ($opt_socket_wrapper);
-       $testenv_default = "dc";
-       require target::Windows;
-       $target = new Windows();
-} elsif ($opt_target eq "kvm") {
-       die("Kvm tests will not run with socket wrapper enabled.") 
-               if ($opt_socket_wrapper);
-       require target::Kvm;
-       die("No image specified") unless ($opt_image);
-       $target = new Kvm($opt_image, undef);
+my %binary_mapping = ();
+if ($opt_binary_mapping) {
+    my @binmapping_list = split(/,/, $opt_binary_mapping);
+    foreach my $mapping (@binmapping_list) {
+       my ($bin, $map) = split(/\:/, $mapping);
+       $binary_mapping{$bin} = $map;
+    }
 }
 
-#
-# Start a Virtual Distributed Ethernet Switch
-# Returns the pid of the switch.
-#
-sub start_vde_switch($)
-{
-       my ($path) = @_;
-
-       system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
+$ENV{BINARY_MAPPING} = $opt_binary_mapping;
 
-       open(PID, "$path/vde.pid");
-       <PID> =~ /([0-9]+)/;
-       my $pid = $1;
-       close(PID);
+# After this many seconds, the server will self-terminate.  All tests
+# must terminate in this time, and testenv will only stay alive this
+# long
 
-       return $pid;
+my $server_maxtime = 7500;
+if (defined($ENV{SMBD_MAXTIME}) and $ENV{SMBD_MAXTIME} ne "") {
+    $server_maxtime = $ENV{SMBD_MAXTIME};
 }
 
-# Stop a Virtual Distributed Ethernet Switch
-sub stop_vde_switch($)
-{
-       my ($pid) = @_;
-       kill 9, $pid;
+unless ($opt_list) {
+       if ($opt_target eq "samba") {
+               if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
+                       die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'.  Exiting....");
+               }
+               $testenv_default = "dc";
+               require target::Samba;
+               $target = new Samba($bindir, \%binary_mapping, $ldap, $srcdir, $server_maxtime);
+       } elsif ($opt_target eq "samba3") {
+               if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
+                       die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'.  Exiting....");
+               }
+               $testenv_default = "member";
+               require target::Samba3;
+               $target = new Samba3($bindir, \%binary_mapping, $srcdir_abs, $server_maxtime);
+       }
 }
 
 sub read_test_regexes($)
@@ -552,19 +441,35 @@ sub write_clientconf($$$)
                mkdir("$clientdir/lockdir", 0777);
        }
 
+       if ( -d "$clientdir/statedir" ) {
+               unlink <$clientdir/statedir/*>;
+       } else {
+               mkdir("$clientdir/statedir", 0777);
+       }
+
+       if ( -d "$clientdir/cachedir" ) {
+               unlink <$clientdir/cachedir/*>;
+       } else {
+               mkdir("$clientdir/cachedir", 0777);
+       }
+
+       # this is ugly, but the ncalrpcdir needs exactly 0755
+       # otherwise tests fail.
+       my $mask = umask;
+       umask 0022;
+       if ( -d "$clientdir/ncalrpcdir/np" ) {
+               unlink <$clientdir/ncalrpcdir/np/*>;
+               rmdir "$clientdir/ncalrpcdir/np";
+       }
        if ( -d "$clientdir/ncalrpcdir" ) {
                unlink <$clientdir/ncalrpcdir/*>;
-       } else {
-               mkdir("$clientdir/ncalrpcdir", 0777);
+               rmdir "$clientdir/ncalrpcdir";
        }
+       mkdir("$clientdir/ncalrpcdir", 0755);
+       umask $mask;
 
        open(CF, ">$conffile");
        print CF "[global]\n";
-       if (defined($ENV{VALGRIND})) {
-               print CF "\ticonv:native = true\n";
-       } else {
-               print CF "\ticonv:native = false\n";
-       }
        print CF "\tnetbios name = client\n";
        if (defined($vars->{DOMAIN})) {
                print CF "\tworkgroup = $vars->{DOMAIN}\n";
@@ -578,9 +483,11 @@ sub write_clientconf($$$)
        print CF "
        private dir = $clientdir/private
        lock dir = $clientdir/lockdir
+       state directory = $clientdir/statedir
+       cache directory = $clientdir/cachedir
        ncalrpc dir = $clientdir/ncalrpcdir
-       name resolve order = bcast file
-       panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
+       name resolve order = file bcast
+       panic action = $RealBin/gdb_backtrace \%d
        max xmit = 32K
        notify:inotify = false
        ldb:nosync = true
@@ -590,8 +497,6 @@ sub write_clientconf($$$)
        torture:basedir = $clientdir
 #We don't want to pass our self-tests if the PAC code is wrong
        gensec:require_pac = true
-       modules dir = $ENV{LD_SAMBA_MODULE_PATH}
-       setup directory = ./setup
        resolv:host file = $prefix_abs/dns_host_file
 #We don't want to run 'speed' tests for very long
         torture:timelimit = 1
@@ -601,8 +506,6 @@ sub write_clientconf($$$)
 
 my @todo = ();
 
-my $testsdir = "$srcdir/selftest";
-
 sub should_run_test($)
 {
        my $name = shift;
@@ -650,22 +553,18 @@ if ($#testlists == -1) {
 }
 
 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
+$ENV{SELFTEST_TMPDIR} = "$tmpdir_abs";
+$ENV{TEST_DATA_PREFIX} = "$tmpdir_abs";
 if ($opt_socket_wrapper) {
        $ENV{SELFTEST_INTERFACES} = $interfaces;
 } else {
        $ENV{SELFTEST_INTERFACES} = "";
 }
-if ($opt_verbose) {
-       $ENV{SELFTEST_VERBOSE} = "1";
-} else {
-       $ENV{SELFTEST_VERBOSE} = "";
-}
 if ($opt_quick) {
        $ENV{SELFTEST_QUICK} = "1";
 } else {
        $ENV{SELFTEST_QUICK} = "";
 }
-$ENV{SELFTEST_TARGET} = $opt_target;
 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
 
 my @available = ();
@@ -712,13 +611,17 @@ foreach my $testsuite (@available) {
                }
                if ($match) {
                        if (defined($skipreason)) {
+                               if (not $opt_list) {
                                        Subunit::skip_testsuite($name, $skipreason);
+                               }
                        } else {
                                push(@todo, $testsuite);
                        }
                }
        } elsif (defined($skipreason)) {
-               Subunit::skip_testsuite($name, $skipreason);
+               if (not $opt_list) {
+                       Subunit::skip_testsuite($name, $skipreason);
+               }
        } else {
                push(@todo, $testsuite);
        }
@@ -737,8 +640,10 @@ if (defined($restricted)) {
 
 my $suitestotal = $#todo + 1;
 
-Subunit::progress($suitestotal);
-Subunit::report_time(time());
+unless ($opt_list) {
+       Subunit::progress($suitestotal);
+       Subunit::report_time(time());
+}
 
 my $i = 0;
 $| = 1;
@@ -802,7 +707,13 @@ my @exported_envvars = (
        "KRB5_CONFIG",
        "WINBINDD_SOCKET_DIR",
        "WINBINDD_PRIV_PIPE_DIR",
-       "LOCAL_PATH"
+       "NMBD_SOCKET_DIR",
+       "LOCAL_PATH",
+
+        # nss_wrapper
+        "NSS_WRAPPER_PASSWD",
+        "NSS_WRAPPER_GROUP"
+
 );
 
 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub { 
@@ -830,14 +741,23 @@ sub setup_env($$)
                $testenv_vars = {};
        } elsif (defined(get_running_env($envname))) {
                $testenv_vars = get_running_env($envname);
-               if (not $target->check_env($testenv_vars)) {
-                       print $target->getlog_env($testenv_vars);
+               if (not $testenv_vars->{target}->check_env($testenv_vars)) {
+                       print $testenv_vars->{target}->getlog_env($testenv_vars);
                        $testenv_vars = undef;
                }
        } else {
                $testenv_vars = $target->setup_env($envname, $prefix);
+               if (defined($testenv_vars) and $testenv_vars eq "UNKNOWN") {
+                   return $testenv_vars;
+               } elsif (defined($testenv_vars) && not defined($testenv_vars->{target})) {
+                       $testenv_vars->{target} = $target;
+               }
+               if (not defined($testenv_vars)) {
+                       warn("$opt_target can't start up known environment '$envname'");
+               }
        }
 
+       
        return undef unless defined($testenv_vars);
 
        $running_envs{$envname} = $testenv_vars;
@@ -881,21 +801,24 @@ sub getlog_env($)
 {
        my ($envname) = @_;
        return "" if ($envname eq "none");
-       return $target->getlog_env(get_running_env($envname));
+       my $env = get_running_env($envname);
+       return $env->{target}->getlog_env($env);
 }
 
 sub check_env($)
 {
        my ($envname) = @_;
        return 1 if ($envname eq "none");
-       return $target->check_env(get_running_env($envname));
+       my $env = get_running_env($envname);
+       return $env->{target}->check_env($env);
 }
 
 sub teardown_env($)
 {
        my ($envname) = @_;
        return if ($envname eq "none");
-       $target->teardown_env(get_running_env($envname));
+       my $env = get_running_env($envname);
+       $env->{target}->teardown_env($env);
        delete $running_envs{$envname};
 }
 
@@ -911,11 +834,17 @@ if ($opt_testenv) {
        die("Unable to setup environment $testenv_name") unless ($testenv_vars);
 
        $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
+       $ENV{ENVNAME} = $testenv_name;
 
        my $envvarstr = exported_envvars_str($testenv_vars);
 
-       my $term = ($ENV{TERMINAL} or "xterm");
-       system("$term -e 'echo -e \"
+       my @term = ();
+       if ($ENV{TERMINAL}) {
+           @term = ($ENV{TERMINAL});
+       } else {
+           @term = ("xterm", "-e");
+       }
+       my @term_args = ("bash", "-c", "echo -e \"
 Welcome to the Samba4 Test environment '$testenv_name'
 
 This matches the client environment used in make test
@@ -926,8 +855,37 @@ TORTURE_OPTIONS=\$TORTURE_OPTIONS
 SMB_CONF_PATH=\$SMB_CONF_PATH
 
 $envvarstr
-\" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
+\" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash");
+
+       system(@term, @term_args);
+
        teardown_env($testenv_name);
+} elsif ($opt_list) {
+       foreach (@todo) {
+               my $cmd = $$_[2];
+               my $name = $$_[0];
+               my $envname = $$_[1];
+
+               unless($cmd =~ /\$LISTOPT/) {
+                       warn("Unable to list tests in $name");
+                       next;
+               }
+
+               $cmd =~ s/\$LISTOPT/--list/g;
+
+               system($cmd);
+
+               if ($? == -1) {
+                       die("Unable to run $cmd: $!");
+               } elsif ($? & 127) {
+                       die(snprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127),  ($? & 128) ? 'with' : 'without'));
+               }
+
+               my $exitcode = $? >> 8;
+               if ($exitcode != 0) {
+                       die("$cmd exited with exit code $exitcode");
+               }
+       }
 } else {
        foreach (@todo) {
                $i++;
@@ -939,7 +897,12 @@ $envvarstr
                if (not defined($envvars)) {
                        Subunit::start_testsuite($name);
                        Subunit::end_testsuite($name, "error",
-                               "unable to set up environment $envname");
+                               "unable to set up environment $envname - exiting");
+                       next;
+               } elsif ($envvars eq "UNKNOWN") {
+                       Subunit::start_testsuite($name);
+                       Subunit::end_testsuite($name, "skip",
+                               "environment $envname is unknown in this test backend - skipping");
                        next;
                }