mtr_cases.pm 29.4 KB
Newer Older
unknown's avatar
unknown committed
1
# -*- cperl -*-
unknown's avatar
unknown committed
2
# Copyright (C) 2005-2006 MySQL AB
unknown's avatar
unknown committed
3
#
unknown's avatar
unknown committed
4 5 6
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
7
#
unknown's avatar
unknown committed
8 9 10 11
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
unknown's avatar
unknown committed
12
#
unknown's avatar
unknown committed
13 14 15
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
unknown's avatar
unknown committed
16 17 18 19 20

# This is a library file used by the Perl version of mysql-test-run,
# and is part of the translation of the Bourne shell script with the
# same name.

unknown's avatar
unknown committed
21
package mtr_cases;
unknown's avatar
unknown committed
22 23
use strict;

unknown's avatar
unknown committed
24 25 26
use base qw(Exporter);
our @EXPORT= qw(collect_option collect_test_cases);

27
use mtr_report;
28
use mtr_match;
29

unknown's avatar
unknown committed
30 31 32 33 34 35 36
# Options used for the collect phase
our $start_from;
our $print_testcases;
our $skip_rpl;
our $do_test;
our $skip_test;
our $opt_skip_combination;
37
our $binlog_format;
unknown's avatar
unknown committed
38 39 40 41 42
our $enable_disabled;
our $default_storage_engine;
our $opt_with_ndbcluster_only;
our $defaults_file;
our $defaults_extra_file;
43
our $reorder= 1;
unknown's avatar
unknown committed
44 45 46 47 48

sub collect_option {
  my ($opt, $value)= @_;

  # Convert - to _ in option name
unknown's avatar
unknown committed
49
  $opt =~ s/-/_/g;
unknown's avatar
unknown committed
50 51 52
  no strict 'refs';
  ${$opt}= $value;
}
53

unknown's avatar
unknown committed
54
use File::Basename;
55
use File::Spec::Functions qw / splitdir /;
unknown's avatar
unknown committed
56 57
use IO::File();
use My::Config;
unknown's avatar
unknown committed
58
use My::Platform;
59
use My::Test;
60
use My::Find;
unknown's avatar
unknown committed
61

unknown's avatar
unknown committed
62
require "mtr_misc.pl";
unknown's avatar
unknown committed
63

unknown's avatar
unknown committed
64 65 66
# Precompiled regex's for tests to do or skip
my $do_test_reg;
my $skip_test_reg;
67 68 69

sub init_pattern {
  my ($from, $what)= @_;
unknown's avatar
unknown committed
70 71 72 73
  return undef unless defined $from;
  if ( $from =~ /^[a-z0-9\.]*$/ ) {
    # Does not contain any regex (except . that we allow as
    # separator betwen suite and testname), make the pattern match
74 75
    # beginning of string
    $from= "^$from";
unknown's avatar
unknown committed
76
    mtr_verbose("$what='$from'");
77
  }
unknown's avatar
unknown committed
78 79 80
  # Check that pattern is a valid regex
  eval { "" =~/$from/; 1 } or
    mtr_error("Invalid regex '$from' passed to $what\nPerl says: $@");
81 82 83 84
  return $from;
}


unknown's avatar
unknown committed
85 86
##############################################################################
#
unknown's avatar
unknown committed
87
#  Collect information about test cases to be run
unknown's avatar
unknown committed
88 89 90
#
##############################################################################

91
sub collect_test_cases ($$) {
92
  my $suites= shift; # Semicolon separated list of test suites
93
  my $opt_cases= shift;
unknown's avatar
unknown committed
94 95 96 97
  my $cases= []; # Array of hash(one hash for each testcase)

  $do_test_reg= init_pattern($do_test, "--do-test");
  $skip_test_reg= init_pattern($skip_test, "--skip-test");
98 99 100

  foreach my $suite (split(",", $suites))
  {
101
    push(@$cases, collect_one_suite($suite, $opt_cases));
102 103
  }

104
  if ( @$opt_cases )
105
  {
unknown's avatar
unknown committed
106
    # A list of tests was specified on the command line
107 108
    # Check that the tests specified was found
    # in at least one suite
109
    foreach my $test_name_spec ( @$opt_cases )
110 111
    {
      my $found= 0;
112
      my ($sname, $tname, $extension)= split_testname($test_name_spec);
113 114
      foreach my $test ( @$cases )
      {
115 116
	# test->{name} is always in suite.name format
	if ( $test->{name} =~ /.*\.$tname/ )
117 118 119 120 121 122 123 124 125 126 127
	{
	  $found= 1;
	}
      }
      if ( not $found )
      {
	mtr_error("Could not find $tname in any suite");
      }
    }
  }

unknown's avatar
unknown committed
128
  if ( $reorder )
129 130 131 132 133 134
  {
    # Reorder the test cases in an order that will make them faster to run
    my %sort_criteria;

    # Make a mapping of test name to a string that represents how that test
    # should be sorted among the other tests.  Put the most important criterion
unknown's avatar
unknown committed
135
    # first, then a sub-criterion, then sub-sub-criterion, etc.
136 137 138 139
    foreach my $tinfo (@$cases)
    {
      my @criteria = ();

140 141 142 143 144 145 146 147
      #
      # Append the criteria for sorting, in order of importance.
      #
      push(@criteria, "ndb=" . ($tinfo->{'ndb_test'} ? "A" : "B"));
      # Group test with equal options together.
      # Ending with "~" makes empty sort later than filled
      my $opts= $tinfo->{'master_opt'} ? $tinfo->{'master_opt'} : [];
      push(@criteria, join("!", sort @{$opts}) . "~");
148

149
      $sort_criteria{$tinfo->{name}} = join(" ", @criteria);
150 151 152 153 154 155
    }

    @$cases = sort {
      $sort_criteria{$a->{'name'}} . $a->{'name'} cmp
	$sort_criteria{$b->{'name'}} . $b->{'name'}; } @$cases;

unknown's avatar
unknown committed
156 157 158 159 160 161 162 163 164 165 166
    # For debugging the sort-order
    # foreach my $tinfo (@$cases)
    # {
    #   print("$sort_criteria{$tinfo->{'name'}} -> \t$tinfo->{'name'}\n");
    # }

  }

  if (defined $print_testcases){
    print_testcases(@$cases);
    exit(1);
167 168 169 170 171 172
  }

  return $cases;

}

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

