2 # Bootstrap Samba and run a number of tests against it.
3 # Copyright (C) 2005-2007 Jelmer Vernooij <jelmer@samba.org>
4 # Published under the GNU GPL, v3 or later.
10 selftest - Samba test runner
16 selftest [--srcdir=DIR] [--builddir=DIR] [--target=samba4|samba3|win] [--socket-wrapper] [--quick] [--exclude=FILE] [--include=FILE] [--one] [--prefix=prefix] [--immediate] [--testlist=FILE] [TESTS]
20 A simple test runner. TESTS is a regular expression with tests to run.
28 Show list of available options.
34 =item I<--builddir=DIR>
40 Change directory to run tests in. Default is 'st'.
44 Show errors as soon as they happen rather than at the end of the test run.
46 =item I<--target samba4|samba3|win>
48 Specify test target against which to run. Default is 'samba4'.
52 Run only a limited number of tests. Intended to run in about 30 seconds on
53 moderately recent systems.
55 =item I<--socket-wrapper>
57 Use socket wrapper library for communication with server. Only works
58 when the server is running locally.
60 Will prevent TCP and UDP ports being opened on the local host but
61 (transparently) redirects these calls to use unix domain sockets.
63 =item I<--expected-failures>
65 Specify a file containing a list of tests that are expected to fail. Failures for
66 these tests will be counted as successes, successes will be counted as failures.
68 The format for the file is, one entry per line:
70 TESTSUITE-NAME.TEST-NAME
72 The reason for a test can also be specified, by adding a hash sign (#) and the reason
77 Specify a file containing a list of tests that should be skipped. Possible
78 candidates are tests that segfault the server, flip or don't end. The format of this file is the same as
79 for the --expected-failures flag.
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);
130 use Cwd qw(abs_path);
132 use Subunit qw(parse_results);
136 my $opt_target = "samba4";
138 my $opt_socket_wrapper = 0;
139 my $opt_socket_wrapper_pcap = undef;
140 my $opt_socket_wrapper_keep_pcap = undef;
142 my $opt_immediate = 0;
143 my $opt_expected_failures = undef;
144 my @opt_exclude = ();
145 my @opt_include = ();
149 my $opt_analyse_cmd = undef;
150 my $opt_resetup_env = undef;
151 my $opt_bindir = undef;
152 my $opt_no_lazy_setup = undef;
153 my $opt_format = "plain";
160 my @expected_failures = ();
167 TESTS_UNEXPECTED_OK => 0,
168 TESTS_EXPECTED_OK => 0,
169 TESTS_UNEXPECTED_FAIL => 0,
170 TESTS_EXPECTED_FAIL => 0,
177 my ($list, $fullname) = @_;
180 if ($fullname =~ /$$_[0]/) {
181 return ($$_[1]) if ($$_[1]);
182 return "NO REASON SPECIFIED";
189 sub expecting_failure($)
192 return find_in_list(\@expected_failures, $name);
199 return find_in_list(\@excludes, $name);
206 my ($state, $name) = @_;
208 return unless ($opt_socket_wrapper_pcap);
209 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR});
212 $fname =~ s%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\-]%_%g;
214 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
216 SocketWrapper::setup_pcap($pcap_file);
221 sub cleanup_pcap($$$)
223 my ($pcap_file, $expected_ret, $ret) = @_;
225 return unless ($opt_socket_wrapper_pcap);
226 return if ($opt_socket_wrapper_keep_pcap);
227 return unless ($expected_ret == $ret);
228 return unless defined($pcap_file);
233 sub run_testsuite($$$$$$)
235 my ($envname, $name, $cmd, $i, $totalsuites, $msg_ops) = @_;
236 my $pcap_file = setup_pcap($name);
238 $msg_ops->start_test([], $name);
240 open(RESULT, "$cmd 2>&1|");
241 my $expected_ret = parse_results(
242 $msg_ops, $statistics, *RESULT, \&expecting_failure, [$name]);
244 my $envlog = getlog_env($envname);
245 $msg_ops->output_msg("ENVLOG: $envlog\n") if ($envlog ne "");
247 $msg_ops->output_msg("CMD: $cmd\n");
249 my $ret = close(RESULT);
250 $ret = 0 unless $ret == 1;
253 $msg_ops->end_test([], $name, "success", $expected_ret != $ret, undef);
255 $msg_ops->end_test([], $name, "failure", $expected_ret != $ret,
259 cleanup_pcap($pcap_file, $expected_ret, $ret);
261 if (not $opt_socket_wrapper_keep_pcap and
262 defined($pcap_file)) {
263 $msg_ops->output_msg("PCAP FILE: $pcap_file\n");
266 if ($ret != $expected_ret) {
267 $statistics->{SUITES_FAIL}++;
268 exit(1) if ($opt_one);
271 return ($ret == $expected_ret);
276 print "Samba test runner
277 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
279 Usage: $Script [OPTIONS] PREFIX
282 --help this help page
283 --target=samba4|samba3|win Samba version to target
284 --testlist=FILE file to read available tests from
287 --prefix=DIR prefix to run tests in [st]
288 --srcdir=DIR source directory [.]
289 --builddir=DIR output directory [.]
292 --socket-wrapper-pcap save traffic to pcap directories
293 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
295 --socket-wrapper enable socket wrapper
296 --expected-failures=FILE specify list of tests that is guaranteed to fail
299 --ldap=openldap|fedora-ds back smbd onto specified ldap server
302 --bindir=PATH path to binaries
305 --quick run quick overall test
306 --one abort when the first test fails
307 --immediate print test output for failed tests during run
309 --analyse-cmd CMD command to run after each test
314 my $result = GetOptions (
315 'help|h|?' => \$opt_help,
316 'target=s' => \$opt_target,
317 'prefix=s' => \$prefix,
318 'socket-wrapper' => \$opt_socket_wrapper,
319 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
320 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
321 'quick' => \$opt_quick,
323 'immediate' => \$opt_immediate,
324 'expected-failures=s' => \$opt_expected_failures,
325 'exclude=s' => \@opt_exclude,
326 'include=s' => \@opt_include,
327 'srcdir=s' => \$srcdir,
328 'builddir=s' => \$builddir,
329 'verbose' => \$opt_verbose,
330 'testenv' => \$opt_testenv,
332 'analyse-cmd=s' => \$opt_analyse_cmd,
333 'no-lazy-setup' => \$opt_no_lazy_setup,
334 'resetup-environment' => \$opt_resetup_env,
335 'bindir:s' => \$opt_bindir,
336 'format=s' => \$opt_format,
337 'testlist=s' => \@testlists
340 exit(1) if (not $result);
342 ShowHelp() if ($opt_help);
346 # quick hack to disable rpc validation when using valgrind - its way too slow
347 unless (defined($ENV{VALGRIND})) {
348 $ENV{VALIDATE} = "validate";
349 $ENV{MALLOC_CHECK_} = 2;
352 my $old_pwd = "$RealBin/..";
354 # Backwards compatibility:
355 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
356 if (defined($ENV{FEDORA_DS_ROOT})) {
363 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
366 $torture_maxtime *= 2;
373 die("using an empty prefix isn't allowed") unless $prefix ne "";
375 #Ensure we have the test prefix around
376 mkdir($prefix, 0777) unless -d $prefix;
378 my $prefix_abs = abs_path($prefix);
379 my $srcdir_abs = abs_path($srcdir);
381 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
382 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
384 $ENV{PREFIX} = $prefix;
385 $ENV{PREFIX_ABS} = $prefix_abs;
386 $ENV{SRCDIR} = $srcdir;
387 $ENV{SRCDIR_ABS} = $srcdir_abs;
389 if (defined($ENV{RUN_FROM_BUILD_FARM}) and
390 ($ENV{RUN_FROM_BUILD_FARM} eq "yes")) {
391 $opt_format = "buildfarm";
394 my $tls_enabled = not $opt_quick;
395 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
396 $ENV{LDB_MODULES_PATH} = "$old_pwd/bin/modules/ldb";
397 $ENV{LD_SAMBA_MODULE_PATH} = "$old_pwd/bin/modules";
398 if (defined($ENV{PKG_CONFIG_PATH})) {
399 $ENV{PKG_CONFIG_PATH} = "$old_pwd/bin/pkgconfig:$ENV{PKG_CONFIG_PATH}";
401 $ENV{PKG_CONFIG_PATH} = "$old_pwd/bin/pkgconfig";
403 # Required for smbscript:
404 $ENV{PATH} = "$old_pwd/bin:$old_pwd:$ENV{PATH}";
406 if ($opt_socket_wrapper_keep_pcap) {
407 # Socket wrapper keep pcap implies socket wrapper pcap
408 $opt_socket_wrapper_pcap = 1;
411 if ($opt_socket_wrapper_pcap) {
412 # Socket wrapper pcap implies socket wrapper
413 $opt_socket_wrapper = 1;
416 my $socket_wrapper_dir;
417 if ($opt_socket_wrapper) {
418 $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix/w", $opt_socket_wrapper_pcap);
419 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
421 warn("Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports") unless $< == 0;
425 my $testenv_default = "none";
427 if ($opt_target eq "samba4") {
428 $testenv_default = "member";
429 require target::Samba4;
430 $target = new Samba4($opt_bindir or "$srcdir/bin", $ldap, "$srcdir/setup");
431 } elsif ($opt_target eq "samba3") {
432 if ($opt_socket_wrapper and `$opt_bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
433 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
435 $testenv_default = "dc";
436 require target::Samba3;
437 $target = new Samba3($opt_bindir);
438 } elsif ($opt_target eq "win") {
439 die("Windows tests will not run with socket wrapper enabled.")
440 if ($opt_socket_wrapper);
441 $testenv_default = "dc";
442 require target::Windows;
443 $target = new Windows();
446 sub read_test_regexes($)
450 open(LF, "<$name") or die("unable to read $name: $!");
453 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
454 push (@ret, [$1, $4]);
456 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
457 push (@ret, [$_, undef]);
464 if (defined($opt_expected_failures)) {
465 @expected_failures = read_test_regexes($opt_expected_failures);
468 foreach (@opt_exclude) {
469 push (@excludes, read_test_regexes($_));
473 push (@includes, read_test_regexes("samba4-quick"));
476 foreach (@opt_include) {
477 push (@includes, read_test_regexes($_));
480 my $interfaces = join(',', ("127.0.0.6/8",
487 my $conffile = "$prefix_abs/client/client.conf";
489 sub write_clientconf($$)
491 my ($conffile, $vars) = @_;
493 mkdir("$prefix/client", 0777) unless -d "$prefix/client";
495 if ( -d "$prefix/client/private" ) {
496 unlink <$prefix/client/private/*>;
498 mkdir("$prefix/client/private", 0777);
501 open(CF, ">$conffile");
502 print CF "[global]\n";
503 if (defined($ENV{VALGRIND})) {
504 print CF "\ticonv:native = true\n";
506 print CF "\ticonv:native = false\n";
508 print CF "\tnetbios name = client\n";
509 if (defined($vars->{DOMAIN})) {
510 print CF "\tworkgroup = $vars->{DOMAIN}\n";
512 if (defined($vars->{REALM})) {
513 print CF "\trealm = $vars->{REALM}\n";
515 if (defined($vars->{NCALRPCDIR})) {
516 print CF "\tncalrpc dir = $vars->{NCALRPCDIR}\n";
518 if (defined($vars->{PIDDIR})) {
519 print CF "\tpid directory = $vars->{PIDDIR}\n";
521 if (defined($vars->{WINBINDD_SOCKET_DIR})) {
522 print CF "\twinbindd socket directory = $vars->{WINBINDD_SOCKET_DIR}\n";
525 private dir = $prefix_abs/client/private
526 js include = $srcdir_abs/scripting/libjs
527 name resolve order = bcast
528 interfaces = $interfaces
529 panic action = $srcdir_abs/script/gdb_backtrace \%PID\% \%PROG\%
531 notify:inotify = false
533 system:anonymous = true
534 torture:basedir = $prefix_abs/client
535 #We don't want to pass our self-tests if the PAC code is wrong
536 gensec:require_pac = true
537 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
542 my @torture_options = ();
543 push (@torture_options, "--configfile=$conffile");
544 # ensure any one smbtorture call doesn't run too long
545 push (@torture_options, "--maximum-runtime=$torture_maxtime");
546 push (@torture_options, "--target=$opt_target");
547 push (@torture_options, "--basedir=$prefix_abs");
548 push (@torture_options, "--option=torture:progress=no") if ($opt_format eq "buildfarm");
549 push (@torture_options, "--format=subunit");
550 push (@torture_options, "--option=torture:quick=yes") if ($opt_quick);
552 $ENV{TORTURE_OPTIONS} = join(' ', @torture_options);
553 print "OPTIONS $ENV{TORTURE_OPTIONS}\n";
557 my $testsdir = "$srcdir/selftest";
558 $ENV{SMB_CONF_PATH} = "$conffile";
559 $ENV{CONFIGURATION} = "--configfile=$conffile";
561 my %required_envs = ();
568 open(IN, $filename) or die("Unable to open $filename: $!");
571 if ($_ eq "-- TEST --\n") {
578 if (not defined($tests) or $name =~ /$tests/) {
579 $required_envs{$env} = 1;
580 push (@ret, [$name, $env, $cmdline]);
586 close(IN) or die("Error creating recipe");
590 if ($#testlists == -1) {
591 die("No testlists specified");
595 foreach my $fn (@testlists) {
596 foreach (read_testlist($fn)) {
598 next if (@includes and not find_in_list(\@includes, $name));
599 push (@available, $_);
604 if ($opt_format eq "buildfarm") {
605 require output::buildfarm;
606 $msg_ops = new output::buildfarm($statistics);
607 } elsif ($opt_format eq "plain") {
608 require output::plain;
609 $msg_ops = new output::plain("$prefix/summary", $opt_verbose, $opt_immediate, $statistics, $#available+1);
610 } elsif ($opt_format eq "html") {
611 require output::html;
612 mkdir("test-results", 0777);
613 $msg_ops = new output::html("test-results", $statistics);
615 die("Invalid output format '$opt_format'");
619 foreach (@available) {
621 my $skipreason = skip($name);
623 $msg_ops->skip_testsuite($name, $skipreason);
630 print STDERR "No tests to run\n";
634 my $suitestotal = $#todo + 1;
638 my %running_envs = ();
640 my @exported_envvars = (
645 # domain controller stuff
665 "WINBINDD_SOCKET_DIR",
666 "WINBINDD_PRIV_PIPE_DIR"
669 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
671 teardown_env($_) foreach(keys %running_envs);
672 die("Received signal $signame");
680 if ($envname eq "none") {
682 } elsif (defined($running_envs{$envname})) {
683 $testenv_vars = $running_envs{$envname};
684 if (not $target->check_env($testenv_vars)) {
685 $testenv_vars = undef;
688 $testenv_vars = $target->setup_env($envname, $prefix);
691 return undef unless defined($testenv_vars);
693 $running_envs{$envname} = $testenv_vars;
695 SocketWrapper::set_default_iface(6);
696 write_clientconf($conffile, $testenv_vars);
698 foreach (@exported_envvars) {
699 if (defined($testenv_vars->{$_})) {
700 $ENV{$_} = $testenv_vars->{$_};
706 return $testenv_vars;
709 sub exported_envvars_str($)
711 my ($testenv_vars) = @_;
714 foreach (@exported_envvars) {
715 next unless defined($testenv_vars->{$_});
716 $out .= $_."=".$testenv_vars->{$_}."\n";
725 return "" if ($envname eq "none");
726 return $target->getlog_env($running_envs{$envname});
732 return 1 if ($envname eq "none");
733 return $target->check_env($running_envs{$envname});
739 return if ($envname eq "none");
740 $target->teardown_env($running_envs{$envname});
741 delete $running_envs{$envname};
744 if ($opt_no_lazy_setup) {
745 setup_env($_) foreach (keys %required_envs);
749 my $testenv_name = $ENV{SELFTEST_TESTENV};
750 $testenv_name = $testenv_default unless defined($testenv_name);
752 my $testenv_vars = setup_env($testenv_name);
754 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
756 my $envvarstr = exported_envvars_str($testenv_vars);
758 my $term = ($ENV{TERM} or "xterm");
759 system("$term -e 'echo -e \"
760 Welcome to the Samba4 Test environment '$testenv_name'
762 This matches the client environment used in make test
763 smbd is pid `cat \$PIDDIR/smbd.pid`
765 Some useful environment variables:
766 TORTURE_OPTIONS=\$TORTURE_OPTIONS
767 CONFIGURATION=\$CONFIGURATION
770 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
771 teardown_env($testenv_name);
776 $cmd =~ s/([\(\)])/\\$1/g;
778 my $envname = $$_[1];
780 my $envvars = setup_env($envname);
781 if (not defined($envvars)) {
782 $msg_ops->skip_testsuite($name, "unable to set up environment $envname");
786 run_testsuite($envname, $name, $cmd, $i, $suitestotal,
789 if (defined($opt_analyse_cmd)) {
790 system("$opt_analyse_cmd \"$name\"");
793 teardown_env($envname) if ($opt_resetup_env);
799 teardown_env($_) foreach (keys %running_envs);
807 # if there were any valgrind failures, show them
808 foreach (<$prefix/valgrind.log*>) {
810 system("grep DWARF2.CFI.reader $_ > /dev/null");
812 print "VALGRIND FAILURE\n";
818 if ($opt_format eq "buildfarm") {
819 print "TEST STATUS: $statistics->{SUITES_FAIL}\n";
822 exit $statistics->{SUITES_FAIL};