X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=ec071722dc01332ac587f80d78a9119ee2ff56c7;hp=fd23e87c877d85f877fd5cc5633678b71658ab45;hb=6dcb54594ccfd856725d88b60ed28adf4e417902;hpb=b9145207c3bea989e46460240870234631956a64 diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index fd23e87c..ec071722 100755 --- a/tools/privoxy-regression-test.pl +++ b/tools/privoxy-regression-test.pl @@ -7,24 +7,19 @@ # A regression test "framework" for Privoxy. For documentation see: # perldoc privoxy-regression-test.pl # -# $Id: privoxy-regression-test.pl,v 1.14 2008/03/27 19:13:08 fabiankeil Exp $ +# $Id: privoxy-regression-test.pl,v 1.89 2013/02/05 14:02:43 fabiankeil 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? # -# Copyright (c) 2007-2008 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 @@ -45,62 +40,57 @@ use strict; use Getopt::Long; use constant { - PRT_VERSION => 'Privoxy-Regression-Test 0.2', + PRT_VERSION => 'Privoxy-Regression-Test 0.6', - CURL => 'curl', - - # CLI option defaults - CLI_RETRIES => 1, - CLI_LOOPS => 1, - CLI_MAX_TIME => 5, - CLI_MIN_LEVEL => 0, - CLI_MAX_LEVEL => 25, - - PRIVOXY_CGI_URL => 'http://p.p/', - FELLATIO_URL => 'http://10.0.0.1:8080/', - LEADING_LOG_DATE => 1, - LEADING_LOG_TIME => 1, - - DEBUG_LEVEL_FILE_LOADING => 0, - DEBUG_LEVEL_PAGE_FETCHING => 0, - - VERBOSE_TEST_DESCRIPTION => 1, - - DEBUG_LEVEL_VERBOSE_FAILURE => 1, - # XXX: Only partly implemented and mostly useless. - DEBUG_LEVEL_VERBOSE_SUCCESS => 0, - DEBUG_LEVEL_STATUS => 1, - - # Internal use, don't modify - # Available debug bits: - LL_ERROR => 1, - LL_VERBOSE_FAILURE => 2, - LL_PAGE_FETCHING => 4, - LL_FILE_LOADING => 8, - LL_VERBOSE_SUCCESS => 16, - LL_STATUS => 32, - LL_SOFT_ERROR => 64, - - CLIENT_HEADER_TEST => 1, - SERVER_HEADER_TEST => 2, - DUMB_FETCH_TEST => 3, - METHOD_TEST => 4, - STICKY_ACTIONS_TEST => 5, - TRUSTED_CGI_REQUEST => 6, - BLOCK_TEST => 7, + CURL => 'curl', + + # CLI option defaults + CLI_RETRIES => 1, + CLI_LOOPS => 1, + CLI_MAX_TIME => 5, + CLI_MIN_LEVEL => 0, + # 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/', + LEADING_LOG_DATE => 1, + LEADING_LOG_TIME => 1, + + DEBUG_LEVEL_FILE_LOADING => 0, + DEBUG_LEVEL_PAGE_FETCHING => 0, + DEBUG_LEVEL_VERBOSE_FAILURE => 1, + # XXX: Only partly implemented and mostly useless. + DEBUG_LEVEL_VERBOSE_SUCCESS => 0, + DEBUG_LEVEL_STATUS => 1, + + # Internal use, don't modify + # Available debug bits: + LL_SOFT_ERROR => 1, + LL_VERBOSE_FAILURE => 2, + LL_PAGE_FETCHING => 4, + LL_FILE_LOADING => 8, + LL_VERBOSE_SUCCESS => 16, + LL_STATUS => 32, + + CLIENT_HEADER_TEST => 1, + SERVER_HEADER_TEST => 2, + DUMB_FETCH_TEST => 3, + METHOD_TEST => 4, + STICKY_ACTIONS_TEST => 5, + TRUSTED_CGI_REQUEST => 6, + BLOCK_TEST => 7, + REDIRECT_TEST =>108, }; 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(); - } sub get_default_log_level () { @@ -113,9 +103,8 @@ sub get_default_log_level () { $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS; $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS; - # These are intended to be always on. + # This one is supposed to be always on. $log_level |= LL_SOFT_ERROR; - $log_level |= LL_ERROR; return $log_level; } @@ -144,30 +133,192 @@ sub parse_tag ($) { sub check_for_forbidden_characters ($) { - my $tag = shift; # XXX: also used to check values though. - my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]'; + my $string = shift; + my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]'; - unless ($tag =~ m/^$allowed*$/) { - my $forbidden = $tag; + unless ($string =~ m/^$allowed*$/o) { + my $forbidden = $string; $forbidden =~ s@^$allowed*(.).*@$1@; - l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable."); + log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable."); } } -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; + our %privoxy_features; my @actionfiles; my $curl_url = ''; my $file_number = 0; + my $feature; + my $privoxy_version = '(Unknown version!)'; $curl_url .= $privoxy_cgi_url; $curl_url .= 'show-status'; l(LL_STATUS, "Asking Privoxy for the number of action files available ..."); + # Dear Privoxy, please reload the config file if necessary ... + get_cgi_page_or_else($curl_url); + + # ... so we get the latest one here. foreach (@{get_cgi_page_or_else($curl_url)}) { chomp; @@ -180,10 +331,23 @@ sub load_regressions_tests () { my $directive = $1 . " " . $2; push (@privoxy_config, $directive); + + } elsif (m@([^<]*)@) { + + $feature = $1; + + } elsif (m@ (Yes|No) @) { + + $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); } @@ -193,13 +357,13 @@ sub token_starts_new_test ($) { my $token = shift; my @new_test_directives = ('set header', 'fetch test', 'trusted cgi request', 'request header', 'method test', - 'blocked url', 'url'); + 'blocked url', 'url', 'redirected url'); foreach my $new_test_directive (@new_test_directives) { return 1 if $new_test_directive eq $token; } - return 0; + return 0; } sub tokenize ($) { @@ -211,12 +375,12 @@ sub tokenize ($) { s@\s*$@@; # Reverse HTML-encoding - # XXX: Seriously imcomplete. + # XXX: Seriously incomplete. s@"@"@g; s@&@&@g; # Tokenize - if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) { + if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) { $token = $1; $value = $2; @@ -228,7 +392,6 @@ sub tokenize ($) { $token = 'tag'; $value = $1; - } return ($token, $value); @@ -238,54 +401,68 @@ sub enlist_new_test ($$$$$$) { my ($regression_tests, $token, $value, $si, $ri, $number) = @_; my $type; + my $executor; if ($token eq 'set header') { l(LL_FILE_LOADING, "Header to set: " . $value); $type = CLIENT_HEADER_TEST; + $executor = \&execute_client_header_regression_test; } elsif ($token eq 'request header') { l(LL_FILE_LOADING, "Header to request: " . $value); $type = SERVER_HEADER_TEST; + $executor = \&execute_server_header_regression_test; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; } elsif ($token eq 'trusted cgi request') { l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value); $type = TRUSTED_CGI_REQUEST; + $executor = \&execute_dumb_fetch_test; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; } elsif ($token eq 'fetch test') { l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value); $type = DUMB_FETCH_TEST; + $executor = \&execute_dumb_fetch_test; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; } elsif ($token eq 'method test') { l(LL_FILE_LOADING, "Method to test: " . $value); $type = METHOD_TEST; + $executor = \&execute_method_test; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; } elsif ($token eq 'blocked url') { l(LL_FILE_LOADING, "URL to block-test: " . $value); + $executor = \&execute_block_test; $type = BLOCK_TEST; } elsif ($token eq 'url') { l(LL_FILE_LOADING, "Sticky URL to test: " . $value); $type = STICKY_ACTIONS_TEST; + $executor = \&execute_sticky_actions_test; + + } elsif ($token eq 'redirected url') { + + l(LL_FILE_LOADING, "Redirected URL to test: " . $value); + $type = REDIRECT_TEST; + $executor = \&execute_redirect_test; } else { die "Incomplete '" . $token . "' support detected."; - } $$regression_tests[$si][$ri]{'type'} = $type; $$regression_tests[$si][$ri]{'level'} = $type; + $$regression_tests[$si][$ri]{'executor'} = $executor; check_for_forbidden_characters($value); @@ -299,6 +476,36 @@ 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); + + # XXX: Should eventually be downgraded to LL_FILE_LOADING. + log_message($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 @@ -314,11 +521,9 @@ sub load_action_files ($) { my $ignored = 0; - l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy."); - for my $file_number (0 .. @actionfiles - 1) { - my $curl_url = ' "' . $actionfiles[$file_number] . '"'; + my $curl_url = quote($actionfiles[$file_number]); my $actionfile = undef; my $sticky_actions = undef; @@ -326,7 +531,7 @@ sub load_action_files ($) { my $no_checks = 0; chomp; - + if (/

