# -*- cperl -*- # Copyright 2004-2008 MySQL AB, 2008 Sun Microsystems, Inc. # # 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 # 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. package mtr_report; use strict; use base qw(Exporter); our @EXPORT= qw(report_option mtr_print_line mtr_print_thick_line mtr_print_header mtr_report mtr_report_stats mtr_warning mtr_error mtr_debug mtr_verbose mtr_verbose_restart mtr_report_test_passed mtr_report_test_skipped mtr_print mtr_report_test); use mtr_match; require "mtr_io.pl"; my $tot_real_time= 0; our $timestamp= 0; our $timediff= 0; our $name; our $verbose; our $verbose_restart= 0; our $timer= 1; sub report_option { my ($opt, $value)= @_; # Evaluate $opt as string to use "Getopt::Long::Callback legacy API" my $opt_name = "$opt"; # Convert - to _ in option name $opt_name =~ s/-/_/g; no strict 'refs'; ${$opt_name}= $value; } sub _name { return $name ? $name." " : undef; } sub _mtr_report_test_name ($) { my $tinfo= shift; my $tname= $tinfo->{name}; return unless defined $verbose; # Add combination name if any $tname.= " '$tinfo->{combination}'" if defined $tinfo->{combination}; print _name(), _timestamp(); printf "%-40s ", $tname; return $tname; } sub mtr_report_test_skipped ($) { my ($tinfo)= @_; $tinfo->{'result'}= 'MTR_RES_SKIPPED'; mtr_report_test($tinfo); } sub mtr_report_test_passed ($) { my ($tinfo)= @_; # Save the timer value my $timer_str= ""; if ( $timer and -f "$::opt_vardir/log/timer" ) { $timer_str= mtr_fromfile("$::opt_vardir/log/timer"); $tinfo->{timer}= $timer_str; } # Big warning if status already set if ( $tinfo->{'result'} ){ mtr_warning("mtr_report_test_passed: Test result", "already set to '", $tinfo->{'result'}, ","); } $tinfo->{'result'}= 'MTR_RES_PASSED'; mtr_report_test($tinfo); } sub mtr_report_test ($) { my ($tinfo)= @_; my $test_name = _mtr_report_test_name($tinfo); my $comment= $tinfo->{'comment'}; my $logfile= $tinfo->{'logfile'}; my $warnings= $tinfo->{'warnings'}; my $result= $tinfo->{'result'}; my $retry= $tinfo->{'retries'} ? "retry-" : ""; if ($result eq 'MTR_RES_FAILED'){ my $timest = format_time(); my $fail = "fail"; if ( $::opt_experimental ) { # Find out if this test case is an experimental one, so we can treat # the failure as an expected failure instead of a regression. for my $exp ( @$::experimental_test_cases ) { if ( $exp ne $test_name ) { # if the expression is not the name of this test case, but has # an asterisk at the end, determine if the characters up to # but excluding the asterisk are the same if ( $exp ne "" && substr($exp, -1, 1) eq "*" ) { $exp = substr($exp, 0, length($exp) - 1); if ( substr($test_name, 0, length($exp)) ne $exp ) { # no match, try next entry next; } # if yes, fall through to set the exp-fail status } else { # no match, try next entry next; } } $fail = "exp-fail"; last; } } if ( $warnings ) { mtr_report("[ $retry$fail ] Found warnings/errors in server log file!"); mtr_report(" Test ended at $timest"); mtr_report($warnings); return; } my $timeout= $tinfo->{'timeout'}; if ( $timeout ) { mtr_report("[ $retry$fail ] timeout after $timeout seconds"); mtr_report(" Test ended at $timest"); mtr_report("\n$tinfo->{'comment'}"); return; } else { mtr_report("[ $retry$fail ]\n Test ended at $timest"); } if ( $logfile ) { # Test failure was detected by test tool and its report # about what failed has been saved to file. Display the report. mtr_report("\n$logfile\n"); } if ( $comment ) { # The test failure has been detected by mysql-test-run.pl # when starting the servers or due to other error, the reason for # failing the test is saved in "comment" mtr_report("\n$comment\n"); } if ( !$logfile and !$comment ) { # Neither this script or the test tool has recorded info # about why the test has failed. Should be debugged. mtr_report("\nUnknown result, neither 'comment' or 'logfile' set"); } } elsif ($result eq 'MTR_RES_SKIPPED') { if ( $tinfo->{'disable'} ) { mtr_report("[ disabled ] $comment"); } elsif ( $comment ) { mtr_report("[ skipped ] $comment"); } else { mtr_report("[ skipped ]"); } } elsif ($result eq 'MTR_RES_PASSED') { my $timer_str= $tinfo->{timer} || ""; $tot_real_time += ($timer_str/1000); mtr_report("[ ${retry}pass ] ", sprintf("%5s", $timer_str)); # Show any problems check-testcase found if ( defined $tinfo->{'check'} ) { mtr_report($tinfo->{'check'}); } } } sub mtr_report_stats ($) { my $tests= shift; # ---------------------------------------------------------------------- # Find out how we where doing # ---------------------------------------------------------------------- my $tot_skiped= 0; my $tot_passed= 0; my $tot_failed= 0; my $tot_tests= 0; my $tot_restarts= 0; my $found_problems= 0; foreach my $tinfo (@$tests) { if ( $tinfo->{failures} ) { # Test has failed at least one time $tot_tests++; $tot_failed++; } elsif ( $tinfo->{'result'} eq 'MTR_RES_SKIPPED' ) { # Test was skipped $tot_skiped++; } elsif ( $tinfo->{'result'} eq 'MTR_RES_PASSED' ) { # Test passed $tot_tests++; $tot_passed++; } if ( $tinfo->{'restarted'} ) { # Servers was restarted $tot_restarts++; } # Look for warnings produced by mysqltest my $base_file= mtr_match_extension($tinfo->{'result_file'}, "result"); # Trim extension my $warning_file= "$base_file.warnings"; if ( -f $warning_file ) { $found_problems= 1; mtr_warning("Check myqltest warnings in '$warning_file'"); } } # ---------------------------------------------------------------------- # Print out a summary report to screen # ---------------------------------------------------------------------- print "The servers were restarted $tot_restarts times\n"; if ( $timer ) { use English; mtr_report("Spent", sprintf("%.3f", $tot_real_time),"of", time - $BASETIME, "seconds executing testcases"); } my $warnlog= "$::opt_vardir/log/warnings"; if ( -f $warnlog ) { mtr_warning("Got errors/warnings while running tests, please examine", "'$warnlog' for details."); } print "\n"; # Print a list of check_testcases that failed(if any) if ( $::opt_check_testcases ) { my %check_testcases; foreach my $tinfo (@$tests) { if ( defined $tinfo->{'check_testcase_failed'} ) { $check_testcases{$tinfo->{'name'}}= 1; } } if ( keys %check_testcases ) { print "Check of testcase failed for: "; print join(" ", keys %check_testcases); print "\n\n"; } } # Print a list of testcases that failed if ( $tot_failed != 0 ) { # Print each failed test, again #foreach my $test ( @$tests ){ # if ( $test->{failures} ) { # mtr_report_test($test); # } #} my $ratio= $tot_passed * 100 / $tot_tests; print "Failed $tot_failed/$tot_tests tests, "; printf("%.2f", $ratio); print "\% were successful.\n\n"; # Print the list of test that failed in a format # that can be copy pasted to rerun only failing tests print "Failing test(s):"; my %seen= (); foreach my $tinfo (@$tests) { my $tname= $tinfo->{'name'}; if ( $tinfo->{failures} and ! $seen{$tname}) { print " $tname"; $seen{$tname}= 1; } } print "\n\n"; # Print info about reporting the error print "The log files in var/log may give you some hint of what went wrong.\n\n", "If you want to report this error, please read first ", "the documentation\n", "at http://dev.mysql.com/doc/mysql/en/mysql-test-suite.html\n\n"; } else { print "All $tot_tests tests were successful.\n\n"; } if ( $tot_failed != 0 || $found_problems) { mtr_error("there were failing test cases"); } } ############################################################################## # # Text formatting # ############################################################################## sub mtr_print_line () { print '-' x 60, "\n"; } sub mtr_print_thick_line { my $char= shift || '='; print $char x 78, "\n"; } sub mtr_print_header () { print "\n"; printf "TEST"; print " " x 38; print "RESULT "; print "TIME (ms)" if $timer; print "\n"; mtr_print_line(); print "\n"; } ############################################################################## # # Log and reporting functions # ############################################################################## use Time::localtime; use Time::HiRes qw(gettimeofday); sub format_time { my $tm= localtime(); return sprintf("%4d-%02d-%02d %02d:%02d:%02d", $tm->year + 1900, $tm->mon+1, $tm->mday, $tm->hour, $tm->min, $tm->sec); } my $t0= gettimeofday(); sub _timestamp { return "" unless $timestamp; my $diff; if ($timediff){ my $t1= gettimeofday(); my $elapsed= $t1 - $t0; $diff= sprintf(" +%02.3f", $elapsed); # Save current time for next lap $t0= $t1; } my $tm= localtime(); return sprintf("%02d%02d%02d %2d:%02d:%02d%s ", $tm->year % 100, $tm->mon+1, $tm->mday, $tm->hour, $tm->min, $tm->sec, $diff); } # Always print message to screen sub mtr_print (@) { print _name(), join(" ", @_), "\n"; } # Print message to screen if verbose is defined sub mtr_report (@) { if (defined $verbose) { print _name(), join(" ", @_), "\n"; } } # Print warning to screen sub mtr_warning (@) { print STDERR _name(), _timestamp(), "mysql-test-run: WARNING: ", join(" ", @_), "\n"; } # Print error to screen and then exit sub mtr_error (@) { print STDERR _name(), _timestamp(), "mysql-test-run: *** ERROR: ", join(" ", @_), "\n"; exit(1); } sub mtr_debug (@) { if ( $verbose > 2 ) { print STDERR _name(), _timestamp(), "####: ", join(" ", @_), "\n"; } } sub mtr_verbose (@) { if ( $verbose ) { print STDERR _name(), _timestamp(), "> ",join(" ", @_),"\n"; } } sub mtr_verbose_restart (@) { my ($server, @args)= @_; my $proc= $server->{proc}; if ( $verbose_restart ) { print STDERR _name(),_timestamp(), "> Restart $proc - ",join(" ", @args),"\n"; } } 1;