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);
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]);
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::start_testsuite($name);
222 system("$cmd 2>&1 | $RealBin/filter-subunit.pl --prefix \"$name.\"");
225 Subunit::end_testsuite($name, "error", "Unable to run $cmd: $!");
227 } elsif ($ret & 127) {
228 Subunit::end_testsuite($name, "error", sprintf("Testsuite died with signal %d, %s coredump", ($ret & 127), ($ret & 128) ? "with": "without"));
231 my $envlog = getlog_env($envname);
233 print "envlog: $envlog\n";
236 print "command: $cmd\n";
238 my $exitcode = $ret >> 8;
240 Subunit::report_time(time());
241 my $reason = "Exit code was $exitcode";
243 if ($exitcode == 0) {
248 Subunit::end_testsuite($name, $result, $reason);
250 cleanup_pcap($pcap_file, $exitcode);
252 if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
253 print "PCAP FILE: $pcap_file\n";
256 if ($exitcode != 0) {
257 exit(1) if ($opt_one);
265 print "Samba test runner
266 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
267 Copyright (C) Stefan Metzmacher <metze\@samba.org>
269 Usage: $Script [OPTIONS] TESTNAME-REGEX
272 --help this help page
273 --target=samba[34]|win|kvm Samba version to target
274 --testlist=FILE file to read available tests from
277 --prefix=DIR prefix to run tests in [st]
278 --srcdir=DIR source directory [.]
279 --builddir=DIR output directory [.]
280 --exeext=EXT executable extention []
283 --socket-wrapper-pcap save traffic to pcap directories
284 --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
286 --socket-wrapper enable socket wrapper
287 --bindir=PATH path to target binaries
290 --ldap=openldap|fedora-ds back samba onto specified ldap server
293 --image=PATH path to KVM image
296 --quick run quick overall test
297 --one abort when the first test fails
299 --analyse-cmd CMD command to run after each test
304 my $result = GetOptions (
305 'help|h|?' => \$opt_help,
306 'target=s' => \$opt_target,
307 'prefix=s' => \$prefix,
308 'socket-wrapper' => \$opt_socket_wrapper,
309 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
310 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
311 'quick' => \$opt_quick,
313 'exclude=s' => \@opt_exclude,
314 'include=s' => \@opt_include,
315 'srcdir=s' => \$srcdir,
316 'builddir=s' => \$builddir,
317 'exeext=s' => \$exeext,
318 'verbose' => \$opt_verbose,
319 'testenv' => \$opt_testenv,
321 'analyse-cmd=s' => \$opt_analyse_cmd,
322 'no-lazy-setup' => \$opt_no_lazy_setup,
323 'resetup-environment' => \$opt_resetup_env,
324 'bindir:s' => \$opt_bindir,
325 'image=s' => \$opt_image,
326 'testlist=s' => \@testlists
329 exit(1) if (not $result);
331 ShowHelp() if ($opt_help);
335 # quick hack to disable rpc validation when using valgrind - its way too slow
336 unless (defined($ENV{VALGRIND})) {
337 $ENV{VALIDATE} = "validate";
338 $ENV{MALLOC_CHECK_} = 2;
341 my $bindir = ($opt_bindir or "$builddir/bin");
342 my $bindir_abs = abs_path($bindir);
344 # Backwards compatibility:
345 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
346 if (defined($ENV{FEDORA_DS_ROOT})) {
353 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
356 $torture_maxtime *= 2;
363 die("using an empty prefix isn't allowed") unless $prefix ne "";
365 #Ensure we have the test prefix around
366 mkdir($prefix, 0777) unless -d $prefix;
368 my $prefix_abs = abs_path($prefix);
369 my $srcdir_abs = abs_path($srcdir);
370 my $builddir_abs = abs_path($builddir);
372 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
373 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
375 $ENV{PREFIX} = $prefix;
376 $ENV{KRB5CCNAME} = "$prefix/krb5ticket";
377 $ENV{PREFIX_ABS} = $prefix_abs;
378 $ENV{SRCDIR} = $srcdir;
379 $ENV{SRCDIR_ABS} = $srcdir_abs;
380 $ENV{BUILDDIR} = $builddir;
381 $ENV{BUILDDIR_ABS} = $builddir_abs;
382 $ENV{EXEEXT} = $exeext;
384 my $tls_enabled = not $opt_quick;
385 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
386 $ENV{LDB_MODULES_PATH} = "$bindir_abs/modules/ldb";
387 $ENV{LD_SAMBA_MODULE_PATH} = "$bindir_abs/modules";
388 sub prefix_pathvar($$)
390 my ($name, $newpath) = @_;
391 if (defined($ENV{$name})) {
392 $ENV{$name} = "$newpath:$ENV{$name}";
394 $ENV{$name} = $newpath;
397 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
398 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
400 if ($opt_socket_wrapper_keep_pcap) {
401 # Socket wrapper keep pcap implies socket wrapper pcap
402 $opt_socket_wrapper_pcap = 1;
405 if ($opt_socket_wrapper_pcap) {
406 # Socket wrapper pcap implies socket wrapper
407 $opt_socket_wrapper = 1;
410 my $socket_wrapper_dir;
411 if ($opt_socket_wrapper) {
412 $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix/w", $opt_socket_wrapper_pcap);
413 print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
416 print "WARNING: Not using socket wrapper, but also not running as root. Will not be able to listen on proper ports\n";
421 my $testenv_default = "none";
423 if ($opt_target eq "samba4") {
424 $testenv_default = "member";
425 require target::Samba4;
426 $target = new Samba4($bindir, $ldap, "$srcdir/setup", $exeext);
427 } elsif ($opt_target eq "samba3") {
428 if ($opt_socket_wrapper and `$bindir/smbd -b | grep SOCKET_WRAPPER` eq "") {
429 die("You must include --enable-socket-wrapper when compiling Samba in order to execute 'make test'. Exiting....");
431 $testenv_default = "member";
432 require target::Samba3;
433 $target = new Samba3($bindir);
434 } elsif ($opt_target eq "win") {
435 die("Windows tests will not run with socket wrapper enabled.")
436 if ($opt_socket_wrapper);
437 $testenv_default = "dc";
438 require target::Windows;
439 $target = new Windows();
440 } elsif ($opt_target eq "kvm") {
441 die("Kvm tests will not run with socket wrapper enabled.")
442 if ($opt_socket_wrapper);
444 die("No image specified") unless ($opt_image);
445 $target = new Kvm($opt_image, undef);
449 # Start a Virtual Distributed Ethernet Switch
450 # Returns the pid of the switch.
452 sub start_vde_switch($)
456 system("vde_switch --pidfile $path/vde.pid --sock $path/vde.sock --daemon");
458 open(PID, "$path/vde.pid");
466 # Stop a Virtual Distributed Ethernet Switch
467 sub stop_vde_switch($)
473 sub read_test_regexes($)
477 open(LF, "<$name") or die("unable to read $name: $!");
481 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
482 push (@ret, [$1, $4]);
484 s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
485 push (@ret, [$_, undef]);
492 foreach (@opt_exclude) {
493 push (@excludes, read_test_regexes($_));
496 foreach (@opt_include) {
497 push (@includes, read_test_regexes($_));
500 my $interfaces = join(',', ("127.0.0.6/8",
507 my $conffile = "$prefix_abs/client/client.conf";
508 $ENV{SMB_CONF_PATH} = $conffile;
510 sub write_clientconf($$)
512 my ($conffile, $vars) = @_;
514 mkdir("$prefix/client", 0777) unless -d "$prefix/client";
516 if ( -d "$prefix/client/private" ) {
517 unlink <$prefix/client/private/*>;
519 mkdir("$prefix/client/private", 0777);
522 if ( -d "$prefix/client/lock" ) {
523 unlink <$prefix/client/lockdir/*>;
525 mkdir("$prefix/client/lockdir", 0777);
528 open(CF, ">$conffile");
529 print CF "[global]\n";
530 if (defined($ENV{VALGRIND})) {
531 print CF "\ticonv:native = true\n";
533 print CF "\ticonv:native = false\n";
535 print CF "\tnetbios name = client\n";
536 if (defined($vars->{DOMAIN})) {
537 print CF "\tworkgroup = $vars->{DOMAIN}\n";
539 if (defined($vars->{REALM})) {
540 print CF "\trealm = $vars->{REALM}\n";
542 if ($opt_socket_wrapper) {
543 print CF "\tinterfaces = $interfaces\n";
546 private dir = $prefix_abs/client/private
547 lock dir = $prefix_abs/client/lockdir
548 name resolve order = bcast
549 panic action = $RealBin/gdb_backtrace \%PID\% \%PROG\%
551 notify:inotify = false
553 system:anonymous = true
554 client lanman auth = Yes
555 torture:basedir = $prefix_abs/client
556 #We don't want to pass our self-tests if the PAC code is wrong
557 gensec:require_pac = true
558 modules dir = $ENV{LD_SAMBA_MODULE_PATH}
565 my $testsdir = "$srcdir/selftest";
567 my %required_envs = ();
574 open(IN, $filename) or die("Unable to open $filename: $!");
577 if ($_ eq "-- TEST --\n") {
584 if (not defined($tests) or $name =~ /$tests/) {
585 $required_envs{$env} = 1;
586 push (@ret, [$name, $env, $cmdline]);
592 close(IN) or die("Error creating recipe");
596 if ($#testlists == -1) {
597 die("No testlists specified");
600 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
601 if ($opt_socket_wrapper) {
602 $ENV{SELFTEST_INTERFACES} = $interfaces;
604 $ENV{SELFTEST_INTERFACES} = "";
607 $ENV{SELFTEST_VERBOSE} = "1";
609 $ENV{SELFTEST_VERBOSE} = "";
612 $ENV{SELFTEST_QUICK} = "1";
614 $ENV{SELFTEST_QUICK} = "";
616 $ENV{SELFTEST_TARGET} = $opt_target;
617 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
620 foreach my $fn (@testlists) {
621 foreach (read_testlist($fn)) {
623 next if (@includes and not defined(find_in_list(\@includes, $name)));
624 push (@available, $_);
628 Subunit::testsuite_count($#available+1);
629 Subunit::report_time(time());
631 foreach (@available) {
633 my $skipreason = skip($name);
634 if (defined($skipreason)) {
635 Subunit::skip_testsuite($name, $skipreason);
642 print STDERR "No tests to run\n";
646 my $suitestotal = $#todo + 1;
650 my %running_envs = ();
652 sub get_running_env($)
660 return $running_envs{$envname};
663 my @exported_envvars = (
668 # domain controller stuff
688 "WINBINDD_SOCKET_DIR",
689 "WINBINDD_PRIV_PIPE_DIR"
692 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
694 teardown_env($_) foreach(keys %running_envs);
695 die("Received signal $signame");
702 my $testenv_vars = undef;
708 $option =~ s/^[^:]*//;
711 $option = "client" if $option eq "";
713 if ($envname eq "none") {
715 } elsif (defined(get_running_env($envname))) {
716 $testenv_vars = get_running_env($envname);
717 if (not $target->check_env($testenv_vars)) {
718 $testenv_vars = undef;
721 $testenv_vars = $target->setup_env($envname, $prefix);
724 return undef unless defined($testenv_vars);
726 $running_envs{$envname} = $testenv_vars;
728 if ($option eq "local") {
729 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
730 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
731 } elsif ($option eq "client") {
732 SocketWrapper::set_default_iface(6);
733 write_clientconf($conffile, $testenv_vars);
734 $ENV{SMB_CONF_PATH} = $conffile;
736 die("Unknown option[$option] for envname[$envname]");
739 foreach (@exported_envvars) {
740 if (defined($testenv_vars->{$_})) {
741 $ENV{$_} = $testenv_vars->{$_};
747 return $testenv_vars;
750 sub exported_envvars_str($)
752 my ($testenv_vars) = @_;
755 foreach (@exported_envvars) {
756 next unless defined($testenv_vars->{$_});
757 $out .= $_."=".$testenv_vars->{$_}."\n";
766 return "" if ($envname eq "none");
767 return $target->getlog_env(get_running_env($envname));
773 return 1 if ($envname eq "none");
774 return $target->check_env(get_running_env($envname));
780 return if ($envname eq "none");
781 $target->teardown_env(get_running_env($envname));
782 delete $running_envs{$envname};
785 if ($opt_no_lazy_setup) {
786 setup_env($_) foreach (keys %required_envs);
790 my $testenv_name = $ENV{SELFTEST_TESTENV};
791 $testenv_name = $testenv_default unless defined($testenv_name);
793 my $testenv_vars = setup_env($testenv_name);
795 $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
797 my $envvarstr = exported_envvars_str($testenv_vars);
799 my $term = ($ENV{TERM} or "xterm");
800 system("$term -e 'echo -e \"
801 Welcome to the Samba4 Test environment '$testenv_name'
803 This matches the client environment used in make test
804 server is pid `cat \$PIDDIR/samba.pid`
806 Some useful environment variables:
807 TORTURE_OPTIONS=\$TORTURE_OPTIONS
808 SMB_CONF_PATH=\$SMB_CONF_PATH
811 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash'");
812 teardown_env($testenv_name);
817 $cmd =~ s/([\(\)])/\\$1/g;
819 my $envname = $$_[1];
821 my $envvars = setup_env($envname);
822 if (not defined($envvars)) {
823 Subunit::skip_testsuite($name,
824 "unable to set up environment $envname");
828 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
830 if (defined($opt_analyse_cmd)) {
831 system("$opt_analyse_cmd \"$name\"");
834 teardown_env($envname) if ($opt_resetup_env);
840 teardown_env($_) foreach (keys %running_envs);
846 # if there were any valgrind failures, show them
847 foreach (<$prefix/valgrind.log*>) {
849 system("grep DWARF2.CFI.reader $_ > /dev/null");
851 print "VALGRIND FAILURE\n";