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 # expand strings from %ENV
216 sub expand_environment_strings
($)
219 # we use a reverse sort so we do the longer ones first
220 foreach my $k (sort { $b cmp $a } keys %ENV) {
221 $s =~ s/\$$k/$ENV{$k}/g;
226 sub run_testsuite
($$$$$)
228 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
229 my $pcap_file = setup_pcap
($name);
231 Subunit
::start_testsuite
($name);
232 Subunit
::report_time
(time());
234 open(RESULTS
, "$cmd 2>&1|");
236 TESTS_UNEXPECTED_OK
=> 0,
237 TESTS_EXPECTED_OK
=> 0,
238 TESTS_UNEXPECTED_FAIL
=> 0,
239 TESTS_EXPECTED_FAIL
=> 0,
244 my $msg_ops = new Subunit
::Filter
("$name\.", []);
246 parse_results
($msg_ops, $statistics, *RESULTS
);
250 unless (close(RESULTS
)) {
252 Subunit
::end_testsuite
($name, "error", "Unable to run $cmd: $!");
260 Subunit
::end_testsuite
($name, "error", sprintf("Testsuite died with signal %d, %s coredump", ($ret & 127), ($ret & 128) ?
"with": "without"));
263 my $envlog = getlog_env
($envname);
265 print "envlog: $envlog\n";
268 print "command: $cmd\n";
269 printf "expanded command: %s\n", expand_environment_strings
($cmd);
271 my $exitcode = $ret >> 8;
273 Subunit
::report_time
(time());
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 --analyse-cmd CMD command to run after each test
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,
351 'analyse-cmd=s' => \
$opt_analyse_cmd,
352 'no-lazy-setup' => \
$opt_no_lazy_setup,
353 'resetup-environment' => \
$opt_resetup_env,
354 'bindir:s' => \
$opt_bindir,
355 'image=s' => \
$opt_image,
356 'testlist=s' => \
@testlists
359 exit(1) if (not $result);
361 ShowHelp
() if ($opt_help);
363 # we want unbuffered output
368 # quick hack to disable rpc validation when using valgrind - its way too slow
369 unless (defined($ENV{VALGRIND
})) {
370 $ENV{VALIDATE
} = "validate";
371 $ENV{MALLOC_CHECK_
} = 2;
374 # make all our python scripts unbuffered
375 $ENV{PYTHONUNBUFFERED
} = 1;
377 my $bindir = ($opt_bindir or "$builddir/bin");
378 my $bindir_abs = abs_path
($bindir);
380 # Backwards compatibility:
381 if (defined($ENV{TEST_LDAP
}) and $ENV{TEST_LDAP
} eq "yes") {
382 if (defined($ENV{FEDORA_DS_ROOT
})) {
389 my $torture_maxtime = ($ENV{TORTURE_MAXTIME
} or 1200);
392 $torture_maxtime *= 2;
399 die("using an empty prefix isn't allowed") unless $prefix ne "";
401 #Ensure we have the test prefix around
402 mkdir($prefix, 0777) unless -d
$prefix;
404 my $prefix_abs = abs_path
($prefix);
405 my $srcdir_abs = abs_path
($srcdir);
406 my $builddir_abs = abs_path
($builddir);
408 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
409 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
411 $ENV{PREFIX
} = $prefix;
412 $ENV{KRB5CCNAME
} = "$prefix/krb5ticket";
413 $ENV{PREFIX_ABS
} = $prefix_abs;
414 $ENV{SRCDIR
} = $srcdir;
415 $ENV{SRCDIR_ABS
} = $srcdir_abs;
416 $ENV{BUILDDIR
} = $builddir;
417 $ENV{BUILDDIR_ABS
} = $builddir_abs;
418 $ENV{EXEEXT
} = $exeext;
420 my $tls_enabled = not $opt_quick;
421 $ENV{TLS_ENABLED
} = ($tls_enabled?
"yes":"no");
422 $ENV{LDB_MODULES_PATH
} = "$bindir_abs/modules/ldb";
423 $ENV{LD_SAMBA_MODULE_PATH
} = "$bindir_abs/modules";
424 sub prefix_pathvar
($$)
426 my ($name, $newpath) = @_;
427 if (defined($ENV{$name})) {
428 $ENV{$name} = "$newpath:$ENV{$name}";
430 $ENV{$name} = $newpath;
433 prefix_pathvar
("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
434 prefix_pathvar
("PYTHONPATH", "$bindir_abs/python");
436 if ($opt_socket_wrapper_keep_pcap) {
437 # Socket wrapper keep pcap implies socket wrapper pcap
438 $opt_socket_wrapper_pcap = 1;
441 if ($opt_socket_wrapper_pcap) {
442 # Socket wrapper pcap implies socket wrapper
443 $opt_socket_wrapper = 1;
446 my $socket_wrapper_dir;
447 if ($opt_socket_wrapper) {
448 $socket_wrapper_dir = SocketWrapper
::setup_dir
("$prefix_abs/w", $opt_socket_wrapper_pcap);
449 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
452 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
457 my $testenv_default = "none";
459 if ($opt_target eq "samba4") {
460 $testenv_default = "member";
461 require target
::Samba4
;
462 $target = new Samba4
($bindir, $ldap, "$srcdir/setup", $exeext);
463 } elsif ($opt_target eq "samba3") {
464 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
465 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
467 $testenv_default = "member";
468 require target
::Samba3
;
469 $target = new Samba3
($bindir);
470 } elsif ($opt_target eq "win") {
471 die("Windows tests will not run with socket wrapper enabled.")
472 if ($opt_socket_wrapper);
473 $testenv_default = "dc";
474 require target
::Windows
;
475 $target = new Windows
();
476 } elsif ($opt_target eq "kvm") {
477 die("Kvm tests will not run with socket wrapper enabled.")
478 if ($opt_socket_wrapper);
480 die("No image specified") unless ($opt_image);
481 $target = new Kvm
($opt_image, undef);
485 # Start a Virtual Distributed Ethernet Switch
486 # Returns the pid of the switch.
488 sub start_vde_switch
($)
492 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
494 open(PID
, "$path/vde.pid");
502 # Stop a Virtual Distributed Ethernet Switch
503 sub stop_vde_switch
($)
509 sub read_test_regexes
($)
513 open(LF
, "<$name") or die("unable to read $name: $!");
517 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
518 push (@ret, [$1, $4]);
520 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
521 push (@ret, [$_, undef]);
528 foreach (@opt_exclude) {
529 push (@excludes, read_test_regexes
($_));
532 foreach (@opt_include) {
533 push (@includes, read_test_regexes
($_));
536 my $interfaces = join(',', ("127.0.0.6/8",
543 my $conffile = "$prefix_abs/client/client.conf";
544 $ENV{SMB_CONF_PATH
} = $conffile;
546 sub write_clientconf
($$)
548 my ($conffile, $vars) = @_;
550 mkdir("$prefix/client", 0777) unless -d
"$prefix/client";
552 if ( -d
"$prefix/client/private" ) {
553 unlink <$prefix/client/private
/*>;
555 mkdir("$prefix/client/private", 0777);
558 if ( -d
"$prefix/client/lockdir" ) {
559 unlink <$prefix/client/lockdir
/*>;
561 mkdir("$prefix/client/lockdir", 0777);
564 if ( -d
"$prefix_abs/client/ncalrpcdir" ) {
565 unlink <$prefix/client/ncalrpcdir
/*>;
567 mkdir("$prefix/client/ncalrpcdir", 0777);
570 open(CF
, ">$conffile");
571 print CF
"[global]\n";
572 if (defined($ENV{VALGRIND
})) {
573 print CF
"\ticonv:native = true\n";
575 print CF
"\ticonv:native = false\n";
577 print CF
"\tnetbios name = client\n";
578 if (defined($vars->{DOMAIN
})) {
579 print CF
"\tworkgroup = $vars->{DOMAIN}\n";
581 if (defined($vars->{REALM
})) {
582 print CF
"\trealm = $vars->{REALM}\n";
584 if ($opt_socket_wrapper) {
585 print CF
"\tinterfaces = $interfaces\n";
588 private dir = $prefix_abs/client/private
589 lock dir = $prefix_abs/client/lockdir
590 ncalrpc dir = $prefix_abs/client/ncalrpcdir
591 name resolve order = bcast
592 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
594 notify:inotify = false
596 system:anonymous = true
597 client lanman auth = Yes
598 torture:basedir = $prefix_abs/client
599 #We don't want to pass our self-tests if the PAC code is wrong
600 gensec:require_pac = true
601 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
602 setup directory = ./setup
609 my $testsdir = "$srcdir/selftest";
611 my %required_envs = ();
613 sub should_run_test
($)
619 for (my $i=0; $i <= $#tests; $i++) {
620 if ($name =~ /$tests[$i]/i) {
632 open(IN
, $filename) or die("Unable to open $filename: $!");
635 if ($_ eq "-- TEST --\n") {
642 if (should_run_test
($name) == 1) {
643 $required_envs{$env} = 1;
644 push (@ret, [$name, $env, $cmdline]);
650 close(IN
) or die("Error creating recipe");
654 if ($#testlists == -1) {
655 die("No testlists specified");
658 $ENV{SELFTEST_PREFIX
} = "$prefix_abs";
659 if ($opt_socket_wrapper) {
660 $ENV{SELFTEST_INTERFACES
} = $interfaces;
662 $ENV{SELFTEST_INTERFACES
} = "";
665 $ENV{SELFTEST_VERBOSE
} = "1";
667 $ENV{SELFTEST_VERBOSE
} = "";
670 $ENV{SELFTEST_QUICK
} = "1";
672 $ENV{SELFTEST_QUICK
} = "";
674 $ENV{SELFTEST_TARGET
} = $opt_target;
675 $ENV{SELFTEST_MAXTIME
} = $torture_maxtime;
678 foreach my $fn (@testlists) {
679 foreach (read_testlist
($fn)) {
681 next if (@includes and not defined(find_in_list
(\
@includes, $name)));
682 push (@available, $_);
686 Subunit
::testsuite_count
($#available+1);
687 Subunit
::report_time
(time());
689 foreach (@available) {
691 my $skipreason = skip
($name);
692 if (defined($skipreason)) {
693 Subunit
::skip_testsuite
($name, $skipreason);
700 print STDERR
"No tests to run\n";
704 my $suitestotal = $#todo + 1;
708 my %running_envs = ();
710 sub get_running_env
($)
718 return $running_envs{$envname};
721 my @exported_envvars = (
726 # domain controller stuff
746 "WINBINDD_SOCKET_DIR",
747 "WINBINDD_PRIV_PIPE_DIR"
750 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub {
752 teardown_env
($_) foreach(keys %running_envs);
753 die("Received signal $signame");
760 my $testenv_vars = undef;
766 $option =~ s/^[^:]*//;
769 $option = "client" if $option eq "";
771 if ($envname eq "none") {
773 } elsif (defined(get_running_env
($envname))) {
774 $testenv_vars = get_running_env
($envname);
775 if (not $target->check_env($testenv_vars)) {
776 $testenv_vars = undef;
779 $testenv_vars = $target->setup_env($envname, $prefix);
782 return undef unless defined($testenv_vars);
784 $running_envs{$envname} = $testenv_vars;
786 if ($option eq "local") {
787 SocketWrapper
::set_default_iface
($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE
});
788 $ENV{SMB_CONF_PATH
} = $testenv_vars->{SERVERCONFFILE
};
789 } elsif ($option eq "client") {
790 SocketWrapper
::set_default_iface
(6);
791 write_clientconf
($conffile, $testenv_vars);
792 $ENV{SMB_CONF_PATH
} = $conffile;
794 die("Unknown option[$option] for envname[$envname]");
797 foreach (@exported_envvars) {
798 if (defined($testenv_vars->{$_})) {
799 $ENV{$_} = $testenv_vars->{$_};
805 return $testenv_vars;
808 sub exported_envvars_str
($)
810 my ($testenv_vars) = @_;
813 foreach (@exported_envvars) {
814 next unless defined($testenv_vars->{$_});
815 $out .= $_."=".$testenv_vars->{$_}."\n";
824 return "" if ($envname eq "none");
825 return $target->getlog_env(get_running_env
($envname));
831 return 1 if ($envname eq "none");
832 return $target->check_env(get_running_env
($envname));
838 return if ($envname eq "none");
839 $target->teardown_env(get_running_env
($envname));
840 delete $running_envs{$envname};
843 if ($opt_no_lazy_setup) {
844 setup_env
($_) foreach (keys %required_envs);
848 my $testenv_name = $ENV{SELFTEST_TESTENV
};
849 $testenv_name = $testenv_default unless defined($testenv_name);
851 my $testenv_vars = setup_env
($testenv_name);
853 $ENV{PIDDIR
} = $testenv_vars->{PIDDIR
};
855 my $envvarstr = exported_envvars_str
($testenv_vars);
857 my $term = ($ENV{TERMINAL
} or "xterm");
858 system("$term -e 'echo -e \"
859 Welcome to the Samba4 Test environment '$testenv_name'
861 This matches the client environment used in make test
862 server is pid `cat \$PIDDIR/samba.pid`
864 Some useful environment variables:
865 TORTURE_OPTIONS=\$TORTURE_OPTIONS
866 SMB_CONF_PATH=\$SMB_CONF_PATH
869 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
870 teardown_env
($testenv_name);
875 $cmd =~ s/([\(\)])/\\$1/g;
877 my $envname = $$_[1];
879 my $envvars = setup_env
($envname);
880 if (not defined($envvars)) {
881 Subunit
::skip_testsuite
($name,
882 "unable to set up environment $envname");
886 run_testsuite
($envname, $name, $cmd, $i, $suitestotal);
888 if (defined($opt_analyse_cmd)) {
889 system("$opt_analyse_cmd \"$name\"");
892 teardown_env
($envname) if ($opt_resetup_env);
898 teardown_env
($_) foreach (keys %running_envs);
904 # if there were any valgrind failures, show them
905 foreach (<$prefix/valgrind
.log*>) {
907 print "VALGRIND FAILURE\n";