2 # Bootstrap Samba and run a number of tests against it.
3 # Copyright (C) 2005-2009 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);
130 use Cwd qw(abs_path);
132 use Subunit
qw(parse_results);
137 my $opt_target = "samba4";
139 my $opt_socket_wrapper = 0;
140 my $opt_socket_wrapper_pcap = undef;
141 my $opt_socket_wrapper_keep_pcap = undef;
143 my @opt_exclude = ();
144 my @opt_include = ();
146 my $opt_image = undef;
149 my $opt_analyse_cmd = undef;
150 my $opt_resetup_env = undef;
151 my $opt_bindir = undef;
152 my $opt_no_lazy_setup = undef;
165 my ($list, $fullname) = @_;
168 if ($fullname =~ /$$_[0]/) {
169 return ($$_[1]) if ($$_[1]);
181 return find_in_list
(\
@excludes, $name);
190 return unless ($opt_socket_wrapper_pcap);
191 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR
});
194 $fname =~ s
%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\
-]%_%g;
196 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
198 SocketWrapper
::setup_pcap
($pcap_file);
205 my ($pcap_file, $exitcode) = @_;
207 return unless ($opt_socket_wrapper_pcap);
208 return if ($opt_socket_wrapper_keep_pcap);
209 return unless ($exitcode == 0);
210 return unless defined($pcap_file);
215 sub run_testsuite
($$$$$)
217 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
218 my $pcap_file = setup_pcap
($name);
220 Subunit
::start_testsuite
($name);
221 Subunit
::report_time
(time());
223 open(RESULTS
, "$cmd 2>&1|");
225 TESTS_UNEXPECTED_OK
=> 0,
226 TESTS_EXPECTED_OK
=> 0,
227 TESTS_UNEXPECTED_FAIL
=> 0,
228 TESTS_EXPECTED_FAIL
=> 0,
233 my $msg_ops = new Subunit
::Filter
("$name\.", []);
235 parse_results
($msg_ops, $statistics, *RESULTS
);
239 unless (close(RESULTS
)) {
241 Subunit
::end_testsuite
($name, "error", "Unable to run $cmd: $!");
249 Subunit
::end_testsuite
($name, "error", sprintf("Testsuite died with signal %d, %s coredump", ($ret & 127), ($ret & 128) ?
"with": "without"));
252 my $envlog = getlog_env
($envname);
254 print "envlog: $envlog\n";
257 print "command: $cmd\n";
259 my $exitcode = $ret >> 8;
261 Subunit
::report_time
(time());
262 if ($exitcode == 0) {
263 Subunit
::end_testsuite
($name, "success");
265 Subunit
::end_testsuite
($name, "failure", "Exit code was $exitcode");
268 cleanup_pcap
($pcap_file, $exitcode);
270 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
271 print "PCAP FILE: $pcap_file\n";
274 if ($exitcode != 0) {
275 exit(1) if ($opt_one);
283 print "Samba test runner
284 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
285 Copyright (C) Stefan Metzmacher <metze\@samba.org>
287 Usage: $Script [OPTIONS] TESTNAME-REGEX
290 --help this help page
291 --target=samba[34]|win|kvm Samba version to target
292 --testlist=FILE file to read available tests from
295 --prefix=DIR prefix to run tests in [st]
296 --srcdir=DIR source directory [.]
297 --builddir=DIR output directory [.]
298 --exeext=EXT executable extention []
301 --socket-wrapper-pcap save traffic to pcap directories
302 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
304 --socket-wrapper enable socket wrapper
305 --bindir=PATH path to target binaries
308 --ldap=openldap|fedora-ds back samba onto specified ldap server
311 --image=PATH path to KVM image
314 --quick run quick overall test
315 --one abort when the first test fails
317 --analyse-cmd CMD command to run after each test
322 my $result = GetOptions
(
323 'help|h|?' => \
$opt_help,
324 'target=s' => \
$opt_target,
325 'prefix=s' => \
$prefix,
326 'socket-wrapper' => \
$opt_socket_wrapper,
327 'socket-wrapper-pcap' => \
$opt_socket_wrapper_pcap,
328 'socket-wrapper-keep-pcap' => \
$opt_socket_wrapper_keep_pcap,
329 'quick' => \
$opt_quick,
331 'exclude=s' => \
@opt_exclude,
332 'include=s' => \
@opt_include,
333 'srcdir=s' => \
$srcdir,
334 'builddir=s' => \
$builddir,
335 'exeext=s' => \
$exeext,
336 'verbose' => \
$opt_verbose,
337 'testenv' => \
$opt_testenv,
339 'analyse-cmd=s' => \
$opt_analyse_cmd,
340 'no-lazy-setup' => \
$opt_no_lazy_setup,
341 'resetup-environment' => \
$opt_resetup_env,
342 'bindir:s' => \
$opt_bindir,
343 'image=s' => \
$opt_image,
344 'testlist=s' => \
@testlists
347 exit(1) if (not $result);
349 ShowHelp
() if ($opt_help);
353 # quick hack to disable rpc validation when using valgrind - its way too slow
354 unless (defined($ENV{VALGRIND
})) {
355 $ENV{VALIDATE
} = "validate";
356 $ENV{MALLOC_CHECK_
} = 2;
359 # make all our python scripts unbuffered
360 $ENV{PYTHONUNBUFFERED
} = 1;
362 my $bindir = ($opt_bindir or "$builddir/bin");
363 my $bindir_abs = abs_path
($bindir);
365 # Backwards compatibility:
366 if (defined($ENV{TEST_LDAP
}) and $ENV{TEST_LDAP
} eq "yes") {
367 if (defined($ENV{FEDORA_DS_ROOT
})) {
374 my $torture_maxtime = ($ENV{TORTURE_MAXTIME
} or 1200);
377 $torture_maxtime *= 2;
384 die("using an empty prefix isn't allowed") unless $prefix ne "";
386 #Ensure we have the test prefix around
387 mkdir($prefix, 0777) unless -d
$prefix;
389 my $prefix_abs = abs_path
($prefix);
390 my $srcdir_abs = abs_path
($srcdir);
391 my $builddir_abs = abs_path
($builddir);
393 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
394 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
396 $ENV{PREFIX
} = $prefix;
397 $ENV{KRB5CCNAME
} = "$prefix/krb5ticket";
398 $ENV{PREFIX_ABS
} = $prefix_abs;
399 $ENV{SRCDIR
} = $srcdir;
400 $ENV{SRCDIR_ABS
} = $srcdir_abs;
401 $ENV{BUILDDIR
} = $builddir;
402 $ENV{BUILDDIR_ABS
} = $builddir_abs;
403 $ENV{EXEEXT
} = $exeext;
405 my $tls_enabled = not $opt_quick;
406 $ENV{TLS_ENABLED
} = ($tls_enabled?
"yes":"no");
407 $ENV{LDB_MODULES_PATH
} = "$bindir_abs/modules/ldb";
408 $ENV{LD_SAMBA_MODULE_PATH
} = "$bindir_abs/modules";
409 sub prefix_pathvar
($$)
411 my ($name, $newpath) = @_;
412 if (defined($ENV{$name})) {
413 $ENV{$name} = "$newpath:$ENV{$name}";
415 $ENV{$name} = $newpath;
418 prefix_pathvar
("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
419 prefix_pathvar
("PYTHONPATH", "$bindir_abs/python");
421 if ($opt_socket_wrapper_keep_pcap) {
422 # Socket wrapper keep pcap implies socket wrapper pcap
423 $opt_socket_wrapper_pcap = 1;
426 if ($opt_socket_wrapper_pcap) {
427 # Socket wrapper pcap implies socket wrapper
428 $opt_socket_wrapper = 1;
431 my $socket_wrapper_dir;
432 if ($opt_socket_wrapper) {
433 $socket_wrapper_dir = SocketWrapper
::setup_dir
("$prefix/w", $opt_socket_wrapper_pcap);
434 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
437 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
442 my $testenv_default = "none";
444 if ($opt_target eq "samba4") {
445 $testenv_default = "member";
446 require target
::Samba4
;
447 $target = new Samba4
($bindir, $ldap, "$srcdir/setup", $exeext);
448 } elsif ($opt_target eq "samba3") {
449 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
450 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
452 $testenv_default = "member";
453 require target
::Samba3
;
454 $target = new Samba3
($bindir);
455 } elsif ($opt_target eq "win") {
456 die("Windows tests will not run with socket wrapper enabled.")
457 if ($opt_socket_wrapper);
458 $testenv_default = "dc";
459 require target
::Windows
;
460 $target = new Windows
();
461 } elsif ($opt_target eq "kvm") {
462 die("Kvm tests will not run with socket wrapper enabled.")
463 if ($opt_socket_wrapper);
465 die("No image specified") unless ($opt_image);
466 $target = new Kvm
($opt_image, undef);
470 # Start a Virtual Distributed Ethernet Switch
471 # Returns the pid of the switch.
473 sub start_vde_switch
($)
477 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
479 open(PID
, "$path/vde.pid");
487 # Stop a Virtual Distributed Ethernet Switch
488 sub stop_vde_switch
($)
494 sub read_test_regexes
($)
498 open(LF
, "<$name") or die("unable to read $name: $!");
502 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
503 push (@ret, [$1, $4]);
505 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
506 push (@ret, [$_, undef]);
513 foreach (@opt_exclude) {
514 push (@excludes, read_test_regexes
($_));
517 foreach (@opt_include) {
518 push (@includes, read_test_regexes
($_));
521 my $interfaces = join(',', ("127.0.0.6/8",
528 my $conffile = "$prefix_abs/client/client.conf";
529 $ENV{SMB_CONF_PATH
} = $conffile;
531 sub write_clientconf
($$)
533 my ($conffile, $vars) = @_;
535 mkdir("$prefix/client", 0777) unless -d
"$prefix/client";
537 if ( -d
"$prefix/client/private" ) {
538 unlink <$prefix/client/private
/*>;
540 mkdir("$prefix/client/private", 0777);
543 if ( -d
"$prefix/client/lockdir" ) {
544 unlink <$prefix/client/lockdir
/*>;
546 mkdir("$prefix/client/lockdir", 0777);
549 if ( -d
"$prefix_abs/client/ncalrpcdir" ) {
550 unlink <$prefix/client/ncalrpcdir
/*>;
552 mkdir("$prefix/client/ncalrpcdir", 0777);
555 open(CF
, ">$conffile");
556 print CF
"[global]\n";
557 if (defined($ENV{VALGRIND
})) {
558 print CF
"\ticonv:native = true\n";
560 print CF
"\ticonv:native = false\n";
562 print CF
"\tnetbios name = client\n";
563 if (defined($vars->{DOMAIN
})) {
564 print CF
"\tworkgroup = $vars->{DOMAIN}\n";
566 if (defined($vars->{REALM
})) {
567 print CF
"\trealm = $vars->{REALM}\n";
569 if ($opt_socket_wrapper) {
570 print CF
"\tinterfaces = $interfaces\n";
573 private dir = $prefix_abs/client/private
574 lock dir = $prefix_abs/client/lockdir
575 ncalrpc dir = $prefix_abs/client/ncalrpcdir
576 name resolve order = bcast
577 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
579 notify:inotify = false
581 system:anonymous = true
582 client lanman auth = Yes
583 torture:basedir = $prefix_abs/client
584 #We don't want to pass our self-tests if the PAC code is wrong
585 gensec:require_pac = true
586 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
593 my $testsdir = "$srcdir/selftest";
595 my %required_envs = ();
597 sub should_run_test
($)
603 for (my $i=0; $i <= $#tests; $i++) {
604 if ($name =~ /$tests[$i]/i) {
616 open(IN
, $filename) or die("Unable to open $filename: $!");
619 if ($_ eq "-- TEST --\n") {
626 if (should_run_test
($name) == 1) {
627 $required_envs{$env} = 1;
628 push (@ret, [$name, $env, $cmdline]);
634 close(IN
) or die("Error creating recipe");
638 if ($#testlists == -1) {
639 die("No testlists specified");
642 $ENV{SELFTEST_PREFIX
} = "$prefix_abs";
643 if ($opt_socket_wrapper) {
644 $ENV{SELFTEST_INTERFACES
} = $interfaces;
646 $ENV{SELFTEST_INTERFACES
} = "";
649 $ENV{SELFTEST_VERBOSE
} = "1";
651 $ENV{SELFTEST_VERBOSE
} = "";
654 $ENV{SELFTEST_QUICK
} = "1";
656 $ENV{SELFTEST_QUICK
} = "";
658 $ENV{SELFTEST_TARGET
} = $opt_target;
659 $ENV{SELFTEST_MAXTIME
} = $torture_maxtime;
662 foreach my $fn (@testlists) {
663 foreach (read_testlist
($fn)) {
665 next if (@includes and not defined(find_in_list
(\
@includes, $name)));
666 push (@available, $_);
670 Subunit
::testsuite_count
($#available+1);
671 Subunit
::report_time
(time());
673 foreach (@available) {
675 my $skipreason = skip
($name);
676 if (defined($skipreason)) {
677 Subunit
::skip_testsuite
($name, $skipreason);
684 print STDERR
"No tests to run\n";
688 my $suitestotal = $#todo + 1;
692 my %running_envs = ();
694 sub get_running_env
($)
702 return $running_envs{$envname};
705 my @exported_envvars = (
710 # domain controller stuff
730 "WINBINDD_SOCKET_DIR",
731 "WINBINDD_PRIV_PIPE_DIR"
734 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub {
736 teardown_env
($_) foreach(keys %running_envs);
737 die("Received signal $signame");
744 my $testenv_vars = undef;
750 $option =~ s/^[^:]*//;
753 $option = "client" if $option eq "";
755 if ($envname eq "none") {
757 } elsif (defined(get_running_env
($envname))) {
758 $testenv_vars = get_running_env
($envname);
759 if (not $target->check_env($testenv_vars)) {
760 $testenv_vars = undef;
763 $testenv_vars = $target->setup_env($envname, $prefix);
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
(6);
775 write_clientconf
($conffile, $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 return $target->getlog_env(get_running_env
($envname));
815 return 1 if ($envname eq "none");
816 return $target->check_env(get_running_env
($envname));
822 return if ($envname eq "none");
823 $target->teardown_env(get_running_env
($envname));
824 delete $running_envs{$envname};
827 if ($opt_no_lazy_setup) {
828 setup_env
($_) foreach (keys %required_envs);
832 my $testenv_name = $ENV{SELFTEST_TESTENV
};
833 $testenv_name = $testenv_default unless defined($testenv_name);
835 my $testenv_vars = setup_env
($testenv_name);
837 $ENV{PIDDIR
} = $testenv_vars->{PIDDIR
};
839 my $envvarstr = exported_envvars_str
($testenv_vars);
841 my $term = ($ENV{TERMINAL
} or "xterm");
842 system("$term -e 'echo -e \"
843 Welcome to the Samba4 Test environment '$testenv_name'
845 This matches the client environment used in make test
846 server is pid `cat \$PIDDIR/samba.pid`
848 Some useful environment variables:
849 TORTURE_OPTIONS=\$TORTURE_OPTIONS
850 SMB_CONF_PATH=\$SMB_CONF_PATH
853 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
854 teardown_env
($testenv_name);
859 $cmd =~ s/([\(\)])/\\$1/g;
861 my $envname = $$_[1];
863 my $envvars = setup_env
($envname);
864 if (not defined($envvars)) {
865 Subunit
::skip_testsuite
($name,
866 "unable to set up environment $envname");
870 run_testsuite
($envname, $name, $cmd, $i, $suitestotal);
872 if (defined($opt_analyse_cmd)) {
873 system("$opt_analyse_cmd \"$name\"");
876 teardown_env
($envname) if ($opt_resetup_env);
882 teardown_env
($_) foreach (keys %running_envs);
888 # if there were any valgrind failures, show them
889 foreach (<$prefix/valgrind
.log*>) {
891 print "VALGRIND FAILURE\n";