# Returns (suitename, testname, extension)
sub split_testname {
  my ($test_name)= @_;

  # Get rid of directory part and split name on .'s
  my @parts= split(/\./, basename($test_name));

  if (@parts == 1){
    # Only testname given, ex: alias
    return (undef , $parts[0], undef);
  } elsif (@parts == 2) {
    # Either testname.test or suite.testname given
    # Ex. main.alias or alias.test

unknown's avatar
unknown committed
188
    if ($parts[1] eq "test")
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    {
      return (undef , $parts[0], $parts[1]);
    }
    else
    {
      return ($parts[0], $parts[1], undef);
    }

  } elsif (@parts == 3) {
    # Fully specified suitename.testname.test
    # ex main.alias.test
    return ( $parts[0], $parts[1], $parts[2]);
  }

  mtr_error("Illegal format of test name: $test_name");
}


207
sub collect_one_suite($)
208 209
{
  my $suite= shift;  # Test suite name
210
  my $opt_cases= shift;
unknown's avatar
unknown committed
211
  my @cases; # Array of hash
212 213

  mtr_verbose("Collecting: $suite");
unknown's avatar
unknown committed
214

215 216
  my $suitedir= "$::glob_mysql_test_dir"; # Default
  if ( $suite ne "main" )
unknown's avatar
unknown committed
217
  {
218 219 220
    # Allow suite to be path to "some dir" if $suite has at least
    # one directory part
    if ( -d $suite and splitdir($suite) > 1 ){
221
      $suitedir= $suite;
222 223
      mtr_report(" - from '$suitedir'");

224 225 226 227 228 229 230 231 232 233 234
    }
    else
    {
      $suitedir= my_find_dir($::basedir,
			     ["mysql-test/suite",
			      "mysql-test",
			      # Look in storage engine specific suite dirs
			      "storage/*/mysql-test-suites"
			     ],
			     [$suite]);
    }
235
    mtr_verbose("suitedir: $suitedir");
unknown's avatar
unknown committed
236 237
  }

238 239 240
  my $testdir= "$suitedir/t";
  my $resdir=  "$suitedir/r";

unknown's avatar
unknown committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
  # Check if t/ exists
  if (-d $testdir){
    # t/ exists

    if ( -d $resdir )
    {
      # r/exists
    }
    else
    {
      # No r/, use t/ as result dir
      $resdir= $testdir;
    }

  }
  else {
    # No t/ dir => there can' be any r/ dir
    mtr_error("Can't have r/ dir without t/") if -d $resdir;

    # No t/ or r/ => use suitedir
    $resdir= $testdir= $suitedir;
  }

  mtr_verbose("testdir: $testdir");
  mtr_verbose("resdir: $resdir");

unknown's avatar
unknown committed
267
  # ----------------------------------------------------------------------
268
  # Build a hash of disabled testcases for this suite
unknown's avatar
unknown committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
  # ----------------------------------------------------------------------
  my %disabled;
  if ( open(DISABLED, "$testdir/disabled.def" ) )
  {
    while ( <DISABLED> )
      {
        chomp;
        if ( /^\s*(\S+)\s*:\s*(.*?)\s*$/ )
          {
            $disabled{$1}= $2;
          }
      }
    close DISABLED;
  }

284 285 286 287 288
  # Read suite.opt file
  my $suite_opt_file=  "$testdir/suite.opt";
  my $suite_opts= [];
  if ( -f $suite_opt_file )
  {
unknown's avatar
unknown committed
289
    $suite_opts= opts_from_file($suite_opt_file);
290 291
  }

292
  if ( @$opt_cases )
unknown's avatar
unknown committed
293
  {
294
    # Collect in specified order
295
    foreach my $test_name_spec ( @$opt_cases )
296
    {
297
      my ($sname, $tname, $extension)= split_testname($test_name_spec);
unknown's avatar
unknown committed
298

299 300 301 302
      # The test name parts have now been defined
      #print "  suite_name: $sname\n";
      #print "  tname:      $tname\n";
      #print "  extension:  $extension\n";
unknown's avatar
unknown committed
303

304 305
      # Check cirrect suite if suitename is defined
      next if (defined $sname and $suite ne $sname);
unknown's avatar
unknown committed
306

307
      if ( defined $extension )
unknown's avatar
unknown committed
308
      {
309 310 311
	my $full_name= "$testdir/$tname.$extension";
	# Extension was specified, check if the test exists
        if ( ! -f $full_name)
unknown's avatar
unknown committed
312
        {
313 314 315 316 317 318
	  # This is only an error if suite was specified, otherwise it
	  # could exist in another suite
          mtr_error("Test '$full_name' was not found in suite '$sname'")
	    if $sname;

	  next;
unknown's avatar
unknown committed
319 320 321
        }
      }
      else
unknown's avatar
unknown committed
322
      {
unknown's avatar
unknown committed
323 324 325
	# No extension was specified, use default
	$extension= "test";
	my $full_name= "$testdir/$tname.$extension";
unknown's avatar
unknown committed
326

327
	# Test not found here, could exist in other suite
unknown's avatar
unknown committed
328
	next if ( ! -f $full_name );
unknown's avatar
unknown committed
329
      }
unknown's avatar
unknown committed
330

unknown's avatar
unknown committed
331 332 333 334 335 336 337 338 339
      push(@cases,
	   collect_one_test_case($suitedir,
				 $testdir,
				 $resdir,
				 $suite,
				 $tname,
				 "$tname.$extension",
				 \%disabled,
				 $suite_opts));
unknown's avatar
unknown committed
340 341 342 343
    }
  }
  else
  {
344 345
    opendir(TESTDIR, $testdir) or mtr_error("Can't open dir \"$testdir\": $!");

346 347
    foreach my $elem ( sort readdir(TESTDIR) )
    {
unknown's avatar
unknown committed
348
      my $tname= mtr_match_extension($elem, 'test');
unknown's avatar
unknown committed
349

unknown's avatar
unknown committed
350
      next unless defined $tname;
351

352
      # Skip tests that does not match the --do-test= filter
unknown's avatar
unknown committed
353 354 355 356 357 358 359 360 361 362 363
      next if ($do_test_reg and not $tname =~ /$do_test_reg/o);

      push(@cases,
	   collect_one_test_case($suitedir,
				 $testdir,
				 $resdir,
				 $suite,
				 $tname,
				 $elem,
				 \%disabled,
				 $suite_opts));
unknown's avatar
unknown committed
364 365 366 367
    }
    closedir TESTDIR;
  }

368 369 370
  #  Return empty list if no testcases found
  return if (@cases == 0);

371
  # ----------------------------------------------------------------------
372 373
  # Read combinations for this suite and build testcases x combinations
  # if any combinations exists
374
  # ----------------------------------------------------------------------
unknown's avatar
unknown committed
375
  if ( ! $opt_skip_combination )
376 377 378 379 380
  {
    my @combinations;
    my $combination_file= "$suitedir/combinations";
    #print "combination_file: $combination_file\n";
    if (@::opt_combinations)
381
    {
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
      # take the combination from command-line
      mtr_verbose("Take the combination from command line");
      foreach my $combination (@::opt_combinations) {
	my $comb= {};
	$comb->{name}= $combination;
	push(@{$comb->{comb_opt}}, $combination);
	push(@combinations, $comb);
      }
    }
    elsif (-f $combination_file )
    {
      # Read combinations file in my.cnf format
      mtr_verbose("Read combinations file");
      my $config= My::Config->new($combination_file);
      foreach my $group ($config->groups()) {
	my $comb= {};
	$comb->{name}= $group->name();
        foreach my $option ( $group->options() ) {
	  push(@{$comb->{comb_opt}}, $option->name()."=".$option->value());
	}
	push(@combinations, $comb);
403 404
      }
    }
405 406 407

    if (@combinations)
    {
408
      print " - adding combinations for $suite\n";
409 410 411 412
      #print_testcases(@cases);

      my @new_cases;
      foreach my $comb (@combinations)
413
      {
414 415 416
	foreach my $test (@cases)
	{

417 418
	  next if ( $test->{'skip'} );

419 420 421 422 423 424
	  # Skip this combination if the values it provides
	  # already are set in master_opt or slave_opt
	  if (My::Options::is_set($test->{master_opt}, $comb->{comb_opt}) &&
	      My::Options::is_set($test->{slave_opt}, $comb->{comb_opt}) ){
	    next;
	  }
425

426
	  # Copy test options
427
	  my $new_test= My::Test->new();
428 429 430 431 432 433 434 435 436 437 438 439
	  while (my ($key, $value) = each(%$test)) {
	    if (ref $value eq "ARRAY") {
	      push(@{$new_test->{$key}}, @$value);
	    } else {
	      $new_test->{$key}= $value;
	    }
	  }

	  # Append the combination options to master_opt and slave_opt
	  push(@{$new_test->{master_opt}}, @{$comb->{comb_opt}});
	  push(@{$new_test->{slave_opt}}, @{$comb->{comb_opt}});

unknown's avatar
unknown committed
440
	  # Add combination name short name
441 442 443 444 445 446
	  $new_test->{combination}= $comb->{name};

	  # Add the new test to new test cases list
	  push(@new_cases, $new_test);
	}
      }
447 448 449 450 451 452 453 454 455 456 457 458

      # Add the plain test if it was not already added
      # as part of a combination
      my %added;
      foreach my $new_test (@new_cases){
	$added{$new_test->{name}}= 1;
      }
      foreach my $test (@cases){
	push(@new_cases, $test) unless $added{$test->{name}};
      }


459 460 461 462
      #print_testcases(@new_cases);
      @cases= @new_cases;
      #print_testcases(@cases);
    }
463
  }
464 465 466 467 468 469 470
  optimize_cases(\@cases);
  #print_testcases(@cases);

  return @cases;
}


