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 my $bindir = ($opt_bindir or "$builddir/bin");
360 my $bindir_abs = abs_path($bindir);
362 # Backwards compatibility:
363 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
364 if (defined($ENV{FEDORA_DS_ROOT})) {
371 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
374 $torture_maxtime *= 2;
381 die("using an empty prefix isn't allowed") unless $prefix ne "";
383 #Ensure we have the test prefix around
384 mkdir($prefix, 0777) unless -d $prefix;
386 my $prefix_abs = abs_path($prefix);
387 my $srcdir_abs = abs_path($srcdir);
388 my $builddir_abs = abs_path($builddir);
390 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
391 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
393 $ENV{PREFIX} = $prefix;
394 $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
395 $ENV{PREFIX_ABS} = $prefix_abs;
396 $ENV{SRCDIR} = $srcdir;
397 $ENV{SRCDIR_ABS} = $srcdir_abs;
398 $ENV{BUILDDIR} = $builddir;
399 $ENV{BUILDDIR_ABS} = $builddir_abs;
400 $ENV{EXEEXT} = $exeext;
402 my $tls_enabled = not $opt_quick;
403 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
404 $ENV{LDB_MODULES_PATH} = "$bindir_abs/modules/ldb";
405 $ENV{LD_SAMBA_MODULE_PATH} = "$bindir_abs/modules";
406 sub prefix_pathvar($$)
408 my ($name, $newpath) = @_;
409 if (defined($ENV{$name})) {
410 $ENV{$name} = "$newpath:$ENV{$name}";
412 $ENV{$name} = $newpath;
415 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
416 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
418 if ($opt_socket_wrapper_keep_pcap) {
419 # Socket wrapper keep pcap implies socket wrapper pcap
420 $opt_socket_wrapper_pcap = 1;
423 if ($opt_socket_wrapper_pcap) {
424 # Socket wrapper pcap implies socket wrapper
425 $opt_socket_wrapper = 1;
428 my $socket_wrapper_dir;
429 if ($opt_socket_wrapper) {
430 $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix/w", $opt_socket_wrapper_pcap);
431 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
434 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
439 my $testenv_default = "none";
441 if ($opt_target eq "samba4") {
442 $testenv_default = "member";
443 require target::Samba4;
444 $target = new Samba4($bindir, $ldap, "$srcdir/setup", $exeext);
445 } elsif ($opt_target eq "samba3") {
446 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
447 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
449 $testenv_default = "member";
450 require target::Samba3;
451 $target = new Samba3($bindir);
452 } elsif ($opt_target eq "win") {
453 die("Windows tests will not run with socket wrapper enabled.")
454 if ($opt_socket_wrapper);
455 $testenv_default = "dc";
456 require target::Windows;
457 $target = new Windows();
458 } elsif ($opt_target eq "kvm") {
459 die("Kvm tests will not run with socket wrapper enabled.")
460 if ($opt_socket_wrapper);
462 die("No image specified") unless ($opt_image);
463 $target = new Kvm($opt_image, undef);
467 # Start a Virtual Distributed Ethernet Switch
468 # Returns the pid of the switch.
470 sub start_vde_switch($)
474 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
476 open(PID, "$path/vde.pid");
484 # Stop a Virtual Distributed Ethernet Switch
485 sub stop_vde_switch($)
491 sub read_test_regexes($)
495 open(LF, "<$name") or die("unable to read $name: $!");
499 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
500 push (@ret, [$1, $4]);
502 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
503 push (@ret, [$_, undef]);
510 foreach (@opt_exclude) {
511 push (@excludes, read_test_regexes($_));
514 foreach (@opt_include) {
515 push (@includes, read_test_regexes($_));
518 my $interfaces = join(',', ("127.0.0.6/8",
525 my $conffile = "$prefix_abs/client/client.conf";
526 $ENV{SMB_CONF_PATH} = $conffile;
528 sub write_clientconf($$)
530 my ($conffile, $vars) = @_;
532 mkdir("$prefix/client", 0777) unless -d "$prefix/client";
534 if ( -d "$prefix/client/private" ) {
535 unlink <$prefix/client/private/*>;
537 mkdir("$prefix/client/private", 0777);
540 if ( -d "$prefix/client/lockdir" ) {
541 unlink <$prefix/client/lockdir/*>;
543 mkdir("$prefix/client/lockdir", 0777);
546 if ( -d "$prefix_abs/client/ncalrpcdir" ) {
547 unlink <$prefix/client/ncalrpcdir/*>;
549 mkdir("$prefix/client/ncalrpcdir", 0777);
552 open(CF, ">$conffile");
553 print CF "[global]\n";
554 if (defined($ENV{VALGRIND})) {
555 print CF "\ticonv:native = true\n";
557 print CF "\ticonv:native = false\n";
559 print CF "\tnetbios name = client\n";
560 if (defined($vars->{DOMAIN})) {
561 print CF "\tworkgroup = $vars->{DOMAIN}\n";
563 if (defined($vars->{REALM})) {
564 print CF "\trealm = $vars->{REALM}\n";
566 if ($opt_socket_wrapper) {
567 print CF "\tinterfaces = $interfaces\n";
570 private dir = $prefix_abs/client/private
571 lock dir = $prefix_abs/client/lockdir
572 ncalrpc dir = $prefix_abs/client/ncalrpcdir
573 name resolve order = bcast
574 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
576 notify:inotify = false
578 system:anonymous = true
579 client lanman auth = Yes
580 torture:basedir = $prefix_abs/client
581 #We don't want to pass our self-tests if the PAC code is wrong
582 gensec:require_pac = true
583 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
590 my $testsdir = "$srcdir/selftest";
592 my %required_envs = ();
599 open(IN, $filename) or die("Unable to open $filename: $!");
602 if ($_ eq "-- TEST --\n") {
609 if (not defined($tests) or $name =~ /$tests/) {
610 $required_envs{$env} = 1;
611 push (@ret, [$name, $env, $cmdline]);
617 close(IN) or die("Error creating recipe");
621 if ($#testlists == -1) {
622 die("No testlists specified");
625 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
626 if ($opt_socket_wrapper) {
627 $ENV{SELFTEST_INTERFACES} = $interfaces;
629 $ENV{SELFTEST_INTERFACES} = "";
632 $ENV{SELFTEST_VERBOSE} = "1";
634 $ENV{SELFTEST_VERBOSE} = "";
637 $ENV{SELFTEST_QUICK} = "1";
639 $ENV{SELFTEST_QUICK} = "";
641 $ENV{SELFTEST_TARGET} = $opt_target;
642 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
645 foreach my $fn (@testlists) {
646 foreach (read_testlist($fn)) {
648 next if (@includes and not defined(find_in_list(\@includes, $name)));
649 push (@available, $_);
653 Subunit::testsuite_count($#available+1);
654 Subunit::report_time(time());
656 foreach (@available) {
658 my $skipreason = skip($name);
659 if (defined($skipreason)) {
660 Subunit::skip_testsuite($name, $skipreason);
667 print STDERR "No tests to run\n";
671 my $suitestotal = $#todo + 1;
675 my %running_envs = ();
677 sub get_running_env($)
685 return $running_envs{$envname};
688 my @exported_envvars = (
693 # domain controller stuff
713 "WINBINDD_SOCKET_DIR",
714 "WINBINDD_PRIV_PIPE_DIR"
717 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
719 teardown_env($_) foreach(keys %running_envs);
720 die("Received signal $signame");
727 my $testenv_vars = undef;
733 $option =~ s/^[^:]*//;
736 $option = "client" if $option eq "";
738 if ($envname eq "none") {
740 } elsif (defined(get_running_env($envname))) {
741 $testenv_vars = get_running_env($envname);
742 if (not $target->check_env($testenv_vars)) {
743 $testenv_vars = undef;
746 $testenv_vars = $target->setup_env($envname, $prefix);
749 return undef unless defined($testenv_vars);
751 $running_envs{$envname} = $testenv_vars;
753 if ($option eq "local") {
754 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
755 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
756 } elsif ($option eq "client") {
757 SocketWrapper::set_default_iface(6);
758 write_clientconf($conffile, $testenv_vars);
759 $ENV{SMB_CONF_PATH} = $conffile;
761 die("Unknown option[$option] for envname[$envname]");
764 foreach (@exported_envvars) {
765 if (defined($testenv_vars->{$_})) {
766 $ENV{$_} = $testenv_vars->{$_};
772 return $testenv_vars;
775 sub exported_envvars_str($)
777 my ($testenv_vars) = @_;
780 foreach (@exported_envvars) {
781 next unless defined($testenv_vars->{$_});
782 $out .= $_."=".$testenv_vars->{$_}."\n";
791 return "" if ($envname eq "none");
792 return $target->getlog_env(get_running_env($envname));
798 return 1 if ($envname eq "none");
799 return $target->check_env(get_running_env($envname));
805 return if ($envname eq "none");
806 $target->teardown_env(get_running_env($envname));
807 delete $running_envs{$envname};
810 if ($opt_no_lazy_setup) {
811 setup_env($_) foreach (keys %required_envs);
815 my $testenv_name = $ENV{SELFTEST_TESTENV};
816 $testenv_name = $testenv_default unless defined($testenv_name);
818 my $testenv_vars = setup_env($testenv_name);
820 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
822 my $envvarstr = exported_envvars_str($testenv_vars);
824 my $term = ($ENV{TERM} or "xterm");
825 system("$term -e 'echo -e \"
826 Welcome to the Samba4 Test environment '$testenv_name'
828 This matches the client environment used in make test
829 server is pid `cat \$PIDDIR/samba.pid`
831 Some useful environment variables:
832 TORTURE_OPTIONS=\$TORTURE_OPTIONS
833 SMB_CONF_PATH=\$SMB_CONF_PATH
836 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
837 teardown_env($testenv_name);
842 $cmd =~ s/([\(\)])/\\$1/g;
844 my $envname = $$_[1];
846 my $envvars = setup_env($envname);
847 if (not defined($envvars)) {
848 Subunit::skip_testsuite($name,
849 "unable to set up environment $envname");
853 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
855 if (defined($opt_analyse_cmd)) {
856 system("$opt_analyse_cmd \"$name\"");
859 teardown_env($envname) if ($opt_resetup_env);
865 teardown_env($_) foreach (keys %running_envs);
871 # if there were any valgrind failures, show them
872 foreach (<$prefix/valgrind.log*>) {
874 system("grep DWARF2.CFI.reader $_ > /dev/null");
876 print "VALGRIND FAILURE\n";