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 # do not depend on the users setup
 305 $ENV{TZ} = "UTC";
 306
 307 my $bindir_abs = abs_path($bindir);
 308
 309 # Backwards compatibility:
 310 if (defined($ENV{TEST_LDAP}) and $ENV{TEST_LDAP} eq "yes") {
 311         if (defined($ENV{FEDORA_DS_ROOT})) {
 312                 $ldap = "fedora-ds";
 313         } else {
 314                 $ldap = "openldap";
 315         }
 316 }
 317
 318 my $torture_maxtime = ($ENV{TORTURE_MAXTIME} or 1200);
 319 if ($ldap) {
 320         # LDAP is slow
 321         $torture_maxtime *= 2;
 322 }
 323
 324 $prefix =~ s+//+/+;
 325 $prefix =~ s+/./+/+;
 326 $prefix =~ s+/$++;
 327
 328 die("using an empty prefix isn't allowed") unless $prefix ne "";
 329
 330 # Ensure we have the test prefix around.
 331 #
 332 # We need restrictive
 333 # permissions on this as some subdirectories in this tree will have
 334 # wider permissions (ie 0777) and this would allow other users on the
 335 # host to subvert the test process.
 336 umask 0077;
 337 mkdir($prefix, 0700) unless -d $prefix;
 338 chmod 0700, $prefix;
 339 # We need to have no umask limitations for the tests.
 340 umask 0000;
 341
 342 my $prefix_abs = abs_path($prefix);
 343 my $tmpdir_abs = abs_path("$prefix/tmp");
 344 mkdir($tmpdir_abs, 0777) unless -d $tmpdir_abs;
 345
 346 my $srcdir_abs = abs_path($srcdir);
 347
 348 die("using an empty absolute prefix isn't allowed") unless $prefix_abs ne "";
 349 die("using '/' as absolute prefix isn't allowed") unless $prefix_abs ne "/";
 350
 351 $ENV{SAMBA_SELFTEST} = "1";
 352
 353 $ENV{PREFIX} = $prefix;
 354 $ENV{PREFIX_ABS} = $prefix_abs;
 355 $ENV{SRCDIR} = $srcdir;
 356 $ENV{SRCDIR_ABS} = $srcdir_abs;
 357 $ENV{GNUPGHOME} = "$srcdir_abs/selftest/gnupg";
 358 $ENV{BINDIR} = $bindir_abs;
 359
 360 my $tls_enabled = not $opt_quick;
 361 $ENV{TLS_ENABLED} = ($tls_enabled?"yes":"no");
 362
 363 sub prefix_pathvar($$)
 364 {
 365         my ($name, $newpath) = @_;
 366         if (defined($ENV{$name})) {
 367                 $ENV{$name} = "$newpath:$ENV{$name}";
 368         } else {
 369                 $ENV{$name} = $newpath;
 370         }
 371 }
 372 prefix_pathvar("PKG_CONFIG_PATH", "$bindir_abs/pkgconfig");
 373 prefix_pathvar("PYTHONPATH", "$bindir_abs/python");
 374
 375 if ($opt_socket_wrapper_keep_pcap) {
 376         # Socket wrapper keep pcap implies socket wrapper pcap
 377         $opt_socket_wrapper_pcap = 1;
 378 }
 379
 380 if ($opt_socket_wrapper_pcap) {
 381         # Socket wrapper pcap implies socket wrapper
 382         $opt_socket_wrapper = 1;
 383 }
 384
 385 my $ld_preload = $ENV{LD_PRELOAD};
 386
 387 if ($opt_libasan_so_path) {
 388         if ($ld_preload) {
 389                 $ld_preload = "$ld_preload:$opt_libasan_so_path";
 390         } else {
 391                 $ld_preload = "$opt_libasan_so_path";
 392         }
 393 }
 394
 395 if ($opt_libnss_wrapper_so_path) {
 396         if ($ld_preload) {
 397                 $ld_preload = "$ld_preload:$opt_libnss_wrapper_so_path";
 398         } else {
 399                 $ld_preload = "$opt_libnss_wrapper_so_path";
 400         }
 401 }
 402
 403 if ($opt_libresolv_wrapper_so_path) {
 404         if ($ld_preload) {
 405                 $ld_preload = "$ld_preload:$opt_libresolv_wrapper_so_path";
 406         } else {
 407                 $ld_preload = "$opt_libresolv_wrapper_so_path";
 408         }
 409 }
 410
 411 if ($opt_libsocket_wrapper_so_path) {
 412         if ($ld_preload) {
 413                 $ld_preload = "$ld_preload:$opt_libsocket_wrapper_so_path";
 414         } else {
 415                 $ld_preload = "$opt_libsocket_wrapper_so_path";
 416         }
 417 }
 418
 419 if ($opt_libuid_wrapper_so_path) {
 420         if ($ld_preload) {
 421                 $ld_preload = "$ld_preload:$opt_libuid_wrapper_so_path";
 422         } else {
 423                 $ld_preload = "$opt_libuid_wrapper_so_path";
 424         }
 425 }
 426
 427 $ENV{LD_PRELOAD} = $ld_preload;
 428 print "LD_PRELOAD=$ENV{LD_PRELOAD}\n";
 429
 430 # Enable uid_wrapper globally
 431 $ENV{UID_WRAPPER} = 1;
 432
 433 # We are already hitting the limit, so double it.
 434 $ENV{NSS_WRAPPER_MAX_HOSTENTS} = 200;
 435
 436 # Disable RTLD_DEEPBIND hack for Samba bind dlz module
 437 #
 438 # This is needed in order to allow the ldb_*ldap module
 439 # to work with a preloaded socket wrapper.
 440 $ENV{LDB_MODULES_DISABLE_DEEPBIND} = 1;
 441
 442 my $socket_wrapper_dir;
 443 if ($opt_socket_wrapper) {
 444         $socket_wrapper_dir = SocketWrapper::setup_dir("$prefix_abs/w", $opt_socket_wrapper_pcap);
 445         print "SOCKET_WRAPPER_DIR=$socket_wrapper_dir\n";
 446 } elsif (not $opt_list) {
 447          unless ($< == 0) {
 448                  warn("not using socket wrapper, but also not running as root. Will not be able to listen on proper ports");
 449          }
 450 }
 451
 452 if ($opt_use_dns_faking) {
 453         print "DNS: Faking nameserver\n";
 454         $ENV{SAMBA_DNS_FAKING} = 1;
 455 }
 456
 457 my $target;
 458 my $testenv_default = "none";
 459
 460 if ($opt_mitkrb5 == 1) {
 461         $ENV{MITKRB5} = $opt_mitkrb5;
 462 }
 463
 464 # After this many seconds, the server will self-terminate.  All tests
 465 # must terminate in this time, and testenv will only stay alive this
 466 # long
 467
 468 my $server_maxtime;
 469 if ($opt_testenv) {
 470     # 1 year should be enough :-)
 471     $server_maxtime = 365 * 24 * 60 * 60;
 472 } else {
 473     # make test should run under 5 hours
 474     $server_maxtime = 5 * 60 * 60;
 475 }
 476
 477 if (defined($ENV{SMBD_MAXTIME}) and $ENV{SMBD_MAXTIME} ne "") {
 478     $server_maxtime = $ENV{SMBD_MAXTIME};
 479 }
 480
 481 $target = new Samba($bindir, $ldap, $srcdir, $server_maxtime);
 482 unless ($opt_list) {
 483         if ($opt_target eq "samba") {
 484                 $testenv_default = "ad_dc";
 485         } elsif ($opt_target eq "samba3") {
 486                 $testenv_default = "nt4_member";
 487         }
 488 }
 489
 490 sub read_test_regexes($)
 491 {
 492         my ($name) = @_;
 493         my @ret = ();
 494         open(LF, "<$name") or die("unable to read $name: $!");
 495         while (<LF>) {
 496                 chomp;
 497                 next if (/^#/);
 498                 if (/^(.*?)([ \t]+)\#([\t ]*)(.*?)$/) {
 499                         push (@ret, [$1, $4]);
 500                 } else {
 501                         s/^(.*?)([ \t]+)\#([\t ]*)(.*?)$//;
 502                         push (@ret, [$_, undef]);
 503                 }
 504         }
 505         close(LF);
 506         return @ret;
 507 }
 508
 509 foreach (@opt_exclude) {
 510         push (@excludes, read_test_regexes($_));
 511 }
 512
 513 foreach (@opt_include) {
 514         push (@includes, read_test_regexes($_));
 515 }
 516
 517 my $interfaces = Samba::get_interfaces_config("client");
 518
 519 my $clientdir = "$prefix_abs/client";
 520
 521 my $conffile = "$clientdir/client.conf";
 522 $ENV{SMB_CONF_PATH} = $conffile;
 523
 524 sub write_clientconf($$$)
 525 {
 526         my ($conffile, $clientdir, $vars) = @_;
 527
 528         mkdir("$clientdir", 0777) unless -d "$clientdir";
 529
 530         if ( -d "$clientdir/private" ) {
 531                 unlink <$clientdir/private/*>;
 532         } else {
 533                 mkdir("$clientdir/private", 0777);
 534         }
 535
 536         if ( -d "$clientdir/bind-dns" ) {
 537                 unlink <$clientdir/bind-dns/*>;
 538         } else {
 539                 mkdir("$clientdir/bind-dns", 0777);
 540         }
 541
 542         if ( -d "$clientdir/lockdir" ) {
 543                 unlink <$clientdir/lockdir/*>;
 544         } else {
 545                 mkdir("$clientdir/lockdir", 0777);
 546         }
 547
 548         if ( -d "$clientdir/statedir" ) {
 549                 unlink <$clientdir/statedir/*>;
 550         } else {
 551                 mkdir("$clientdir/statedir", 0777);
 552         }
 553
 554         if ( -d "$clientdir/cachedir" ) {
 555                 unlink <$clientdir/cachedir/*>;
 556         } else {
 557                 mkdir("$clientdir/cachedir", 0777);
 558         }
 559
 560         # this is ugly, but the ncalrpcdir needs exactly 0755
 561         # otherwise tests fail.
 562         my $mask = umask;
 563         umask 0022;
 564         if ( -d "$clientdir/ncalrpcdir/np" ) {
 565                 unlink <$clientdir/ncalrpcdir/np/*>;
 566                 rmdir "$clientdir/ncalrpcdir/np";
 567         }
 568         if ( -d "$clientdir/ncalrpcdir" ) {
 569                 unlink <$clientdir/ncalrpcdir/*>;
 570                 rmdir "$clientdir/ncalrpcdir";
 571         }
 572         mkdir("$clientdir/ncalrpcdir", 0755);
 573         umask $mask;
 574
 575         my $cadir = "$ENV{SRCDIR_ABS}/selftest/manage-ca/CA-samba.example.com";
 576         my $cacert = "$cadir/Public/CA-samba.example.com-cert.pem";
 577         my $cacrl_pem = "$cadir/Public/CA-samba.example.com-crl.pem";
 578         my $ca_users_dir = "$cadir/Users";
 579
 580         if ( -d "$clientdir/pkinit" ) {
 581                 unlink <$clientdir/pkinit/*>;
 582         } else {
 583                 mkdir("$clientdir/pkinit", 0700);
 584         }
 585
 586         # each user has a USER-${USER_PRINCIPAL_NAME}-cert.pem and
 587         # USER-${USER_PRINCIPAL_NAME}-private-key.pem symlink
 588         # We make a copy here and make the certificated easily
 589         # accessable in the client environment.
 590         my $mask = umask;
 591         umask 0077;
 592         opendir USERS, "${ca_users_dir}" or die "Could not open dir '${ca_users_dir}': $!";
 593         for my $d (readdir USERS) {
 594                 my $user_dir = "${ca_users_dir}/${d}";
 595                 next if ${d} =~ /^\./;
 596                 next if (! -d "${user_dir}");
 597                 opendir USER, "${user_dir}" or die "Could not open dir '${user_dir}': $!";
 598                 for my $l (readdir USER) {
 599                         my $user_link = "${user_dir}/${l}";
 600                         next if ${l} =~ /^\./;
 601                         next if (! -l "${user_link}");
 602
 603                         my $dest = "${clientdir}/pkinit/${l}";
 604                         Samba::copy_file_content(${user_link}, ${dest});
 605                 }
 606                 closedir USER;
 607         }
 608         closedir USERS;
 609         umask $mask;
 610
 611         open(CF, ">$conffile");
 612         print CF "[global]\n";
 613         print CF "\tnetbios name = client\n";
 614         if (defined($vars->{DOMAIN})) {
 615                 print CF "\tworkgroup = $vars->{DOMAIN}\n";
 616         }
 617         if (defined($vars->{REALM})) {
 618                 print CF "\trealm = $vars->{REALM}\n";
 619         }
 620         if ($opt_socket_wrapper) {
 621                 print CF "\tinterfaces = $interfaces\n";
 622         }
 623         print CF "
 624         private dir = $clientdir/private
 625         binddns dir = $clientdir/bind-dns
 626         lock dir = $clientdir/lockdir
 627         state directory = $clientdir/statedir
 628         cache directory = $clientdir/cachedir
 629         ncalrpc dir = $clientdir/ncalrpcdir
 630         panic action = $RealBin/gdb_backtrace \%d
 631         max xmit = 32K
 632         notify:inotify = false
 633         ldb:nosync = true
 634         system:anonymous = true
 635         client lanman auth = Yes
 636         log level = 1
 637         torture:basedir = $clientdir
 638 #We don't want to pass our self-tests if the PAC code is wrong
 639         gensec:require_pac = true
 640 #We don't want to run 'speed' tests for very long
 641         torture:timelimit = 1
 642         winbind separator = /
 643         tls cafile = ${cacert}
 644         tls crlfile = ${cacrl_pem}
 645         tls verify peer = no_check
 646         include system krb5 conf = no
 647 ";
 648         close(CF);
 649 }
 650
 651 my @todo = ();
 652
 653 sub should_run_test($)
 654 {
 655         my $name = shift;
 656         if ($#tests == -1) {
 657                 return 1;
 658         }
 659         for (my $i=0; $i <= $#tests; $i++) {
 660                 if ($name =~ /$tests[$i]/i) {
 661                         return 1;
 662                 }
 663         }
 664         return 0;
 665 }
 666
 667 sub read_testlist($)
 668 {
 669         my ($filename) = @_;
 670
 671         my @ret = ();
 672         open(IN, $filename) or die("Unable to open $filename: $!");
 673
 674         while (<IN>) {
 675                 if (/-- TEST(-LOADLIST|) --\n/) {
 676                         my $supports_loadlist = (defined($1) and $1 eq "-LOADLIST");
 677                         my $name = <IN>;
 678                         $name =~ s/\n//g;
 679                         my $env = <IN>;
 680                         $env =~ s/\n//g;
 681                         my $loadlist;
 682                         if ($supports_loadlist) {
 683                                 $loadlist = <IN>;
 684                                 $loadlist =~ s/\n//g;
 685                         }
 686                         my $cmdline = <IN>;
 687                         $cmdline =~ s/\n//g;
 688                         if (should_run_test($name) == 1) {
 689                                 push (@ret, [$name, $env, $cmdline, $loadlist]);
 690                         }
 691                 } else {
 692                         print;
 693                 }
 694         }
 695         close(IN) or die("Error creating recipe from $filename");
 696         return @ret;
 697 }
 698
 699 if ($#testlists == -1) {
 700         die("No testlists specified");
 701 }
 702
 703 $ENV{SELFTEST_PREFIX} = "$prefix_abs";
 704 $ENV{SELFTEST_TMPDIR} = "$tmpdir_abs";
 705 $ENV{TMPDIR} = "$tmpdir_abs";
 706 $ENV{TEST_DATA_PREFIX} = "$tmpdir_abs";
 707 if ($opt_quick) {
 708         $ENV{SELFTEST_QUICK} = "1";
 709 } else {
 710         $ENV{SELFTEST_QUICK} = "";
 711 }
 712 $ENV{SELFTEST_MAXTIME} = $torture_maxtime;
 713
 714 my $selftest_krbt_ccache_path = "$tmpdir_abs/selftest.krb5_ccache";
 715 $ENV{KRB5CCNAME} = "FILE:${selftest_krbt_ccache_path}.global";
 716
 717 my @available = ();
 718 foreach my $fn (@testlists) {
 719         foreach (read_testlist($fn)) {
 720                 my $name = $$_[0];
 721                 next if (@includes and not defined(find_in_list(\@includes, $name)));
 722                 push (@available, $_);
 723         }
 724 }
 725
 726 my $restricted = undef;
 727 my $restricted_used = {};
 728
 729 if ($opt_load_list) {
 730         $restricted = [];
 731         open(LOAD_LIST, "<$opt_load_list") or die("Unable to open $opt_load_list");
 732         while (<LOAD_LIST>) {
 733                 chomp;
 734                 push (@$restricted, $_);
 735         }
 736         close(LOAD_LIST);
 737 }
 738
 739 my $individual_tests = undef;
 740 $individual_tests = {};
 741
 742 foreach my $testsuite (@available) {
 743         my $name = $$testsuite[0];
 744         my $skipreason = skip(@$testsuite);
 745         if (defined($restricted)) {
 746                 # Find the testsuite for this test
 747                 my $match = undef;
 748                 foreach my $r (@$restricted) {
 749                         if ($r eq $name) {
 750                                 $individual_tests->{$name} = [];
 751                                 $match = $r;
 752                                 $restricted_used->{$r} = 1;
 753                         } elsif (substr($r, 0, length($name)+1) eq "$name.") {
 754                                 push(@{$individual_tests->{$name}}, $r);
 755                                 $match = $r;
 756                                 $restricted_used->{$r} = 1;
 757                         }
 758                 }
 759                 if ($match) {
 760                         if (defined($skipreason)) {
 761                                 if (not $opt_list) {
 762                                         Subunit::skip_testsuite($name, $skipreason);
 763                                 }
 764                         } else {
 765                                 push(@todo, $testsuite);
 766                         }
 767                 }
 768         } elsif (defined($skipreason)) {
 769                 if (not $opt_list) {
 770                         Subunit::skip_testsuite($name, $skipreason);
 771                 }
 772         } else {
 773                 push(@todo, $testsuite);
 774         }
 775 }
 776
 777 if (defined($restricted)) {
 778         foreach (@$restricted) {
 779                 unless (defined($restricted_used->{$_})) {
 780                         print "No test or testsuite found matching $_\n";
 781                 }
 782         }
 783 } elsif ($#todo == -1) {
 784         print STDERR "No tests to run\n";
 785         exit(1);
 786 }
 787
 788 my $suitestotal = $#todo + 1;
 789
 790 unless ($opt_list) {
 791         Subunit::progress($suitestotal);
 792         Subunit::report_time();
 793 }
 794
 795 my $i = 0;
 796 $| = 1;
 797
 798 my %running_envs = ();
 799
 800 sub get_running_env($)
 801 {
 802         my ($name) = @_;
 803
 804         my $envname = $name;
 805
 806         $envname =~ s/:.*//;
 807
 808         return $running_envs{$envname};
 809 }
 810
 811 sub sighandler($)
 812 {
 813         my $signame = shift;
 814
 815         $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = 'DEFAULT';
 816         $SIG{PIPE} = 'IGNORE';
 817
 818         open(STDOUT, ">&STDERR") or die "can't dup STDOUT to STDERR: $!";
 819
 820         print "$0: PID[$$]: Got SIG${signame} teardown environments.\n";
 821         teardown_env($_) foreach(keys %running_envs);
 822         system("pstree -p $$");
 823         print "$0: PID[$$]: Exiting...\n";
 824         exit(1);
 825 };
 826
 827 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = $SIG{PIPE} = \&sighandler;
 828
 829 sub setup_env($$)
 830 {
 831         my ($name, $prefix) = @_;
 832
 833         my $testenv_vars = undef;
 834
 835         my $envname = $name;
 836         my $option = $name;
 837
 838         $envname =~ s/:.*//;
 839         $option =~ s/^[^:]*//;
 840         $option =~ s/^://;
 841
 842         $option = "client" if $option eq "";
 843
 844         # Initially clear out the environment for the provision, so previous envs'
 845         # variables don't leak in. Provisioning steps must explicitly set their
 846         # necessary variables when calling out to other executables
 847         Samba::clear_exported_envvars();
 848         delete $ENV{SOCKET_WRAPPER_DEFAULT_IFACE};
 849         delete $ENV{SMB_CONF_PATH};
 850
 851         $ENV{KRB5CCNAME} = "FILE:${selftest_krbt_ccache_path}.${envname}/ignore";
 852
 853         if (defined(get_running_env($envname))) {
 854                 $testenv_vars = get_running_env($envname);
 855                 if (not $testenv_vars->{target}->check_env($testenv_vars)) {
 856                         print $testenv_vars->{target}->getlog_env($testenv_vars);
 857                         $testenv_vars = undef;
 858                 }
 859         } else {
 860                 $testenv_vars = $target->setup_env($envname, $prefix);
 861                 if (defined($testenv_vars) and $testenv_vars eq "UNKNOWN") {
 862                     return $testenv_vars;
 863                 } elsif (defined($testenv_vars) && not defined($testenv_vars->{target})) {
 864                         $testenv_vars->{target} = $target;
 865                 }
 866                 if (not defined($testenv_vars)) {
 867                         if ($opt_one) {
 868                                 die("$opt_target can't start up known environment '$envname'");
 869                         } else {
 870                                 warn("$opt_target can't start up known environment '$envname'");
 871                         }
 872                 }
 873         }
 874
 875         return undef unless defined($testenv_vars);
 876
 877         $running_envs{$envname} = $testenv_vars;
 878
 879         if ($option eq "local") {
 880                 SocketWrapper::set_default_iface($testenv_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
 881                 $ENV{SMB_CONF_PATH} = $testenv_vars->{SERVERCONFFILE};
 882         } elsif ($option eq "client") {
 883                 SocketWrapper::set_default_iface(11);
 884                 write_clientconf($conffile, $clientdir, $testenv_vars);
 885                 $ENV{SMB_CONF_PATH} = $conffile;
 886         } else {
 887                 die("Unknown option[$option] for envname[$envname]");
 888         }
 889
 890         # export the environment variables for the testenv (SERVER, SERVER_IP, etc)
 891         Samba::export_envvars($testenv_vars);
 892
 893         my $krb5_ccache_path = "${selftest_krbt_ccache_path}.${envname}.${option}";
 894         unlink($krb5_ccache_path);
 895         $ENV{KRB5CCNAME} = "FILE:${krb5_ccache_path}";
 896         return $testenv_vars;
 897 }
 898
 899 sub getlog_env($)
 900 {
 901         my ($envname) = @_;
 902         return "" if ($envname eq "none");
 903         my $env = get_running_env($envname);
 904         return $env->{target}->getlog_env($env);
 905 }
 906
 907 sub check_env($)
 908 {
 909         my ($envname) = @_;
 910         my $env = get_running_env($envname);
 911         return $env->{target}->check_env($env);
 912 }
 913
 914 sub teardown_env($)
 915 {
 916         my ($envname) = @_;
 917         return if ($envname eq "none");
 918         print STDERR "teardown_env($envname)\n";
 919         my $env = get_running_env($envname);
 920         $env->{target}->teardown_env($env);
 921         delete $running_envs{$envname};
 922 }
 923
 924 # This 'global' file needs to be empty when we start
 925 unlink("$prefix_abs/dns_host_file");
 926 unlink("$prefix_abs/hosts");
 927
 928 if ($opt_random_order) {
 929         require List::Util;
 930         my @newtodo = List::Util::shuffle(@todo);
 931         @todo = @newtodo;
 932 }
 933
 934 if ($opt_testenv) {
 935         my $testenv_name = $ENV{SELFTEST_TESTENV};
 936         $testenv_name = $testenv_default unless defined($testenv_name);
 937
 938         my $testenv_vars = setup_env($testenv_name, $prefix);
 939
 940         if (not $testenv_vars or $testenv_vars eq "UNKNOWN") {
 941                 die("Unable to setup environment $testenv_name");
 942         }
 943
 944         $ENV{PIDDIR} = $testenv_vars->{PIDDIR};
 945         $ENV{ENVNAME} = $testenv_name;
 946
 947         my $envvarstr = Samba::exported_envvars_str($testenv_vars);
 948
 949         my @term_args = ("echo -e \"
 950 Welcome to the Samba4 Test environment '$testenv_name'
 951
 952 This matches the client environment used in make test
 953 server is pid `cat \$PIDDIR/samba.pid`
 954
 955 Some useful environment variables:
 956 TORTURE_OPTIONS=\$TORTURE_OPTIONS
 957 SMB_CONF_PATH=\$SMB_CONF_PATH
 958
 959 $envvarstr
 960 \" && LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH} bash");
 961         my @term = ();
 962         if ($ENV{TERMINAL}) {
 963             @term = ($ENV{TERMINAL});
 964         } else {
 965             @term = ("xterm", "-e");
 966             unshift(@term_args, ("bash", "-c"));
 967         }
 968
 969         system(@term, @term_args);
 970
 971         teardown_env($testenv_name);
 972 } elsif ($opt_list) {
 973         foreach (@todo) {
 974                 my $name = $$_[0];
 975                 my $envname = $$_[1];
 976                 my $cmd = $$_[2];
 977                 my $listcmd = $$_[3];
 978
 979                 unless (defined($listcmd)) {
 980                         warn("Unable to list tests in $name");
 981                         # Rather than ignoring this testsuite altogether, just pretend the entire testsuite is
 982                         # a single "test".
 983                         print "$name\n";
 984                         next;
 985                 }
 986
 987                 system($listcmd);
 988
 989                 if ($? == -1) {
 990                         die("Unable to run $listcmd: $!");
 991                 } elsif ($? & 127) {
 992                         die(sprintf("%s died with signal %d, %s coredump\n", $listcmd, ($? & 127),  ($? & 128) ? 'with' : 'without'));
 993                 }
 994
 995                 my $exitcode = $? >> 8;
 996                 if ($exitcode != 0) {
 997                         die("$cmd exited with exit code $exitcode");
 998                 }
 999         }
1000 } else {
1001         foreach (@todo) {
1002                 $i++;
1003                 my $cmd = $$_[2];
1004                 my $name = $$_[0];
1005                 my $envname = $$_[1];
1006                 my $envvars = setup_env($envname, $prefix);
1007
1008                 if (not defined($envvars)) {
1009                         Subunit::start_testsuite($name);
1010                         Subunit::end_testsuite($name, "error",
1011                                 "unable to set up environment $envname - exiting");
1012                         next;
1013                 } elsif ($envvars eq "UNKNOWN") {
1014                         Subunit::start_testsuite($name);
1015                         Subunit::end_testsuite($name, "error",
1016                                 "environment $envname is unknown - exiting");
1017                         next;
1018                 }
1019
1020                 # Generate a file with the individual tests to run, if the
1021                 # test runner for this test suite supports it.
1022                 if ($individual_tests and $individual_tests->{$name}) {
1023                         if ($$_[3]) {
1024                                 my ($fh, $listid_file) = tempfile(UNLINK => 0);
1025                                 foreach my $test (@{$individual_tests->{$name}}) {
1026                                         print $fh substr($test, length($name)+1) . "\n";
1027                                 }
1028                                 $cmd =~ s/\$LOADLIST/--load-list=$listid_file/g;
1029                         } else {
1030                                 warn("Unable to run individual tests in $name, it does not support --loadlist.");
1031                         }
1032                 }
1033
1034                 run_testsuite($envname, $name, $cmd, $i, $suitestotal);
1035
1036                 teardown_env($envname) if ($opt_resetup_env);
1037         }
1038 }
1039
1040 print "\n";
1041
1042 teardown_env($_) foreach (keys %running_envs);
1043
1044 my $failed = 0;
1045
1046 # if there were any valgrind failures, show them
1047 foreach (<$prefix/valgrind.log*>) {
1048         next unless (-s $_);
1049         print "VALGRIND FAILURE\n";
1050         $failed++;
1051         system("cat $_");
1052 }
1053 exit 0;