unknown's avatar
unknown committed
471

472 473 474 475 476 477 478 479 480 481
#
# Loop through all test cases
# - optimize which test to run by skipping unnecessary ones
# - update settings if necessary
#
sub optimize_cases {
  my ($cases)= @_;

  foreach my $tinfo ( @$cases )
  {
482 483 484
    # Skip processing if already marked as skipped
    next if $tinfo->{skip};

unknown's avatar
unknown committed
485 486 487 488 489
    # =======================================================
    # If a special binlog format was selected with
    # --mysqld=--binlog-format=x, skip all test that does not
    # support it
    # =======================================================
490
    #print "binlog_format: $binlog_format\n";
unknown's avatar
unknown committed
491
    if (defined $binlog_format )
492 493
    {
      # =======================================================
unknown's avatar
unknown committed
494
      # Fixed --binlog-format=x specified on command line
495
      # =======================================================
unknown's avatar
unknown committed
496
      if ( defined $tinfo->{'binlog_formats'} )
497
      {
498 499
	#print "binlog_formats: ". join(", ", @{$tinfo->{binlog_formats}})."\n";

unknown's avatar
unknown committed
500 501
	# The test supports different binlog formats
	# check if the selected one is ok
502
	my $supported=
unknown's avatar
unknown committed
503
	  grep { $_ eq $binlog_format } @{$tinfo->{'binlog_formats'}};
504 505 506 507
	if ( !$supported )
	{
	  $tinfo->{'skip'}= 1;
	  $tinfo->{'comment'}=
unknown's avatar
unknown committed
508
	    "Doesn't support --binlog-format='$binlog_format'";
509 510
	}
      }
unknown's avatar
unknown committed
511 512 513
    }
    else
    {
514
      # =======================================================
unknown's avatar
unknown committed
515
      # Use dynamic switching of binlog format
516
      # =======================================================
unknown's avatar
unknown committed
517 518 519 520 521 522

      # Get binlog-format used by this test from master_opt
      my $test_binlog_format;
      foreach my $opt ( @{$tinfo->{master_opt}} ) {
	$test_binlog_format=
	  mtr_match_prefix($opt, "--binlog-format=") || $test_binlog_format;
523 524
      }

525 526
      if (defined $test_binlog_format and
	  defined $tinfo->{binlog_formats} )
unknown's avatar
unknown committed
527
      {
528 529 530
	my $supported=
	  grep { $_ eq $test_binlog_format } @{$tinfo->{'binlog_formats'}};
	if ( !$supported )
unknown's avatar
unknown committed
531
	{
532 533 534 535
	  $tinfo->{'skip'}= 1;
	  $tinfo->{'comment'}=
	    "Doesn't support --binlog-format='$test_binlog_format'";
	  next;
unknown's avatar
unknown committed
536 537
	}
      }
538
    }
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558


    # =======================================================
    # Check that engine selected by
    # --default-storage-engine=<engine> is supported
    # =======================================================
    foreach my $opt ( @{$tinfo->{master_opt}} ) {
      my $default_engine=
	mtr_match_prefix($opt, "--default-storage-engine=");

      if (defined $default_engine){
	if ( ! exists $::mysqld_variables{$default_engine} )
	{
	 $tinfo->{'skip'}= 1;
	 $tinfo->{'comment'}=
	 "'$default_engine' not supported";

	}
      }
    }
559
  }
unknown's avatar
unknown committed
560 561 562 563
}


