simplify-mysqltest.pl

#!/usr/bin/perl

# Copyright (C) 2008-2010 Sun Microsystems, Inc. All rights reserved.
# Use is subject to license terms.
#
# 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.
#
# 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.
#
# 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

$| = 1;

use strict;
use lib 'lib';
use lib '../lib';
use DBI;
use Carp;
use File::Compare;
use File::Copy;
use Getopt::Long;
use Time::HiRes;

use GenTest;
use GenTest::Properties;
use GenTest::Constants;
use GenTest::Simplifier::Mysqltest;


# NOTE: "oracle" function behaves differently if basedir2 is specified in addition
#       to basedir. In this case expected_mtr_output is ignored, and result
#       comparison between servers is performed instead.

my $options = {};
my $o = GetOptions($options, 
           'config=s',
           'input_file=s',
           'basedir=s',
           'basedir2=s',
           'expected_mtr_output=s',
           'verbose!',
           'mtr_options=s%',
           'mysqld=s%');
my $config = GenTest::Properties->new(
    options => $options,
    legal => [
        'config',
        'input_file',
        'basedir',
        'basedir2',
        'expected_mtr_output',
        'mtr_options',
        'verbose',
        'header',
        'footer',
        'filter',
        'mysqld',
        'use_connections'
    ],
    required => [
        'basedir',
        'input_file',
        'mtr_options']
    );

$config->printHelp if not $o;
$config->printProps;

my $header = $config->header() || [];
my $footer = $config->footer() || [];

# End of user-configurable section

my $iteration = 0;
my $run_id = time();

say("run_id = $run_id");