Contents of Actions File (.*?) 1) { @@ -519,19 +774,54 @@ sub execute_regression_tests () { } } +sub get_skip_reason ($) { + my $test = shift; + my $skip_reason = undef; + + if ($test->{'ignore'}) { + + $skip_reason = "Ignore flag is set"; + + } elsif (cli_option_is_set('test-number') and + get_cli_option('test-number') != $test->{'number'}) { + + $skip_reason = "Only executing test " . get_cli_option('test-number'); + + } else { + + $skip_reason = level_is_unacceptable($test->{'level'}); + } + + return $skip_reason; +} + sub level_is_unacceptable ($) { my $level = shift; - return ((cli_option_is_set('level') and get_cli_option('level') != $level) - or ($level < get_cli_option('min-level')) - or ($level > get_cli_option('max-level')) - or dependency_unsatisfied($level) - ); -} + my $min_level = get_cli_option('min-level'); + my $max_level = get_cli_option('max-level'); + my $required_level = cli_option_is_set('level') ? + get_cli_option('level') : $level; + my $reason = undef; + + if ($required_level != $level) { + + $reason = "Level doesn't match (" . $level . + " != " . $required_level . ")" + + } elsif ($level < $min_level) { + + $reason = "Level too low (" . $level . " < " . $min_level . ")"; + + } elsif ($level > $max_level) { + + $reason = "Level too high (" . $level . " > " . $max_level . ")"; + + } else { -sub test_number_is_unacceptable ($) { - my $test_number = shift; - return (cli_option_is_set('test-number') - and get_cli_option('test-number') != $test_number) + $reason = dependency_unsatisfied($level); + } + + return $reason; } sub dependency_unsatisfied ($) { @@ -539,16 +829,36 @@ sub dependency_unsatisfied ($) { my $level = shift; our %dependencies; our @privoxy_config; - my $dependency_problem = 0; + our %privoxy_features; + + my $dependency_problem = undef; if (defined ($dependencies{$level}{'config line'})) { my $dependency = $dependencies{$level}{'config line'}; - $dependency_problem = 1; + $dependency_problem = "depends on config line matching: '" . $dependency . "'"; foreach (@privoxy_config) { - $dependency_problem = 0 if (/$dependency/); + if (/$dependency/) { + $dependency_problem = undef; + last; + } + } + + } + + if (defined ($dependencies{$level}{'feature status'}) + and not defined $dependency_problem) { + + my $dependency = $dependencies{$level}{'feature status'}; + my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/; + + unless (defined($privoxy_features{$feature}) + and ($privoxy_features{$feature} eq $status)) + { + $dependency_problem = "depends on '" . $feature . + "' being set to '" . $status . "'"; } } @@ -563,61 +873,27 @@ sub register_dependency ($$) { if ($dependency =~ /config line\s+(.*)/) { - $dependencies{$level}{'config line'} = $1; - } -} - -# XXX: somewhat misleading name -sub execute_regression_test ($) { - - my $test_ref = shift; - my %test = %{$test_ref}; - my $result = 0; - - if ($test{'type'} == CLIENT_HEADER_TEST) { - - $result = execute_client_header_regression_test($test_ref); - - } elsif ($test{'type'} == SERVER_HEADER_TEST) { - - $result = execute_server_header_regression_test($test_ref); - - } elsif ($test{'type'} == DUMB_FETCH_TEST - or $test{'type'} == TRUSTED_CGI_REQUEST) { - - $result = execute_dumb_fetch_test($test_ref); + $dependencies{$level}{'config line'} = $1; - } elsif ($test{'type'} == METHOD_TEST) { + } elsif ($dependency =~ /feature status\s+(.*)/) { - $result = execute_method_test($test_ref); - - } elsif ($test{'type'} == BLOCK_TEST) { - - $result = execute_block_test($test_ref); - - } elsif ($test{'type'} == STICKY_ACTIONS_TEST) { - - $result = execute_sticky_actions_test($test_ref); + $dependencies{$level}{'feature status'} = $1; } else { - die "Unsupported test type detected: " . $test{'type'}; - + log_and_die("Didn't recognize dependency: $dependency."); } - - return $result; } sub execute_method_test ($) { - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; my $buffer_ref; my $status_code; - my $method = $test{'data'}; + my $method = $test->{'data'}; my $curl_parameters = ''; - my $expected_status_code = $test{'expected-status-code'}; + my $expected_status_code = $test->{'expected-status-code'}; $curl_parameters .= '--request ' . $method . ' '; # Don't complain about the 'missing' body @@ -631,24 +907,68 @@ sub execute_method_test ($) { return check_status_code_result($status_code, $expected_status_code); } +sub execute_redirect_test ($) { + + my $test = shift; + my $buffer_ref; + my $status_code; + + my $curl_parameters = ''; + my $url = $test->{'data'}; + my $redirect_destination; + my $expected_redirect_destination = $test->{'redirect destination'}; + + # XXX: Check if a redirect actually applies before doing the request. + # otherwise the test may hit a real server in failure cases. + + $curl_parameters .= '--head '; + + $curl_parameters .= quote($url); + + $buffer_ref = get_page_with_curl($curl_parameters); + $status_code = get_status_code($buffer_ref); + + if ($status_code ne "302") { + l(LL_VERBOSE_FAILURE, + "Ooops. Expected redirect to: '" . $expected_redirect_destination + . "' but got a response with status code: " . $status_code); + return 0; + } + foreach (@{$buffer_ref}) { + if (/^Location: (.*)\r\n/) { + $redirect_destination = $1; + last; + } + } + + my $success = ($redirect_destination eq $expected_redirect_destination); + + unless ($success) { + l(LL_VERBOSE_FAILURE, + "Ooops. Expected redirect to: '" . $expected_redirect_destination + . "' but the redirect leads to: '" . $redirect_destination. "'"); + } + + return $success; +} + sub execute_dumb_fetch_test ($) { - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; my $buffer_ref; my $status_code; my $curl_parameters = ''; - my $expected_status_code = $test{'expected-status-code'}; + my $expected_status_code = $test->{'expected-status-code'}; - if (defined $test{method}) { - $curl_parameters .= '--request ' . $test{method} . ' '; + if (defined $test->{method}) { + $curl_parameters .= '--request ' . quote($test->{method}) . ' '; } - if ($test{type} == TRUSTED_CGI_REQUEST) { - $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' '; + if ($test->{type} == TRUSTED_CGI_REQUEST) { + $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); @@ -675,15 +995,18 @@ sub execute_sticky_actions_test ($) { my $final_results = get_final_results($url); foreach my $sticky_action (@sticky_actions) { + if (defined $final_results->{$sticky_action}) { # Exact match $verified_actions++; - }elsif ($sticky_action =~ /-.*\{/ and - not defined $final_results->{$sticky_action}) { + + } elsif ($sticky_action =~ /-.*\{/) { + # Disabled multi actions aren't explicitly listed as # disabled and thus have to be checked by verifying # that they aren't enabled. $verified_actions++; + } else { l(LL_VERBOSE_FAILURE, "Ooops. '$sticky_action' is not among the final results."); @@ -700,7 +1023,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; @@ -708,7 +1031,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)}) { @@ -717,16 +1040,19 @@ sub get_final_results ($) { next unless ($final_results_reached); last if (m@@); - if (m@
([-+])([^>]*)(?: (\{.*\}))?@) { + # Privoxy versions before 3.0.16 add a space + # between action name and parameters, therefore + # the " ?". + if (m@
([-+])([^>]*)(?: ?(\{.*\}))?@) { my $action = $1.$2; my $parameter = $3; 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; } @@ -741,7 +1067,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, @@ -756,7 +1088,6 @@ sub check_status_code_result ($$) { l(LL_VERBOSE_FAILURE, "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.'); - } return $result; @@ -764,31 +1095,30 @@ sub check_status_code_result ($$) { sub execute_client_header_regression_test ($) { - my $test_ref = shift; + my $test = shift; my $buffer_ref; my $header; - $buffer_ref = get_show_request_with_curl($test_ref); + $buffer_ref = get_show_request_with_curl($test); - $header = get_header($buffer_ref, $test_ref); + $header = get_header($buffer_ref, $test); - return check_header_result($test_ref, $header); + return check_header_result($test, $header); } sub execute_server_header_regression_test ($) { - my $test_ref = shift; + my $test = shift; my $buffer_ref; my $header; - $buffer_ref = get_head_with_curl($test_ref); + $buffer_ref = get_head_with_curl($test); - $header = get_server_header($buffer_ref, $test_ref); + $header = get_server_header($buffer_ref, $test); - return check_header_result($test_ref, $header); + return check_header_result($test, $header); } - sub interpret_result ($) { my $success = shift; return $success ? "Success" : "Failure"; @@ -796,68 +1126,51 @@ sub interpret_result ($) { sub check_header_result ($$) { - my $test_ref = shift; + my $test = shift; my $header = shift; - my %test = %{$test_ref}; - my $expect_header = $test{'expect-header'}; + 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'}) { - - $success = 1; - - } else { + $success = (defined($header) and $header eq $test->{'data'}); + unless ($success) { $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, - "Ooops. Got: " . $header . " while expecting: " . $expect_header); + "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'"); } } elsif ($expect_header eq 'REMOVAL') { - if (defined($header) and $header eq $test{'data'}) { + # XXX: Use more reliable check here and make sure + # the header has a different name. + $success = not (defined($header) and $header eq $test->{'data'}); + unless ($success) { l(LL_VERBOSE_FAILURE, - "Ooops. Expected removal but: " . $header . " is still there."); - - } else { - - # XXX: Use more reliable check here and make sure - # the header has a different name. - $success = 1; - + "Ooops. Expected removal but: '" . $header . "' is still there."); } } elsif ($expect_header eq 'SOME CHANGE') { - if (defined($header) and not $header eq $test{'data'}) { - - $success = 1; - - } else { + $success = (defined($header) and $header ne $test->{'data'}); + unless ($success) { $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, - "Ooops. Got: " . $header . " while expecting: SOME CHANGE"); + "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE"); } - } else { - if (defined($header) and $header eq $expect_header) { - - $success = 1; + $success = (defined($header) and $header eq $expect_header); - } else { - - $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise + unless ($success) { + $header = "No matching header" unless defined $header; # XXX: No header detected to be precise l(LL_VERBOSE_FAILURE, - "Ooops. Got: " . $header . " while expecting: " . $expect_header); + "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'"); } } return $success; @@ -877,12 +1190,13 @@ sub get_header ($$) { our $filtered_request = ''; my $buffer_ref = shift; - my $test_ref = shift; + my $test = shift; - my %test = %{$test_ref}; my @buffer = @{$buffer_ref}; - my $expect_header = $test{'expect-header'}; + my $expect_header = $test->{'expect-header'}; + + die "get_header called with no expect header" unless defined $expect_header; my $line; my $processed_request_reached = 0; @@ -893,10 +1207,9 @@ sub get_header ($$) { if ($expect_header eq 'REMOVAL' or $expect_header eq 'NO CHANGE' - or $expect_header eq 'SOME CHANGE') { - - $expect_header = $test{'data'}; + or $expect_header eq 'SOME CHANGE') { + $expect_header = $test->{'data'}; } $header_to_get = get_header_name($expect_header); @@ -917,6 +1230,9 @@ sub get_header ($$) { s@^\s*<.*?>@@g; s@\s*$@@g; + # Decode characters we care about. + s@"@"@g; + $filtered_request .= "\n" . $_; if (/^$header_to_get/) { @@ -932,21 +1248,23 @@ sub get_header ($$) { sub get_server_header ($$) { my $buffer_ref = shift; - my $test_ref = shift; + my $test = shift; - my %test = %{$test_ref}; my @buffer = @{$buffer_ref}; - my $expect_header = $test{'expect-header'}; + my $expect_header = $test->{'expect-header'}; my $header; my $header_to_get; + # XXX: Should be caught before starting to test. + log_and_die("No expect header for test " . $test->{'number'}) + unless defined $expect_header; + if ($expect_header eq 'REMOVAL' or $expect_header eq 'NO CHANGE' or $expect_header eq 'SOME CHANGE') { - $expect_header = $test{'data'}; - + $expect_header = $test->{'data'}; } $header_to_get = get_header_name($expect_header); @@ -980,7 +1298,7 @@ sub get_status_code ($) { return '123' if cli_option_is_set('fuzzer-feeding'); chomp; - l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"'); + log_and_die('Unexpected buffer line: "' . $_ . '"'); } } } @@ -992,37 +1310,45 @@ sub get_test_keys () { # XXX: incomplete sub test_content_as_string ($) { - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; my $s = "\n\t"; foreach my $key (get_test_keys()) { - $test{$key} = 'Not set' unless (defined $test{$key}); + $test->{$key} = 'Not set' unless (defined $test->{$key}); } - $s .= 'Tag: ' . $test{'tag'}; + $s .= 'Tag: ' . $test->{'tag'}; $s .= "\n\t"; - $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types + $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types $s .= "\n\t"; - $s .= 'Expected header: ' . $test{'expect-header'}; + $s .= 'Expected header: ' . $test->{'expect-header'}; $s .= "\n\t"; - $s .= 'Ignore: ' . $test{'ignore'}; + $s .= 'Ignore: ' . $test->{'ignore'}; 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 # ############################################################################ -sub check_for_curl () { - my $curl = CURL; - l(LL_ERROR, "No curl found.") unless (`which $curl`); -} - sub get_cgi_page_or_else ($) { my $cgi_url = shift; @@ -1042,26 +1368,30 @@ sub get_cgi_page_or_else ($) { } else { - l(LL_ERROR, $log_message); - + log_and_die($log_message); } } return $content_ref; } +# XXX: misleading name sub get_show_request_with_curl ($) { our $privoxy_cgi_url; - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; 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'} . '\' '; + $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; @@ -1070,19 +1400,17 @@ sub get_show_request_with_curl ($) { return get_cgi_page_or_else($curl_parameters); } - sub get_head_with_curl ($) { our $fellatio_url = FELLATIO_URL; - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; my $curl_parameters = ' '; # Enable the action to test - $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' '; + $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' '; # The header to filter - $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' '; + $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' '; $curl_parameters .= '--head '; $curl_parameters .= ' '; @@ -1091,19 +1419,19 @@ 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'); + 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. @@ -1128,6 +1456,7 @@ sub get_page_with_curl ($) { @buffer = `$curl_line`; if ($?) { + log_and_die("Executing '$curl_line' failed.") unless @buffer; $failure_reason = array_as_string(\@buffer); chomp $failure_reason; l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'"); @@ -1135,9 +1464,8 @@ sub get_page_with_curl ($) { } while ($? && --$retries_left); unless ($retries_left) { - l(LL_ERROR, - "Running curl failed " . get_cli_option('retries') . - " times in a row. Last error: '" . $failure_reason . "'."); + log_and_die("Running curl failed " . get_cli_option('retries') . + " times in a row. Last error: '" . $failure_reason . "'."); } return \@buffer; @@ -1161,10 +1489,9 @@ sub array_as_string ($) { return $string; } - sub show_test ($) { - my $test_ref = shift; - log_message('Test is:' . test_content_as_string($test_ref)); + my $test = shift; + log_message('Test is:' . test_content_as_string($test)); } # Conditional log @@ -1173,17 +1500,14 @@ sub l ($$) { my $this_level = shift; my $message = shift; - return unless ($log_level & $this_level); - - if (LL_ERROR & $this_level) { - $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.'; - } + log_message($message) if ($log_level & $this_level); +} - log_message($message); +sub log_and_die ($) { + my $message = shift; - if (LL_ERROR & $this_level) { - exit; - } + log_message('Oh noes. ' . $message . ' Fatal error. Exiting.'); + exit; } sub log_message ($) { @@ -1203,7 +1527,7 @@ sub log_message ($) { if ($leading_log_date) { $year += 1900; $mon += 1; - $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday); + $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday); } if ($leading_log_time) { @@ -1214,91 +1538,89 @@ 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_ref = shift; + my $test = shift; my $result = shift; my $number = shift; - my %test = %{$test_ref}; - 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'}); - } else { + } elsif ($test->{'type'} == REDIRECT_TEST) { - die "Incomplete support for test type " . $test{'type'} . " detected."; + $message .= 'Redirected URL: '; + $message .= quote($test->{'data'}); + $message .= ' and redirect destination: '; + $message .= quote($test->{'redirect destination'}); - } + } else { + + die "Incomplete support for test type " . $test->{'type'} . " detected."; } - log_message($message) unless ($result && cli_option_is_set('silent')); + log_message($message) if (!$result or cli_option_is_set('verbose')); } sub quote ($) { @@ -1307,7 +1629,25 @@ sub quote ($) { } sub print_version () { - printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil ' . "\n"; + printf PRT_VERSION . "\n"; +} + +sub list_test_types () { + my %test_types = ( + 'Client header test' => CLIENT_HEADER_TEST, + 'Server header test' => 2, + 'Dumb fetch test' => 3, + 'Method test' => 4, + 'Sticky action test' => 5, + 'Trusted CGI test' => 6, + 'Block test' => 7, + 'Redirect test' => 108, + ); + + print "\nThe supported test types and their default levels are:\n"; + foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) { + printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type}; + } } sub help () { @@ -1320,20 +1660,36 @@ 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] + [--local-test-file] [--loops $cli_options{'loops'}] [--max-level $cli_options{'max-level'}] [--max-time $cli_options{'max-time'}] [--min-level $cli_options{'min-level'}] [--privoxy-address] [--retries $cli_options{'retries'}] - [--silent] + [--show-skipped-tests] + [--shuffle-tests] + [--sleep-time $cli_options{'sleep-time'}] + [--test-number] + [--verbose] [--version] -see "perldoc $0" for more information EOF ; + + list_test_types(); + + print << " EOF" + +Try "perldoc $0" for more information + EOF + ; + exit(0); } @@ -1342,12 +1698,14 @@ sub init_cli_options () { our %cli_options; our $log_level; - $cli_options{'min-level'} = CLI_MIN_LEVEL; + $cli_options{'debug'} = $log_level; + $cli_options{'forks'} = CLI_FORKS; + $cli_options{'loops'} = CLI_LOOPS; $cli_options{'max-level'} = CLI_MAX_LEVEL; - $cli_options{'debug'} = $log_level; - $cli_options{'loops'} = CLI_LOOPS; $cli_options{'max-time'} = CLI_MAX_TIME; - $cli_options{'retries'} = CLI_RETRIES; + $cli_options{'min-level'} = CLI_MIN_LEVEL; + $cli_options{'sleep-time'}= CLI_SLEEP_TIME; + $cli_options{'retries'} = CLI_RETRIES; } sub parse_cli_options () { @@ -1358,20 +1716,27 @@ sub parse_cli_options () { init_cli_options(); GetOptions ( - 'debug=s' => \$cli_options{'debug'}, - 'help' => sub { help }, - 'silent' => \$cli_options{'silent'}, - 'min-level=s' => \$cli_options{'min-level'}, - 'max-level=s' => \$cli_options{'max-level'}, - 'privoxy-address=s' => \$cli_options{'privoxy-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'}, - 'version' => sub { print_version && exit(0) } - ); + '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=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=i' => \$cli_options{'retries'}, + 'shuffle-tests' => \$cli_options{'shuffle-tests'}, + 'show-skipped-tests' => \$cli_options{'show-skipped-tests'}, + '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); $log_level |= $cli_options{'debug'}; } @@ -1393,12 +1758,45 @@ 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; + + log_and_die("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(); - load_regressions_tests(); + init_proxy_settings('vanilla-proxy'); + load_regression_tests(); + init_proxy_settings('fuzz-proxy'); + start_forks(get_cli_option('forks')) if cli_option_is_set('forks'); execute_regression_tests(); } @@ -1410,10 +1808,13 @@ 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 [B<--debug bitmask>] [B<--forks> forks] +[B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>] +[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<--silent>] [B<--version>] +[B<--retries retries>] [B<--test-number test-number>] +[B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>] +[B<--version>] =head1 DESCRIPTION @@ -1496,6 +1897,41 @@ To verify that a specific set of actions is applied to an URL, use: The sticky actions will be checked for all URLs below it until the next sticky actions directive. +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 @@ -1503,15 +1939,28 @@ control which ones to execute (see I below). Test levels are either set with the B directive, or implicitly through the test type. -Block tests default to level 7, fetch tests to level 6, -"Sticky Actions" tests default to level 5, tests for trusted CGI -requests to level 3 and client-header-action tests to level 1. +Redirect tests default to level 108, block tests to level 7, +fetch tests to level 6, "Sticky Actions" tests default to +level 5, tests for trusted CGI requests to level 3 and +client-header-action tests to level 1. + +The current redirect test level is above the default +max-level value as failed tests will result in outgoing +connections. Use the B<--max-level> option to run them +as well. =head1 OPTIONS 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 @@ -1522,8 +1971,17 @@ 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<--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 @@ -1548,7 +2006,21 @@ 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<--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. B<--version> Print version and exit.