X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=a083ff0c8a3460fb98de29e2805eb42e9df37d7d;hp=edb7307f83447cb28d03fe6bbe151dfe03edb194;hb=d63f1037628b50ce7c2c91e511beab46c502eb66;hpb=9f36a5cd42b565b1236068011d67c105004426c2 diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index edb7307f..a083ff0c 100755 --- a/tools/privoxy-regression-test.pl +++ b/tools/privoxy-regression-test.pl @@ -7,7 +7,7 @@ # A regression test "framework" for Privoxy. For documentation see: # perldoc privoxy-regression-test.pl # -# $Id: privoxy-regression-test.pl,v 1.71 2011/06/23 14:02:53 fabiankeil Exp $ +# $Id: privoxy-regression-test.pl,v 1.92 2013/03/20 11:30:45 fabiankeil Exp $ # # Wish list: # @@ -19,7 +19,7 @@ # - Document magic Expect Header values # - Internal fuzz support? # -# Copyright (c) 2007-2011 Fabian Keil +# Copyright (c) 2007-2013 Fabian Keil # # Permission to use, copy, modify, and distribute this software for any # purpose with or without fee is hereby granted, provided that the above @@ -40,7 +40,7 @@ use strict; use Getopt::Long; use constant { - PRT_VERSION => 'Privoxy-Regression-Test 0.4', + PRT_VERSION => 'Privoxy-Regression-Test 0.6', CURL => 'curl', @@ -52,6 +52,7 @@ use constant { # XXX: why limit at all? CLI_MAX_LEVEL => 100, CLI_FORKS => 0, + CLI_SLEEP_TIME => 0, PRIVOXY_CGI_URL => 'http://p.p/', FELLATIO_URL => 'http://127.0.0.1:8080/', @@ -65,8 +66,6 @@ use constant { DEBUG_LEVEL_VERBOSE_SUCCESS => 0, DEBUG_LEVEL_STATUS => 1, - VERBOSE_TEST_DESCRIPTION => 1, - # Internal use, don't modify # Available debug bits: LL_SOFT_ERROR => 1, @@ -91,7 +90,6 @@ sub init_our_variables () { our $leading_log_time = LEADING_LOG_TIME; our $leading_log_date = LEADING_LOG_DATE; our $privoxy_cgi_url = PRIVOXY_CGI_URL; - our $verbose_test_description = VERBOSE_TEST_DESCRIPTION; our $log_level = get_default_log_level(); } @@ -146,7 +144,162 @@ sub check_for_forbidden_characters ($) { } } -sub load_regressions_tests () { +sub load_regression_tests() { + if (cli_option_is_set('local-test-file')) { + load_regression_tests_from_file(get_cli_option('local-test-file')); + } else { + load_regression_tests_through_privoxy(); + } +} + +# XXX: Contains a lot of code duplicated from load_action_files() +# that should be factored out. +sub load_regression_tests_from_file ($) { + my $action_file = shift; + + # initialized here + our %actions; + our @regression_tests; + + my $si = 0; # Section index + my $ri = -1; # Regression test index + my $count = 0; + + my $ignored = 0; + + my $sticky_actions = undef; + + l(LL_STATUS, "Gathering regression tests from local file " . $action_file); + + open(my $ACTION_FILE, "<", $action_file) + or log_and_die("Failed to open $action_file: $!"); + + while (<$ACTION_FILE>) { + + my $no_checks = 0; + chomp; + my ($token, $value) = tokenize($_); + + next unless defined $token; + + # Load regression tests + + if (token_starts_new_test($token)) { + + # Beginning of new regression test. + $ri++; + $count++; + enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count); + $no_checks = 1; # Already validated by enlist_new_test(). + } + + if ($token =~ /level\s+(\d+)/i) { + + my $level = $1; + register_dependency($level, $value); + } + + if ($token eq 'sticky actions') { + + # Will be used by each following Sticky URL. + $sticky_actions = $value; + if ($sticky_actions =~ /{[^}]*\s/) { + log_and_die("'Sticky Actions' with whitespace inside the " . + "action parameters are currently unsupported."); + } + } + + if ($si == -1 || $ri == -1) { + # No beginning of a test detected yet, + # so we don't care about any other test + # attributes. + next; + } + + if ($token eq 'expect header') { + + l(LL_FILE_LOADING, "Detected expectation: " . $value); + $regression_tests[$si][$ri]{'expect-header'} = $value; + + } elsif ($token eq 'tag') { + + next if ($ri == -1); + + my $tag = parse_tag($value); + + # We already checked in parse_tag() after filtering + $no_checks = 1; + + l(LL_FILE_LOADING, "Detected TAG: " . $tag); + + # Save tag for all tests in this section + do { + $regression_tests[$si][$ri]{'tag'} = $tag; + } while ($ri-- > 0); + + $si++; + $ri = -1; + + } elsif ($token eq 'ignore' && $value =~ /Yes/i) { + + l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri])); + $regression_tests[$si][$ri]{'ignore'} = 1; + $ignored++; + + } elsif ($token eq 'expect status code') { + + l(LL_FILE_LOADING, "Expecting status code: " . $value); + $regression_tests[$si][$ri]{'expected-status-code'} = $value; + + } elsif ($token eq 'level') { # XXX: stupid name + + $value =~ s@(\d+).*@$1@; + l(LL_FILE_LOADING, "Level: " . $value); + $regression_tests[$si][$ri]{'level'} = $value; + + } elsif ($token eq 'method') { + + l(LL_FILE_LOADING, "Method: " . $value); + $regression_tests[$si][$ri]{'method'} = $value; + + } elsif ($token eq 'redirect destination') { + + l(LL_FILE_LOADING, "Redirect destination: " . $value); + $regression_tests[$si][$ri]{'redirect destination'} = $value; + + } elsif ($token eq 'url') { + + if (defined $sticky_actions) { + die "WTF? Attempted to overwrite Sticky Actions" + if defined ($regression_tests[$si][$ri]{'sticky-actions'}); + + l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions); + $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions; + } else { + log_and_die("Sticky URL without Sticky Actions: $value"); + } + + } else { + + # We don't use it, so we don't need + $no_checks = 1; + l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks; + } + + # XXX: Necessary? + unless ($no_checks) { + check_for_forbidden_characters($value); + check_for_forbidden_characters($token); + } + } + + l(LL_FILE_LOADING, "Done loading " . $count . " regression tests." + . " Of which " . $ignored. " will be ignored)\n"); + +} + + +sub load_regression_tests_through_privoxy () { our $privoxy_cgi_url; our @privoxy_config; @@ -155,6 +308,7 @@ sub load_regressions_tests () { my $curl_url = ''; my $file_number = 0; my $feature; + my $privoxy_version = '(Unknown version!)'; $curl_url .= $privoxy_cgi_url; $curl_url .= 'show-status'; @@ -186,10 +340,14 @@ sub load_regressions_tests () { $privoxy_features{$feature} = $1 if defined $feature; $feature = undef; + + } elsif (m@This is Privoxy (\d+\.\d+\.\d+) on@) { + $privoxy_version = $1; } } - l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files"); + l(LL_STATUS, "Gathering regression tests from " . + @actionfiles . " action file(s) delivered by Privoxy $privoxy_version."); load_action_files(\@actionfiles); } @@ -318,6 +476,35 @@ sub enlist_new_test ($$$$$$) { "Regression test " . $number . " (section:" . $si . "):"); } +sub mark_matching_tests_for_skipping($) { + my $overwrite_condition = shift; + + our @regression_tests; + + for (my $s = 0; $s < @regression_tests; $s++) { + + my $r = 0; + + while (defined $regression_tests[$s][$r]) { + + if ($regression_tests[$s][$r]{'data'} eq $overwrite_condition) { + my $message = sprintf("Marking test %s for ignoring. Overwrite condition: %s.", + $regression_tests[$s][$r]{'number'}, $overwrite_condition); + + l(LL_FILE_LOADING, $message); + + # XXX: Should eventually get its own key so get_skip_reason() + # can tell about the overwrite condition. + $regression_tests[$s][$r]{'ignore'} = 1; + } + $r++; + } + } +} + + +# XXX: Shares a lot of code with load_regression_tests_from_file() +# that should be factored out. sub load_action_files ($) { # initialized here @@ -333,9 +520,6 @@ sub load_action_files ($) { my $ignored = 0; - l(LL_STATUS, "Gathering regression tests from " . - @actionfiles . " action file(s) delivered by Privoxy."); - for my $file_number (0 .. @actionfiles - 1) { my $curl_url = quote($actionfiles[$file_number]); @@ -385,7 +569,16 @@ sub load_action_files ($) { "action parameters are currently unsupported."); } } - + + if ($token eq 'overwrite condition') { + + l(LL_FILE_LOADING, "Detected overwrite condition: " . $value); + # We can only skip matching tests that have already + # be loaded but that is exactly what we want anyway. + mark_matching_tests_for_skipping($value); + next; + } + if ($si == -1 || $ri == -1) { # No beginning of a test detected yet, # so we don't care about any other test @@ -481,6 +674,16 @@ sub load_action_files ($) { # ############################################################################ +# Fisher Yates shuffle from Perl's "How do I shuffle an array randomly?" FAQ +sub fisher_yates_shuffle ($) { + my $deck = shift; + my $i = @$deck; + while ($i--) { + my $j = int rand($i+1); + @$deck[$i,$j] = @$deck[$j,$i]; + } +} + sub execute_regression_tests () { our @regression_tests; @@ -504,14 +707,30 @@ sub execute_regression_tests () { my $failures; my $skipped = 0; - for (my $s = 0; $s < @regression_tests; $s++) { + if (cli_option_is_set('shuffle-tests')) { + + # Shuffle both the test sections and + # the tests they contain. + # + # XXX: With the current data layout, shuffling tests + # from different sections isn't possible. + # Is this worth changing the layout? + fisher_yates_shuffle(\@regression_tests); + for (my $s = 0; $s < @regression_tests; $s++) { + fisher_yates_shuffle($regression_tests[$s]); + } + } + + for (my $s = 0; $s < @regression_tests; $s++) { my $r = 0; while (defined $regression_tests[$s][$r]) { - die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'}); - die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'}); + unless (cli_option_is_set('shuffle-tests')) { + die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'}); + die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'}); + } die "Internal error. Test executor missing." unless defined $regression_tests[$s][$r]{executor}; @@ -532,6 +751,7 @@ sub execute_regression_tests () { $successes += $result; $tests++; + sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time')); } $r++; } @@ -741,13 +961,13 @@ sub execute_dumb_fetch_test ($) { my $expected_status_code = $test->{'expected-status-code'}; if (defined $test->{method}) { - $curl_parameters .= '--request ' . $test->{method} . ' '; + $curl_parameters .= '--request ' . quote($test->{method}) . ' '; } if ($test->{type} == TRUSTED_CGI_REQUEST) { - $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' '; + $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' '; } - $curl_parameters .= $test->{'data'}; + $curl_parameters .= quote($test->{'data'}); $buffer_ref = get_page_with_curl($curl_parameters); $status_code = get_status_code($buffer_ref); @@ -1208,8 +1428,9 @@ sub get_page_with_curl ($) { my $retries_left = get_cli_option('retries') + 1; my $failure_reason; - $curl_line .= ' --proxy ' . $proxy if (defined $proxy); - + if (defined $proxy) { + $curl_line .= ' --proxy ' . quote($proxy); + } # We want to see the HTTP status code $curl_line .= " --include "; # Let Privoxy emit two log messages less. @@ -1316,91 +1537,86 @@ sub log_message ($) { $message = $time_stamp . ": " . $message; } - printf(STDERR "%s\n", $message); + printf("%s\n", $message); } sub log_result ($$) { - our $verbose_test_description; our $filtered_request; my $test = shift; my $result = shift; my $number = shift; - my $message = ''; + my $message = sprintf("%s for test %d", + interpret_result($result), + $test->{'number'}); - $message .= interpret_result($result); - $message .= " for test "; - $message .= $number; - $message .= '/'; - $message .= $test->{'number'}; - $message .= '/'; - $message .= $test->{'section-id'}; - $message .= '/'; - $message .= $test->{'regression-test-id'}; - $message .= '.'; + if (cli_option_is_set('verbose')) { + $message .= sprintf(" (%d/%d/%d)", $number, + $test->{'section-id'}, + $test->{'regression-test-id'}); + } - if ($verbose_test_description) { + $message .= '. '; - if ($test->{'type'} == CLIENT_HEADER_TEST) { + if ($test->{'type'} == CLIENT_HEADER_TEST) { - $message .= ' Header '; - $message .= quote($test->{'data'}); - $message .= ' and tag '; - $message .= quote($test->{'tag'}); + $message .= 'Header '; + $message .= quote($test->{'data'}); + $message .= ' and tag '; + $message .= quote($test->{'tag'}); - } elsif ($test->{'type'} == SERVER_HEADER_TEST) { + } elsif ($test->{'type'} == SERVER_HEADER_TEST) { - $message .= ' Request Header '; - $message .= quote($test->{'data'}); - $message .= ' and tag '; - $message .= quote($test->{'tag'}); + $message .= 'Request Header '; + $message .= quote($test->{'data'}); + $message .= ' and tag '; + $message .= quote($test->{'tag'}); - } elsif ($test->{'type'} == DUMB_FETCH_TEST) { + } elsif ($test->{'type'} == DUMB_FETCH_TEST) { - $message .= ' URL '; - $message .= quote($test->{'data'}); - $message .= ' and expected status code '; - $message .= quote($test->{'expected-status-code'}); + $message .= 'URL '; + $message .= quote($test->{'data'}); + $message .= ' and expected status code '; + $message .= quote($test->{'expected-status-code'}); - } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) { + } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) { - $message .= ' CGI URL '; - $message .= quote($test->{'data'}); - $message .= ' and expected status code '; - $message .= quote($test->{'expected-status-code'}); + $message .= 'CGI URL '; + $message .= quote($test->{'data'}); + $message .= ' and expected status code '; + $message .= quote($test->{'expected-status-code'}); - } elsif ($test->{'type'} == METHOD_TEST) { + } elsif ($test->{'type'} == METHOD_TEST) { - $message .= ' HTTP method '; - $message .= quote($test->{'data'}); - $message .= ' and expected status code '; - $message .= quote($test->{'expected-status-code'}); + $message .= 'HTTP method '; + $message .= quote($test->{'data'}); + $message .= ' and expected status code '; + $message .= quote($test->{'expected-status-code'}); - } elsif ($test->{'type'} == BLOCK_TEST) { + } elsif ($test->{'type'} == BLOCK_TEST) { - $message .= ' Supposedly-blocked URL: '; - $message .= quote($test->{'data'}); + $message .= 'Supposedly-blocked URL: '; + $message .= quote($test->{'data'}); - } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) { + } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) { - $message .= ' Sticky Actions: '; - $message .= quote($test->{'sticky-actions'}); - $message .= ' and URL: '; - $message .= quote($test->{'data'}); + $message .= 'Sticky Actions: '; + $message .= quote($test->{'sticky-actions'}); + $message .= ' and URL: '; + $message .= quote($test->{'data'}); - } elsif ($test->{'type'} == REDIRECT_TEST) { + } elsif ($test->{'type'} == REDIRECT_TEST) { - $message .= ' Redirected URL: '; - $message .= quote($test->{'data'}); - $message .= ' and redirect destination: '; - $message .= quote($test->{'redirect destination'}); + $message .= 'Redirected URL: '; + $message .= quote($test->{'data'}); + $message .= ' and redirect destination: '; + $message .= quote($test->{'redirect destination'}); - } else { + } else { - die "Incomplete support for test type " . $test->{'type'} . " detected."; - } + die "Incomplete support for test type " . $test->{'type'} . " detected."; } log_message($message) if (!$result or cli_option_is_set('verbose')); @@ -1412,7 +1628,7 @@ sub quote ($) { } sub print_version () { - printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil ' . "\n"; + printf PRT_VERSION . "\n"; } sub list_test_types () { @@ -1449,6 +1665,7 @@ Options and their default values if they have any: [--help] [--header-fuzzing] [--level] + [--local-test-file] [--loops $cli_options{'loops'}] [--max-level $cli_options{'max-level'}] [--max-time $cli_options{'max-time'}] @@ -1456,6 +1673,8 @@ Options and their default values if they have any: [--privoxy-address] [--retries $cli_options{'retries'}] [--show-skipped-tests] + [--shuffle-tests] + [--sleep-time $cli_options{'sleep-time'}] [--test-number] [--verbose] [--version] @@ -1484,6 +1703,7 @@ sub init_cli_options () { $cli_options{'max-level'} = CLI_MAX_LEVEL; $cli_options{'max-time'} = CLI_MAX_TIME; $cli_options{'min-level'} = CLI_MIN_LEVEL; + $cli_options{'sleep-time'}= CLI_SLEEP_TIME; $cli_options{'retries'} = CLI_RETRIES; } @@ -1495,21 +1715,24 @@ sub parse_cli_options () { init_cli_options(); GetOptions ( - 'debug=s' => \$cli_options{'debug'}, - 'forks=s' => \$cli_options{'forks'}, + 'debug=i' => \$cli_options{'debug'}, + 'forks=i' => \$cli_options{'forks'}, 'fuzzer-address=s' => \$cli_options{'fuzzer-address'}, 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'}, 'header-fuzzing' => \$cli_options{'header-fuzzing'}, 'help' => \&help, - 'level=s' => \$cli_options{'level'}, - 'loops=s' => \$cli_options{'loops'}, - 'max-level=s' => \$cli_options{'max-level'}, - 'max-time=s' => \$cli_options{'max-time'}, - 'min-level=s' => \$cli_options{'min-level'}, + 'level=i' => \$cli_options{'level'}, + 'local-test-file=s' => \$cli_options{'local-test-file'}, + 'loops=i' => \$cli_options{'loops'}, + 'max-level=i' => \$cli_options{'max-level'}, + 'max-time=i' => \$cli_options{'max-time'}, + 'min-level=i' => \$cli_options{'min-level'}, 'privoxy-address=s' => \$cli_options{'privoxy-address'}, - 'retries=s' => \$cli_options{'retries'}, + 'retries=i' => \$cli_options{'retries'}, + 'shuffle-tests' => \$cli_options{'shuffle-tests'}, 'show-skipped-tests' => \$cli_options{'show-skipped-tests'}, - 'test-number=s' => \$cli_options{'test-number'}, + 'sleep-time=i' => \$cli_options{'sleep-time'}, + 'test-number=i' => \$cli_options{'test-number'}, 'verbose' => \$cli_options{'verbose'}, 'version' => sub {print_version && exit(0)} ) or exit(1); @@ -1570,7 +1793,7 @@ sub main () { init_our_variables(); parse_cli_options(); init_proxy_settings('vanilla-proxy'); - load_regressions_tests(); + load_regression_tests(); init_proxy_settings('fuzz-proxy'); start_forks(get_cli_option('forks')) if cli_option_is_set('forks'); execute_regression_tests(); @@ -1586,10 +1809,10 @@ B - A regression test "framework" for Privoxy. B [B<--debug bitmask>] [B<--forks> forks] [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>] -[B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>] -[B<--min-level min-level>] B<--privoxy-address proxy-address> +[B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>] +[B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address> [B<--retries retries>] [B<--test-number test-number>] -[B<--show-skipped-tests>] [B<--verbose>] +[B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>] [B<--version>] =head1 DESCRIPTION @@ -1678,6 +1901,36 @@ To verify that requests for a URL get redirected, use: # Redirected URL = http://www.example.com/redirect-me # Redirect Destination = http://www.example.org/redirected +To skip a test, add the following line: + +# Ignore = Yes + +The difference between a skipped test and a removed one is that removing +a test affects the numbers of the following tests, while a skipped test +is still loaded and thus keeps the test numbers unchanged. + +Sometimes user modifications intentionally conflict with tests in the +default configuration and thus cause test failures. Adding the Ignore +directive to the failing tests works but is inconvenient as the directive +is likely to get lost with the next update. + +Overwrite conditions are an alternative and can be added in any action +file as long as the come after the test that is expected to fail. +They causes all previous tests a matching the condition to be skipped. + +It is recommended to put the overwrite condition below the custom Privoxy +section that causes the expected test failure and before the custom test +that verifies that tests the now expected behaviour. Example: + +# The following section is expected to overwrite a section in +# default.action, whose effect is tested. Thus also disable the +# test that is now expected to fail and add a new one. +# +{+block{Facebook makes Firefox even more unstable. Do not want.}} +# Overwrite condition = http://apps.facebook.com/onthefarm/track.php?creative=&cat=friendvisit&subcat=weeds&key=a789a971dc687bee4c20c044834fabdd&next=index.php%3Fref%3Dnotif%26visitId%3D898835505 +# Blocked URL = http://apps.facebook.com/ +.facebook./ + =head1 TEST LEVELS All tests have test levels to let the user @@ -1722,6 +1975,12 @@ headers in a way that should not affect the test result. B<--level level> Only execute tests with the specified B. +B<--local-test-file test-file> Do not get the tests +through Privoxy's web interface, but use a single local +file. Not recommended for testing Privoxy, but can be useful +to "misappropriate" Privoxy-Regression-Test to test other +stuff, like webserver configurations. + B<--loop count> Loop through the regression tests B times. Useful to feed a fuzzer, or when doing stress tests with several Privoxy-Regression-Test instances running at the same @@ -1751,6 +2010,14 @@ number. B<--show-skipped-tests> Log skipped tests even if verbose mode is off. +B<--shuffle-tests> Shuffle test sections and their tests before +executing them. When combined with B<--forks>, this can increase +the chances of detecting race conditions. Of course some problems +are easier to detect without this option. + +B<--sleep-time seconds> Wait B between tests. Useful when +debugging issues with systems that don't log with millisecond precision. + B<--verbose> Log successful tests as well. By default only the failures are logged.