2 # Bootstrap Samba and run a number of tests against it.
3 # Copyright (C) 2005-2012 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/>.
25 opt_socket_wrapper = 0;
26 opt_socket_wrapper_pcap = undef;
27 opt_socket_wrapper_keep_pcap = undef;
35 opt_resetup_env = undef;
36 opt_binary_mapping = "";
37 opt_load_list = undef;
47 def pipe_handler(sig):
48 sys.stderr.write("Exiting early because of SIGPIPE.\n")
51 signal.signal(signal.SIGPIPE, pipe_handler)
55 my ($list, $fullname) = @_;
58 if ($fullname =~ /$$_[0]/) {
59 return ($$_[1]) if ($$_[1]);
71 return find_in_list(\@excludes, $name);
80 return unless ($opt_socket_wrapper_pcap);
81 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR});
84 $fname =~ s%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\-]%_%g;
86 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
88 SocketWrapper::setup_pcap($pcap_file);
95 my ($pcap_file, $exitcode) = @_;
97 return unless ($opt_socket_wrapper_pcap);
98 return if ($opt_socket_wrapper_keep_pcap);
99 return unless ($exitcode == 0);
100 return unless defined($pcap_file);
105 # expand strings from %ENV
106 sub expand_environment_strings($)
109 # we use a reverse sort so we do the longer ones first
110 foreach my $k (sort { $b cmp $a } keys %ENV) {
111 $s =~ s/\$$k/$ENV{$k}/g;
116 sub run_testsuite($$$$$)
118 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
119 my $pcap_file = setup_pcap($name);
121 Subunit::start_testsuite($name);
122 Subunit::progress_push();
123 Subunit::report_time(time());
125 Subunit::report_time(time());
126 Subunit::progress_pop();
129 Subunit::progress_pop();
130 Subunit::end_testsuite($name, "error", "Unable to run $cmd: $!");
133 Subunit::end_testsuite($name, "error",
134 sprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127), ($? & 128) ? 'with' : 'without'));
138 my $exitcode = $? >> 8;
140 my $envlog = getlog_env($envname);
142 print "envlog: $envlog\n";
145 print "command: $cmd\n";
146 printf "expanded command: %s\n", expand_environment_strings($cmd);
148 if ($exitcode == 0) {
149 Subunit::end_testsuite($name, "success");
151 Subunit::end_testsuite($name, "failure", "Exit code was $exitcode");
154 cleanup_pcap($pcap_file, $exitcode);
156 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
157 print "PCAP FILE: $pcap_file\n";
160 if ($exitcode != 0) {
161 exit(1) if ($opt_one);
169 print "Samba test runner
170 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
171 Copyright (C) Stefan Metzmacher <metze\@samba.org>
173 Usage: $Script [OPTIONS] TESTNAME-REGEX
176 --help this help page
177 --target=samba[3]|win Samba version to target
178 --testlist=FILE file to read available tests from
181 --prefix=DIR prefix to run tests in [st]
182 --srcdir=DIR source directory [.]
183 --bindir=DIR binaries directory [./bin]
186 --socket-wrapper-pcap save traffic to pcap directories
187 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
189 --socket-wrapper enable socket wrapper
192 --ldap=openldap|fedora-ds back samba onto specified ldap server
195 --quick run quick overall test
196 --one abort when the first test fails
198 --testenv run a shell in the requested test environment
199 --list list available tests
204 my $result = GetOptions (
205 'help|h|?' => \$opt_help,
206 'target=s' => \$opt_target,
207 'prefix=s' => \$prefix,
208 'socket-wrapper' => \$opt_socket_wrapper,
209 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
210 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
211 'quick' => \$opt_quick,
213 'exclude=s' => \@opt_exclude,
214 'include=s' => \@opt_include,
215 'srcdir=s' => \$srcdir,
216 'bindir=s' => \$bindir,
217 'verbose' => \$opt_verbose,
218 'testenv' => \$opt_testenv,
219 'list' => \$opt_list,
221 'resetup-environment' => \$opt_resetup_env,
222 'testlist=s' => \@testlists,
223 'load-list=s' => \$opt_load_list,
224 'binary-mapping=s' => \$opt_binary_mapping
227 exit(1) if (not $result);
229 ShowHelp() if ($opt_help);
231 die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
233 # we want unbuffered output
238 # quick hack to disable rpc validation when using valgrind - its way too slow
239 unless (defined($ENV{VALGRIND})) {
240 $ENV{VALIDATE} = "validate";
241 $ENV{MALLOC_CHECK_} = 2;
244 # make all our python scripts unbuffered
245 $ENV{PYTHONUNBUFFERED} = 1;
247 my $bindir_abs = abs_path($bindir);
249 # Backwards compatibility:
250 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
251 if (defined($ENV{FEDORA_DS_ROOT})) {
258 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
261 $torture_maxtime *= 2;
268 die("using an empty prefix isn't allowed") unless $prefix ne "";
270 # Ensure we have the test prefix around.
272 # We need restrictive
273 # permissions on this as some subdirectories in this tree will have
274 # wider permissions (ie 0777) and this would allow other users on the
275 # host to subvert the test process.
276 mkdir($prefix, 0700) unless -d $prefix;
279 my $prefix_abs = abs_path($prefix);
280 my $tmpdir_abs = abs_path("$prefix/tmp");
281 mkdir($tmpdir_abs, 0777) unless -d $tmpdir_abs;
283 my $srcdir_abs = abs_path($srcdir);
285 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
286 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
288 $ENV{PREFIX} = $prefix;
289 $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
290 $ENV{PREFIX_ABS} = $prefix_abs;
291 $ENV{SRCDIR} = $srcdir;
292 $ENV{SRCDIR_ABS} = $srcdir_abs;
293 $ENV{BINDIR} = $bindir_abs;
295 my $tls_enabled = not $opt_quick;
296 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
298 sub prefix_pathvar($$)
300 my ($name, $newpath) = @_;
301 if (defined($ENV{$name})) {
302 $ENV{$name} = "$newpath:$ENV{$name}";
304 $ENV{$name} = $newpath;
307 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
308 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
310 if ($opt_socket_wrapper_keep_pcap) {
311 # Socket wrapper keep pcap implies socket wrapper pcap
312 $opt_socket_wrapper_pcap = 1;
315 if ($opt_socket_wrapper_pcap) {
316 # Socket wrapper pcap implies socket wrapper
317 $opt_socket_wrapper = 1;
320 my $socket_wrapper_dir;
321 if ($opt_socket_wrapper) {
322 $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix_abs/w", $opt_socket_wrapper_pcap);
323 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
324 } elsif (not $opt_list) {
326 warn("not using socket wrapper, but also not running as root. Will not be able to listen on proper ports");
331 my $testenv_default = "none";
333 my %binary_mapping = ();
334 if ($opt_binary_mapping) {
335 my @binmapping_list = split(/,/, $opt_binary_mapping);
336 foreach my $mapping (@binmapping_list) {
337 my ($bin, $map) = split(/\:/, $mapping);
338 $binary_mapping{$bin} = $map;
342 $ENV{BINARY_MAPPING} = $opt_binary_mapping;
344 # After this many seconds, the server will self-terminate. All tests
345 # must terminate in this time, and testenv will only stay alive this
348 my $server_maxtime = 7500;
349 if (defined($ENV{SMBD_MAXTIME}) and $ENV{SMBD_MAXTIME} ne "") {
350 $server_maxtime = $ENV{SMBD_MAXTIME};
354 if ($opt_target eq "samba") {
355 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
356 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
358 $testenv_default = "dc";
359 require target::Samba;
360 $target = new Samba($bindir, \%binary_mapping, $ldap, $srcdir, $server_maxtime);
361 } elsif ($opt_target eq "samba3") {
362 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
363 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
365 $testenv_default = "member";
366 require target::Samba3;
367 $target = new Samba3($bindir, \%binary_mapping, $srcdir_abs, $server_maxtime);
372 # Start a Virtual Distributed Ethernet Switch
373 # Returns the pid of the switch.
375 sub start_vde_switch($)
379 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
381 open(PID, "$path/vde.pid");
389 # Stop a Virtual Distributed Ethernet Switch
390 sub stop_vde_switch($)
396 sub read_test_regexes($)
400 open(LF, "<$name") or die("unable to read $name: $!");
404 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
405 push (@ret, [$1, $4]);
407 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
408 push (@ret, [$_, undef]);
415 foreach (@opt_exclude) {
416 push (@excludes, read_test_regexes($_));
419 foreach (@opt_include) {
420 push (@includes, read_test_regexes($_));
423 my $interfaces = join(',', ("127.0.0.11/8",
430 my $clientdir = "$prefix_abs/client";
432 my $conffile = "$clientdir/client.conf";
433 $ENV{SMB_CONF_PATH} = $conffile;
435 sub write_clientconf($$$)
437 my ($conffile, $clientdir, $vars) = @_;
439 mkdir("$clientdir", 0777) unless -d "$clientdir";
441 if ( -d "$clientdir/private" ) {
442 unlink <$clientdir/private/*>;
444 mkdir("$clientdir/private", 0777);
447 if ( -d "$clientdir/lockdir" ) {
448 unlink <$clientdir/lockdir/*>;
450 mkdir("$clientdir/lockdir", 0777);
453 if ( -d "$clientdir/statedir" ) {
454 unlink <$clientdir/statedir/*>;
456 mkdir("$clientdir/statedir", 0777);
459 if ( -d "$clientdir/cachedir" ) {
460 unlink <$clientdir/cachedir/*>;
462 mkdir("$clientdir/cachedir", 0777);
465 # this is ugly, but the ncalrpcdir needs exactly 0755
466 # otherwise tests fail.
469 if ( -d "$clientdir/ncalrpcdir/np" ) {
470 unlink <$clientdir/ncalrpcdir/np/*>;
471 rmdir "$clientdir/ncalrpcdir/np";
473 if ( -d "$clientdir/ncalrpcdir" ) {
474 unlink <$clientdir/ncalrpcdir/*>;
475 rmdir "$clientdir/ncalrpcdir";
477 mkdir("$clientdir/ncalrpcdir", 0755);
480 open(CF, ">$conffile");
481 print CF "[global]\n";
482 print CF "\tnetbios name = client\n";
483 if (defined($vars->{DOMAIN})) {
484 print CF "\tworkgroup = $vars->{DOMAIN}\n";
486 if (defined($vars->{REALM})) {
487 print CF "\trealm = $vars->{REALM}\n";
489 if ($opt_socket_wrapper) {
490 print CF "\tinterfaces = $interfaces\n";
493 private dir = $clientdir/private
494 lock dir = $clientdir/lockdir
495 state directory = $clientdir/statedir
496 cache directory = $clientdir/cachedir
497 ncalrpc dir = $clientdir/ncalrpcdir
498 name resolve order = file bcast
499 panic action = $RealBin/gdb_backtrace \%d
501 notify:inotify = false
503 system:anonymous = true
504 client lanman auth = Yes
506 torture:basedir = $clientdir
507 #We don't want to pass our self-tests if the PAC code is wrong
508 gensec:require_pac = true
509 resolv:host file = $prefix_abs/dns_host_file
510 #We don't want to run 'speed' tests for very long
511 torture:timelimit = 1
518 sub should_run_test($)
524 for (my $i=0; $i <= $#tests; $i++) {
525 if ($name =~ /$tests[$i]/i) {
537 open(IN, $filename) or die("Unable to open $filename: $!");
540 if (/-- TEST(-LOADLIST|-IDLIST|) --\n/) {
541 my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
542 my $supports_idlist = (defined($1) and $1 eq "-IDLIST");
549 if (should_run_test($name) == 1) {
550 push (@ret, [$name, $env, $cmdline, $supports_loadlist, $supports_idlist]);
556 close(IN) or die("Error creating recipe");
560 if ($#testlists == -1) {
561 die("No testlists specified");
564 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
565 $ENV{SELFTEST_TMPDIR} = "$tmpdir_abs";
566 $ENV{TEST_DATA_PREFIX} = "$tmpdir_abs";
567 if ($opt_socket_wrapper) {
568 $ENV{SELFTEST_INTERFACES} = $interfaces;
570 $ENV{SELFTEST_INTERFACES} = "";
573 $ENV{SELFTEST_VERBOSE} = "1";
575 $ENV{SELFTEST_VERBOSE} = "";
578 $ENV{SELFTEST_QUICK} = "1";
580 $ENV{SELFTEST_QUICK} = "";
582 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
585 foreach my $fn (@testlists) {
586 foreach (read_testlist($fn)) {
588 next if (@includes and not defined(find_in_list(\@includes, $name)));
589 push (@available, $_);
593 my $restricted = undef;
594 my $restricted_used = {};
596 if ($opt_load_list) {
598 open(LOAD_LIST, "<$opt_load_list") or die("Unable to open $opt_load_list");
599 while (<LOAD_LIST>) {
601 push (@$restricted, $_);
606 my $individual_tests = undef;
607 $individual_tests = {};
609 foreach my $testsuite (@available) {
610 my $name = $$testsuite[0];
611 my $skipreason = skip($name);
612 if (defined($restricted)) {
613 # Find the testsuite for this test
615 foreach my $r (@$restricted) {
617 $individual_tests->{$name} = [];
619 $restricted_used->{$r} = 1;
620 } elsif (substr($r, 0, length($name)+1) eq "$name.") {
621 push(@{$individual_tests->{$name}}, $r);
623 $restricted_used->{$r} = 1;
627 if (defined($skipreason)) {
629 Subunit::skip_testsuite($name, $skipreason);
632 push(@todo, $testsuite);
635 } elsif (defined($skipreason)) {
637 Subunit::skip_testsuite($name, $skipreason);
640 push(@todo, $testsuite);
644 if (defined($restricted)) {
645 foreach (@$restricted) {
646 unless (defined($restricted_used->{$_})) {
647 print "No test or testsuite found matching $_\n";
650 } elsif ($#todo == -1) {
651 print STDERR "No tests to run\n";
655 my $suitestotal = $#todo + 1;
658 Subunit::progress($suitestotal);
659 Subunit::report_time(time());
665 my %running_envs = ();
667 sub get_running_env($)
675 return $running_envs{$envname};
678 my @exported_envvars = (
683 # domain controller stuff
692 "MEMBER_NETBIOSNAME",
693 "MEMBER_NETBIOSALIAS",
695 # rpc proxy controller stuff
697 "RPC_PROXY_SERVER_IP",
698 "RPC_PROXY_NETBIOSNAME",
699 "RPC_PROXY_NETBIOSALIAS",
701 # domain controller stuff for Vampired DC
703 "VAMPIRE_DC_SERVER_IP",
704 "VAMPIRE_DC_NETBIOSNAME",
705 "VAMPIRE_DC_NETBIOSALIAS",
722 "WINBINDD_SOCKET_DIR",
723 "WINBINDD_PRIV_PIPE_DIR",
728 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
730 teardown_env($_) foreach(keys %running_envs);
731 die("Received signal $signame");
736 my ($name, $prefix) = @_;
738 my $testenv_vars = undef;
744 $option =~ s/^[^:]*//;
747 $option = "client" if $option eq "";
749 if ($envname eq "none") {
751 } elsif (defined(get_running_env($envname))) {
752 $testenv_vars = get_running_env($envname);
753 if (not $testenv_vars->{target}->check_env($testenv_vars)) {
754 print $testenv_vars->{target}->getlog_env($testenv_vars);
755 $testenv_vars = undef;
758 $testenv_vars = $target->setup_env($envname, $prefix);
759 if (defined($testenv_vars) and $testenv_vars eq "UNKNOWN") {
760 return $testenv_vars;
761 } elsif (defined($testenv_vars) && not defined($testenv_vars->{target})) {
762 $testenv_vars->{target} = $target;
764 if (not defined($testenv_vars)) {
765 warn("$opt_target can't start up known environment '$envname'");
770 return undef unless defined($testenv_vars);
772 $running_envs{$envname} = $testenv_vars;
774 if ($option eq "local") {
775 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
776 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
777 } elsif ($option eq "client") {
778 SocketWrapper::set_default_iface(11);
779 write_clientconf($conffile, $clientdir, $testenv_vars);
780 $ENV{SMB_CONF_PATH} = $conffile;
782 die("Unknown option[$option] for envname[$envname]");
785 foreach (@exported_envvars) {
786 if (defined($testenv_vars->{$_})) {
787 $ENV{$_} = $testenv_vars->{$_};
793 return $testenv_vars;
796 sub exported_envvars_str($)
798 my ($testenv_vars) = @_;
801 foreach (@exported_envvars) {
802 next unless defined($testenv_vars->{$_});
803 $out .= $_."=".$testenv_vars->{$_}."\n";
812 return "" if ($envname eq "none");
813 my $env = get_running_env($envname);
814 return $env->{target}->getlog_env($env);
820 return 1 if ($envname eq "none");
821 my $env = get_running_env($envname);
822 return $env->{target}->check_env($env);
828 return if ($envname eq "none");
829 my $env = get_running_env($envname);
830 $env->{target}->teardown_env($env);
831 delete $running_envs{$envname};
834 # This 'global' file needs to be empty when we start
835 unlink("$prefix_abs/dns_host_file");
838 my $testenv_name = $ENV{SELFTEST_TESTENV};
839 $testenv_name = $testenv_default unless defined($testenv_name);
841 my $testenv_vars = setup_env($testenv_name, $prefix);
843 die("Unable to setup environment $testenv_name") unless ($testenv_vars);
845 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
846 $ENV{ENVNAME} = $testenv_name;
848 my $envvarstr = exported_envvars_str($testenv_vars);
850 my $term = ($ENV{TERMINAL} or "xterm -e");
851 system("$term 'echo -e \"
852 Welcome to the Samba4 Test environment '$testenv_name'
854 This matches the client environment used in make test
855 server is pid `cat \$PIDDIR/samba.pid`
857 Some useful environment variables:
858 TORTURE_OPTIONS=\$TORTURE_OPTIONS
859 SMB_CONF_PATH=\$SMB_CONF_PATH
862 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
863 teardown_env($testenv_name);
864 } elsif ($opt_list) {
868 my $envname = $$_[1];
870 unless($cmd =~ /\$LISTOPT/) {
871 warn("Unable to list tests in $name");
875 $cmd =~ s/\$LISTOPT/--list/g;
880 die("Unable to run $cmd: $!");
882 die(snprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127), ($? & 128) ? 'with' : 'without'));
885 my $exitcode = $? >> 8;
886 if ($exitcode != 0) {
887 die("$cmd exited with exit code $exitcode");
895 my $envname = $$_[1];
897 my $envvars = setup_env($envname, $prefix);
898 if (not defined($envvars)) {
899 Subunit::start_testsuite($name);
900 Subunit::end_testsuite($name, "error",
901 "unable to set up environment $envname - exiting");
903 } elsif ($envvars eq "UNKNOWN") {
904 Subunit::start_testsuite($name);
905 Subunit::end_testsuite($name, "skip",
906 "environment $envname is unknown in this test backend - skipping");
910 # Generate a file with the individual tests to run, if the
911 # test runner for this test suite supports it.
912 if ($individual_tests and $individual_tests->{$name}) {
914 my ($fh, $listid_file) = tempfile(UNLINK => 0);
915 foreach my $test (@{$individual_tests->{$name}}) {
916 print $fh substr($test, length($name)+1) . "\n";
918 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
920 $cmd =~ s/\s+[^\s]+\s*$//;
921 $cmd .= " " . join(' ', @{$individual_tests->{$name}});
925 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
927 teardown_env($envname) if ($opt_resetup_env);
933 teardown_env($_) foreach (keys %running_envs);
937 # if there were any valgrind failures, show them
938 foreach (<$prefix/valgrind.log*>) {
940 print "VALGRIND FAILURE\n";