my $simplifier = GenTest::Simplifier::Mysqltest->new(
    filter => $config->filter(),
    use_connections => $config->use_connections(),
    oracle => sub {
        my $oracle_mysqltest = shift;
        $iteration++;
        
        chdir($config->basedir.'/mysql-test'); # assume forward slash works

        my $testfile_base_name = $run_id.'-'.$iteration; # we need this for both test- and result file name
        my $testfile = $testfile_base_name.'.test';      # test file of this iteration
        my $resultfile = $testfile_base_name.'.result';      # test file of this iteration
        
        open (ORACLE_MYSQLTEST, ">t/$testfile") or croak "Unable to open $testfile: $!";

        print ORACLE_MYSQLTEST join("\n",@{$header})."\n\n";
        print ORACLE_MYSQLTEST $oracle_mysqltest;
        print ORACLE_MYSQLTEST "\n\n".join("\n",@{$footer})."\n";
        close ORACLE_MYSQLTEST;

        my $mysqldopt = $config->genOpt('--mysqld=--', 'mysqld');
        my $mtr_start_time = Time::HiRes::time();
        my $mysqltest_cmd = "perl mysql-test-run.pl $mysqldopt ". $config->genOpt('--', 'mtr_options')." t/$testfile 2>&1";
        my $mysqltest_output = `$mysqltest_cmd`;
        my $mtr_exit_code = $? >> 8;
        my $mtr_duration = Time::HiRes::time() - $mtr_start_time;
        if ($iteration == 1) {
            say ($mysqltest_output);
        } else {
            say ("MTR test duration: $mtr_duration; exit_code: $mtr_exit_code");
        }
    
        system("grep 'Unsafe statement binlogged' ".$config->basedir()."/mysql-test/var/log/mysqld.1.err");
        my $grep_exit_code = $? >> 8;
        if ($grep_exit_code == 0) {
            say("Messages about unsafe replication found in master error log.");
            return ORACLE_ISSUE_NO_LONGER_REPEATABLE;
        } elsif ($grep_exit_code > 1) {
            say("grep on the mysqld.1.err error log failed");
        }

        ########################################################################
        # Start of comparison mode (two basedirs)
        ########################################################################
        
        if (defined $config->basedir2) {
            if ($iteration == 1) {
                say ('Two basedirs specified. Will compare outputs instead of looking for expected output.');
                say ('Server A: '.$config->basedir);
                say ('Server B: '.$config->basedir2);
                # NOTE: --record MTR option is required. TODO: Check for this?
            }
            
            #
            # Run the test against basedir2 and compare results against the previous run.
            #
            
            chdir($config->basedir2.'/mysql-test');
            
            # working dir is now for Server B, so we need full path to Server A's files for later
            my $testfile_full_path = $config->basedir.'/mysql-test/t/'.$testfile;
            my $resultfile_full_path = $config->basedir.'/mysql-test/r/'.$testfile_base_name.'.result';
                
            # tests/results for Server B include "-b" in the filename
            my $testfile2_base_name = $run_id.'-'.$iteration.'-b';
            my $testfile2 = $testfile2_base_name.'.test';
            my $testfile2_full_path = $config->basedir2.'/mysql-test/t/'.$testfile2;
            my $resultfile2_full_path = $config->basedir2.'/mysql-test/r/'.$testfile2_base_name.'.result';
            
            # Copy test file to server B
            copy($testfile_full_path, $testfile2_full_path) or croak("Unable to copy test file $testfile to $testfile2");
            
            my $mysqltest_cmd2 = 
                "perl mysql-test-run.pl $mysqldopt ". $config->genOpt('--', 'mtr_options').
                " $testfile2 2>&1";

            # Run the test against server B
            # we don't really use this output for anything right now
            my $mysqltest_output2 = `$mysqltest_cmd2`;
            #say $mysqltest_output2 if $iteration == 1;
            
            
            # Compare the two results
            # We declare the tests to have failed properly only if the results
            # from the two test runs differ.
            # (We ignore expected_mtr_output in this mode)
            my $compare_result = compare($resultfile_full_path, $resultfile2_full_path);
            if ( $compare_result == 0) {
                # no diff
                say('Issue not repeatable (results were equal) with test '.$testfile_base_name);
                if ($iteration > 1) {
                    unlink($testfile_full_path); # deletes test for Server A
                    unlink($testfile2_full_path); # deletes test for Server B
                    unlink($resultfile_full_path); # deletes result for Server A
                    unlink($resultfile2_full_path); # deletes result for Server B
                }
                return ORACLE_ISSUE_NO_LONGER_REPEATABLE;
            } elsif ($compare_result > 0) {
                # diff
                say("Issue is repeatable (results differ) with test $testfile_base_name");
                return ORACLE_ISSUE_STILL_REPEATABLE;
            } else {
                # error ($compare_result < 0)
                if ( (! -e $resultfile_full_path) && (! -e $resultfile2_full_path) ) {
                    # both servers are lacking result file. Probably due to bad SQL in simplified test.
                    return ORACLE_ISSUE_NO_LONGER_REPEATABLE;
                }
                if (! -e $resultfile_full_path) {
                    say("Error ($compare_result) comparing result files for test $testfile_base_name");
                    say("Test output was:");
                    say $mysqltest_output;
                    croak("Resultfile  $resultfile_full_path not found");
                } elsif (! -e $resultfile2_full_path) {
                    say("Error ($compare_result) comparing result files for test $testfile_base_name");
                    say("Test output was:");
                    say $mysqltest_output2;
                    croak("Resultfile2 $resultfile2_full_path not found");
                }
            }

        ########################################################################
        # End of comparison mode (two basedirs)
        ########################################################################
            
        } else {
            # Only one basedir specified - retain old behavior (look for expected output).

            #
            # We declare the test to have failed properly only if the
            # desired message is present in the output and it is not a
            # result of an error that caused part of the test, including
            # the --croak construct, to be printed to stdout.
            #
    
            my $expected_mtr_output = $config->expected_mtr_output;
            if (
                ($mysqltest_output =~ m{$expected_mtr_output}sio) &&
                ($mysqltest_output !~ m{--die}sio)
            ) {
                say("Issue repeatable with $testfile");
                return ORACLE_ISSUE_STILL_REPEATABLE;
            } else {
                say("Issue not repeatable with $testfile.");
                if (
                    ($mtr_exit_code == 0) &&
                    ($iteration > 1)
                ) {
                    unlink('t/'.$testfile);
                    unlink('r/'.$resultfile);
                }

                say $mysqltest_output if $iteration > 1 && $mtr_exit_code != 0;
                return ORACLE_ISSUE_NO_LONGER_REPEATABLE;
            }
        }
    }
);

my $simplified_mysqltest;

## Copy input file
if (-f $config->input_file){
    $config->input_file =~ m/\.([a-z]+$)/i;
    my $extension = $1;
    my $input_file_copy = $config->basedir."/mysql-test/t/".$run_id."-0.".$extension;
    system("cp ".$config->input_file." ".$input_file_copy);
    
    if (lc($extension) eq 'csv') {
        say("Treating ".$config->input_file." as a CSV file");
        $simplified_mysqltest = $simplifier->simplifyFromCSV($input_file_copy);
    } elsif (lc($extension) eq 'test') {
        say("Treating ".$config->input_file." as a mysqltest file");
        open (MYSQLTEST_FILE , $input_file_copy) or croak "Unable to open ".$input_file_copy." as a .test file: $!";
        read (MYSQLTEST_FILE , my $initial_mysqltest, -s $input_file_copy);
        close (MYSQLTEST_FILE);
        $simplified_mysqltest = $simplifier->simplify($initial_mysqltest);
    } else {
        carp "Unknown file type for ".$config->input_file;
    }

    if (defined $simplified_mysqltest) {
        say "Simplified mysqltest:";
        print "\n\n".join("\n",@{$header})."\n\n\n".$simplified_mysqltest.join("\n",@{$footer})."\n\n";
        exit (STATUS_OK);
    } else {
        say "Unable to simplify ". $config->input_file.".\n";
        exit (STATUS_ENVIRONMENT_FAILURE);
    }
} else {
    croak "Can't find ".$config->input_file;
}
##