#
unknown's avatar
unknown committed
564 565
# Read options from the given opt file and append them as an array
# to $tinfo->{$opt_name}
unknown's avatar
unknown committed
566
#
unknown's avatar
unknown committed
567 568
sub process_opts_file {
  my ($tinfo, $opt_file, $opt_name)= @_;
unknown's avatar
unknown committed
569

unknown's avatar
unknown committed
570 571
  $tinfo->{$opt_name}= [];
  if ( -f $opt_file )
unknown's avatar
unknown committed
572
  {
unknown's avatar
unknown committed
573
    my $opts= opts_from_file($opt_file);
unknown's avatar
unknown committed
574

unknown's avatar
unknown committed
575
    foreach my $opt ( @$opts )
576 577
    {
      my $value;
unknown's avatar
unknown committed
578

579 580 581
      # The opt file is used both to send special options to the mysqld
      # as well as pass special test case specific options to this
      # script
unknown's avatar
unknown committed
582

583 584 585 586 587 588
      $value= mtr_match_prefix($opt, "--timezone=");
      if ( defined $value )
      {
	$tinfo->{'timezone'}= $value;
	next;
      }
unknown's avatar
unknown committed
589

590 591 592 593 594 595 596 597
      $value= mtr_match_prefix($opt, "--result-file=");
      if ( defined $value )
      {
	# Specifies the file mysqltest should compare
	# output against
	$tinfo->{'result_file'}= "r/$value.result";
	next;
      }
unknown's avatar
unknown committed
598

unknown's avatar
unknown committed
599 600 601 602 603 604 605 606
      $value= mtr_match_prefix($opt, "--config-file-template=");
      if ( defined $value)
      {
	# Specifies the configuration file to use for this test
	$tinfo->{'template_path'}= dirname($tinfo->{path})."/$value";
	next;
      }

607 608 609 610
      # If we set default time zone, remove the one we have
      $value= mtr_match_prefix($opt, "--default-time-zone=");
      if ( defined $value )
      {
611 612 613
	# Set timezone for this test case to something different
	$tinfo->{'timezone'}= "GMT-8";
	# Fallthrough, add the --default-time-zone option
614
      }
unknown's avatar
unknown committed
615

616 617 618 619 620 621 622 623
      # The --restart option forces a restart even if no special
      # option is set. If the options are the same as next testcase
      # there is no need to restart after the testcase
      # has completed
      if ( $opt eq "--force-restart" )
      {
	$tinfo->{'force_restart'}= 1;
	next;
unknown's avatar
unknown committed
624
      }
unknown's avatar
unknown committed
625

626
      # Ok, this was a real option, add it
unknown's avatar
unknown committed
627
      push(@{$tinfo->{$opt_name}}, $opt);
unknown's avatar
unknown committed
628 629
    }
  }
unknown's avatar
unknown committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
}

