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);
136 my $opt_target = "samba4";
138 my $opt_socket_wrapper = 0;
139 my $opt_socket_wrapper_pcap = undef;
140 my $opt_socket_wrapper_keep_pcap = undef;
142 my @opt_exclude = ();
143 my @opt_include = ();
145 my $opt_image = undef;
148 my $opt_analyse_cmd = undef;
149 my $opt_resetup_env = undef;
150 my $opt_bindir = undef;
151 my $opt_no_lazy_setup = undef;
164 my ($list, $fullname) = @_;
167 if ($fullname =~ /$$_[0]/) {
168 return ($$_[1]) if ($$_[1]);
169 return "NO REASON SPECIFIED";
180 return find_in_list(\@excludes, $name);
189 return unless ($opt_socket_wrapper_pcap);
190 return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR});
193 $fname =~ s%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\-]%_%g;
195 my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
197 SocketWrapper::setup_pcap($pcap_file);
204 my ($pcap_file, $exitcode) = @_;
206 return unless ($opt_socket_wrapper_pcap);
207 return if ($opt_socket_wrapper_keep_pcap);
208 return unless ($exitcode == 0);
209 return unless defined($pcap_file);
214 sub run_testsuite($$$$$)
216 my ($envname, $name, $cmd, $i, $totalsuites) = @_;
217 my $pcap_file = setup_pcap($name);
219 Subunit::report_time(time());
220 Subunit::prefix($name);
221 Subunit::start_test($name);
223 my $ret = system("$cmd | $RealBin/filter-subunit.pl --prefix \"$name.\" 2>&1");
225 Subunit::end_test($name, "error", "Unable to run $cmd: $!");
228 my $envlog = getlog_env($envname);
230 print "envlog: $envlog\n";
233 print "command: $cmd\n";
235 my $exitcode = $ret >> 8;
237 Subunit::report_time(time());
238 my $reason = "Exit code was $exitcode";
240 if ($exitcode == 0) {
245 Subunit::end_test($name, $result, $reason);
247 cleanup_pcap($pcap_file, $exitcode);
249 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
250 print "PCAP FILE: $pcap_file\n";
253 if ($exitcode != 0) {
254 exit(1) if ($opt_one);
262 print "Samba test runner
263 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
264 Copyright (C) Stefan Metzmacher <metze\@samba.org>
266 Usage: $Script [OPTIONS] TESTNAME-REGEX
269 --help this help page
270 --target=samba[34]|win|kvm Samba version to target
271 --testlist=FILE file to read available tests from
274 --prefix=DIR prefix to run tests in [st]
275 --srcdir=DIR source directory [.]
276 --builddir=DIR output directory [.]
277 --exeext=EXT executable extention []
280 --socket-wrapper-pcap save traffic to pcap directories
281 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
283 --socket-wrapper enable socket wrapper
284 --bindir=PATH path to target binaries
287 --ldap=openldap|fedora-ds back samba onto specified ldap server
290 --image=PATH path to KVM image
293 --quick run quick overall test
294 --one abort when the first test fails
296 --analyse-cmd CMD command to run after each test
301 my $result = GetOptions (
302 'help|h|?' => \$opt_help,
303 'target=s' => \$opt_target,
304 'prefix=s' => \$prefix,
305 'socket-wrapper' => \$opt_socket_wrapper,
306 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
307 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
308 'quick' => \$opt_quick,
310 'exclude=s' => \@opt_exclude,
311 'include=s' => \@opt_include,
312 'srcdir=s' => \$srcdir,
313 'builddir=s' => \$builddir,
314 'exeext=s' => \$exeext,
315 'verbose' => \$opt_verbose,
316 'testenv' => \$opt_testenv,
318 'analyse-cmd=s' => \$opt_analyse_cmd,
319 'no-lazy-setup' => \$opt_no_lazy_setup,
320 'resetup-environment' => \$opt_resetup_env,
321 'bindir:s' => \$opt_bindir,
322 'image=s' => \$opt_image,
323 'testlist=s' => \@testlists
326 exit(1) if (not $result);
328 ShowHelp() if ($opt_help);
332 # quick hack to disable rpc validation when using valgrind - its way too slow
333 unless (defined($ENV{VALGRIND})) {
334 $ENV{VALIDATE} = "validate";
335 $ENV{MALLOC_CHECK_} = 2;
338 my $bindir = ($opt_bindir or "$builddir/bin");
339 my $bindir_abs = abs_path($bindir);
341 # Backwards compatibility:
342 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
343 if (defined($ENV{FEDORA_DS_ROOT})) {
350 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
353 $torture_maxtime *= 2;
360 die("using an empty prefix isn't allowed") unless $prefix ne "";
362 #Ensure we have the test prefix around
363 mkdir($prefix, 0777) unless -d $prefix;
365 my $prefix_abs = abs_path($prefix);
366 my $srcdir_abs = abs_path($srcdir);
367 my $builddir_abs = abs_path($builddir);
369 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
370 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
372 $ENV{PREFIX} = $prefix;
373 $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
374 $ENV{PREFIX_ABS} = $prefix_abs;
375 $ENV{SRCDIR} = $srcdir;
376 $ENV{SRCDIR_ABS} = $srcdir_abs;
377 $ENV{BUILDDIR} = $builddir;
378 $ENV{BUILDDIR_ABS} = $builddir_abs;
379 $ENV{EXEEXT} = $exeext;
381 my $tls_enabled = not $opt_quick;
382 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
383 $ENV{LDB_MODULES_PATH} = "$bindir_abs/modules/ldb";
384 $ENV{LD_SAMBA_MODULE_PATH} = "$bindir_abs/modules";
385 sub prefix_pathvar($$)
387 my ($name, $newpath) = @_;
388 if (defined($ENV{$name})) {
389 $ENV{$name} = "$newpath:$ENV{$name}";
391 $ENV{$name} = $newpath;
394 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
395 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
397 if ($opt_socket_wrapper_keep_pcap) {
398 # Socket wrapper keep pcap implies socket wrapper pcap
399 $opt_socket_wrapper_pcap = 1;
402 if ($opt_socket_wrapper_pcap) {
403 # Socket wrapper pcap implies socket wrapper
404 $opt_socket_wrapper = 1;
407 my $socket_wrapper_dir;
408 if ($opt_socket_wrapper) {
409 $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix/w", $opt_socket_wrapper_pcap);
410 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
413 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
418 my $testenv_default = "none";
420 if ($opt_target eq "samba4") {
421 $testenv_default = "member";
422 require target::Samba4;
423 $target = new Samba4($bindir, $ldap, "$srcdir/setup", $exeext);
424 } elsif ($opt_target eq "samba3") {
425 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
426 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
428 $testenv_default = "member";
429 require target::Samba3;
430 $target = new Samba3($bindir);
431 } elsif ($opt_target eq "win") {
432 die("Windows tests will not run with socket wrapper enabled.")
433 if ($opt_socket_wrapper);
434 $testenv_default = "dc";
435 require target::Windows;
436 $target = new Windows();
437 } elsif ($opt_target eq "kvm") {
438 die("Kvm tests will not run with socket wrapper enabled.")
439 if ($opt_socket_wrapper);
441 die("No image specified") unless ($opt_image);
442 $target = new Kvm($opt_image, undef);
446 # Start a Virtual Distributed Ethernet Switch
447 # Returns the pid of the switch.
449 sub start_vde_switch($)
453 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
455 open(PID, "$path/vde.pid");
463 # Stop a Virtual Distributed Ethernet Switch
464 sub stop_vde_switch($)
470 sub read_test_regexes($)
474 open(LF, "<$name") or die("unable to read $name: $!");
478 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
479 push (@ret, [$1, $4]);
481 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
482 push (@ret, [$_, undef]);
489 foreach (@opt_exclude) {
490 push (@excludes, read_test_regexes($_));
493 foreach (@opt_include) {
494 push (@includes, read_test_regexes($_));
497 my $interfaces = join(',', ("127.0.0.6/8",
504 my $conffile = "$prefix_abs/client/client.conf";
505 $ENV{SMB_CONF_PATH} = $conffile;
507 sub write_clientconf($$)
509 my ($conffile, $vars) = @_;
511 mkdir("$prefix/client", 0777) unless -d "$prefix/client";
513 if ( -d "$prefix/client/private" ) {
514 unlink <$prefix/client/private/*>;
516 mkdir("$prefix/client/private", 0777);
519 if ( -d "$prefix/client/lock" ) {
520 unlink <$prefix/client/lockdir/*>;
522 mkdir("$prefix/client/lockdir", 0777);
525 open(CF, ">$conffile");
526 print CF "[global]\n";
527 if (defined($ENV{VALGRIND})) {
528 print CF "\ticonv:native = true\n";
530 print CF "\ticonv:native = false\n";
532 print CF "\tnetbios name = client\n";
533 if (defined($vars->{DOMAIN})) {
534 print CF "\tworkgroup = $vars->{DOMAIN}\n";
536 if (defined($vars->{REALM})) {
537 print CF "\trealm = $vars->{REALM}\n";
539 if ($opt_socket_wrapper) {
540 print CF "\tinterfaces = $interfaces\n";
543 private dir = $prefix_abs/client/private
544 lock dir = $prefix_abs/client/lockdir
545 name resolve order = bcast
546 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
548 notify:inotify = false
550 system:anonymous = true
551 client lanman auth = Yes
552 torture:basedir = $prefix_abs/client
553 #We don't want to pass our self-tests if the PAC code is wrong
554 gensec:require_pac = true
555 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
562 my $testsdir = "$srcdir/selftest";
564 my %required_envs = ();
571 open(IN, $filename) or die("Unable to open $filename: $!");
574 if ($_ eq "-- TEST --\n") {
581 if (not defined($tests) or $name =~ /$tests/) {
582 $required_envs{$env} = 1;
583 push (@ret, [$name, $env, $cmdline]);
589 close(IN) or die("Error creating recipe");
593 if ($#testlists == -1) {
594 die("No testlists specified");
597 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
598 if ($opt_socket_wrapper) {
599 $ENV{SELFTEST_INTERFACES} = $interfaces;
601 $ENV{SELFTEST_INTERFACES} = "";
604 $ENV{SELFTEST_VERBOSE} = "1";
606 $ENV{SELFTEST_VERBOSE} = "";
609 $ENV{SELFTEST_QUICK} = "1";
611 $ENV{SELFTEST_QUICK} = "";
613 $ENV{SELFTEST_TARGET} = $opt_target;
614 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
617 foreach my $fn (@testlists) {
618 foreach (read_testlist($fn)) {
620 next if (@includes and not find_in_list(\@includes, $name));
621 push (@available, $_);
625 Subunit::report_time(time());
627 foreach (@available) {
629 my $skipreason = skip($name);
631 Subunit::end_test($name, "skip", $skipreason);
638 print STDERR "No tests to run\n";
642 my $suitestotal = $#todo + 1;
646 my %running_envs = ();
648 sub get_running_env($)
656 return $running_envs{$envname};
659 my @exported_envvars = (
664 # domain controller stuff
684 "WINBINDD_SOCKET_DIR",
685 "WINBINDD_PRIV_PIPE_DIR"
688 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
690 teardown_env($_) foreach(keys %running_envs);
691 die("Received signal $signame");
698 my $testenv_vars = undef;
704 $option =~ s/^[^:]*//;
707 $option = "client" if $option eq "";
709 if ($envname eq "none") {
711 } elsif (defined(get_running_env($envname))) {
712 $testenv_vars = get_running_env($envname);
713 if (not $target->check_env($testenv_vars)) {
714 $testenv_vars = undef;
717 $testenv_vars = $target->setup_env($envname, $prefix);
720 return undef unless defined($testenv_vars);
722 $running_envs{$envname} = $testenv_vars;
724 if ($option eq "local") {
725 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
726 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
727 } elsif ($option eq "client") {
728 SocketWrapper::set_default_iface(6);
729 write_clientconf($conffile, $testenv_vars);
730 $ENV{SMB_CONF_PATH} = $conffile;
732 die("Unknown option[$option] for envname[$envname]");
735 foreach (@exported_envvars) {
736 if (defined($testenv_vars->{$_})) {
737 $ENV{$_} = $testenv_vars->{$_};
743 return $testenv_vars;
746 sub exported_envvars_str($)
748 my ($testenv_vars) = @_;
751 foreach (@exported_envvars) {
752 next unless defined($testenv_vars->{$_});
753 $out .= $_."=".$testenv_vars->{$_}."\n";
762 return "" if ($envname eq "none");
763 return $target->getlog_env(get_running_env($envname));
769 return 1 if ($envname eq "none");
770 return $target->check_env(get_running_env($envname));
776 return if ($envname eq "none");
777 $target->teardown_env(get_running_env($envname));
778 delete $running_envs{$envname};
781 if ($opt_no_lazy_setup) {
782 setup_env($_) foreach (keys %required_envs);
786 my $testenv_name = $ENV{SELFTEST_TESTENV};
787 $testenv_name = $testenv_default unless defined($testenv_name);
789 my $testenv_vars = setup_env($testenv_name);
791 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
793 my $envvarstr = exported_envvars_str($testenv_vars);
795 my $term = ($ENV{TERM} or "xterm");
796 system("$term -e 'echo -e \"
797 Welcome to the Samba4 Test environment '$testenv_name'
799 This matches the client environment used in make test
800 server is pid `cat \$PIDDIR/samba.pid`
802 Some useful environment variables:
803 TORTURE_OPTIONS=\$TORTURE_OPTIONS
804 SMB_CONF_PATH=\$SMB_CONF_PATH
807 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
808 teardown_env($testenv_name);
813 $cmd =~ s/([\(\)])/\\$1/g;
815 my $envname = $$_[1];
817 my $envvars = setup_env($envname);
818 if (not defined($envvars)) {
819 Subunit::end_test($name, "skip",
820 "unable to set up environment $envname");
824 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
826 if (defined($opt_analyse_cmd)) {
827 system("$opt_analyse_cmd \"$name\"");
830 teardown_env($envname) if ($opt_resetup_env);
836 teardown_env($_) foreach (keys %running_envs);
842 # if there were any valgrind failures, show them
843 foreach (<$prefix/valgrind.log*>) {
845 system("grep DWARF2.CFI.reader $_ > /dev/null");
847 print "VALGRIND FAILURE\n";