X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=61f1b0ab8fdfae0afca88bb03902949e0df3bbdd;hb=6c1ca835721aba75e4d3cf029ecf85837151e4fc;hp=b30a39fcc1922d5ab294009e93765dbddd2f926b;hpb=9087ae1aa5ec3738b8f7f473a04019e466b01dfc;p=privoxy.git diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index b30a39fc..61f1b0ab 100755 --- a/tools/privoxy-regression-test.pl +++ b/tools/privoxy-regression-test.pl @@ -7,20 +7,15 @@ # A regression test "framework" for Privoxy. For documentation see: # perldoc privoxy-regression-test.pl # -# $Id: privoxy-regression-test.pl,v 1.143 2008/04/04 17:17:32 fk Exp $ +# $Id: privoxy-regression-test.pl,v 1.159 2008/08/22 16:53:06 fk Exp $ # # Wish list: # # - Update documentation # - Validate HTTP times. -# - Understand default.action.master comment syntax -# and verify that we actually block and unblock what -# the comments claim we do. # - Implement a HTTP_VERSION directive or allow to # specify whole request lines. # - Support filter regression tests. -# - Add option to fork regression tests and run them in parallel, -# possibly optional forever. # - Document magic Expect Header values # - Internal fuzz support? # @@ -45,19 +40,20 @@ use strict; use Getopt::Long; use constant { - PRT_VERSION => 'Privoxy-Regression-Test 0.2', + PRT_VERSION => 'Privoxy-Regression-Test 0.3', - CURL => 'curl', + CURL => 'curl', # CLI option defaults - CLI_RETRIES => 1, - CLI_LOOPS => 1, - CLI_MAX_TIME => 5, - CLI_MIN_LEVEL => 0, - CLI_MAX_LEVEL => 25, + CLI_RETRIES => 1, + CLI_LOOPS => 1, + CLI_MAX_TIME => 5, + CLI_MIN_LEVEL => 0, + CLI_MAX_LEVEL => 25, + CLI_FORKS => 0, PRIVOXY_CGI_URL => 'http://p.p/', - FELLATIO_URL => 'http://10.0.0.1:8080/', + FELLATIO_URL => 'http://127.0.0.1:8080/', LEADING_LOG_DATE => 1, LEADING_LOG_TIME => 1, @@ -314,7 +310,8 @@ sub load_action_files ($) { my $ignored = 0; - l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy."); + l(LL_STATUS, "Gathering regression tests from " . + @actionfiles . " action file(s) delivered by Privoxy."); for my $file_number (0 .. @actionfiles - 1) { @@ -703,7 +700,7 @@ sub get_final_results ($) { my %final_results = (); my $final_results_reached = 0; - die "Unacceptable characterss in $url" if $url =~ m@[\\'"]@; + die "Unacceptable characters in $url" if $url =~ m@[\\'"]@; # XXX: should be URL-encoded properly $url =~ s@%@%25@g; $url =~ s@\s@%20@g; @@ -711,7 +708,7 @@ sub get_final_results ($) { $url =~ s@:@%3A@g; $url =~ s@/@%2F@g; - $curl_parameters .= "'" . PRIVOXY_CGI_URL . 'show-url-info?url=' . $url . "'"; + $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url); foreach (@{get_cgi_page_or_else($curl_parameters)}) { @@ -726,10 +723,10 @@ sub get_final_results ($) { if (defined $parameter) { # In case the caller needs to check - # the action and it's parameter + # the action and its parameter $final_results{$action . $parameter} = 1; } - # In case the action doesn't have paramters + # In case the action doesn't have parameters # or the caller doesn't care for the parameter. $final_results{$action} = 1; } @@ -744,7 +741,13 @@ sub check_status_code_result ($$) { my $expected_status_code = shift; my $result = 0; - if ($expected_status_code == $status_code) { + unless (defined $status_code) { + + # XXX: should probably be caught earlier. + l(LL_VERBOSE_FAILURE, + "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all."); + + } elsif ($expected_status_code == $status_code) { $result = 1; l(LL_VERBOSE_SUCCESS, @@ -791,7 +794,6 @@ sub execute_server_header_regression_test ($) { return check_header_result($test_ref, $header); } - sub interpret_result ($) { my $success = shift; return $success ? "Success" : "Failure"; @@ -806,8 +808,6 @@ sub check_header_result ($$) { my $expect_header = $test{'expect-header'}; my $success = 0; - $header =~ s@ @ @g if defined($header); - if ($expect_header eq 'NO CHANGE') { if (defined($header) and $header eq $test{'data'}) { @@ -922,6 +922,9 @@ sub get_header ($$) { s@^\s*<.*?>@@g; s@\s*$@@g; + # Decode characters we care about. + s@"@"@g; + $filtered_request .= "\n" . $_; if (/^$header_to_get/) { @@ -1021,6 +1024,20 @@ sub test_content_as_string ($) { return $s; } +sub fuzz_header($) { + my $header = shift; + my $white_space = int(rand(2)) - 1 ? " " : "\t"; + + $white_space = $white_space x (1 + int(rand(5))); + + # Only fuzz white space before the first quoted token. + # (Privoxy doesn't touch white space inside quoted tokens + # and modifying it would cause the tests to fail). + $header =~ s@(^[^"]*?)\s@$1$white_space@g; + + return $header; +} + ############################################################################ # # HTTP fetch functions @@ -1059,6 +1076,7 @@ sub get_cgi_page_or_else ($) { return $content_ref; } +# XXX: misleading name sub get_show_request_with_curl ($) { our $privoxy_cgi_url; @@ -1066,11 +1084,16 @@ sub get_show_request_with_curl ($) { my %test = %{$test_ref}; my $curl_parameters = ' '; + my $header = $test{'data'}; + + if (cli_option_is_set('header-fuzzing')) { + $header = fuzz_header($header); + } # Enable the action to test $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' '; # The header to filter - $curl_parameters .= '-H \'' . $test{'data'} . '\' '; + $curl_parameters .= '-H \'' . $header . '\' '; $curl_parameters .= ' '; $curl_parameters .= $privoxy_cgi_url; @@ -1079,7 +1102,6 @@ sub get_show_request_with_curl ($) { return get_cgi_page_or_else($curl_parameters); } - sub get_head_with_curl ($) { our $fellatio_url = FELLATIO_URL; @@ -1100,18 +1122,17 @@ sub get_head_with_curl ($) { return get_page_with_curl($curl_parameters); } - sub get_page_with_curl ($) { + our $proxy; + my $parameters = shift; my @buffer; my $curl_line = CURL; my $retries_left = get_cli_option('retries') + 1; my $failure_reason; - if (cli_option_is_set('privoxy-address')) { - $curl_line .= ' --proxy ' . get_cli_option('privoxy-address'); - } + $curl_line .= ' --proxy ' . $proxy if (defined $proxy); # We want to see the HTTP status code $curl_line .= " --include "; @@ -1170,7 +1191,6 @@ sub array_as_string ($) { return $string; } - sub show_test ($) { my $test_ref = shift; log_message('Test is:' . test_content_as_string($test_ref)); @@ -1307,7 +1327,7 @@ sub log_result ($$) { } } - log_message($message) unless ($result && cli_option_is_set('silent')); + log_message($message) if (!$result or cli_option_is_set('verbose')); } sub quote ($) { @@ -1329,8 +1349,11 @@ sub help () { Options and their default values if they have any: [--debug $cli_options{'debug'}] + [--forks $cli_options{'forks'}] + [--fuzzer-address] [--fuzzer-feeding] [--help] + [--header-fuzzing] [--level] [--loops $cli_options{'loops'}] [--max-level $cli_options{'max-level'}] @@ -1338,7 +1361,8 @@ Options and their default values if they have any: [--min-level $cli_options{'min-level'}] [--privoxy-address] [--retries $cli_options{'retries'}] - [--silent] + [--test-number] + [--verbose] [--version] see "perldoc $0" for more information EOF @@ -1357,6 +1381,7 @@ sub init_cli_options () { $cli_options{'loops'} = CLI_LOOPS; $cli_options{'max-time'} = CLI_MAX_TIME; $cli_options{'retries'} = CLI_RETRIES; + $cli_options{'forks'} = CLI_FORKS; } sub parse_cli_options () { @@ -1368,17 +1393,20 @@ sub parse_cli_options () { GetOptions ( 'debug=s' => \$cli_options{'debug'}, + 'forks=s' => \$cli_options{'forks'}, 'help' => sub { help }, - 'silent' => \$cli_options{'silent'}, + 'header-fuzzing' => \$cli_options{'header-fuzzing'}, 'min-level=s' => \$cli_options{'min-level'}, 'max-level=s' => \$cli_options{'max-level'}, 'privoxy-address=s' => \$cli_options{'privoxy-address'}, + 'fuzzer-address=s' => \$cli_options{'fuzzer-address'}, 'level=s' => \$cli_options{'level'}, 'loops=s' => \$cli_options{'loops'}, 'test-number=s' => \$cli_options{'test-number'}, 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'}, 'retries=s' => \$cli_options{'retries'}, 'max-time=s' => \$cli_options{'max-time'}, + 'verbose' => \$cli_options{'verbose'}, 'version' => sub { print_version && exit(0) } ); $log_level |= $cli_options{'debug'}; @@ -1402,12 +1430,47 @@ sub get_cli_option ($) { return $cli_options{$cli_option}; } +sub init_proxy_settings($) { + + my $choice = shift; + our $proxy = undef; + + if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) { + $proxy = get_cli_option('fuzzer-address'); + } + + if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) { + + if (cli_option_is_set('privoxy-address')) { + $proxy .= get_cli_option('privoxy-address'); + } + + } +} + +sub start_forks($) { + my $forks = shift; + + l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0); + + foreach my $fork (1 .. $forks) { + log_message("Starting fork $fork"); + my $pid = fork(); + if (defined $pid && !$pid) { + return; + } + } +} + sub main () { init_our_variables(); parse_cli_options(); check_for_curl(); + init_proxy_settings('vanilla-proxy'); load_regressions_tests(); + init_proxy_settings('fuzz-proxy'); + start_forks(get_cli_option('forks')) if cli_option_is_set('forks'); execute_regression_tests(); } @@ -1419,10 +1482,12 @@ B - A regression test "framework" for Privoxy. =head1 SYNOPSIS -B [B<--debug bitmask>] [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<--retries retries>] [B<--silent>] [B<--version>] +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<--retries retries>] [B<--test-number test-number>] [B<--verbose>] +[B<--version>] =head1 DESCRIPTION @@ -1521,6 +1586,13 @@ requests to level 3 and client-header-action tests to level 1. B<--debug bitmask> Add the bitmask provided as integer to the debug settings. +B<--forks forks> Number of forks to start before executing +the regression tests. This is mainly useful for stress-testing. + +B<--fuzzer-address> Listening address used when executing +the regression tests. Useful to make sure that the requests +to load the regression tests don't fail due to fuzzing. + B<--fuzzer-feeding> Ignore some errors that would otherwise cause Privoxy-Regression-Test to abort the test because they shouldn't happen in normal operation. This option is @@ -1531,6 +1603,9 @@ message. B<--help> Shows available command line options. +B<--header-fuzzing> Modifies linear white space in +headers in a way that should not affect the test result. + B<--level level> Only execute tests with the specified B. B<--loop count> Loop through the regression tests B times. @@ -1557,7 +1632,10 @@ syntax. B<--retries retries> Retry B times. -B<--silent> Don't log succesful test runs. +B<--test-number test-number> Only run the test with the specified +number. + +B<--verbose> Also log succesful test runs. B<--version> Print version and exit.