##############################################################################
#
#  Collect information about a single test case
#
##############################################################################

sub collect_one_test_case {
  my $suitedir=   shift;
  my $testdir=    shift;
  my $resdir=     shift;
  my $suitename=  shift;
  my $tname=      shift;
  my $filename=   shift;
  my $disabled=   shift;
  my $suite_opts= shift;
unknown's avatar
unknown committed
647

unknown's avatar
unknown committed
648 649 650 651 652 653 654 655 656
  #print "collect_one_test_case\n";
  #print " suitedir: $suitedir\n";
  #print " testdir: $testdir\n";
  #print " resdir: $resdir\n";
  #print " suitename: $suitename\n";
  #print " tname: $tname\n";
  #print " filename: $filename\n";

  # ----------------------------------------------------------------------
657
  # Check --start-from
unknown's avatar
unknown committed
658
  # ----------------------------------------------------------------------
659
  if ( $start_from )
unknown's avatar
unknown committed
660
  {
661 662 663 664 665 666 667 668 669
    # start_from can be specified as [suite.].testname_prefix
    my ($suite, $test, $ext)= split_testname($start_from);

    if ( $suite and $suitename lt $suite){
      return; # Skip silently
    }
    if ( $tname lt $test ){
      return; # Skip silently
    }
unknown's avatar
unknown committed
670
  }
unknown's avatar
unknown committed
671

unknown's avatar
unknown committed
672 673 674
  # ----------------------------------------------------------------------
  # Set defaults
  # ----------------------------------------------------------------------
675 676 677 678
  my $tinfo= My::Test->new
    (
     name          => "$suitename.$tname",
     path          => "$testdir/$filename",
unknown's avatar
unknown committed
679

680
    );
unknown's avatar
unknown committed
681

682 683 684 685 686 687 688 689
  my $result_file= "$resdir/$tname.result";
  if (-f $result_file) {
    # Allow nonexistsing result file
    # in that case .test must issue "exit" otherwise test
    # should fail by default
    $tinfo->{result_file}= $result_file;
  }

unknown's avatar
unknown committed
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  # ----------------------------------------------------------------------
  # Skip some tests but include in list, just mark them as skipped
  # ----------------------------------------------------------------------
  if ( $skip_test_reg and $tname =~ /$skip_test_reg/o )
  {
    $tinfo->{'skip'}= 1;
    return $tinfo;
  }

  # ----------------------------------------------------------------------
  # Check for disabled tests
  # ----------------------------------------------------------------------
  my $marked_as_disabled= 0;
  if ( $disabled->{$tname} )
  {
    # Test was marked as disabled in suites disabled.def file
    $marked_as_disabled= 1;
    $tinfo->{'comment'}= $disabled->{$tname};
  }

  my $disabled_file= "$testdir/$tname.disabled";
  if ( -f $disabled_file )
  {
    $marked_as_disabled= 1;
    $tinfo->{'comment'}= mtr_fromfile($disabled_file);
unknown's avatar
unknown committed
715 716
  }

unknown's avatar
unknown committed
717
  if ( $marked_as_disabled )
unknown's avatar
unknown committed
718
  {
unknown's avatar
unknown committed
719 720 721 722 723 724 725 726 727 728 729 730
    if ( $enable_disabled )
    {
      # User has selected to run all disabled tests
      mtr_report(" - $tinfo->{name} wil be run although it's been disabled\n",
		 "  due to '$tinfo->{comment}'");
    }
    else
    {
      $tinfo->{'skip'}= 1;
      $tinfo->{'disable'}= 1;   # Sub type of 'skip'
      return $tinfo;
    }
unknown's avatar
unknown committed
731 732
  }

unknown's avatar
unknown committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
  # ----------------------------------------------------------------------
  # Append suite extra options to both master and slave
  # ----------------------------------------------------------------------
  push(@{$tinfo->{'master_opt'}}, @$suite_opts);
  push(@{$tinfo->{'slave_opt'}}, @$suite_opts);

  # ----------------------------------------------------------------------
  # Add master opts, extra options only for master
  # ----------------------------------------------------------------------
  process_opts_file($tinfo, "$testdir/$tname-master.opt", 'master_opt');

  # ----------------------------------------------------------------------
  # Add slave opts, list of extra option only for slave
  # ----------------------------------------------------------------------
  process_opts_file($tinfo, "$testdir/$tname-slave.opt", 'slave_opt');
748 749 750 751 752 753 754 755 756 757
  
  
  #-----------------------------------------------------------------------
  # Check for test specific config file
  #-----------------------------------------------------------------------
  my $test_cnf_file= "$testdir/$tname.cnf";
  if ( -f $test_cnf_file) {
    # Specifies the configuration file to use for this test
    $tinfo->{'template_path'}= $test_cnf_file;
  }
unknown's avatar
unknown committed
758

759 760 761 762 763 764 765 766 767
  # ----------------------------------------------------------------------
  # Check for test specific config file
  # ----------------------------------------------------------------------
  my $test_cnf_file= "$testdir/$tname.cnf";
  if ( -f $test_cnf_file ) {
    # Specifies the configuration file to use for this test
    $tinfo->{'template_path'}= $test_cnf_file;
  }

unknown's avatar
unknown committed
768 769 770 771
  # ----------------------------------------------------------------------
  # master sh
  # ----------------------------------------------------------------------
  my $master_sh= "$testdir/$tname-master.sh";
unknown's avatar
unknown committed
772 773
  if ( -f $master_sh )
  {
unknown's avatar
unknown committed
774
    if ( IS_WIN32PERL )
unknown's avatar
unknown committed
775 776
    {
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
777
      $tinfo->{'comment'}= "No tests with sh scripts on Windows";
unknown's avatar
unknown committed
778
      return $tinfo;
unknown's avatar
unknown committed
779 780 781 782 783 784 785
    }
    else
    {
      $tinfo->{'master_sh'}= $master_sh;
    }
  }

unknown's avatar
unknown committed
786 787 788 789
  # ----------------------------------------------------------------------
  # slave sh
  # ----------------------------------------------------------------------
  my $slave_sh= "$testdir/$tname-slave.sh";
unknown's avatar
unknown committed
790 791
  if ( -f $slave_sh )
  {
unknown's avatar
unknown committed
792
    if ( IS_WIN32PERL )
unknown's avatar
unknown committed
793 794
    {
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
795
      $tinfo->{'comment'}= "No tests with sh scripts on Windows";
unknown's avatar
unknown committed
796
      return $tinfo;
unknown's avatar
unknown committed
797 798 799 800 801 802 803
    }
    else
    {
      $tinfo->{'slave_sh'}= $slave_sh;
    }
  }

unknown's avatar
unknown committed
804 805 806 807 808 809 810 811 812 813
  # ----------------------------------------------------------------------
  # <tname>.slave-mi
  # ----------------------------------------------------------------------
  mtr_error("$tname: slave-mi not supported anymore")
    if ( -f "$testdir/$tname.slave-mi");


  tags_from_test_file($tinfo,"$testdir/${tname}.test");

  if ( defined $default_storage_engine )
unknown's avatar
unknown committed
814
  {
unknown's avatar
unknown committed
815 816 817 818 819 820 821 822
    # Different default engine is used
    # tag test to require that engine
    $tinfo->{'ndb_test'}= 1
      if ( $default_storage_engine =~ /^ndb/i );

    $tinfo->{'innodb_test'}= 1
      if ( $default_storage_engine =~ /^innodb/i );

unknown's avatar
unknown committed
823 824
  }

unknown's avatar
unknown committed
825
  if ( $tinfo->{'big_test'} and ! $::opt_big_test )
unknown's avatar
unknown committed
826
  {
unknown's avatar
unknown committed
827 828 829
    $tinfo->{'skip'}= 1;
    $tinfo->{'comment'}= "Test need 'big-test' option";
    return $tinfo
unknown's avatar
unknown committed
830 831
  }

unknown's avatar
unknown committed
832
  if ( $tinfo->{'need_debug'} && ! $::debug_compiled_binaries )
unknown's avatar
unknown committed
833
  {
unknown's avatar
unknown committed
834 835 836
    $tinfo->{'skip'}= 1;
    $tinfo->{'comment'}= "Test need debug binaries";
    return $tinfo
unknown's avatar
unknown committed
837 838
  }

unknown's avatar
unknown committed
839
  if ( $tinfo->{'ndb_test'} )
unknown's avatar
unknown committed
840
  {
unknown's avatar
unknown committed
841
    # This is a NDB test
842
    if ( $::opt_skip_ndbcluster == 2 )
unknown's avatar
unknown committed
843
    {
unknown's avatar
unknown committed
844
      # Ndb is not supported, skip it
unknown's avatar
unknown committed
845
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
846 847
      $tinfo->{'comment'}= "No ndbcluster support";
      return $tinfo;
unknown's avatar
unknown committed
848
    }
unknown's avatar
unknown committed
849
    elsif ( $::opt_skip_ndbcluster )
unknown's avatar
unknown committed
850
    {
unknown's avatar
unknown committed
851
      # All ndb test's should be skipped
unknown's avatar
unknown committed
852
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
853 854
      $tinfo->{'comment'}= "No ndbcluster tests(--skip-ndbcluster)";
      return $tinfo;
unknown's avatar
unknown committed
855 856 857 858
    }
  }
  else
  {
unknown's avatar
unknown committed
859 860
    # This is not a ndb test
    if ( $opt_with_ndbcluster_only )
unknown's avatar
unknown committed
861
    {
unknown's avatar
unknown committed
862
      # Only the ndb test should be run, all other should be skipped
unknown's avatar
unknown committed
863
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
864 865
      $tinfo->{'comment'}= "Only ndbcluster tests";
      return $tinfo;
unknown's avatar
unknown committed
866
    }
unknown's avatar
unknown committed
867
  }
unknown's avatar
unknown committed
868

Magnus Svensson's avatar
Merge  
Magnus Svensson committed
869 870 871 872 873 874 875
  if ($tinfo->{'federated_test'})
  {
    # This is a test that need federated, enable it
    push(@{$tinfo->{'master_opt'}}, "--loose-federated");
    push(@{$tinfo->{'slave_opt'}}, "--loose-federated");
  }

unknown's avatar
unknown committed
876 877
  if ( $tinfo->{'innodb_test'} )
  {
Magnus Svensson's avatar
Merge  
Magnus Svensson committed
878
    # This is a test that need innodb
unknown's avatar
unknown committed
879
    if ( $::mysqld_variables{'innodb'} ne "TRUE" )
unknown's avatar
unknown committed
880
    {
unknown's avatar
unknown committed
881
      # innodb is not supported, skip it
unknown's avatar
unknown committed
882
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
883 884
      $tinfo->{'comment'}= "No innodb support";
      return $tinfo;
unknown's avatar
unknown committed
885
    }
unknown's avatar
unknown committed
886 887 888 889 890 891
  }
  else
  {
    push(@{$tinfo->{'master_opt'}}, "--loose-skip-innodb");
    push(@{$tinfo->{'slave_opt'}}, "--loose-skip-innodb");
  }
unknown's avatar
unknown committed
892

unknown's avatar
unknown committed
893 894 895
  if ( $tinfo->{'need_binlog'} )
  {
    if (grep(/^--skip-log-bin/,  @::opt_extra_mysqld_opt) )
unknown's avatar
unknown committed
896 897
    {
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
898 899
      $tinfo->{'comment'}= "Test need binlog";
      return $tinfo;
unknown's avatar
unknown committed
900
    }
unknown's avatar
unknown committed
901 902 903 904 905 906 907 908
  }
  else
  {
    # Test does not need binlog, add --skip-binlog to
    # the options used when starting
    push(@{$tinfo->{'master_opt'}}, "--loose-skip-log-bin");
    push(@{$tinfo->{'slave_opt'}}, "--loose-skip-log-bin");
  }
unknown's avatar
unknown committed
909

unknown's avatar
unknown committed
910 911 912
  if ( $tinfo->{'rpl_test'} )
  {
    if ( $skip_rpl )
unknown's avatar
unknown committed
913 914
    {
      $tinfo->{'skip'}= 1;
unknown's avatar
unknown committed
915 916
      $tinfo->{'comment'}= "No replication tests(--skip-rpl)";
      return $tinfo;
917
    }
unknown's avatar
unknown committed
918
  }
919

920 921 922 923 924 925 926 927 928 929
  if ( $::opt_embedded_server )
  {
    if ( $tinfo->{'not_embedded'} )
    {
      $tinfo->{'skip'}= 1;
      $tinfo->{'comment'}= "Not run for embedded server";
      return $tinfo;
    }
  }

unknown's avatar
unknown committed
930 931 932 933 934 935 936 937 938 939 940
  # ----------------------------------------------------------------------
  # Find config file to use if not already selected in <testname>.opt file
  # ----------------------------------------------------------------------
  if (defined $defaults_file) {
    # Using same config file for all tests
    $tinfo->{template_path}= $defaults_file;
  }
  elsif (! $tinfo->{template_path} )
  {
    my $config= "$suitedir/my.cnf";
    if (! -f $config )
941
    {
942
      # assume default.cnf will be used
unknown's avatar
unknown committed
943
      $config= "include/default_my.cnf";
944 945 946 947 948 949 950 951 952 953 954

      # Suite has no config, autodetect which one to use
      if ( $tinfo->{rpl_test} ){
	$config= "suite/rpl/my.cnf";
	if ( $tinfo->{ndb_test} ){
	  $config= "suite/rpl_ndb/my.cnf";
	}
      }
      elsif ( $tinfo->{ndb_test} ){
	$config= "suite/ndb/my.cnf";
      }
955
    }
unknown's avatar
unknown committed
956 957
    $tinfo->{template_path}= $config;
  }
958

unknown's avatar
unknown committed
959 960 961
  # Set extra config file to use
  if (defined $defaults_extra_file) {
    $tinfo->{extra_template_path}= $defaults_extra_file;
unknown's avatar
unknown committed
962
  }
unknown's avatar
unknown committed
963

964 965 966 967 968 969
  # ----------------------------------------------------------------------
  # Append mysqld extra options to both master and slave
  # ----------------------------------------------------------------------
  push(@{$tinfo->{'master_opt'}}, @::opt_extra_mysqld_opt);
  push(@{$tinfo->{'slave_opt'}}, @::opt_extra_mysqld_opt);

unknown's avatar
unknown committed
970
  return $tinfo;
unknown's avatar
unknown committed
971 972 973
}


