2 # Bootstrap Samba and run a number of tests against it.
3 # Copyright (C) 2005-2010 Jelmer Vernooij <jelmer@samba.org>
4 # Copyright (C) 2007-2009 Stefan Metzmacher <metze@samba.org>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 selftest - Samba test runner
29 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]
33 A simple test runner. TESTS is a regular expression with tests to run.
41 Show list of available options.
47 =item I<--builddir=DIR>
57 Change directory to run tests in. Default is 'st'.
59 =item I<--target samba4|samba3|win|kvm>
61 Specify test target against which to run. Default is 'samba4'.
65 Run only a limited number of tests. Intended to run in about 30 seconds on
66 moderately recent systems.
68 =item I<--socket-wrapper>
70 Use socket wrapper library for communication with server. Only works
71 when the server is running locally.
73 Will prevent TCP and UDP ports being opened on the local host but
74 (transparently) redirects these calls to use unix domain sockets.
78 Specify a file containing a list of tests that should be skipped. Possible
79 candidates are tests that segfault the server, flip or don't end.
83 Specify a file containing a list of tests that should be run. Same format
84 as the --exclude flag.
86 Not includes specified means all tests will be run.
90 Abort as soon as one test fails.
94 Load a list of tests from the specified location.
102 =item I<SMBD_VALGRIND>
104 =item I<TORTURE_MAXTIME>
116 selftest is licensed under the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>.
126 use FindBin
qw($RealBin $Script);
128 use File::Temp qw(tempfile);
131 use Cwd
qw(abs_path);
138 Time
::HiRes
->import("time");
141 print "You don't have Time::Hires installed !\n";
145 my $opt_target = "samba4";
147 my $opt_socket_wrapper = 0;
148 my $opt_socket_wrapper_pcap = undef;
149 my $opt_socket_wrapper_keep_pcap = undef;
151 my @opt_exclude = ();
152 my @opt_include = ();
154 my $opt_image = undef;
157 my $opt_resetup_env = undef;
158 my $opt_bindir = undef;
159 my $opt_load_list = undef;
172 print STDERR
"Exiting early because of SIGPIPE.\n";
176 $SIG{PIPE
} = \
&pipe_handler
;
180 my ($list, $fullname) = @_;
183 if ($fullname =~ /$$_[0]/) {
184 return ($$_[1]) if ($$_[1]);
196 return find_in_list
(\
@excludes, $name);
205 return unless ($opt_socket_wrapper_pcap);
206 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR
});
209 $fname =~ s
%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\
-]%_%g;
211 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
213 SocketWrapper
::setup_pcap
($pcap_file);
220 my ($pcap_file, $exitcode) = @_;
222 return unless ($opt_socket_wrapper_pcap);
223 return if ($opt_socket_wrapper_keep_pcap);
224 return unless ($exitcode == 0);
225 return unless defined($pcap_file);
230 # expand strings from %ENV
231 sub expand_environment_strings
($)
234 # we use a reverse sort so we do the longer ones first
235 foreach my $k (sort { $b cmp $a } keys %ENV) {
236 $s =~ s/\$$k/$ENV{$k}/g;
241 sub run_testsuite
($$$$$)
243 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
244 my $pcap_file = setup_pcap
($name);
246 Subunit
::start_testsuite
($name);
247 Subunit
::progress_push
();
248 Subunit
::report_time
(time());
250 Subunit
::report_time
(time());
251 Subunit
::progress_pop
();
254 Subunit
::progress_pop
();
255 Subunit
::end_testsuite
($name, "error", "Unable to run $cmd: $!");
258 Subunit
::end_testsuite
($name, "error",
259 sprintf("%s died with signal %d, %s coredump\n", $cmd, ($?
& 127), ($?
& 128) ?
'with' : 'without'));
263 my $exitcode = $?
>> 8;
265 my $envlog = getlog_env
($envname);
267 print "envlog: $envlog\n";
270 print "command: $cmd\n";
271 printf "expanded command: %s\n", expand_environment_strings
($cmd);
273 if ($exitcode == 0) {
274 Subunit
::end_testsuite
($name, "success");
276 Subunit
::end_testsuite
($name, "failure", "Exit code was $exitcode");
279 cleanup_pcap
($pcap_file, $exitcode);
281 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
282 print "PCAP FILE: $pcap_file\n";
285 if ($exitcode != 0) {
286 exit(1) if ($opt_one);
294 print "Samba test runner
295 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
296 Copyright (C) Stefan Metzmacher <metze\@samba.org>
298 Usage: $Script [OPTIONS] TESTNAME-REGEX
301 --help this help page
302 --target=samba[34]|win|kvm Samba version to target
303 --testlist=FILE file to read available tests from
306 --prefix=DIR prefix to run tests in [st]
307 --srcdir=DIR source directory [.]
308 --builddir=DIR output directory [.]
309 --exeext=EXT executable extention []
312 --socket-wrapper-pcap save traffic to pcap directories
313 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
315 --socket-wrapper enable socket wrapper
316 --bindir=PATH path to target binaries
319 --ldap=openldap|fedora-ds back samba onto specified ldap server
322 --image=PATH path to KVM image
325 --quick run quick overall test
326 --one abort when the first test fails
328 --analyse-cmd CMD command to run after each test
333 my $result = GetOptions
(
334 'help|h|?' => \
$opt_help,
335 'target=s' => \
$opt_target,
336 'prefix=s' => \
$prefix,
337 'socket-wrapper' => \
$opt_socket_wrapper,
338 'socket-wrapper-pcap' => \
$opt_socket_wrapper_pcap,
339 'socket-wrapper-keep-pcap' => \
$opt_socket_wrapper_keep_pcap,
340 'quick' => \
$opt_quick,
342 'exclude=s' => \
@opt_exclude,
343 'include=s' => \
@opt_include,
344 'srcdir=s' => \
$srcdir,
345 'builddir=s' => \
$builddir,
346 'exeext=s' => \
$exeext,
347 'verbose' => \
$opt_verbose,
348 'testenv' => \
$opt_testenv,
350 'resetup-environment' => \
$opt_resetup_env,
351 'bindir:s' => \
$opt_bindir,
352 'image=s' => \
$opt_image,
353 'testlist=s' => \
@testlists,
354 'load-list=s' => \
$opt_load_list,
357 exit(1) if (not $result);
359 ShowHelp
() if ($opt_help);
361 # we want unbuffered output
366 # quick hack to disable rpc validation when using valgrind - its way too slow
367 unless (defined($ENV{VALGRIND
})) {
368 $ENV{VALIDATE
} = "validate";
369 $ENV{MALLOC_CHECK_
} = 2;
372 # make all our python scripts unbuffered
373 $ENV{PYTHONUNBUFFERED
} = 1;
375 my $bindir = ($opt_bindir or "$builddir/bin");
376 my $bindir_abs = abs_path
($bindir);
378 # Backwards compatibility:
379 if (defined($ENV{TEST_LDAP
}) and $ENV{TEST_LDAP
} eq "yes") {
380 if (defined($ENV{FEDORA_DS_ROOT
})) {
387 my $torture_maxtime = ($ENV{TORTURE_MAXTIME
} or 1200);
390 $torture_maxtime *= 2;
397 die("using an empty prefix isn't allowed") unless $prefix ne "";
399 #Ensure we have the test prefix around
400 mkdir($prefix, 0777) unless -d
$prefix;
402 my $prefix_abs = abs_path
($prefix);
403 my $tmpdir_abs = abs_path
("$prefix/tmp");
404 mkdir($tmpdir_abs, 0777) unless -d
$tmpdir_abs;
406 my $srcdir_abs = abs_path
($srcdir);
407 my $builddir_abs = abs_path
($builddir);
409 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
410 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
412 $ENV{PREFIX
} = $prefix;
413 $ENV{KRB5CCNAME
} = "$prefix/krb5ticket";
414 $ENV{PREFIX_ABS
} = $prefix_abs;
415 $ENV{SRCDIR
} = $srcdir;
416 $ENV{SRCDIR_ABS
} = $srcdir_abs;
417 $ENV{BUILDDIR
} = $builddir;
418 $ENV{BUILDDIR_ABS
} = $builddir_abs;
419 $ENV{EXEEXT
} = $exeext;
421 my $tls_enabled = not $opt_quick;
422 $ENV{TLS_ENABLED
} = ($tls_enabled?
"yes":"no");
424 sub prefix_pathvar
($$)
426 my ($name, $newpath) = @_;
427 if (defined($ENV{$name})) {
428 $ENV{$name} = "$newpath:$ENV{$name}";
430 $ENV{$name} = $newpath;
433 prefix_pathvar
("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
434 prefix_pathvar
("PYTHONPATH", "$bindir_abs/python");
436 if ($opt_socket_wrapper_keep_pcap) {
437 # Socket wrapper keep pcap implies socket wrapper pcap
438 $opt_socket_wrapper_pcap = 1;
441 if ($opt_socket_wrapper_pcap) {
442 # Socket wrapper pcap implies socket wrapper
443 $opt_socket_wrapper = 1;
446 my $socket_wrapper_dir;
447 if ($opt_socket_wrapper) {
448 $socket_wrapper_dir = SocketWrapper
::setup_dir
("$prefix_abs/w", $opt_socket_wrapper_pcap);
449 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
452 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
457 my $testenv_default = "none";
459 if ($opt_target eq "samba4") {
460 $testenv_default = "all";
461 require target
::Samba4
;
462 $target = new Samba4
($bindir, $ldap, "$srcdir/setup", $exeext);
463 } elsif ($opt_target eq "samba3") {
464 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
465 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
467 $testenv_default = "member";
468 require target
::Samba3
;
469 $target = new Samba3
($bindir);
470 } elsif ($opt_target eq "win") {
471 die("Windows tests will not run with socket wrapper enabled.")
472 if ($opt_socket_wrapper);
473 $testenv_default = "dc";
474 require target
::Windows
;
475 $target = new Windows
();
476 } elsif ($opt_target eq "kvm") {
477 die("Kvm tests will not run with socket wrapper enabled.")
478 if ($opt_socket_wrapper);
480 die("No image specified") unless ($opt_image);
481 $target = new Kvm
($opt_image, undef);
485 # Start a Virtual Distributed Ethernet Switch
486 # Returns the pid of the switch.
488 sub start_vde_switch
($)
492 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
494 open(PID
, "$path/vde.pid");
502 # Stop a Virtual Distributed Ethernet Switch
503 sub stop_vde_switch
($)
509 sub read_test_regexes
($)
513 open(LF
, "<$name") or die("unable to read $name: $!");
517 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
518 push (@ret, [$1, $4]);
520 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
521 push (@ret, [$_, undef]);
528 foreach (@opt_exclude) {
529 push (@excludes, read_test_regexes
($_));
532 foreach (@opt_include) {
533 push (@includes, read_test_regexes
($_));
536 my $interfaces = join(',', ("127.0.0.11/8",
543 my $clientdir = "$prefix_abs/client";
545 my $conffile = "$clientdir/client.conf";
546 $ENV{SMB_CONF_PATH
} = $conffile;
548 sub write_clientconf
($$$)
550 my ($conffile, $clientdir, $vars) = @_;
552 mkdir("$clientdir", 0777) unless -d
"$clientdir";
554 if ( -d
"$clientdir/private" ) {
555 unlink <$clientdir/private/*>;
557 mkdir("$clientdir/private", 0777);
560 if ( -d
"$clientdir/lockdir" ) {
561 unlink <$clientdir/lockdir/*>;
563 mkdir("$clientdir/lockdir", 0777);
566 if ( -d
"$clientdir/ncalrpcdir" ) {
567 unlink <$clientdir/ncalrpcdir/*>;
569 mkdir("$clientdir/ncalrpcdir", 0777);
572 open(CF
, ">$conffile");
573 print CF
"[global]\n";
574 if (defined($ENV{VALGRIND
})) {
575 print CF
"\ticonv:native = true\n";
577 print CF
"\ticonv:native = false\n";
579 print CF
"\tnetbios name = client\n";
580 if (defined($vars->{DOMAIN
})) {
581 print CF
"\tworkgroup = $vars->{DOMAIN}\n";
583 if (defined($vars->{REALM
})) {
584 print CF
"\trealm = $vars->{REALM}\n";
586 if ($opt_socket_wrapper) {
587 print CF
"\tinterfaces = $interfaces\n";
590 private dir = $clientdir/private
591 lock dir = $clientdir/lockdir
592 ncalrpc dir = $clientdir/ncalrpcdir
593 name resolve order = bcast file
594 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
596 notify:inotify = false
598 system:anonymous = true
599 client lanman auth = Yes
601 torture:basedir = $clientdir
602 #We don't want to pass our self-tests if the PAC code is wrong
603 gensec:require_pac = true
604 setup directory = ./setup
605 resolv:host file = $prefix_abs/dns_host_file
606 #We don't want to run 'speed' tests for very long
607 torture:timelimit = 1
614 my $testsdir = "$srcdir/selftest";
616 sub should_run_test
($)
622 for (my $i=0; $i <= $#tests; $i++) {
623 if ($name =~ /$tests[$i]/i) {
635 open(IN
, $filename) or die("Unable to open $filename: $!");
638 if (/-- TEST(-LOADLIST|-IDLIST|) --\n/) {
639 my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
640 my $supports_idlist = (defined($1) and $1 eq "-IDLIST");
647 if (should_run_test
($name) == 1) {
648 push (@ret, [$name, $env, $cmdline, $supports_loadlist, $supports_idlist]);
654 close(IN
) or die("Error creating recipe");
658 if ($#testlists == -1) {
659 die("No testlists specified");
662 $ENV{SELFTEST_PREFIX
} = "$prefix_abs";
663 $ENV{SELFTEST_TMPDIR
} = "$tmpdir_abs";
664 if ($opt_socket_wrapper) {
665 $ENV{SELFTEST_INTERFACES
} = $interfaces;
667 $ENV{SELFTEST_INTERFACES
} = "";
670 $ENV{SELFTEST_VERBOSE
} = "1";
672 $ENV{SELFTEST_VERBOSE
} = "";
675 $ENV{SELFTEST_QUICK
} = "1";
677 $ENV{SELFTEST_QUICK
} = "";
679 $ENV{SELFTEST_TARGET
} = $opt_target;
680 $ENV{SELFTEST_MAXTIME
} = $torture_maxtime;
683 foreach my $fn (@testlists) {
684 foreach (read_testlist
($fn)) {
686 next if (@includes and not defined(find_in_list
(\
@includes, $name)));
687 push (@available, $_);
691 my $restricted = undef;
692 my $restricted_used = {};
694 if ($opt_load_list) {
696 open(LOAD_LIST
, "<$opt_load_list") or die("Unable to open $opt_load_list");
697 while (<LOAD_LIST
>) {
699 push (@
$restricted, $_);
704 my $individual_tests = undef;
705 $individual_tests = {};
707 foreach my $testsuite (@available) {
708 my $name = $$testsuite[0];
709 my $skipreason = skip
($name);
710 if (defined($restricted)) {
711 # Find the testsuite for this test
713 foreach my $r (@
$restricted) {
715 $individual_tests->{$name} = [];
717 $restricted_used->{$r} = 1;
718 } elsif (substr($r, 0, length($name)+1) eq "$name.") {
719 push(@
{$individual_tests->{$name}}, $r);
721 $restricted_used->{$r} = 1;
725 if (defined($skipreason)) {
726 Subunit
::skip_testsuite
($name, $skipreason);
728 push(@todo, $testsuite);
731 } elsif (defined($skipreason)) {
732 Subunit
::skip_testsuite
($name, $skipreason);
734 push(@todo, $testsuite);
738 if (defined($restricted)) {
739 foreach (@
$restricted) {
740 unless (defined($restricted_used->{$_})) {
741 print "No test or testsuite found matching $_\n";
744 } elsif ($#todo == -1) {
745 print STDERR
"No tests to run\n";
749 my $suitestotal = $#todo + 1;
751 Subunit
::progress
($suitestotal);
752 Subunit
::report_time
(time());
757 my %running_envs = ();
759 sub get_running_env
($)
767 return $running_envs{$envname};
770 my @exported_envvars = (
775 # domain controller stuff
784 "MEMBER_NETBIOSNAME",
785 "MEMBER_NETBIOSALIAS",
787 # rpc proxy controller stuff
789 "RPC_PROXY_SERVER_IP",
790 "RPC_PROXY_NETBIOSNAME",
791 "RPC_PROXY_NETBIOSALIAS",
793 # domain controller stuff for Vampired DC
795 "VAMPIRE_DC_SERVER_IP",
796 "VAMPIRE_DC_NETBIOSNAME",
797 "VAMPIRE_DC_NETBIOSALIAS",
814 "WINBINDD_SOCKET_DIR",
815 "WINBINDD_PRIV_PIPE_DIR",
819 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub {
821 teardown_env
($_) foreach(keys %running_envs);
822 die("Received signal $signame");
827 my ($name, $prefix) = @_;
829 my $testenv_vars = undef;
835 $option =~ s/^[^:]*//;
838 $option = "client" if $option eq "";
840 if ($envname eq "none") {
842 } elsif (defined(get_running_env
($envname))) {
843 $testenv_vars = get_running_env
($envname);
844 if (not $target->check_env($testenv_vars)) {
845 print $target->getlog_env($testenv_vars);
846 $testenv_vars = undef;
849 $testenv_vars = $target->setup_env($envname, $prefix);
852 return undef unless defined($testenv_vars);
854 $running_envs{$envname} = $testenv_vars;
856 if ($option eq "local") {
857 SocketWrapper
::set_default_iface
($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE
});
858 $ENV{SMB_CONF_PATH
} = $testenv_vars->{SERVERCONFFILE
};
859 } elsif ($option eq "client") {
860 SocketWrapper
::set_default_iface
(11);
861 write_clientconf
($conffile, $clientdir, $testenv_vars);
862 $ENV{SMB_CONF_PATH
} = $conffile;
864 die("Unknown option[$option] for envname[$envname]");
867 foreach (@exported_envvars) {
868 if (defined($testenv_vars->{$_})) {
869 $ENV{$_} = $testenv_vars->{$_};
875 return $testenv_vars;
878 sub exported_envvars_str
($)
880 my ($testenv_vars) = @_;
883 foreach (@exported_envvars) {
884 next unless defined($testenv_vars->{$_});
885 $out .= $_."=".$testenv_vars->{$_}."\n";
894 return "" if ($envname eq "none");
895 return $target->getlog_env(get_running_env
($envname));
901 return 1 if ($envname eq "none");
902 return $target->check_env(get_running_env
($envname));
908 return if ($envname eq "none");
909 $target->teardown_env(get_running_env
($envname));
910 delete $running_envs{$envname};
913 # This 'global' file needs to be empty when we start
914 unlink("$prefix_abs/dns_host_file");
917 my $testenv_name = $ENV{SELFTEST_TESTENV
};
918 $testenv_name = $testenv_default unless defined($testenv_name);
920 my $testenv_vars = setup_env
($testenv_name, $prefix);
922 die("Unable to setup environment $testenv_name") unless ($testenv_vars);
924 $ENV{PIDDIR
} = $testenv_vars->{PIDDIR
};
925 $ENV{ENVNAME
} = $testenv_name;
927 my $envvarstr = exported_envvars_str
($testenv_vars);
929 my $term = ($ENV{TERMINAL
} or "xterm -e");
930 system("$term 'echo -e \"
931 Welcome to the Samba4 Test environment '$testenv_name'
933 This matches the client environment used in make test
934 server is pid `cat \$PIDDIR/samba.pid`
936 Some useful environment variables:
937 TORTURE_OPTIONS=\$TORTURE_OPTIONS
938 SMB_CONF_PATH=\$SMB_CONF_PATH
941 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
942 teardown_env
($testenv_name);
948 my $envname = $$_[1];
950 my $envvars = setup_env
($envname, $prefix);
951 if (not defined($envvars)) {
952 Subunit
::start_testsuite
($name);
953 Subunit
::end_testsuite
($name, "error",
954 "unable to set up environment $envname - exiting");
958 # Generate a file with the individual tests to run, if the
959 # test runner for this test suite supports it.
960 if ($individual_tests and $individual_tests->{$name}) {
962 my ($fh, $listid_file) = tempfile
(UNLINK
=> 0);
963 foreach my $test (@
{$individual_tests->{$name}}) {
964 print $fh substr($test, length($name)+1) . "\n";
966 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
968 $cmd =~ s/\s+[^\s]+\s*$//;
969 $cmd .= " " . join(' ', @
{$individual_tests->{$name}});
973 run_testsuite
($envname, $name, $cmd, $i, $suitestotal);
975 teardown_env
($envname) if ($opt_resetup_env);
981 teardown_env
($_) foreach (keys %running_envs);
985 # if there were any valgrind failures, show them
986 foreach (<$prefix/valgrind
.log*>) {
988 print "VALGRIND FAILURE\n";