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/>.
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);
128 use File::Temp qw(tempfile);
131 use Cwd
qw(abs_path);
138 Time
::HiRes
->import("time");
141 print "You don't have Time::Hires installed !\n";
145 my $opt_target = "samba4";
147 my $opt_socket_wrapper = 0;
148 my $opt_socket_wrapper_pcap = undef;
149 my $opt_socket_wrapper_keep_pcap = undef;
151 my @opt_exclude = ();
152 my @opt_include = ();
154 my $opt_image = undef;
158 my $opt_resetup_env = undef;
159 my $opt_bindir = undef;
160 my $opt_load_list = undef;
173 print STDERR
"Exiting early because of SIGPIPE.\n";
177 $SIG{PIPE
} = \
&pipe_handler
;
181 my ($list, $fullname) = @_;
184 if ($fullname =~ /$$_[0]/) {
185 return ($$_[1]) if ($$_[1]);
197 return find_in_list
(\
@excludes, $name);
206 return unless ($opt_socket_wrapper_pcap);
207 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR
});
210 $fname =~ s
%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\
-]%_%g;
212 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
214 SocketWrapper
::setup_pcap
($pcap_file);
221 my ($pcap_file, $exitcode) = @_;
223 return unless ($opt_socket_wrapper_pcap);
224 return if ($opt_socket_wrapper_keep_pcap);
225 return unless ($exitcode == 0);
226 return unless defined($pcap_file);
231 # expand strings from %ENV
232 sub expand_environment_strings
($)
235 # we use a reverse sort so we do the longer ones first
236 foreach my $k (sort { $b cmp $a } keys %ENV) {
237 $s =~ s/\$$k/$ENV{$k}/g;
242 sub run_testsuite
($$$$$)
244 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
245 my $pcap_file = setup_pcap
($name);
247 Subunit
::start_testsuite
($name);
248 Subunit
::progress_push
();
249 Subunit
::report_time
(time());
251 Subunit
::report_time
(time());
252 Subunit
::progress_pop
();
255 Subunit
::progress_pop
();
256 Subunit
::end_testsuite
($name, "error", "Unable to run $cmd: $!");
259 Subunit
::end_testsuite
($name, "error",
260 sprintf("%s died with signal %d, %s coredump\n", $cmd, ($?
& 127), ($?
& 128) ?
'with' : 'without'));
264 my $exitcode = $?
>> 8;
266 my $envlog = getlog_env
($envname);
268 print "envlog: $envlog\n";
271 print "command: $cmd\n";
272 printf "expanded command: %s\n", expand_environment_strings
($cmd);
274 if ($exitcode == 0) {
275 Subunit
::end_testsuite
($name, "success");
277 Subunit
::end_testsuite
($name, "failure", "Exit code was $exitcode");
280 cleanup_pcap
($pcap_file, $exitcode);
282 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
283 print "PCAP FILE: $pcap_file\n";
286 if ($exitcode != 0) {
287 exit(1) if ($opt_one);
295 print "Samba test runner
296 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
297 Copyright (C) Stefan Metzmacher <metze\@samba.org>
299 Usage: $Script [OPTIONS] TESTNAME-REGEX
302 --help this help page
303 --target=samba[34]|win|kvm Samba version to target
304 --testlist=FILE file to read available tests from
307 --prefix=DIR prefix to run tests in [st]
308 --srcdir=DIR source directory [.]
309 --builddir=DIR output directory [.]
310 --exeext=EXT executable extention []
313 --socket-wrapper-pcap save traffic to pcap directories
314 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
316 --socket-wrapper enable socket wrapper
317 --bindir=PATH path to target binaries
320 --ldap=openldap|fedora-ds back samba onto specified ldap server
323 --image=PATH path to KVM image
326 --quick run quick overall test
327 --one abort when the first test fails
329 --testenv run a shell in the requested test environment
330 --list list available tests
335 my $result = GetOptions
(
336 'help|h|?' => \
$opt_help,
337 'target=s' => \
$opt_target,
338 'prefix=s' => \
$prefix,
339 'socket-wrapper' => \
$opt_socket_wrapper,
340 'socket-wrapper-pcap' => \
$opt_socket_wrapper_pcap,
341 'socket-wrapper-keep-pcap' => \
$opt_socket_wrapper_keep_pcap,
342 'quick' => \
$opt_quick,
344 'exclude=s' => \
@opt_exclude,
345 'include=s' => \
@opt_include,
346 'srcdir=s' => \
$srcdir,
347 'builddir=s' => \
$builddir,
348 'exeext=s' => \
$exeext,
349 'verbose' => \
$opt_verbose,
350 'testenv' => \
$opt_testenv,
351 'list' => \
$opt_list,
353 'resetup-environment' => \
$opt_resetup_env,
354 'bindir:s' => \
$opt_bindir,
355 'image=s' => \
$opt_image,
356 'testlist=s' => \
@testlists,
357 'load-list=s' => \
$opt_load_list,
360 exit(1) if (not $result);
362 ShowHelp
() if ($opt_help);
364 die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
366 # we want unbuffered output
371 # quick hack to disable rpc validation when using valgrind - its way too slow
372 unless (defined($ENV{VALGRIND
})) {
373 $ENV{VALIDATE
} = "validate";
374 $ENV{MALLOC_CHECK_
} = 2;
377 # make all our python scripts unbuffered
378 $ENV{PYTHONUNBUFFERED
} = 1;
380 my $bindir = ($opt_bindir or "$builddir/bin");
381 my $bindir_abs = abs_path
($bindir);
383 # Backwards compatibility:
384 if (defined($ENV{TEST_LDAP
}) and $ENV{TEST_LDAP
} eq "yes") {
385 if (defined($ENV{FEDORA_DS_ROOT
})) {
392 my $torture_maxtime = ($ENV{TORTURE_MAXTIME
} or 1200);
395 $torture_maxtime *= 2;
402 die("using an empty prefix isn't allowed") unless $prefix ne "";
404 #Ensure we have the test prefix around
405 mkdir($prefix, 0777) unless -d
$prefix;
407 my $prefix_abs = abs_path
($prefix);
408 my $tmpdir_abs = abs_path
("$prefix/tmp");
409 mkdir($tmpdir_abs, 0777) unless -d
$tmpdir_abs;
411 my $srcdir_abs = abs_path
($srcdir);
412 my $builddir_abs = abs_path
($builddir);
414 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
415 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
417 $ENV{PREFIX
} = $prefix;
418 $ENV{KRB5CCNAME
} = "$prefix/krb5ticket";
419 $ENV{PREFIX_ABS
} = $prefix_abs;
420 $ENV{SRCDIR
} = $srcdir;
421 $ENV{SRCDIR_ABS
} = $srcdir_abs;
422 $ENV{BUILDDIR
} = $builddir;
423 $ENV{BUILDDIR_ABS
} = $builddir_abs;
424 $ENV{EXEEXT
} = $exeext;
426 my $tls_enabled = not $opt_quick;
427 $ENV{TLS_ENABLED
} = ($tls_enabled?
"yes":"no");
429 sub prefix_pathvar
($$)
431 my ($name, $newpath) = @_;
432 if (defined($ENV{$name})) {
433 $ENV{$name} = "$newpath:$ENV{$name}";
435 $ENV{$name} = $newpath;
438 prefix_pathvar
("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
439 prefix_pathvar
("PYTHONPATH", "$bindir_abs/python");
441 if ($opt_socket_wrapper_keep_pcap) {
442 # Socket wrapper keep pcap implies socket wrapper pcap
443 $opt_socket_wrapper_pcap = 1;
446 if ($opt_socket_wrapper_pcap) {
447 # Socket wrapper pcap implies socket wrapper
448 $opt_socket_wrapper = 1;
451 my $socket_wrapper_dir;
452 if ($opt_socket_wrapper) {
453 $socket_wrapper_dir = SocketWrapper
::setup_dir
("$prefix_abs/w", $opt_socket_wrapper_pcap);
454 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
457 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
462 my $testenv_default = "none";
464 if ($opt_target eq "samba4") {
465 $testenv_default = "all";
466 require target
::Samba4
;
467 $target = new Samba4
($bindir, $ldap, $srcdir, $exeext);
468 } elsif ($opt_target eq "samba3") {
469 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
470 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
472 $testenv_default = "member";
473 require target
::Samba3
;
474 $target = new Samba3
($bindir);
475 } elsif ($opt_target eq "win") {
476 die("Windows tests will not run with socket wrapper enabled.")
477 if ($opt_socket_wrapper);
478 $testenv_default = "dc";
479 require target
::Windows
;
480 $target = new Windows
();
481 } elsif ($opt_target eq "kvm") {
482 die("Kvm tests will not run with socket wrapper enabled.")
483 if ($opt_socket_wrapper);
485 die("No image specified") unless ($opt_image);
486 $target = new Kvm
($opt_image, undef);
490 # Start a Virtual Distributed Ethernet Switch
491 # Returns the pid of the switch.
493 sub start_vde_switch
($)
497 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
499 open(PID
, "$path/vde.pid");
507 # Stop a Virtual Distributed Ethernet Switch
508 sub stop_vde_switch
($)
514 sub read_test_regexes
($)
518 open(LF
, "<$name") or die("unable to read $name: $!");
522 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
523 push (@ret, [$1, $4]);
525 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
526 push (@ret, [$_, undef]);
533 foreach (@opt_exclude) {
534 push (@excludes, read_test_regexes
($_));
537 foreach (@opt_include) {
538 push (@includes, read_test_regexes
($_));
541 my $interfaces = join(',', ("127.0.0.11/8",
548 my $clientdir = "$prefix_abs/client";
550 my $conffile = "$clientdir/client.conf";
551 $ENV{SMB_CONF_PATH
} = $conffile;
553 sub write_clientconf
($$$)
555 my ($conffile, $clientdir, $vars) = @_;
557 mkdir("$clientdir", 0777) unless -d
"$clientdir";
559 if ( -d
"$clientdir/private" ) {
560 unlink <$clientdir/private/*>;
562 mkdir("$clientdir/private", 0777);
565 if ( -d
"$clientdir/lockdir" ) {
566 unlink <$clientdir/lockdir/*>;
568 mkdir("$clientdir/lockdir", 0777);
571 if ( -d
"$clientdir/ncalrpcdir" ) {
572 unlink <$clientdir/ncalrpcdir/*>;
574 mkdir("$clientdir/ncalrpcdir", 0777);
577 open(CF
, ">$conffile");
578 print CF
"[global]\n";
579 if (defined($ENV{VALGRIND
})) {
580 print CF
"\ticonv:native = true\n";
582 print CF
"\ticonv:native = false\n";
584 print CF
"\tnetbios name = client\n";
585 if (defined($vars->{DOMAIN
})) {
586 print CF
"\tworkgroup = $vars->{DOMAIN}\n";
588 if (defined($vars->{REALM
})) {
589 print CF
"\trealm = $vars->{REALM}\n";
591 if ($opt_socket_wrapper) {
592 print CF
"\tinterfaces = $interfaces\n";
595 private dir = $clientdir/private
596 lock dir = $clientdir/lockdir
597 ncalrpc dir = $clientdir/ncalrpcdir
598 name resolve order = bcast file
599 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
601 notify:inotify = false
603 system:anonymous = true
604 client lanman auth = Yes
606 torture:basedir = $clientdir
607 #We don't want to pass our self-tests if the PAC code is wrong
608 gensec:require_pac = true
609 resolv:host file = $prefix_abs/dns_host_file
610 #We don't want to run 'speed' tests for very long
611 torture:timelimit = 1
618 sub should_run_test
($)
624 for (my $i=0; $i <= $#tests; $i++) {
625 if ($name =~ /$tests[$i]/i) {
637 open(IN
, $filename) or die("Unable to open $filename: $!");
640 if (/-- TEST(-LOADLIST|-IDLIST|) --\n/) {
641 my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
642 my $supports_idlist = (defined($1) and $1 eq "-IDLIST");
649 if (should_run_test
($name) == 1) {
650 push (@ret, [$name, $env, $cmdline, $supports_loadlist, $supports_idlist]);
656 close(IN
) or die("Error creating recipe");
660 if ($#testlists == -1) {
661 die("No testlists specified");
664 $ENV{SELFTEST_PREFIX
} = "$prefix_abs";
665 $ENV{SELFTEST_TMPDIR
} = "$tmpdir_abs";
666 $ENV{TEST_DATA_PREFIX
} = "$tmpdir_abs";
667 if ($opt_socket_wrapper) {
668 $ENV{SELFTEST_INTERFACES
} = $interfaces;
670 $ENV{SELFTEST_INTERFACES
} = "";
673 $ENV{SELFTEST_VERBOSE
} = "1";
675 $ENV{SELFTEST_VERBOSE
} = "";
678 $ENV{SELFTEST_QUICK
} = "1";
680 $ENV{SELFTEST_QUICK
} = "";
682 $ENV{SELFTEST_TARGET
} = $opt_target;
683 $ENV{SELFTEST_MAXTIME
} = $torture_maxtime;
686 foreach my $fn (@testlists) {
687 foreach (read_testlist
($fn)) {
689 next if (@includes and not defined(find_in_list
(\
@includes, $name)));
690 push (@available, $_);
694 my $restricted = undef;
695 my $restricted_used = {};
697 if ($opt_load_list) {
699 open(LOAD_LIST
, "<$opt_load_list") or die("Unable to open $opt_load_list");
700 while (<LOAD_LIST
>) {
702 push (@
$restricted, $_);
707 my $individual_tests = undef;
708 $individual_tests = {};
710 foreach my $testsuite (@available) {
711 my $name = $$testsuite[0];
712 my $skipreason = skip
($name);
713 if (defined($restricted)) {
714 # Find the testsuite for this test
716 foreach my $r (@
$restricted) {
718 $individual_tests->{$name} = [];
720 $restricted_used->{$r} = 1;
721 } elsif (substr($r, 0, length($name)+1) eq "$name.") {
722 push(@
{$individual_tests->{$name}}, $r);
724 $restricted_used->{$r} = 1;
728 if (defined($skipreason)) {
729 Subunit
::skip_testsuite
($name, $skipreason);
731 push(@todo, $testsuite);
734 } elsif (defined($skipreason)) {
735 Subunit
::skip_testsuite
($name, $skipreason);
737 push(@todo, $testsuite);
741 if (defined($restricted)) {
742 foreach (@
$restricted) {
743 unless (defined($restricted_used->{$_})) {
744 print "No test or testsuite found matching $_\n";
747 } elsif ($#todo == -1) {
748 print STDERR
"No tests to run\n";
752 my $suitestotal = $#todo + 1;
754 Subunit
::progress
($suitestotal);
755 Subunit
::report_time
(time());
760 my %running_envs = ();
762 sub get_running_env
($)
770 return $running_envs{$envname};
773 my @exported_envvars = (
778 # domain controller stuff
787 "MEMBER_NETBIOSNAME",
788 "MEMBER_NETBIOSALIAS",
790 # rpc proxy controller stuff
792 "RPC_PROXY_SERVER_IP",
793 "RPC_PROXY_NETBIOSNAME",
794 "RPC_PROXY_NETBIOSALIAS",
796 # domain controller stuff for Vampired DC
798 "VAMPIRE_DC_SERVER_IP",
799 "VAMPIRE_DC_NETBIOSNAME",
800 "VAMPIRE_DC_NETBIOSALIAS",
817 "WINBINDD_SOCKET_DIR",
818 "WINBINDD_PRIV_PIPE_DIR",
823 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub {
825 teardown_env
($_) foreach(keys %running_envs);
826 die("Received signal $signame");
831 my ($name, $prefix) = @_;
833 my $testenv_vars = undef;
839 $option =~ s/^[^:]*//;
842 $option = "client" if $option eq "";
844 if ($envname eq "none") {
846 } elsif (defined(get_running_env
($envname))) {
847 $testenv_vars = get_running_env
($envname);
848 if (not $target->check_env($testenv_vars)) {
849 print $target->getlog_env($testenv_vars);
850 $testenv_vars = undef;
853 $testenv_vars = $target->setup_env($envname, $prefix);
856 return undef unless defined($testenv_vars);
858 $running_envs{$envname} = $testenv_vars;
860 if ($option eq "local") {
861 SocketWrapper
::set_default_iface
($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE
});
862 $ENV{SMB_CONF_PATH
} = $testenv_vars->{SERVERCONFFILE
};
863 } elsif ($option eq "client") {
864 SocketWrapper
::set_default_iface
(11);
865 write_clientconf
($conffile, $clientdir, $testenv_vars);
866 $ENV{SMB_CONF_PATH
} = $conffile;
868 die("Unknown option[$option] for envname[$envname]");
871 foreach (@exported_envvars) {
872 if (defined($testenv_vars->{$_})) {
873 $ENV{$_} = $testenv_vars->{$_};
879 return $testenv_vars;
882 sub exported_envvars_str
($)
884 my ($testenv_vars) = @_;
887 foreach (@exported_envvars) {
888 next unless defined($testenv_vars->{$_});
889 $out .= $_."=".$testenv_vars->{$_}."\n";
898 return "" if ($envname eq "none");
899 return $target->getlog_env(get_running_env
($envname));
905 return 1 if ($envname eq "none");
906 return $target->check_env(get_running_env
($envname));
912 return if ($envname eq "none");
913 $target->teardown_env(get_running_env
($envname));
914 delete $running_envs{$envname};
917 # This 'global' file needs to be empty when we start
918 unlink("$prefix_abs/dns_host_file");
921 my $testenv_name = $ENV{SELFTEST_TESTENV
};
922 $testenv_name = $testenv_default unless defined($testenv_name);
924 my $testenv_vars = setup_env
($testenv_name, $prefix);
926 die("Unable to setup environment $testenv_name") unless ($testenv_vars);
928 $ENV{PIDDIR
} = $testenv_vars->{PIDDIR
};
929 $ENV{ENVNAME
} = $testenv_name;
931 my $envvarstr = exported_envvars_str
($testenv_vars);
933 my $term = ($ENV{TERMINAL
} or "xterm -e");
934 system("$term 'echo -e \"
935 Welcome to the Samba4 Test environment '$testenv_name'
937 This matches the client environment used in make test
938 server is pid `cat \$PIDDIR/samba.pid`
940 Some useful environment variables:
941 TORTURE_OPTIONS=\$TORTURE_OPTIONS
942 SMB_CONF_PATH=\$SMB_CONF_PATH
945 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
946 teardown_env
($testenv_name);
947 } elsif ($opt_list) {
951 my $envname = $$_[1];
953 unless($cmd =~ /\$LISTOPT/) {
954 warn("Unable to list tests in $name");
958 $cmd =~ s/\$LISTOPT/--list/g;
963 die("Unable to run $cmd: $!");
965 die(snprintf
("%s died with signal %d, %s coredump\n", $cmd, ($?
& 127), ($?
& 128) ?
'with' : 'without'));
968 my $exitcode = $?
>> 8;
969 if ($exitcode != 0) {
970 die("$cmd exited with exit code $exitcode");
978 my $envname = $$_[1];
980 my $envvars = setup_env
($envname, $prefix);
981 if (not defined($envvars)) {
982 Subunit
::start_testsuite
($name);
983 Subunit
::end_testsuite
($name, "error",
984 "unable to set up environment $envname - exiting");
988 # Generate a file with the individual tests to run, if the
989 # test runner for this test suite supports it.
990 if ($individual_tests and $individual_tests->{$name}) {
992 my ($fh, $listid_file) = tempfile
(UNLINK
=> 0);
993 foreach my $test (@
{$individual_tests->{$name}}) {
994 print $fh substr($test, length($name)+1) . "\n";
996 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
998 $cmd =~ s/\s+[^\s]+\s*$//;
999 $cmd .= " " . join(' ', @
{$individual_tests->{$name}});
1003 run_testsuite
($envname, $name, $cmd, $i, $suitestotal);
1005 teardown_env
($envname) if ($opt_resetup_env);
1011 teardown_env
($_) foreach (keys %running_envs);
1015 # if there were any valgrind failures, show them
1016 foreach (<$prefix/valgrind
.log*>) {
1017 next unless (-s
$_);
1018 print "VALGRIND FAILURE\n";