unknown's avatar
unknown committed
974 975
# List of tags in the .test files that if found should set
# the specified value in "tinfo"
unknown's avatar
unknown committed
976
my @tags=
unknown's avatar
unknown committed
977
(
unknown's avatar
unknown committed
978 979 980
 ["include/have_binlog_format_row.inc", "binlog_formats", ["row"]],
 ["include/have_binlog_format_statement.inc", "binlog_formats", ["statement"]],
 ["include/have_binlog_format_mixed.inc", "binlog_formats", ["mixed"]],
981
 ["include/have_binlog_format_mixed_or_row.inc",
unknown's avatar
unknown committed
982
  "binlog_formats", ["mixed", "row"]],
983
 ["include/have_binlog_format_mixed_or_statement.inc",
unknown's avatar
unknown committed
984
  "binlog_formats", ["mixed", "statement"]],
985
 ["include/have_binlog_format_row_or_statement.inc",
unknown's avatar
unknown committed
986 987 988 989 990
  "binlog_formats", ["row", "statement"]],

 ["include/have_log_bin.inc", "need_binlog", 1],

 ["include/have_innodb.inc", "innodb_test", 1],
unknown's avatar
unknown committed
991 992
 ["include/big_test.inc", "big_test", 1],
 ["include/have_debug.inc", "need_debug", 1],
993
 ["include/have_ndb.inc", "ndb_test", 1],
994
 ["include/have_multi_ndb.inc", "ndb_test", 1],
unknown's avatar
unknown committed
995 996
 ["include/master-slave.inc", "rpl_test", 1],
 ["include/ndb_master-slave.inc", "rpl_test", 1],
997
 ["include/ndb_master-slave.inc", "ndb_test", 1],
Magnus Svensson's avatar
Merge  
Magnus Svensson committed
998
 ["federated.inc", "federated_test", 1],
999
 ["include/not_embedded.inc", "not_embedded", 1],
unknown's avatar
unknown committed
1000 1001
);

