selftest/selftest.pl

   1 #!/usr/bin/perl
   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>
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 use strict;
  20
  21 use FindBin qw($RealBin $Script);
  22 use File::Spec;
  23 use File::Temp qw(tempfile);
  24 use Getopt::Long;
  25 use POSIX;
  26 use Cwd qw(abs_path);
  27 use lib "$RealBin";
  28 use Subunit;
  29 use SocketWrapper;
  30 use target::Samba;
  31 use Time::HiRes qw(time);
  32
  33 eval {
  34 require Time::HiRes;
  35 Time::HiRes->import("time");
  36 };
  37 if ($@) {
  38         print "You don't have Time::Hires installed !\n";
  39 }
  40
  41 my $opt_help = 0;
  42 my $opt_target = "samba";
  43 my $opt_quick = 0;
  44 my $opt_socket_wrapper = 0;
  45 my $opt_socket_wrapper_pcap = undef;
  46 my $opt_socket_wrapper_keep_pcap = undef;
  47 my $opt_random_order = 0;
  48 my $opt_one = 0;
  49 my @opt_exclude = ();
  50 my @opt_include = ();
  51 my @opt_exclude_env = ();
  52 my @opt_include_env = ();
  53 my $opt_testenv = 0;
  54 my $opt_list = 0;
  55 my $opt_mitkrb5 = 0;
  56 my $ldap = undef;
  57 my $opt_resetup_env = undef;
  58 my $opt_load_list = undef;
  59 my $opt_libnss_wrapper_so_path = "";
  60 my $opt_libresolv_wrapper_so_path = "";
  61 my $opt_libsocket_wrapper_so_path = "";
  62 my $opt_libuid_wrapper_so_path = "";
  63 my $opt_libasan_so_path = "";
  64 my $opt_use_dns_faking = 0;
  65 my @testlists = ();
  66
  67 my $srcdir = ".";
  68 my $bindir = "./bin";
  69 my $prefix = "./st";
  70
  71 my @includes = ();
  72 my @excludes = ();
  73
  74 sub find_in_list($$)
  75 {
  76         my ($list, $fullname) = @_;
  77
  78         foreach (@$list) {
  79                 if ($fullname =~ /$$_[0]/) {
  80                          return ($$_[1]) if ($$_[1]);
  81                          return "";
  82                 }
  83         }
  84
  85         return undef;
  86 }
  87
  88 sub skip
  89 {
  90         my ($name, $envname) = @_;
  91         my ($env_basename, $env_localpart) = split(/:/, $envname);
  92
  93         if ($opt_target eq "samba3" && $Samba::ENV_NEEDS_AD_DC{$env_basename}) {
  94                 return "environment $envname is disabled as this build does not include an AD DC";
  95         }
  96
  97         if (@opt_include_env && !(grep {$_ eq $env_basename} @opt_include_env)) {
  98                 return "environment $envname is disabled (via --include-env command line option) in this test run - skipping";
  99         } elsif (@opt_exclude_env && grep {$_ eq $env_basename} @opt_exclude_env) {
 100                 return "environment $envname is disabled (via --exclude-env command line option) in this test run - skipping";
 101         }
 102
 103         return find_in_list(\@excludes, $name);
 104 }
 105
 106 sub getlog_env($);
 107
 108 sub setup_pcap($)
 109 {
 110         my ($name) = @_;
 111
 112         return unless ($opt_socket_wrapper_pcap);
 113         return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR});
 114
 115         my $fname = $name;
 116         $fname =~ s%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\-]%_%g;
 117
 118         my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
 119
 120         SocketWrapper::setup_pcap($pcap_file);
 121
 122         return $pcap_file;
 123 }
 124
 125 sub cleanup_pcap($$)
 126 {
 127         my ($pcap_file, $exitcode) = @_;
 128
 129         return unless ($opt_socket_wrapper_pcap);
 130         return if ($opt_socket_wrapper_keep_pcap);
 131         return unless ($exitcode == 0);
 132         return unless defined($pcap_file);
 133
 134         unlink($pcap_file);
 135 }
 136
 137 # expand strings from %ENV
 138 sub expand_environment_strings($)
 139 {
 140         my $s = shift;
 141         # we use a reverse sort so we do the longer ones first
 142         foreach my $k (sort { $b cmp $a } keys %ENV) {
 143                 $s =~ s/\$$k/$ENV{$k}/g;
 144         }
 145         return $s;
 146 }
 147
 148 sub run_testsuite($$$$$)
 149 {
 150         my ($envname, $name, $cmd, $i, $totalsuites) = @_;
 151         my $pcap_file = setup_pcap($name);
 152
 153         Subunit::start_testsuite($name);
 154         Subunit::progress_push();
 155         Subunit::report_time();
 156         system($cmd);
 157         Subunit::report_time();
 158         Subunit::progress_pop();
 159
 160         if ($? == -1) {
 161                 print "command: $cmd\n";
 162                 printf "expanded command: %s\n", expand_environment_strings($cmd);
 163                 Subunit::end_testsuite($name, "error", "Unable to run $cmd: $!");
 164                 exit(1);
 165         } elsif ($? & 127) {
 166                 print "command: $cmd\n";
 167                 printf "expanded command: %s\n", expand_environment_strings($cmd);
 168                 Subunit::end_testsuite($name, "error",
 169                         sprintf("%s died with signal %d, %s coredump\n", $cmd, ($? & 127),  ($? & 128) ? 'with' : 'without'));
 170                 exit(1);
 171         }
 172
 173         my $exitcode = $? >> 8;
 174
 175         my $envlog = getlog_env($envname);
 176         if ($envlog ne "") {
 177                 print "envlog: $envlog\n";
 178         }
 179
 180         print "command: $cmd\n";
 181         printf "expanded command: %s\n", expand_environment_strings($cmd);
 182
 183         if ($exitcode == 0) {
 184                 Subunit::end_testsuite($name, "success");
 185         } else {
 186                 Subunit::end_testsuite($name, "failure", "Exit code was $exitcode");
 187         }
 188
 189         cleanup_pcap($pcap_file, $exitcode);
 190
 191         if (not $opt_socket_wrapper_keep_pcap and defined($pcap_file)) {
 192                 print "PCAP FILE: $pcap_file\n";
 193         }
 194
 195         if ($exitcode != 0) {
 196                 exit(1) if ($opt_one);
 197         }
 198
 199         return $exitcode;
 200 }
 201
 202 sub ShowHelp()
 203 {
 204         print "Samba test runner
 205 Copyright (C) Jelmer Vernooij <jelmer\@samba.org>
 206 Copyright (C) Stefan Metzmacher <metze\@samba.org>
 207
 208 Usage: $Script [OPTIONS] TESTNAME-REGEX [TESTNAME-REGEX...]
 209
 210 Generic options:
 211  --help                     this help page
 212  --target=samba[3]|win      Samba version to target
 213  --testlist=FILE            file to read available tests from
 214  --exclude=FILE             Exclude tests listed in the file
 215  --include=FILE             Include tests listed in the file
 216  --exclude-env=ENV          Exclude tests for the specified environment
 217  --include-env=ENV          Include tests for the specified environment
 218
 219 Paths:
 220  --prefix=DIR               prefix to run tests in [st]
 221  --srcdir=DIR               source directory [.]
 222  --bindir=DIR               binaries directory [./bin]
 223
 224 Preload cwrap:
 225  --nss_wrapper_so_path=FILE the nss_wrapper library to preload
 226  --resolv_wrapper_so_path=FILE the resolv_wrapper library to preload
 227  --socket_wrapper_so_path=FILE the socket_wrapper library to preload
 228  --uid_wrapper_so_path=FILE the uid_wrapper library to preload
 229  --asan_so_path=FILE the asan library to preload
 230
 231 DNS:
 232   --use-dns-faking          Fake DNS entries rather than talking to our
 233                             DNS implementation.
 234
 235 Target Specific:
 236  --socket-wrapper-pcap      save traffic to pcap directories
 237  --socket-wrapper-keep-pcap keep all pcap files, not just those for tests that
 238                             failed
 239  --socket-wrapper           enable socket wrapper
 240
 241 Samba4 Specific:
 242  --ldap=openldap|fedora-ds  back samba onto specified ldap server
 243
 244 Behaviour:
 245  --quick                    run quick overall test
 246  --one                      abort when the first test fails
 247  --testenv                  run a shell in the requested test environment
 248  --list                     list available tests
 249 ";
 250         exit(0);
 251 }
 252
 253 my $result = GetOptions (
 254                 'help|h|?' => \$opt_help,
 255                 'target=s' => \$opt_target,
 256                 'prefix=s' => \$prefix,
 257                 'socket-wrapper' => \$opt_socket_wrapper,
 258                 'socket-wrapper-pcap' => \$opt_socket_wrapper_pcap,
 259                 'socket-wrapper-keep-pcap' => \$opt_socket_wrapper_keep_pcap,
 260                 'quick' => \$opt_quick,
 261                 'one' => \$opt_one,
 262                 'exclude=s' => \@opt_exclude,
 263                 'include=s' => \@opt_include,
 264                 'exclude-env=s' => \@opt_exclude_env,
 265                 'include-env=s' => \@opt_include_env,
 266                 'srcdir=s' => \$srcdir,
 267                 'bindir=s' => \$bindir,
 268                 'testenv' => \$opt_testenv,
 269                 'list' => \$opt_list,
 270                 'mitkrb5' => \$opt_mitkrb5,
 271                 'ldap:s' => \$ldap,
 272                 'resetup-environment' => \$opt_resetup_env,
 273                 'testlist=s' => \@testlists,
 274                 'random-order' => \$opt_random_order,
 275                 'load-list=s' => \$opt_load_list,
 276                 'nss_wrapper_so_path=s' => \$opt_libnss_wrapper_so_path,
 277                 'resolv_wrapper_so_path=s' => \$opt_libresolv_wrapper_so_path,
 278                 'socket_wrapper_so_path=s' => \$opt_libsocket_wrapper_so_path,
 279                 'uid_wrapper_so_path=s' => \$opt_libuid_wrapper_so_path,
 280                 'asan_so_path=s' => \$opt_libasan_so_path,
 281                 'use-dns-faking' => \$opt_use_dns_faking
 282             );
 283
 284 exit(1) if (not $result);
 285
 286 ShowHelp() if ($opt_help);
 287
 288 die("--list and --testenv are mutually exclusive") if ($opt_list and $opt_testenv);
 289
 290 # we want unbuffered output
 291 $| = 1;
 292
 293 my @tests = @ARGV;
 294
 295 # quick hack to disable rpc validation when using valgrind - its way too slow
 296 unless (defined($ENV{VALGRIND})) {
 297         $ENV{VALIDATE} = "validate";
 298         $ENV{MALLOC_CHECK_} = 3;
 299 }
 300
 301 # make all our python scripts unbuffered
 302 $ENV{PYTHONUNBUFFERED} = 1;
 303
 304 my $bindir_abs = abs_path($bindir);
 305
 306 # Backwards compatibility:
 307 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
 308         if (defined($ENV{FEDORA_DS_ROOT})) {
 309                 $ldap = "fedora-ds";
 310         } else {
 311                 $ldap = "openldap";
 312         }
 313 }
 314
 315 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
 316 if ($ldap) {
 317         # LDAP is slow
 318         $torture_maxtime *= 2;
 319 }
 320
 321 $prefix =~ s+//+/+;
 322 $prefix =~ s+/./+/+;
 323 $prefix =~ s+/$++;
 324
 325 die("using an empty prefix isn't allowed") unless $prefix ne "";
 326
 327 # Ensure we have the test prefix around.
 328 #
 329 # We need restrictive
 330 # permissions on this as some subdirectories in this tree will have
 331 # wider permissions (ie 0777) and this would allow other users on the
 332 # host to subvert the test process.
 333 umask 0077;
 334 mkdir($prefix, 0700) unless -d $prefix;
 335 chmod 0700, $prefix;
 336 # We need to have no umask limitations for the tests.
 337 umask 0000;
 338
 339 my $prefix_abs = abs_path($prefix);
 340 my $tmpdir_abs = abs_path("$prefix/tmp");
 341 mkdir($tmpdir_abs, 0777) unless -d $tmpdir_abs;
 342
 343 my $srcdir_abs = abs_path($srcdir);
 344
 345 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
 346 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
 347
 348 $ENV{SAMBA_SELFTEST} = "1";
 349
 350 $ENV{PREFIX} = $prefix;
 351 $ENV{PREFIX_ABS} = $prefix_abs;
 352 $ENV{SRCDIR} = $srcdir;
 353 $ENV{SRCDIR_ABS} = $srcdir_abs;
 354 $ENV{GNUPGHOME} = "$srcdir_abs/selftest/gnupg";
 355 $ENV{BINDIR} = $bindir_abs;
 356
 357 my $tls_enabled = not $opt_quick;
 358 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
 359
 360 sub prefix_pathvar($$)
 361 {
 362         my ($name, $newpath) = @_;
 363         if (defined($ENV{$name})) {
 364                 $ENV{$name} = "$newpath:$ENV{$name}";
 365         } else {
 366                 $ENV{$name} = $newpath;
 367         }
 368 }
 369 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
 370 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
 371
 372 if ($opt_socket_wrapper_keep_pcap) {
 373         # Socket wrapper keep pcap implies socket wrapper pcap
 374         $opt_socket_wrapper_pcap = 1;
 375 }
 376
 377 if ($opt_socket_wrapper_pcap) {
 378         # Socket wrapper pcap implies socket wrapper
 379         $opt_socket_wrapper = 1;
 380 }
 381
 382 my $ld_preload = $ENV{LD_PRELOAD};
 383
 384 if ($opt_libasan_so_path) {
 385         if ($ld_preload) {
 386                 $ld_preload = "$ld_preload:$opt_libasan_so_path";
 387         } else {
 388                 $ld_preload = "$opt_libasan_so_path";
 389         }
 390 }
 391
 392 if ($opt_libnss_wrapper_so_path) {
 393         if ($ld_preload) {
 394                 $ld_preload = "$ld_preload:$opt_libnss_wrapper_so_path";
 395         } else {
 396                 $ld_preload = "$opt_libnss_wrapper_so_path";
 397         }
 398 }
 399
 400 if ($opt_libresolv_wrapper_so_path) {
 401         if ($ld_preload) {
 402                 $ld_preload = "$ld_preload:$opt_libresolv_wrapper_so_path";
 403         } else {
 404                 $ld_preload = "$opt_libresolv_wrapper_so_path";
 405         }
 406 }
 407
 408 if ($opt_libsocket_wrapper_so_path) {
 409         if ($ld_preload) {
 410                 $ld_preload = "$ld_preload:$opt_libsocket_wrapper_so_path";
 411         } else {
 412                 $ld_preload = "$opt_libsocket_wrapper_so_path";
 413         }
 414 }
 415
 416 if ($opt_libuid_wrapper_so_path) {
 417         if ($ld_preload) {
 418                 $ld_preload = "$ld_preload:$opt_libuid_wrapper_so_path";
 419         } else {
 420                 $ld_preload = "$opt_libuid_wrapper_so_path";
 421         }
 422 }
 423
 424 $ENV{LD_PRELOAD} = $ld_preload;
 425 print "LD_PRELOAD=$ENV{LD_PRELOAD}\n";
 426
 427 # Enable uid_wrapper globally
 428 $ENV{UID_WRAPPER} = 1;
 429
 430 # Disable RTLD_DEEPBIND hack for Samba bind dlz module
 431 #
 432 # This is needed in order to allow the ldb_*ldap module
 433 # to work with a preloaded socket wrapper.
 434 $ENV{LDB_MODULES_DISABLE_DEEPBIND} = 1;
 435
 436 my $socket_wrapper_dir;
 437 if ($opt_socket_wrapper) {
 438         $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix_abs/w", $opt_socket_wrapper_pcap);
 439         print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
 440 } elsif (not $opt_list) {
 441          unless ($< == 0) {
 442                  warn("not using socket wrapper, but also not running as root. Will not be able to listen on proper ports");
 443          }
 444 }
 445
 446 if ($opt_use_dns_faking) {
 447         print "DNS: Faking nameserver\n";
 448         $ENV{SAMBA_DNS_FAKING} = 1;
 449 }
 450
 451 my $target;
 452 my $testenv_default = "none";
 453
 454 if ($opt_mitkrb5 == 1) {
 455         $ENV{MITKRB5} = $opt_mitkrb5;
 456 }
 457
 458 # After this many seconds, the server will self-terminate.  All tests
 459 # must terminate in this time, and testenv will only stay alive this
 460 # long
 461
 462 my $server_maxtime;
 463 if ($opt_testenv) {
 464     # 1 year should be enough :-)
 465     $server_maxtime = 365 * 24 * 60 * 60;
 466 } else {
 467     # make test should run under 5 hours
 468     $server_maxtime = 5 * 60 * 60;
 469 }
 470
 471 if (defined($ENV{SMBD_MAXTIME}) and $ENV{SMBD_MAXTIME} ne "") {
 472     $server_maxtime = $ENV{SMBD_MAXTIME};
 473 }
 474
 475 $target = new Samba($bindir, $ldap, $srcdir, $server_maxtime);
 476 unless ($opt_list) {
 477         if ($opt_target eq "samba") {
 478                 $testenv_default = "ad_dc";
 479         } elsif ($opt_target eq "samba3") {
 480                 $testenv_default = "nt4_member";
 481         }
 482 }
 483
 484 sub read_test_regexes($)
 485 {
 486         my ($name) = @_;
 487         my @ret = ();
 488         open(LF, "<$name") or die("unable to read $name: $!");
 489         while (<LF>) {
 490                 chomp;
 491                 next if (/^#/);
 492                 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
 493                         push (@ret, [$1, $4]);
 494                 } else {
 495                         s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
 496                         push (@ret, [$_, undef]);
 497                 }
 498         }
 499         close(LF);
 500         return @ret;
 501 }
 502
 503 foreach (@opt_exclude) {
 504         push (@excludes, read_test_regexes($_));
 505 }
 506
 507 foreach (@opt_include) {
 508         push (@includes, read_test_regexes($_));
 509 }
 510
 511 my $interfaces = join(',', ("127.0.0.11/8",
 512                             "127.0.0.12/8",
 513                             "127.0.0.13/8",
 514                             "127.0.0.14/8",
 515                             "127.0.0.15/8",
 516                             "127.0.0.16/8"));
 517
 518 my $clientdir = "$prefix_abs/client";
 519
 520 my $conffile = "$clientdir/client.conf";
 521 $ENV{SMB_CONF_PATH} = $conffile;
 522
 523 sub write_clientconf($$$)
 524 {
 525         my ($conffile, $clientdir, $vars) = @_;
 526
 527         mkdir("$clientdir", 0777) unless -d "$clientdir";
 528
 529         if ( -d "$clientdir/private" ) {
 530                 unlink <$clientdir/private/*>;
 531         } else {
 532                 mkdir("$clientdir/private", 0777);
 533         }
 534
 535         if ( -d "$clientdir/bind-dns" ) {
 536                 unlink <$clientdir/bind-dns/*>;
 537         } else {
 538                 mkdir("$clientdir/bind-dns", 0777);
 539         }
 540
 541         if ( -d "$clientdir/lockdir" ) {
 542                 unlink <$clientdir/lockdir/*>;
 543         } else {
 544                 mkdir("$clientdir/lockdir", 0777);
 545         }
 546
 547         if ( -d "$clientdir/statedir" ) {
 548                 unlink <$clientdir/statedir/*>;
 549         } else {
 550                 mkdir("$clientdir/statedir", 0777);
 551         }
 552
 553         if ( -d "$clientdir/cachedir" ) {
 554                 unlink <$clientdir/cachedir/*>;
 555         } else {
 556                 mkdir("$clientdir/cachedir", 0777);
 557         }
 558
 559         # this is ugly, but the ncalrpcdir needs exactly 0755
 560         # otherwise tests fail.
 561         my $mask = umask;
 562         umask 0022;
 563         if ( -d "$clientdir/ncalrpcdir/np" ) {
 564                 unlink <$clientdir/ncalrpcdir/np/*>;
 565                 rmdir "$clientdir/ncalrpcdir/np";
 566         }
 567         if ( -d "$clientdir/ncalrpcdir" ) {
 568                 unlink <$clientdir/ncalrpcdir/*>;
 569                 rmdir "$clientdir/ncalrpcdir";
 570         }
 571         mkdir("$clientdir/ncalrpcdir", 0755);
 572         umask $mask;
 573
 574         my $cadir = "$ENV{SRCDIR_ABS}/selftest/manage-ca/CA-samba.example.com";
 575         my $cacert = "$cadir/Public/CA-samba.example.com-cert.pem";
 576         my $cacrl_pem = "$cadir/Public/CA-samba.example.com-crl.pem";
 577         my $ca_users_dir = "$cadir/Users";
 578
 579         if ( -d "$clientdir/pkinit" ) {
 580                 unlink <$clientdir/pkinit/*>;
 581         } else {
 582                 mkdir("$clientdir/pkinit", 0700);
 583         }
 584
 585         # each user has a USER-${USER_PRINCIPAL_NAME}-cert.pem and
 586         # USER-${USER_PRINCIPAL_NAME}-private-key.pem symlink
 587         # We make a copy here and make the certificated easily
 588         # accessable in the client environment.
 589         my $mask = umask;
 590         umask 0077;
 591         opendir USERS, "${ca_users_dir}" or die "Could not open dir '${ca_users_dir}': $!";
 592         for my $d (readdir USERS) {
 593                 my $user_dir = "${ca_users_dir}/${d}";
 594                 next if ${d} =~ /^\./;
 595                 next if (! -d "${user_dir}");
 596                 opendir USER, "${user_dir}" or die "Could not open dir '${user_dir}': $!";
 597                 for my $l (readdir USER) {
 598                         my $user_link = "${user_dir}/${l}";
 599                         next if ${l} =~ /^\./;
 600                         next if (! -l "${user_link}");
 601
 602                         my $dest = "${clientdir}/pkinit/${l}";
 603                         Samba::copy_file_content(${user_link}, ${dest});
 604                 }
 605                 closedir USER;
 606         }
 607         closedir USERS;
 608         umask $mask;
 609
 610         open(CF, ">$conffile");
 611         print CF "[global]\n";
 612         print CF "\tnetbios name = client\n";
 613         if (defined($vars->{DOMAIN})) {
 614                 print CF "\tworkgroup = $vars->{DOMAIN}\n";
 615         }
 616         if (defined($vars->{REALM})) {
 617                 print CF "\trealm = $vars->{REALM}\n";
 618         }
 619         if ($opt_socket_wrapper) {
 620                 print CF "\tinterfaces = $interfaces\n";
 621         }
 622         print CF "
 623         private dir = $clientdir/private
 624         binddns dir = $clientdir/bind-dns
 625         lock dir = $clientdir/lockdir
 626         state directory = $clientdir/statedir
 627         cache directory = $clientdir/cachedir
 628         ncalrpc dir = $clientdir/ncalrpcdir
 629         panic action = $RealBin/gdb_backtrace \%d
 630         max xmit = 32K
 631         notify:inotify = false
 632         ldb:nosync = true
 633         system:anonymous = true
 634         client lanman auth = Yes
 635         log level = 1
 636         torture:basedir = $clientdir
 637 #We don't want to pass our self-tests if the PAC code is wrong
 638         gensec:require_pac = true
 639 #We don't want to run 'speed' tests for very long
 640         torture:timelimit = 1
 641         winbind separator = /
 642         tls cafile = ${cacert}
 643         tls crlfile = ${cacrl_pem}
 644         tls verify peer = no_check
 645         include system krb5 conf = no
 646 ";
 647         close(CF);
 648 }
 649
 650 my @todo = ();
 651
 652 sub should_run_test($)
 653 {
 654         my $name = shift;
 655         if ($#tests == -1) {
 656                 return 1;
 657         }
 658         for (my $i=0; $i <= $#tests; $i++) {
 659                 if ($name =~ /$tests[$i]/i) {
 660                         return 1;
 661                 }
 662         }
 663         return 0;
 664 }
 665
 666 sub read_testlist($)
 667 {
 668         my ($filename) = @_;
 669
 670         my @ret = ();
 671         open(IN, $filename) or die("Unable to open $filename: $!");
 672
 673         while (<IN>) {
 674                 if (/-- TEST(-LOADLIST|) --\n/) {
 675                         my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
 676                         my $name = <IN>;
 677                         $name =~ s/\n//g;
 678                         my $env = <IN>;
 679                         $env =~ s/\n//g;
 680                         my $loadlist;
 681                         if ($supports_loadlist) {
 682                                 $loadlist = <IN>;
 683                                 $loadlist =~ s/\n//g;
 684                         }
 685                         my $cmdline = <IN>;
 686                         $cmdline =~ s/\n//g;
 687                         if (should_run_test($name) == 1) {
 688                                 push (@ret, [$name, $env, $cmdline, $loadlist]);
 689                         }
 690                 } else {
 691                         print;
 692                 }
 693         }
 694         close(IN) or die("Error creating recipe from $filename");
 695         return @ret;
 696 }
 697
 698 if ($#testlists == -1) {
 699         die("No testlists specified");
 700 }
 701
 702 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
 703 $ENV{SELFTEST_TMPDIR} = "$tmpdir_abs";
 704 $ENV{TMPDIR} = "$tmpdir_abs";
 705 $ENV{TEST_DATA_PREFIX} = "$tmpdir_abs";
 706 if ($opt_socket_wrapper) {
 707         $ENV{SELFTEST_INTERFACES} = $interfaces;
 708 } else {
 709         $ENV{SELFTEST_INTERFACES} = "";
 710 }
 711 if ($opt_quick) {
 712         $ENV{SELFTEST_QUICK} = "1";
 713 } else {
 714         $ENV{SELFTEST_QUICK} = "";
 715 }
 716 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
 717
 718 my $selftest_krbt_ccache_path = "$tmpdir_abs/selftest.krb5_ccache";
 719 $ENV{KRB5CCNAME} = "FILE:${selftest_krbt_ccache_path}.global";
 720
 721 my @available = ();
 722 foreach my $fn (@testlists) {
 723         foreach (read_testlist($fn)) {
 724                 my $name = $$_[0];
 725                 next if (@includes and not defined(find_in_list(\@includes, $name)));
 726                 push (@available, $_);
 727         }
 728 }
 729
 730 my $restricted = undef;
 731 my $restricted_used = {};
 732
 733 if ($opt_load_list) {
 734         $restricted = [];
 735         open(LOAD_LIST, "<$opt_load_list") or die("Unable to open $opt_load_list");
 736         while (<LOAD_LIST>) {
 737                 chomp;
 738                 push (@$restricted, $_);
 739         }
 740         close(LOAD_LIST);
 741 }
 742
 743 my $individual_tests = undef;
 744 $individual_tests = {};
 745
 746 foreach my $testsuite (@available) {
 747         my $name = $$testsuite[0];
 748         my $skipreason = skip(@$testsuite);
 749         if (defined($restricted)) {
 750                 # Find the testsuite for this test
 751                 my $match = undef;
 752                 foreach my $r (@$restricted) {
 753                         if ($r eq $name) {
 754                                 $individual_tests->{$name} = [];
 755                                 $match = $r;
 756                                 $restricted_used->{$r} = 1;
 757                         } elsif (substr($r, 0, length($name)+1) eq "$name.") {
 758                                 push(@{$individual_tests->{$name}}, $r);
 759                                 $match = $r;
 760                                 $restricted_used->{$r} = 1;
 761                         }
 762                 }
 763                 if ($match) {
 764                         if (defined($skipreason)) {
 765                                 if (not $opt_list) {
 766                                         Subunit::skip_testsuite($name, $skipreason);
 767                                 }
 768                         } else {
 769                                 push(@todo, $testsuite);
 770                         }
 771                 }
 772         } elsif (defined($skipreason)) {
 773                 if (not $opt_list) {
 774                         Subunit::skip_testsuite($name, $skipreason);
 775                 }
 776         } else {
 777                 push(@todo, $testsuite);
 778         }
 779 }
 780
 781 if (defined($restricted)) {
 782         foreach (@$restricted) {
 783                 unless (defined($restricted_used->{$_})) {
 784                         print "No test or testsuite found matching $_\n";
 785                 }
 786         }
 787 } elsif ($#todo == -1) {
 788         print STDERR "No tests to run\n";
 789         exit(1);
 790 }
 791
 792 my $suitestotal = $#todo + 1;
 793
 794 unless ($opt_list) {
 795         Subunit::progress($suitestotal);
 796         Subunit::report_time();
 797 }
 798
 799 my $i = 0;
 800 $| = 1;
 801
 802 my %running_envs = ();
 803
 804 sub get_running_env($)
 805 {
 806         my ($name) = @_;
 807
 808         my $envname = $name;
 809
 810         $envname =~ s/:.*//;
 811
 812         return $running_envs{$envname};
 813 }
 814
 815 my @exported_envvars = (
 816         # domain stuff
 817         "DOMAIN",
 818         "REALM",
 819         "DOMSID",
 820
 821         # stuff related to a trusted domain
 822         "TRUST_SERVER",
 823         "TRUST_SERVER_IP",
 824         "TRUST_SERVER_IPV6",
 825         "TRUST_NETBIOSNAME",
 826         "TRUST_USERNAME",
 827         "TRUST_PASSWORD",
 828         "TRUST_DOMAIN",
 829         "TRUST_REALM",
 830         "TRUST_DOMSID",
 831
 832         # domain controller stuff
 833         "DC_SERVER",
 834         "DC_SERVER_IP",
 835         "DC_SERVER_IPV6",
 836         "DC_NETBIOSNAME",
 837         "DC_NETBIOSALIAS",
 838
 839         # domain member
 840         "MEMBER_SERVER",
 841         "MEMBER_SERVER_IP",
 842         "MEMBER_SERVER_IPV6",
 843         "MEMBER_NETBIOSNAME",
 844         "MEMBER_NETBIOSALIAS",
 845
 846         # rpc proxy controller stuff
 847         "RPC_PROXY_SERVER",
 848         "RPC_PROXY_SERVER_IP",
 849         "RPC_PROXY_SERVER_IPV6",
 850         "RPC_PROXY_NETBIOSNAME",
 851         "RPC_PROXY_NETBIOSALIAS",
 852
 853         # domain controller stuff for Vampired DC
 854         "VAMPIRE_DC_SERVER",
 855         "VAMPIRE_DC_SERVER_IP",
 856         "VAMPIRE_DC_SERVER_IPV6",
 857         "VAMPIRE_DC_NETBIOSNAME",
 858         "VAMPIRE_DC_NETBIOSALIAS",
 859
 860         # domain controller stuff for RODC
 861         "RODC_DC_SERVER",
 862         "RODC_DC_SERVER_IP",
 863         "RODC_DC_SERVER_IPV6",
 864         "RODC_DC_NETBIOSNAME",
 865
 866         # domain controller stuff for FL 2000 Vampired DC
 867         "VAMPIRE_2000_DC_SERVER",
 868         "VAMPIRE_2000_DC_SERVER_IP",
 869         "VAMPIRE_2000_DC_SERVER_IPV6",
 870         "VAMPIRE_2000_DC_NETBIOSNAME",
 871         "VAMPIRE_2000_DC_NETBIOSALIAS",
 872
 873         "PROMOTED_DC_SERVER",
 874         "PROMOTED_DC_SERVER_IP",
 875         "PROMOTED_DC_SERVER_IPV6",
 876         "PROMOTED_DC_NETBIOSNAME",
 877         "PROMOTED_DC_NETBIOSALIAS",
 878
 879         # server stuff
 880         "SERVER",
 881         "SERVER_IP",
 882         "SERVER_IPV6",
 883         "NETBIOSNAME",
 884         "NETBIOSALIAS",
 885         "SAMSID",
 886
 887         # user stuff
 888         "USERNAME",
 889         "USERID",
 890         "PASSWORD",
 891         "DC_USERNAME",
 892         "DC_PASSWORD",
 893
 894         # UID/GID for rfc2307 mapping tests
 895         "UID_RFC2307TEST",
 896         "GID_RFC2307TEST",
 897
 898         # misc stuff
 899         "KRB5_CONFIG",
 900         "KRB5CCNAME",
 901         "SELFTEST_WINBINDD_SOCKET_DIR",
 902         "NMBD_SOCKET_DIR",
 903         "LOCAL_PATH",
 904         "DNS_FORWARDER1",
 905         "DNS_FORWARDER2",
 906         "RESOLV_CONF",
 907         "UNACCEPTABLE_PASSWORD",
 908         "LOCK_DIR",
 909         "SMBD_TEST_LOG",
 910
 911         # nss_wrapper
 912         "NSS_WRAPPER_PASSWD",
 913         "NSS_WRAPPER_GROUP",
 914         "NSS_WRAPPER_HOSTS",
 915         "NSS_WRAPPER_HOSTNAME",
 916         "NSS_WRAPPER_MODULE_SO_PATH",
 917         "NSS_WRAPPER_MODULE_FN_PREFIX",
 918
 919         # resolv_wrapper
 920         "RESOLV_WRAPPER_CONF",
 921         "RESOLV_WRAPPER_HOSTS",
 922 );
 923
 924 sub sighandler($)
 925 {
 926         my $signame = shift;
 927
 928         $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = 'DEFAULT';
 929         $SIG{PIPE} = 'IGNORE';
 930
 931         open(STDOUT, ">&STDERR") or die "can't dup STDOUT to STDERR: $!";
 932
 933         print "$0: PID[$$]: Got SIG${signame} teardown environments.\n";
 934         teardown_env($_) foreach(keys %running_envs);
 935         system("pstree -p $$");
 936         print "$0: PID[$$]: Exiting...\n";
 937         exit(1);
 938 };
 939
 940 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = $SIG{PIPE} = \&sighandler;
 941
 942 sub setup_env($$)
 943 {
 944         my ($name, $prefix) = @_;
 945
 946         my $testenv_vars = undef;
 947
 948         my $envname = $name;
 949         my $option = $name;
 950
 951         $envname =~ s/:.*//;
 952         $option =~ s/^[^:]*//;
 953         $option =~ s/^://;
 954
 955         $option = "client" if $option eq "";
 956
 957         # Initially clear out the environment for the provision, so previous envs'
 958         # variables don't leak in. Provisioning steps must explicitly set their
 959         # necessary variables when calling out to other executables
 960         foreach (@exported_envvars) {
 961                 delete $ENV{$_};
 962         }
 963         delete $ENV{SOCKET_WRAPPER_DEFAULT_IFACE};
 964         delete $ENV{SMB_CONF_PATH};
 965
 966         $ENV{KRB5CCNAME} = "FILE:${selftest_krbt_ccache_path}.${envname}/ignore";
 967
 968         if (defined(get_running_env($envname))) {
 969                 $testenv_vars = get_running_env($envname);
 970                 if (not $testenv_vars->{target}->check_env($testenv_vars)) {
 971                         print $testenv_vars->{target}->getlog_env($testenv_vars);
 972                         $testenv_vars = undef;
 973                 }
 974         } else {
 975                 $testenv_vars = $target->setup_env($envname, $prefix);
 976                 if (defined($testenv_vars) and $testenv_vars eq "UNKNOWN") {
 977                     return $testenv_vars;
 978                 } elsif (defined($testenv_vars) && not defined($testenv_vars->{target})) {
 979                         $testenv_vars->{target} = $target;
 980                 }
 981                 if (not defined($testenv_vars)) {
 982                         warn("$opt_target can't start up known environment '$envname'");
 983                 }
 984         }
 985
 986         return undef unless defined($testenv_vars);
 987
 988         $running_envs{$envname} = $testenv_vars;
 989
 990         if ($option eq "local") {
 991                 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
 992                 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
 993         } elsif ($option eq "client") {
 994                 SocketWrapper::set_default_iface(11);
 995                 write_clientconf($conffile, $clientdir, $testenv_vars);
 996                 $ENV{SMB_CONF_PATH} = $conffile;
 997         } else {
 998                 die("Unknown option[$option] for envname[$envname]");
 999         }
1000
1001         foreach (@exported_envvars) {
1002                 if (defined($testenv_vars->{$_})) {
1003                         $ENV{$_} = $testenv_vars->{$_};
1004                 } else {
1005                         delete $ENV{$_};
1006                 }
1007         }
1008
1009         my $krb5_ccache_path = "${selftest_krbt_ccache_path}.${envname}.${option}";
1010         unlink($krb5_ccache_path);
1011         $ENV{KRB5CCNAME} = "FILE:${krb5_ccache_path}";
1012         return $testenv_vars;
1013 }
1014
1015 sub exported_envvars_str($)
1016 {
1017         my ($testenv_vars) = @_;
1018         my $out = "";
1019
1020         foreach (@exported_envvars) {
1021                 next unless defined($testenv_vars->{$_});
1022                 $out .= $_."=".$testenv_vars->{$_}."\n";
1023         }
1024
1025         return $out;
1026 }
1027
1028 sub getlog_env($)
1029 {
1030         my ($envname) = @_;
1031         return "" if ($envname eq "none");
1032         my $env = get_running_env($envname);
1033         return $env->{target}->getlog_env($env);
1034 }
1035
1036 sub check_env($)
1037 {
1038         my ($envname) = @_;
1039         my $env = get_running_env($envname);
1040         return $env->{target}->check_env($env);
1041 }
1042
1043 sub teardown_env($)
1044 {
1045         my ($envname) = @_;
1046         return if ($envname eq "none");
1047         print STDERR "teardown_env($envname)\n";
1048         my $env = get_running_env($envname);
1049         $env->{target}->teardown_env($env);
1050         delete $running_envs{$envname};
1051 }
1052
1053 # This 'global' file needs to be empty when we start
1054 unlink("$prefix_abs/dns_host_file");
1055 unlink("$prefix_abs/hosts");
1056
1057 if ($opt_random_order) {
1058         require List::Util;
1059         my @newtodo = List::Util::shuffle(@todo);
1060         @todo = @newtodo;
1061 }
1062
1063 if ($opt_testenv) {
1064         my $testenv_name = $ENV{SELFTEST_TESTENV};
1065         $testenv_name = $testenv_default unless defined($testenv_name);
1066
1067         my $testenv_vars = setup_env($testenv_name, $prefix);
1068
1069         if (not $testenv_vars or $testenv_vars eq "UNKNOWN") {
1070                 die("Unable to setup environment $testenv_name");
1071         }
1072
1073         $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
1074         $ENV{ENVNAME} = $testenv_name;
1075
1076         my $envvarstr = exported_envvars_str($testenv_vars);
1077
1078         my @term_args = ("echo -e \"
1079 Welcome to the Samba4 Test environment '$testenv_name'
1080
1081 This matches the client environment used in make test
1082 server is pid `cat \$PIDDIR/samba.pid`
1083
1084 Some useful environment variables:
1085 TORTURE_OPTIONS=\$TORTURE_OPTIONS
1086 SMB_CONF_PATH=\$SMB_CONF_PATH
1087
1088 $envvarstr
1089 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash");
1090         my @term = ();
1091         if ($ENV{TERMINAL}) {
1092             @term = ($ENV{TERMINAL});
1093         } else {
1094             @term = ("xterm", "-e");
1095             unshift(@term_args, ("bash", "-c"));
1096         }
1097
1098         system(@term, @term_args);
1099
1100         teardown_env($testenv_name);
1101 } elsif ($opt_list) {
1102         foreach (@todo) {
1103                 my $name = $$_[0];
1104                 my $envname = $$_[1];
1105                 my $cmd = $$_[2];
1106                 my $listcmd = $$_[3];
1107
1108                 unless (defined($listcmd)) {
1109                         warn("Unable to list tests in $name");
1110                         # Rather than ignoring this testsuite altogether, just pretend the entire testsuite is
1111                         # a single "test".
1112                         print "$name\n";
1113                         next;
1114                 }
1115
1116                 system($listcmd);
1117
1118                 if ($? == -1) {
1119                         die("Unable to run $listcmd: $!");
1120                 } elsif ($? & 127) {
1121                         die(sprintf("%s died with signal %d, %s coredump\n", $listcmd, ($? & 127),  ($? & 128) ? 'with' : 'without'));
1122                 }
1123
1124                 my $exitcode = $? >> 8;
1125                 if ($exitcode != 0) {
1126                         die("$cmd exited with exit code $exitcode");
1127                 }
1128         }
1129 } else {
1130         foreach (@todo) {
1131                 $i++;
1132                 my $cmd = $$_[2];
1133                 my $name = $$_[0];
1134                 my $envname = $$_[1];
1135                 my $envvars = setup_env($envname, $prefix);
1136
1137                 if (not defined($envvars)) {
1138                         Subunit::start_testsuite($name);
1139                         Subunit::end_testsuite($name, "error",
1140                                 "unable to set up environment $envname - exiting");
1141                         next;
1142                 } elsif ($envvars eq "UNKNOWN") {
1143                         Subunit::start_testsuite($name);
1144                         Subunit::end_testsuite($name, "error",
1145                                 "environment $envname is unknown - exiting");
1146                         next;
1147                 }
1148
1149                 # Generate a file with the individual tests to run, if the
1150                 # test runner for this test suite supports it.
1151                 if ($individual_tests and $individual_tests->{$name}) {
1152                         if ($$_[3]) {
1153                                 my ($fh, $listid_file) = tempfile(UNLINK => 0);
1154                                 foreach my $test (@{$individual_tests->{$name}}) {
1155                                         print $fh substr($test, length($name)+1) . "\n";
1156                                 }
1157                                 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
1158                         } else {
1159                                 warn("Unable to run individual tests in $name, it does not support --loadlist.");
1160                         }
1161                 }
1162
1163                 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
1164
1165                 teardown_env($envname) if ($opt_resetup_env);
1166         }
1167 }
1168
1169 print "\n";
1170
1171 teardown_env($_) foreach (keys %running_envs);
1172
1173 my $failed = 0;
1174
1175 # if there were any valgrind failures, show them
1176 foreach (<$prefix/valgrind.log*>) {
1177         next unless (-s $_);
1178         print "VALGRIND FAILURE\n";
1179         $failed++;
1180         system("cat $_");
1181 }
1182 exit 0;