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/>.
21 use FindBin
qw($RealBin $Script);
23 use File::Temp qw(tempfile);
33 Time
::HiRes
->import("time");
36 print "You don't have Time::Hires installed !\n";
40 my $opt_target = "samba";
42 my $opt_socket_wrapper = 0;
43 my $opt_socket_wrapper_pcap = undef;
44 my $opt_socket_wrapper_keep_pcap = undef;
45 my $opt_random_order = 0;
52 my $opt_resetup_env = undef;
53 my $opt_binary_mapping = "";
54 my $opt_load_list = undef;
66 print STDERR
"Exiting early because of SIGPIPE.\n";
70 $SIG{PIPE
} = \
&pipe_handler
;
74 my ($list, $fullname) = @_;
77 if ($fullname =~ /$$_[0]/) {
78 return ($$_[1]) if ($$_[1]);
90 return find_in_list
(\
@excludes, $name);
99 return unless ($opt_socket_wrapper_pcap);
100 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR
});
103 $fname =~ s
%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\
-]%_%g;
105 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
107 SocketWrapper
::setup_pcap
($pcap_file);
114 my ($pcap_file, $exitcode) = @_;
116 return unless ($opt_socket_wrapper_pcap);
117 return if ($opt_socket_wrapper_keep_pcap);
118 return unless ($exitcode == 0);
119 return unless defined($pcap_file);
124 # expand strings from %ENV
125 sub expand_environment_strings
($)
128 # we use a reverse sort so we do the longer ones first
129 foreach my $k (sort { $b cmp $a } keys %ENV) {
130 $s =~ s/\$$k/$ENV{$k}/g;
135 sub run_testsuite
($$$$$)
137 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
138 my $pcap_file = setup_pcap
($name);
140 Subunit
::start_testsuite
($name);
141 Subunit
::progress_push
();
142 Subunit
::report_time
(time());
144 Subunit
::report_time
(time());
145 Subunit
::progress_pop
();
148 Subunit
::progress_pop
();
149 Subunit
::end_testsuite
($name, "error", "Unable to run $cmd: $!");
152 Subunit
::end_testsuite
($name, "error",
153 sprintf("%s died with signal %d, %s coredump\n", $cmd, ($?
& 127), ($?
& 128) ?
'with' : 'without'));
157 my $exitcode = $?
>> 8;
159 my $envlog = getlog_env
($envname);
161 print "envlog: $envlog\n";
164 print "command: $cmd\n";
165 printf "expanded command: %s\n", expand_environment_strings
($cmd);
167 if ($exitcode == 0) {
168 Subunit
::end_testsuite
($name, "success");
170 Subunit
::end_testsuite
($name, "failure", "Exit code was $exitcode");
173 cleanup_pcap
($pcap_file, $exitcode);
175 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
176 print "PCAP FILE: $pcap_file\n";
179 if ($exitcode != 0) {
180 exit(1) if ($opt_one);
188 print "Samba test runner
189 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
190 Copyright (C) Stefan Metzmacher <metze\@samba.org>
192 Usage: $Script [OPTIONS] TESTNAME-REGEX
195 --help this help page
196 --target=samba[3]|win Samba version to target
197 --testlist=FILE file to read available tests from
200 --prefix=DIR prefix to run tests in [st]
201 --srcdir=DIR source directory [.]
202 --bindir=DIR binaries directory [./bin]
205 --socket-wrapper-pcap save traffic to pcap directories
206 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
208 --socket-wrapper enable socket wrapper
211 --ldap=openldap|fedora-ds back samba onto specified ldap server
214 --quick run quick overall test
215 --one abort when the first test fails
216 --testenv run a shell in the requested test environment
217 --list list available tests
222 my $result = GetOptions
(
223 'help|h|?' => \
$opt_help,
224 'target=s' => \
$opt_target,
225 'prefix=s' => \
$prefix,
226 'socket-wrapper' => \
$opt_socket_wrapper,
227 'socket-wrapper-pcap' => \
$opt_socket_wrapper_pcap,
228 'socket-wrapper-keep-pcap' => \
$opt_socket_wrapper_keep_pcap,
229 'quick' => \
$opt_quick,
231 'exclude=s' => \
@opt_exclude,
232 'include=s' => \
@opt_include,
233 'srcdir=s' => \
$srcdir,
234 'bindir=s' => \
$bindir,
235 'testenv' => \
$opt_testenv,
236 'list' => \
$opt_list,
238 'resetup-environment' => \
$opt_resetup_env,
239 'testlist=s' => \
@testlists,
240 'random-order' => \
$opt_random_order,
241 'load-list=s' => \
$opt_load_list,
242 'binary-mapping=s' => \
$opt_binary_mapping
245 exit(1) if (not $result);
247 ShowHelp
() if ($opt_help);
249 die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
251 # we want unbuffered output
256 # quick hack to disable rpc validation when using valgrind - its way too slow
257 unless (defined($ENV{VALGRIND
})) {
258 $ENV{VALIDATE
} = "validate";
259 $ENV{MALLOC_CHECK_
} = 2;
262 # make all our python scripts unbuffered
263 $ENV{PYTHONUNBUFFERED
} = 1;
265 my $bindir_abs = abs_path
($bindir);
267 # Backwards compatibility:
268 if (defined($ENV{TEST_LDAP
}) and $ENV{TEST_LDAP
} eq "yes") {
269 if (defined($ENV{FEDORA_DS_ROOT
})) {
276 my $torture_maxtime = ($ENV{TORTURE_MAXTIME
} or 1200);
279 $torture_maxtime *= 2;
286 die("using an empty prefix isn't allowed") unless $prefix ne "";
288 # Ensure we have the test prefix around.
290 # We need restrictive
291 # permissions on this as some subdirectories in this tree will have
292 # wider permissions (ie 0777) and this would allow other users on the
293 # host to subvert the test process.
294 mkdir($prefix, 0700) unless -d
$prefix;
297 my $prefix_abs = abs_path
($prefix);
298 my $tmpdir_abs = abs_path
("$prefix/tmp");
299 mkdir($tmpdir_abs, 0777) unless -d
$tmpdir_abs;
301 my $srcdir_abs = abs_path
($srcdir);
303 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
304 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
306 $ENV{PREFIX
} = $prefix;
307 $ENV{KRB5CCNAME
} = "$prefix/krb5ticket";
308 $ENV{PREFIX_ABS
} = $prefix_abs;
309 $ENV{SRCDIR
} = $srcdir;
310 $ENV{SRCDIR_ABS
} = $srcdir_abs;
311 $ENV{BINDIR
} = $bindir_abs;
313 my $tls_enabled = not $opt_quick;
314 $ENV{TLS_ENABLED
} = ($tls_enabled?
"yes":"no");
316 sub prefix_pathvar
($$)
318 my ($name, $newpath) = @_;
319 if (defined($ENV{$name})) {
320 $ENV{$name} = "$newpath:$ENV{$name}";
322 $ENV{$name} = $newpath;
325 prefix_pathvar
("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
326 prefix_pathvar
("PYTHONPATH", "$bindir_abs/python");
328 if ($opt_socket_wrapper_keep_pcap) {
329 # Socket wrapper keep pcap implies socket wrapper pcap
330 $opt_socket_wrapper_pcap = 1;
333 if ($opt_socket_wrapper_pcap) {
334 # Socket wrapper pcap implies socket wrapper
335 $opt_socket_wrapper = 1;
338 my $socket_wrapper_dir;
339 if ($opt_socket_wrapper) {
340 $socket_wrapper_dir = SocketWrapper
::setup_dir
("$prefix_abs/w", $opt_socket_wrapper_pcap);
341 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
342 } elsif (not $opt_list) {
344 warn("not using socket wrapper, but also not running as root. Will not be able to listen on proper ports");
349 my $testenv_default = "none";
351 my %binary_mapping = ();
352 if ($opt_binary_mapping) {
353 my @binmapping_list = split(/,/, $opt_binary_mapping);
354 foreach my $mapping (@binmapping_list) {
355 my ($bin, $map) = split(/\:/, $mapping);
356 $binary_mapping{$bin} = $map;
360 $ENV{BINARY_MAPPING
} = $opt_binary_mapping;
362 # After this many seconds, the server will self-terminate. All tests
363 # must terminate in this time, and testenv will only stay alive this
366 my $server_maxtime = 7500;
367 if (defined($ENV{SMBD_MAXTIME
}) and $ENV{SMBD_MAXTIME
} ne "") {
368 $server_maxtime = $ENV{SMBD_MAXTIME
};
372 if ($opt_target eq "samba") {
373 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
374 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
376 $testenv_default = "dc";
377 require target
::Samba
;
378 $target = new Samba
($bindir, \
%binary_mapping, $ldap, $srcdir, $server_maxtime);
379 } elsif ($opt_target eq "samba3") {
380 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
381 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
383 $testenv_default = "member";
384 require target
::Samba3
;
385 $target = new Samba3
($bindir, \
%binary_mapping, $srcdir_abs, $server_maxtime);
389 sub read_test_regexes
($)
393 open(LF
, "<$name") or die("unable to read $name: $!");
397 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
398 push (@ret, [$1, $4]);
400 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
401 push (@ret, [$_, undef]);
408 foreach (@opt_exclude) {
409 push (@excludes, read_test_regexes
($_));
412 foreach (@opt_include) {
413 push (@includes, read_test_regexes
($_));
416 my $interfaces = join(',', ("127.0.0.11/8",
423 my $clientdir = "$prefix_abs/client";
425 my $conffile = "$clientdir/client.conf";
426 $ENV{SMB_CONF_PATH
} = $conffile;
428 sub write_clientconf
($$$)
430 my ($conffile, $clientdir, $vars) = @_;
432 mkdir("$clientdir", 0777) unless -d
"$clientdir";
434 if ( -d
"$clientdir/private" ) {
435 unlink <$clientdir/private/*>;
437 mkdir("$clientdir/private", 0777);
440 if ( -d
"$clientdir/lockdir" ) {
441 unlink <$clientdir/lockdir/*>;
443 mkdir("$clientdir/lockdir", 0777);
446 if ( -d
"$clientdir/statedir" ) {
447 unlink <$clientdir/statedir/*>;
449 mkdir("$clientdir/statedir", 0777);
452 if ( -d
"$clientdir/cachedir" ) {
453 unlink <$clientdir/cachedir/*>;
455 mkdir("$clientdir/cachedir", 0777);
458 # this is ugly, but the ncalrpcdir needs exactly 0755
459 # otherwise tests fail.
462 if ( -d
"$clientdir/ncalrpcdir/np" ) {
463 unlink <$clientdir/ncalrpcdir/np
/*>;
464 rmdir "$clientdir/ncalrpcdir/np";
466 if ( -d
"$clientdir/ncalrpcdir" ) {
467 unlink <$clientdir/ncalrpcdir/*>;
468 rmdir "$clientdir/ncalrpcdir";
470 mkdir("$clientdir/ncalrpcdir", 0755);
473 open(CF
, ">$conffile");
474 print CF
"[global]\n";
475 print CF
"\tnetbios name = client\n";
476 if (defined($vars->{DOMAIN
})) {
477 print CF
"\tworkgroup = $vars->{DOMAIN}\n";
479 if (defined($vars->{REALM
})) {
480 print CF
"\trealm = $vars->{REALM}\n";
482 if ($opt_socket_wrapper) {
483 print CF
"\tinterfaces = $interfaces\n";
486 private dir = $clientdir/private
487 lock dir = $clientdir/lockdir
488 state directory = $clientdir/statedir
489 cache directory = $clientdir/cachedir
490 ncalrpc dir = $clientdir/ncalrpcdir
491 name resolve order = file bcast
492 panic action = $RealBin/gdb_backtrace \%d
494 notify:inotify = false
496 system:anonymous = true
497 client lanman auth = Yes
499 torture:basedir = $clientdir
500 #We don't want to pass our self-tests if the PAC code is wrong
501 gensec:require_pac = true
502 resolv:host file = $prefix_abs/dns_host_file
503 #We don't want to run 'speed' tests for very long
504 torture:timelimit = 1
511 sub should_run_test
($)
517 for (my $i=0; $i <= $#tests; $i++) {
518 if ($name =~ /$tests[$i]/i) {
530 open(IN
, $filename) or die("Unable to open $filename: $!");
533 if (/-- TEST(-LOADLIST|-IDLIST|) --\n/) {
534 my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
535 my $supports_idlist = (defined($1) and $1 eq "-IDLIST");
542 if (should_run_test
($name) == 1) {
543 push (@ret, [$name, $env, $cmdline, $supports_loadlist, $supports_idlist]);
549 close(IN
) or die("Error creating recipe");
553 if ($#testlists == -1) {
554 die("No testlists specified");
557 $ENV{SELFTEST_PREFIX
} = "$prefix_abs";
558 $ENV{SELFTEST_TMPDIR
} = "$tmpdir_abs";
559 $ENV{TEST_DATA_PREFIX
} = "$tmpdir_abs";
560 if ($opt_socket_wrapper) {
561 $ENV{SELFTEST_INTERFACES
} = $interfaces;
563 $ENV{SELFTEST_INTERFACES
} = "";
566 $ENV{SELFTEST_QUICK
} = "1";
568 $ENV{SELFTEST_QUICK
} = "";
570 $ENV{SELFTEST_MAXTIME
} = $torture_maxtime;
573 foreach my $fn (@testlists) {
574 foreach (read_testlist
($fn)) {
576 next if (@includes and not defined(find_in_list
(\
@includes, $name)));
577 push (@available, $_);
581 my $restricted = undef;
582 my $restricted_used = {};
584 if ($opt_load_list) {
586 open(LOAD_LIST
, "<$opt_load_list") or die("Unable to open $opt_load_list");
587 while (<LOAD_LIST
>) {
589 push (@
$restricted, $_);
594 my $individual_tests = undef;
595 $individual_tests = {};
597 foreach my $testsuite (@available) {
598 my $name = $$testsuite[0];
599 my $skipreason = skip
($name);
600 if (defined($restricted)) {
601 # Find the testsuite for this test
603 foreach my $r (@
$restricted) {
605 $individual_tests->{$name} = [];
607 $restricted_used->{$r} = 1;
608 } elsif (substr($r, 0, length($name)+1) eq "$name.") {
609 push(@
{$individual_tests->{$name}}, $r);
611 $restricted_used->{$r} = 1;
615 if (defined($skipreason)) {
617 Subunit
::skip_testsuite
($name, $skipreason);
620 push(@todo, $testsuite);
623 } elsif (defined($skipreason)) {
625 Subunit
::skip_testsuite
($name, $skipreason);
628 push(@todo, $testsuite);
632 if (defined($restricted)) {
633 foreach (@
$restricted) {
634 unless (defined($restricted_used->{$_})) {
635 print "No test or testsuite found matching $_\n";
638 } elsif ($#todo == -1) {
639 print STDERR
"No tests to run\n";
643 my $suitestotal = $#todo + 1;
646 Subunit
::progress
($suitestotal);
647 Subunit
::report_time
(time());
653 my %running_envs = ();
655 sub get_running_env
($)
663 return $running_envs{$envname};
666 my @exported_envvars = (
671 # domain controller stuff
680 "MEMBER_NETBIOSNAME",
681 "MEMBER_NETBIOSALIAS",
683 # rpc proxy controller stuff
685 "RPC_PROXY_SERVER_IP",
686 "RPC_PROXY_NETBIOSNAME",
687 "RPC_PROXY_NETBIOSALIAS",
689 # domain controller stuff for Vampired DC
691 "VAMPIRE_DC_SERVER_IP",
692 "VAMPIRE_DC_NETBIOSNAME",
693 "VAMPIRE_DC_NETBIOSALIAS",
710 "WINBINDD_SOCKET_DIR",
711 "WINBINDD_PRIV_PIPE_DIR",
716 "NSS_WRAPPER_PASSWD",
719 # UID/GID for rfc2307 mapping tests
724 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub {
726 teardown_env
($_) foreach(keys %running_envs);
727 die("Received signal $signame");
732 my ($name, $prefix) = @_;
734 my $testenv_vars = undef;
740 $option =~ s/^[^:]*//;
743 $option = "client" if $option eq "";
745 if ($envname eq "none") {
747 } elsif (defined(get_running_env
($envname))) {
748 $testenv_vars = get_running_env
($envname);
749 if (not $testenv_vars->{target
}->check_env($testenv_vars)) {
750 print $testenv_vars->{target
}->getlog_env($testenv_vars);
751 $testenv_vars = undef;
754 $testenv_vars = $target->setup_env($envname, $prefix);
755 if (defined($testenv_vars) and $testenv_vars eq "UNKNOWN") {
756 return $testenv_vars;
757 } elsif (defined($testenv_vars) && not defined($testenv_vars->{target
})) {
758 $testenv_vars->{target
} = $target;
760 if (not defined($testenv_vars)) {
761 warn("$opt_target can't start up known environment '$envname'");
766 return undef unless defined($testenv_vars);
768 $running_envs{$envname} = $testenv_vars;
770 if ($option eq "local") {
771 SocketWrapper
::set_default_iface
($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE
});
772 $ENV{SMB_CONF_PATH
} = $testenv_vars->{SERVERCONFFILE
};
773 } elsif ($option eq "client") {
774 SocketWrapper
::set_default_iface
(11);
775 write_clientconf
($conffile, $clientdir, $testenv_vars);
776 $ENV{SMB_CONF_PATH
} = $conffile;
778 die("Unknown option[$option] for envname[$envname]");
781 foreach (@exported_envvars) {
782 if (defined($testenv_vars->{$_})) {
783 $ENV{$_} = $testenv_vars->{$_};
789 return $testenv_vars;
792 sub exported_envvars_str
($)
794 my ($testenv_vars) = @_;
797 foreach (@exported_envvars) {
798 next unless defined($testenv_vars->{$_});
799 $out .= $_."=".$testenv_vars->{$_}."\n";
808 return "" if ($envname eq "none");
809 my $env = get_running_env
($envname);
810 return $env->{target
}->getlog_env($env);
816 return 1 if ($envname eq "none");
817 my $env = get_running_env
($envname);
818 return $env->{target
}->check_env($env);
824 return if ($envname eq "none");
825 my $env = get_running_env
($envname);
826 $env->{target
}->teardown_env($env);
827 delete $running_envs{$envname};
830 # This 'global' file needs to be empty when we start
831 unlink("$prefix_abs/dns_host_file");
833 if ($opt_random_order) {
835 my @newtodo = List
::Util
::shuffle
(@todo);
840 my $testenv_name = $ENV{SELFTEST_TESTENV
};
841 $testenv_name = $testenv_default unless defined($testenv_name);
843 my $testenv_vars = setup_env
($testenv_name, $prefix);
845 die("Unable to setup environment $testenv_name") unless ($testenv_vars);
847 $ENV{PIDDIR
} = $testenv_vars->{PIDDIR
};
848 $ENV{ENVNAME
} = $testenv_name;
850 my $envvarstr = exported_envvars_str
($testenv_vars);
852 my @term_args = ("echo -e \"
853 Welcome to the Samba4 Test environment '$testenv_name'
855 This matches the client environment used in make test
856 server is pid `cat \$PIDDIR/samba.pid`
858 Some useful environment variables:
859 TORTURE_OPTIONS=\$TORTURE_OPTIONS
860 SMB_CONF_PATH=\$SMB_CONF_PATH
863 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash");
865 if ($ENV{TERMINAL
}) {
866 @term = ($ENV{TERMINAL
});
868 @term = ("xterm", "-e");
869 unshift(@term_args, ("bash", "-c"));
872 system(@term, @term_args);
874 teardown_env
($testenv_name);
875 } elsif ($opt_list) {
879 my $envname = $$_[1];
881 unless($cmd =~ /\$LISTOPT/) {
882 warn("Unable to list tests in $name");
886 $cmd =~ s/\$LISTOPT/--list/g;
891 die("Unable to run $cmd: $!");
893 die(sprintf("%s died with signal %d, %s coredump\n", $cmd, ($?
& 127), ($?
& 128) ?
'with' : 'without'));
896 my $exitcode = $?
>> 8;
897 if ($exitcode != 0) {
898 die("$cmd exited with exit code $exitcode");
906 my $envname = $$_[1];
908 my $envvars = setup_env
($envname, $prefix);
909 if (not defined($envvars)) {
910 Subunit
::start_testsuite
($name);
911 Subunit
::end_testsuite
($name, "error",
912 "unable to set up environment $envname - exiting");
914 } elsif ($envvars eq "UNKNOWN") {
915 Subunit
::start_testsuite
($name);
916 Subunit
::end_testsuite
($name, "skip",
917 "environment $envname is unknown in this test backend - skipping");
921 # Generate a file with the individual tests to run, if the
922 # test runner for this test suite supports it.
923 if ($individual_tests and $individual_tests->{$name}) {
925 my ($fh, $listid_file) = tempfile
(UNLINK
=> 0);
926 foreach my $test (@
{$individual_tests->{$name}}) {
927 print $fh substr($test, length($name)+1) . "\n";
929 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
931 $cmd =~ s/\s+[^\s]+\s*$//;
932 $cmd .= " " . join(' ', @
{$individual_tests->{$name}});
936 run_testsuite
($envname, $name, $cmd, $i, $suitestotal);
938 teardown_env
($envname) if ($opt_resetup_env);
944 teardown_env
($_) foreach (keys %running_envs);
948 # if there were any valgrind failures, show them
949 foreach (<$prefix/valgrind
.log*>) {
951 print "VALGRIND FAILURE\n";