unknown's avatar
unknown committed
1002 1003

sub tags_from_test_file {
unknown's avatar
unknown committed
1004 1005 1006 1007 1008 1009 1010
  my $tinfo= shift;
  my $file= shift;
  #mtr_verbose("$file");
  my $F= IO::File->new($file) or mtr_error("can't open file \"$file\": $!");

  while ( my $line= <$F> )
  {
1011 1012 1013 1014

    # Skip line if it start's with #
    next if ( $line =~ /^#/ );

unknown's avatar
unknown committed
1015 1016 1017 1018 1019
    # Match this line against tag in "tags" array
    foreach my $tag (@tags)
    {
      if ( index($line, $tag->[0]) >= 0 )
      {
unknown's avatar
unknown committed
1020 1021
	# Tag matched, assign value to "tinfo"
	$tinfo->{"$tag->[1]"}= $tag->[2];
unknown's avatar
unknown committed
1022 1023 1024 1025
      }
    }

    # If test sources another file, open it as well
1026 1027
    if ( $line =~ /^\-\-([[:space:]]*)source(.*)$/ or
	 $line =~ /^([[:space:]]*)source(.*);$/ )
unknown's avatar
unknown committed
1028 1029 1030 1031 1032
    {
      my $value= $2;
      $value =~ s/^\s+//;  # Remove leading space
      $value =~ s/[[:space:]]+$//;  # Remove ending space

1033 1034 1035 1036
      # Sourced file may exist relative to test or
      # in global location
      foreach my $sourced_file (dirname($file). "/$value",
				"$::glob_mysql_test_dir/$value")
1037
      {
1038 1039 1040 1041 1042 1043 1044 1045
	if ( -f $sourced_file )
	{
	  # Only source the file if it exists, we may get
	  # false positives in the regexes above if someone
	  # writes "source nnnn;" in a test case(such as mysqltest.test)
	  tags_from_test_file($tinfo, $sourced_file);
	  last;
	}
1046
      }
unknown's avatar
unknown committed
1047
    }
unknown's avatar
unknown committed
1048

1049 1050 1051
  }
}

unknown's avatar
unknown committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
sub unspace {
  my $string= shift;
  my $quote=  shift;
  $string =~ s/[ \t]/\x11/g;
  return "$quote$string$quote";
}


sub opts_from_file ($) {
  my $file=  shift;

  open(FILE,"<",$file) or mtr_error("can't open file \"$file\": $!");
  my @args;
  while ( <FILE> )
  {
    chomp;

    #    --set-variable=init_connect=set @a='a\\0c'
    s/^\s+//;                           # Remove leading space
    s/\s+$//;                           # Remove ending space

    # This is strange, but we need to fill whitespace inside
    # quotes with something, to remove later. We do this to
    # be able to split on space. Else, we have trouble with
    # options like
    #
    #   --someopt="--insideopt1 --insideopt2"
    #
    # But still with this, we are not 100% sure it is right,
    # we need a shell to do it right.

    s/\'([^\'\"]*)\'/unspace($1,"\x0a")/ge;
    s/\"([^\'\"]*)\"/unspace($1,"\x0b")/ge;
    s/\'([^\'\"]*)\'/unspace($1,"\x0a")/ge;
    s/\"([^\'\"]*)\"/unspace($1,"\x0b")/ge;

    foreach my $arg (split(/[ \t]+/))
    {
      $arg =~ tr/\x11\x0a\x0b/ \'\"/;     # Put back real chars
      # The outermost quotes has to go
      $arg =~ s/^([^\'\"]*)\'(.*)\'([^\'\"]*)$/$1$2$3/
        or $arg =~ s/^([^\'\"]*)\"(.*)\"([^\'\"]*)$/$1$2$3/;
      $arg =~ s/\\\\/\\/g;

      # Do not pass empty string since my_getopt is not capable to handle it.
      if (length($arg)) {
	push(@args, $arg);
      }
    }
  }
  close FILE;
  return \@args;
}
1105 1106 1107

sub print_testcases {
  my (@cases)= @_;
unknown's avatar
unknown committed
1108

1109 1110
  print "=" x 60, "\n";
  foreach my $test (@cases){
1111
    $test->print_test();
unknown's avatar
unknown committed
1112
  }
1113
  print "=" x 60, "\n";
unknown's avatar
unknown committed
1114 1115
}

1116

unknown's avatar
unknown committed
1117
1;