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_binary_mapping = "";
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
319 --ldap=openldap|fedora-ds back samba onto specified ldap server
322 --image=PATH path to KVM image
325 --quick run quick overall test
326 --one abort when the first test fails
328 --testenv run a shell in the requested test environment
329 --list list available tests
334 my $result = GetOptions (
335 'help|h|?' => \$opt_help,
336 'target=s' => \$opt_target,
337 'prefix=s' => \$prefix,
338 'socket-wrapper' => \$opt_socket_wrapper,
339 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
340 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
341 'quick' => \$opt_quick,
343 'exclude=s' => \@opt_exclude,
344 'include=s' => \@opt_include,
345 'srcdir=s' => \$srcdir,
346 'builddir=s' => \$builddir,
347 'exeext=s' => \$exeext,
348 'verbose' => \$opt_verbose,
349 'testenv' => \$opt_testenv,
350 'list' => \$opt_list,
352 'resetup-environment' => \$opt_resetup_env,
353 'image=s' => \$opt_image,
354 'testlist=s' => \@testlists,
355 'load-list=s' => \$opt_load_list,
356 'binary-mapping=s' => \$opt_binary_mapping
359 exit(1) if (not $result);
361 ShowHelp() if ($opt_help);
363 die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
365 # we want unbuffered output
370 # quick hack to disable rpc validation when using valgrind - its way too slow
371 unless (defined($ENV{VALGRIND})) {
372 $ENV{VALIDATE} = "validate";
373 $ENV{MALLOC_CHECK_} = 2;
376 # make all our python scripts unbuffered
377 $ENV{PYTHONUNBUFFERED} = 1;
379 my $bindir = "$builddir/bin";
380 my $bindir_abs = abs_path($bindir);
382 # Backwards compatibility:
383 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
384 if (defined($ENV{FEDORA_DS_ROOT})) {
391 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
394 $torture_maxtime *= 2;
401 die("using an empty prefix isn't allowed") unless $prefix ne "";
403 #Ensure we have the test prefix around
404 mkdir($prefix, 0777) unless -d $prefix;
406 my $prefix_abs = abs_path($prefix);
407 my $tmpdir_abs = abs_path("$prefix/tmp");
408 mkdir($tmpdir_abs, 0777) unless -d $tmpdir_abs;
410 my $srcdir_abs = abs_path($srcdir);
411 my $builddir_abs = abs_path($builddir);
413 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
414 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
416 $ENV{PREFIX} = $prefix;
417 $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
418 $ENV{PREFIX_ABS} = $prefix_abs;
419 $ENV{SRCDIR} = $srcdir;
420 $ENV{SRCDIR_ABS} = $srcdir_abs;
421 $ENV{BUILDDIR} = $builddir;
422 $ENV{BUILDDIR_ABS} = $builddir_abs;
423 $ENV{BINDIR} = $bindir_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 my %binary_mapping = {};
465 if ($opt_binary_mapping) {
466 my @binmapping_list = split(/,/, $opt_binary_mapping);
467 foreach my $mapping (@binmapping_list) {
468 my ($bin, $map) = split(/\:/, $mapping);
469 $binary_mapping{$bin} = $map;
473 $ENV{BINARY_MAPPING} = $opt_binary_mapping;
475 sub bindir_path($$) {
476 my ($self, $path) = @_;
478 if (defined($self->{binary_mapping}->{$path})) {
479 $path = $self->{binary_mapping}->{$path};
482 my $valpath = "$self->{bindir}/$path$self->{exeext}";
484 return $valpath if (-f $valpath);
488 if ($opt_target eq "samba4") {
489 $testenv_default = "all";
490 require target::Samba4;
491 $target = new Samba4($bindir, \%binary_mapping, \&bindir_path, $ldap, $srcdir, $exeext);
492 } elsif ($opt_target eq "samba3") {
493 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
494 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
496 $testenv_default = "member";
497 require target::Samba3;
498 $target = new Samba3($bindir, \%binary_mapping, \&bindir_path, $srcdir_abs, $exeext);
499 } elsif ($opt_target eq "win") {
500 die("Windows tests will not run with socket wrapper enabled.")
501 if ($opt_socket_wrapper);
502 $testenv_default = "dc";
503 require target::Windows;
504 $target = new Windows();
505 } elsif ($opt_target eq "kvm") {
506 die("Kvm tests will not run with socket wrapper enabled.")
507 if ($opt_socket_wrapper);
509 die("No image specified") unless ($opt_image);
510 $target = new Kvm($opt_image, undef);
514 # Start a Virtual Distributed Ethernet Switch
515 # Returns the pid of the switch.
517 sub start_vde_switch($)
521 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
523 open(PID, "$path/vde.pid");
531 # Stop a Virtual Distributed Ethernet Switch
532 sub stop_vde_switch($)
538 sub read_test_regexes($)
542 open(LF, "<$name") or die("unable to read $name: $!");
546 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
547 push (@ret, [$1, $4]);
549 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
550 push (@ret, [$_, undef]);
557 foreach (@opt_exclude) {
558 push (@excludes, read_test_regexes($_));
561 foreach (@opt_include) {
562 push (@includes, read_test_regexes($_));
565 my $interfaces = join(',', ("127.0.0.11/8",
572 my $clientdir = "$prefix_abs/client";
574 my $conffile = "$clientdir/client.conf";
575 $ENV{SMB_CONF_PATH} = $conffile;
577 sub write_clientconf($$$)
579 my ($conffile, $clientdir, $vars) = @_;
581 mkdir("$clientdir", 0777) unless -d "$clientdir";
583 if ( -d "$clientdir/private" ) {
584 unlink <$clientdir/private/*>;
586 mkdir("$clientdir/private", 0777);
589 if ( -d "$clientdir/lockdir" ) {
590 unlink <$clientdir/lockdir/*>;
592 mkdir("$clientdir/lockdir", 0777);
595 if ( -d "$clientdir/ncalrpcdir" ) {
596 unlink <$clientdir/ncalrpcdir/*>;
598 mkdir("$clientdir/ncalrpcdir", 0777);
601 open(CF, ">$conffile");
602 print CF "[global]\n";
603 if (defined($ENV{VALGRIND})) {
604 print CF "\ticonv:native = true\n";
606 print CF "\ticonv:native = false\n";
608 print CF "\tnetbios name = client\n";
609 if (defined($vars->{DOMAIN})) {
610 print CF "\tworkgroup = $vars->{DOMAIN}\n";
612 if (defined($vars->{REALM})) {
613 print CF "\trealm = $vars->{REALM}\n";
615 if ($opt_socket_wrapper) {
616 print CF "\tinterfaces = $interfaces\n";
619 private dir = $clientdir/private
620 lock dir = $clientdir/lockdir
621 ncalrpc dir = $clientdir/ncalrpcdir
622 name resolve order = file bcast
623 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
625 notify:inotify = false
627 system:anonymous = true
628 client lanman auth = Yes
630 torture:basedir = $clientdir
631 #We don't want to pass our self-tests if the PAC code is wrong
632 gensec:require_pac = true
633 resolv:host file = $prefix_abs/dns_host_file
634 #We don't want to run 'speed' tests for very long
635 torture:timelimit = 1
642 sub should_run_test($)
648 for (my $i=0; $i <= $#tests; $i++) {
649 if ($name =~ /$tests[$i]/i) {
661 open(IN, $filename) or die("Unable to open $filename: $!");
664 if (/-- TEST(-LOADLIST|-IDLIST|) --\n/) {
665 my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
666 my $supports_idlist = (defined($1) and $1 eq "-IDLIST");
673 if (should_run_test($name) == 1) {
674 push (@ret, [$name, $env, $cmdline, $supports_loadlist, $supports_idlist]);
680 close(IN) or die("Error creating recipe");
684 if ($#testlists == -1) {
685 die("No testlists specified");
688 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
689 $ENV{SELFTEST_TMPDIR} = "$tmpdir_abs";
690 $ENV{TEST_DATA_PREFIX} = "$tmpdir_abs";
691 if ($opt_socket_wrapper) {
692 $ENV{SELFTEST_INTERFACES} = $interfaces;
694 $ENV{SELFTEST_INTERFACES} = "";
697 $ENV{SELFTEST_VERBOSE} = "1";
699 $ENV{SELFTEST_VERBOSE} = "";
702 $ENV{SELFTEST_QUICK} = "1";
704 $ENV{SELFTEST_QUICK} = "";
706 $ENV{SELFTEST_TARGET} = $opt_target;
707 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
710 foreach my $fn (@testlists) {
711 foreach (read_testlist($fn)) {
713 next if (@includes and not defined(find_in_list(\@includes, $name)));
714 push (@available, $_);
718 my $restricted = undef;
719 my $restricted_used = {};
721 if ($opt_load_list) {
723 open(LOAD_LIST, "<$opt_load_list") or die("Unable to open $opt_load_list");
724 while (<LOAD_LIST>) {
726 push (@$restricted, $_);
731 my $individual_tests = undef;
732 $individual_tests = {};
734 foreach my $testsuite (@available) {
735 my $name = $$testsuite[0];
736 my $skipreason = skip($name);
737 if (defined($restricted)) {
738 # Find the testsuite for this test
740 foreach my $r (@$restricted) {
742 $individual_tests->{$name} = [];
744 $restricted_used->{$r} = 1;
745 } elsif (substr($r, 0, length($name)+1) eq "$name.") {
746 push(@{$individual_tests->{$name}}, $r);
748 $restricted_used->{$r} = 1;
752 if (defined($skipreason)) {
753 Subunit::skip_testsuite($name, $skipreason);
755 push(@todo, $testsuite);
758 } elsif (defined($skipreason)) {
759 Subunit::skip_testsuite($name, $skipreason);
761 push(@todo, $testsuite);
765 if (defined($restricted)) {
766 foreach (@$restricted) {
767 unless (defined($restricted_used->{$_})) {
768 print "No test or testsuite found matching $_\n";
771 } elsif ($#todo == -1) {
772 print STDERR "No tests to run\n";
776 my $suitestotal = $#todo + 1;
778 Subunit::progress($suitestotal);
779 Subunit::report_time(time());
784 my %running_envs = ();
786 sub get_running_env($)
794 return $running_envs{$envname};
797 my @exported_envvars = (
802 # domain controller stuff
811 "MEMBER_NETBIOSNAME",
812 "MEMBER_NETBIOSALIAS",
814 # rpc proxy controller stuff
816 "RPC_PROXY_SERVER_IP",
817 "RPC_PROXY_NETBIOSNAME",
818 "RPC_PROXY_NETBIOSALIAS",
820 # domain controller stuff for Vampired DC
822 "VAMPIRE_DC_SERVER_IP",
823 "VAMPIRE_DC_NETBIOSNAME",
824 "VAMPIRE_DC_NETBIOSALIAS",
841 "WINBINDD_SOCKET_DIR",
842 "WINBINDD_PRIV_PIPE_DIR",
847 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
849 teardown_env($_) foreach(keys %running_envs);
850 die("Received signal $signame");
855 my ($name, $prefix) = @_;
857 my $testenv_vars = undef;
863 $option =~ s/^[^:]*//;
866 $option = "client" if $option eq "";
868 if ($envname eq "none") {
870 } elsif (defined(get_running_env($envname))) {
871 $testenv_vars = get_running_env($envname);
872 if (not $target->check_env($testenv_vars)) {
873 print $target->getlog_env($testenv_vars);
874 $testenv_vars = undef;
877 $testenv_vars = $target->setup_env($envname, $prefix);
880 return undef unless defined($testenv_vars);
882 $running_envs{$envname} = $testenv_vars;
884 if ($option eq "local") {
885 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
886 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
887 } elsif ($option eq "client") {
888 SocketWrapper::set_default_iface(11);
889 write_clientconf($conffile, $clientdir, $testenv_vars);
890 $ENV{SMB_CONF_PATH} = $conffile;
892 die("Unknown option[$option] for envname[$envname]");
895 foreach (@exported_envvars) {
896 if (defined($testenv_vars->{$_})) {
897 $ENV{$_} = $testenv_vars->{$_};
903 return $testenv_vars;
906 sub exported_envvars_str($)
908 my ($testenv_vars) = @_;
911 foreach (@exported_envvars) {
912 next unless defined($testenv_vars->{$_});
913 $out .= $_."=".$testenv_vars->{$_}."\n";
922 return "" if ($envname eq "none");
923 return $target->getlog_env(get_running_env($envname));
929 return 1 if ($envname eq "none");
930 return $target->check_env(get_running_env($envname));
936 return if ($envname eq "none");
937 $target->teardown_env(get_running_env($envname));
938 delete $running_envs{$envname};
941 # This 'global' file needs to be empty when we start
942 unlink("$prefix_abs/dns_host_file");
945 my $testenv_name = $ENV{SELFTEST_TESTENV};
946 $testenv_name = $testenv_default unless defined($testenv_name);
948 my $testenv_vars = setup_env($testenv_name, $prefix);
950 die("Unable to setup environment $testenv_name") unless ($testenv_vars);
952 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
953 $ENV{ENVNAME} = $testenv_name;
955 my $envvarstr = exported_envvars_str($testenv_vars);
957 my $term = ($ENV{TERMINAL} or "xterm -e");
958 system("$term 'echo -e \"
959 Welcome to the Samba4 Test environment '$testenv_name'
961 This matches the client environment used in make test
962 server is pid `cat \$PIDDIR/samba.pid`
964 Some useful environment variables:
965 TORTURE_OPTIONS=\$TORTURE_OPTIONS
966 SMB_CONF_PATH=\$SMB_CONF_PATH
969 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
970 teardown_env($testenv_name);
971 } elsif ($opt_list) {
975 my $envname = $$_[1];
977 unless($cmd =~ /\$LISTOPT/) {
978 warn("Unable to list tests in $name");
982 $cmd =~ s/\$LISTOPT/--list/g;
987 die("Unable to run $cmd: $!");
989 die(snprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127), ($? & 128) ? 'with' : 'without'));
992 my $exitcode = $? >> 8;
993 if ($exitcode != 0) {
994 die("$cmd exited with exit code $exitcode");
1002 my $envname = $$_[1];
1004 my $envvars = setup_env($envname, $prefix);
1005 if (not defined($envvars)) {
1006 Subunit::start_testsuite($name);
1007 Subunit::end_testsuite($name, "error",
1008 "unable to set up environment $envname - exiting");
1012 # Generate a file with the individual tests to run, if the
1013 # test runner for this test suite supports it.
1014 if ($individual_tests and $individual_tests->{$name}) {
1016 my ($fh, $listid_file) = tempfile(UNLINK => 0);
1017 foreach my $test (@{$individual_tests->{$name}}) {
1018 print $fh substr($test, length($name)+1) . "\n";
1020 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
1022 $cmd =~ s/\s+[^\s]+\s*$//;
1023 $cmd .= " " . join(' ', @{$individual_tests->{$name}});
1027 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
1029 teardown_env($envname) if ($opt_resetup_env);
1035 teardown_env($_) foreach (keys %running_envs);
1039 # if there were any valgrind failures, show them
1040 foreach (<$prefix/valgrind.log*>) {
1041 next unless (-s $_);
1042 print "VALGRIND FAILURE\n";