X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=fcdf81693e04f5d945d2402d1aeb26ff9a4d22b3;hp=4fc909648a56d97f4036de8410f9672b537e60b4;hb=922ae4e04677a23a14feac41e55033a9953b2636;hpb=e56d26413b7b73cae45e39d934d655d67865ee4e diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index 4fc90964..fcdf8169 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.104 2008/01/21 18:23:49 fk Exp $ +# $Id: privoxy-regression-test.pl,v 1.166 2009/02/27 18:33:39 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? # -# Copyright (c) 2007-2008 Fabian Keil +# Copyright (c) 2007-2009 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,47 +40,50 @@ use strict; use Getopt::Long; use constant { - PRT_VERSION => 'Privoxy-Regression-Test 0.2', + PRT_VERSION => 'Privoxy-Regression-Test 0.3', - 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, - TRUSTED_CGI_REQUEST => 6, + 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, + + 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, + + VERBOSE_TEST_DESCRIPTION => 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, }; sub init_our_variables () { @@ -143,7 +141,7 @@ 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 $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]'; unless ($tag =~ m/^$allowed*$/) { my $forbidden = $tag; @@ -156,9 +154,12 @@ sub check_for_forbidden_characters ($) { sub load_regressions_tests () { our $privoxy_cgi_url; + our @privoxy_config; + our %privoxy_features; my @actionfiles; - my $curl_url = ''; + my $curl_url = ''; my $file_number = 0; + my $feature; $curl_url .= $privoxy_cgi_url; $curl_url .= 'show-status'; @@ -167,10 +168,25 @@ sub load_regressions_tests () { foreach (@{get_cgi_page_or_else($curl_url)}) { + chomp; if (/(.*?)<\/td>/) { my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2; $actionfiles[$file_number++] = $url; + + } elsif (m@config\.html#.*\">([^<]*)\s+(.*)
@) { + + 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; } } @@ -182,14 +198,15 @@ sub load_regressions_tests () { sub token_starts_new_test ($) { my $token = shift; - my @new_test_directives = - ('set header', 'fetch test', 'trusted cgi request', 'request header', 'method test'); + my @new_test_directives = ('set header', 'fetch test', + 'trusted cgi request', 'request header', 'method test', + 'blocked url', 'url'); foreach my $new_test_directive (@new_test_directives) { return 1 if $new_test_directive eq $token; } - return 0; + return 0; } sub tokenize ($) { @@ -203,19 +220,21 @@ sub tokenize ($) { # Reverse HTML-encoding # XXX: Seriously imcomplete. s@"@"@g; + s@&@&@g; # Tokenize - if (/^\#\s*([^=]*?)\s*[=]\s*(.*?)\s*$/) { + if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) { $token = $1; - $token =~ tr/[A-Z]/[a-z]/; $value = $2; + $token =~ s@\s\s+@ @g; + $token =~ tr/[A-Z]/[a-z]/; + } elsif (/^TAG\s*:(.*)$/) { $token = 'tag'; $value = $1; - } return ($token, $value); @@ -224,52 +243,55 @@ sub tokenize ($) { sub enlist_new_test ($$$$$$) { my ($regression_tests, $token, $value, $si, $ri, $number) = @_; + my $type; if ($token eq 'set header') { l(LL_FILE_LOADING, "Header to set: " . $value); - ${$regression_tests}[$si][$ri]{'type'} = CLIENT_HEADER_TEST; - # Implicit default - $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST; + $type = CLIENT_HEADER_TEST; } elsif ($token eq 'request header') { l(LL_FILE_LOADING, "Header to request: " . $value); - $$regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST; - # Implicit default + $type = SERVER_HEADER_TEST; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; - $$regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST; } elsif ($token eq 'trusted cgi request') { l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value); - $$regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST; - # Implicit default + $type = TRUSTED_CGI_REQUEST; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; - $$regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST; } elsif ($token eq 'fetch test') { l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value); - $$regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST; - # Implicit default + $type = DUMB_FETCH_TEST; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; - $$regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST; } elsif ($token eq 'method test') { l(LL_FILE_LOADING, "Method to test: " . $value); - $$regression_tests[$si][$ri]{'type'} = METHOD_TEST; - # Implicit default + $type = METHOD_TEST; $$regression_tests[$si][$ri]{'expected-status-code'} = 200; - $$regression_tests[$si][$ri]{'level'} = METHOD_TEST; + + } elsif ($token eq 'blocked url') { + + l(LL_FILE_LOADING, "URL to block-test: " . $value); + $type = BLOCK_TEST; + + } elsif ($token eq 'url') { + + l(LL_FILE_LOADING, "Sticky URL to test: " . $value); + $type = STICKY_ACTIONS_TEST; } else { die "Incomplete '" . $token . "' support detected."; - } + $$regression_tests[$si][$ri]{'type'} = $type; + $$regression_tests[$si][$ri]{'level'} = $type; + check_for_forbidden_characters($value); $$regression_tests[$si][$ri]{'data'} = $value; @@ -297,18 +319,20 @@ 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) { my $curl_url = ' "' . $actionfiles[$file_number] . '"'; my $actionfile = undef; + my $sticky_actions = undef; foreach (@{get_cgi_page_or_else($curl_url)}) { my $no_checks = 0; chomp; - + if (/

Contents of Actions File (.*?) 1) { log_message("Total: Executed " . $all_tests . " regression tests. " . $all_successes . " successes, " . $all_failures . " failures."); @@ -476,18 +546,85 @@ sub execute_regression_tests () { 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')) - ); + 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 to low (" . $level . " < " . $min_level . ")"; + + } elsif ($level > $max_level) { + + $reason = "Level to high (" . $level . " > " . $max_level . ")"; + + } else { + + $reason = dependency_unsatisfied($level); + } + + return $reason; } -sub test_number_is_unacceptable ($) { - my $test_number = shift; - return (cli_option_is_set('test-number') - and get_cli_option('test-number') != $test_number) +sub dependency_unsatisfied ($) { + + my $level = shift; + our %dependencies; + our @privoxy_config; + our %privoxy_features; + + my $dependency_problem = undef; + + if (defined ($dependencies{$level}{'config line'})) { + + my $dependency = $dependencies{$level}{'config line'}; + $dependency_problem = "depends on config line matching: '" . $dependency . "'"; + + foreach (@privoxy_config) { + + $dependency_problem = undef if (/$dependency/); + last; # XXX: this looks ... interesting. + } + + } elsif (defined ($dependencies{$level}{'feature status'})) { + + 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 . "'"; + } + } + + return $dependency_problem; } +sub register_dependency ($$) { + + my $level = shift; + my $dependency = shift; + our %dependencies; + + if ($dependency =~ /config line\s+(.*)/) { + + $dependencies{$level}{'config line'} = $1; + + } elsif ($dependency =~ /feature status\s+(.*)/) { + + $dependencies{$level}{'feature status'} = $1; + + } +} # XXX: somewhat misleading name sub execute_regression_test ($) { @@ -513,12 +650,18 @@ sub execute_regression_test ($) { $result = execute_method_test($test_ref); - } else { + } elsif ($test{'type'} == BLOCK_TEST) { - die "Unsuported test type detected: " . $test{'type'}; + $result = execute_block_test($test_ref); - } + } elsif ($test{'type'} == STICKY_ACTIONS_TEST) { + + $result = execute_sticky_actions_test($test_ref); + + } else { + die "Unsupported test type detected: " . $test{'type'}; + } return $result; } @@ -528,46 +671,36 @@ sub execute_method_test ($) { my $test_ref = shift; my %test = %{$test_ref}; my $buffer_ref; - my $result = 0; my $status_code; my $method = $test{'data'}; my $curl_parameters = ''; my $expected_status_code = $test{'expected-status-code'}; - if ($method =~ /HEAD/i) { - - $curl_parameters .= '--head '; - - } else { - - $curl_parameters .= '-X ' . $method . ' '; - } + $curl_parameters .= '--request ' . $method . ' '; + # Don't complain about the 'missing' body + $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i); $curl_parameters .= PRIVOXY_CGI_URL; $buffer_ref = get_page_with_curl($curl_parameters); $status_code = get_status_code($buffer_ref); - $result = check_status_code_result($status_code, $expected_status_code); - - return $result; + return check_status_code_result($status_code, $expected_status_code); } - sub execute_dumb_fetch_test ($) { my $test_ref = shift; my %test = %{$test_ref}; my $buffer_ref; - my $result = 0; my $status_code; my $curl_parameters = ''; my $expected_status_code = $test{'expected-status-code'}; if (defined $test{method}) { - $curl_parameters .= '-X ' . $test{method} . ' '; + $curl_parameters .= '--request ' . $test{method} . ' '; } if ($test{type} == TRUSTED_CGI_REQUEST) { $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' '; @@ -578,9 +711,86 @@ sub execute_dumb_fetch_test ($) { $buffer_ref = get_page_with_curl($curl_parameters); $status_code = get_status_code($buffer_ref); - $result = check_status_code_result($status_code, $expected_status_code); + return check_status_code_result($status_code, $expected_status_code); +} + +sub execute_block_test ($) { - return $result; + my $test = shift; + my $url = $test->{'data'}; + my $final_results = get_final_results($url); + + return defined $final_results->{'+block'}; +} + +sub execute_sticky_actions_test ($) { + + my $test = shift; + my $url = $test->{'data'}; + my $verified_actions = 0; + # XXX: splitting currently doesn't work for actions whose parameters contain spaces. + my @sticky_actions = split(/\s+/, $test->{'sticky-actions'}); + 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}) { + # 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."); + } + } + + return $verified_actions == @sticky_actions; +} + +sub get_final_results ($) { + + my $url = shift; + my $curl_parameters = ''; + my %final_results = (); + my $final_results_reached = 0; + + die "Unacceptable characters in $url" if $url =~ m@[\\'"]@; + # XXX: should be URL-encoded properly + $url =~ s@%@%25@g; + $url =~ s@\s@%20@g; + $url =~ s@&@%26@g; + $url =~ s@:@%3A@g; + $url =~ s@/@%2F@g; + + $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url); + + foreach (@{get_cgi_page_or_else($curl_parameters)}) { + + $final_results_reached = 1 if (m@

Final results:

@); + + next unless ($final_results_reached); + last if (m@@); + + if (m@
([-+])([^>]*)(?: (\{.*\}))?@) { + my $action = $1.$2; + my $parameter = $3; + + if (defined $parameter) { + # In case the caller needs to check + # the action and its parameter + $final_results{$action . $parameter} = 1; + } + # In case the action doesn't have parameters + # or the caller doesn't care for the parameter. + $final_results{$action} = 1; + } + } + + return \%final_results; } sub check_status_code_result ($$) { @@ -589,7 +799,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, @@ -604,7 +820,6 @@ sub check_status_code_result ($$) { l(LL_VERBOSE_FAILURE, "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.'); - } return $result; @@ -615,14 +830,12 @@ sub execute_client_header_regression_test ($) { my $test_ref = shift; my $buffer_ref; my $header; - my $result = 0; $buffer_ref = get_show_request_with_curl($test_ref); $header = get_header($buffer_ref, $test_ref); - $result = check_header_result($test_ref, $header); - return $result; + return check_header_result($test_ref, $header); } sub execute_server_header_regression_test ($) { @@ -630,17 +843,14 @@ sub execute_server_header_regression_test ($) { my $test_ref = shift; my $buffer_ref; my $header; - my $result = 0; $buffer_ref = get_head_with_curl($test_ref); $header = get_server_header($buffer_ref, $test_ref); - $result = check_header_result($test_ref, $header); - return $result; + return check_header_result($test_ref, $header); } - sub interpret_result ($) { my $success = shift; return $success ? "Success" : "Failure"; @@ -655,8 +865,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'}) { @@ -665,7 +873,7 @@ sub check_header_result ($$) { } else { - $header //= "REMOVAL"; + $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, "Ooops. Got: " . $header . " while expecting: " . $expect_header); } @@ -682,7 +890,6 @@ sub check_header_result ($$) { # XXX: Use more reliable check here and make sure # the header has a different name. $success = 1; - } } elsif ($expect_header eq 'SOME CHANGE') { @@ -693,7 +900,7 @@ sub check_header_result ($$) { } else { - $header //= "REMOVAL"; + $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, "Ooops. Got: " . $header . " while expecting: SOME CHANGE"); } @@ -707,7 +914,7 @@ sub check_header_result ($$) { } else { - $header //= "'No matching header'"; # XXX: No header detected to be precise + $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); } @@ -715,7 +922,6 @@ sub check_header_result ($$) { return $success; } - sub get_header_name ($) { my $header = shift; @@ -737,6 +943,8 @@ sub get_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; my $read_header = 0; @@ -770,6 +978,9 @@ sub get_header ($$) { s@^\s*<.*?>@@g; s@\s*$@@g; + # Decode characters we care about. + s@"@"@g; + $filtered_request .= "\n" . $_; if (/^$header_to_get/) { @@ -794,19 +1005,22 @@ sub get_server_header ($$) { my $header; my $header_to_get; + # XXX: Should be caught before starting to test. + l(LL_ERROR, "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') { + or $expect_header eq 'SOME CHANGE') { $expect_header = $test{'data'}; - } $header_to_get = get_header_name($expect_header); foreach (@buffer) { - # XXX: shoul probably verify that the request + # XXX: should probably verify that the request # was actually answered by Fellatio. if (/^$header_to_get/) { $header = $_; @@ -818,53 +1032,6 @@ sub get_server_header ($$) { return $header; } -sub get_header_to_check ($) { - - # No longer in use but not removed yet. - - my $buffer_ref = shift; - my $header; - my @buffer = @{$buffer_ref}; - my $line; - my $processed_request_reached = 0; - my $read_header = 0; - my $processed_request = ''; - - l(LL_ERROR, "You are not supposed to use get_header_to_()!"); - - foreach (@buffer) { - - # Skip everything before the Processed request - if (/Processed Request/) { - $processed_request_reached = 1; - next; - } - next unless $processed_request_reached; - - # End loop after the Processed request - last if (/<\/pre>/); - - # Ditch tags and leading/trailing white space. - s@^\s*<.*?>@@g; - s@\s*$@@g; - - $processed_request .= $_; - - if (/^X-Privoxy-Regression-Test/) { - $read_header = 1; - next; - } - - if ($read_header) { - $header = $_; - $read_header = 0; - } - - } - - return $header; -} - sub get_status_code ($) { my $buffer_ref = shift; @@ -898,7 +1065,6 @@ sub test_content_as_string ($) { my $s = "\n\t"; foreach my $key (get_test_keys()) { - #$test{$key} = $test{$key} // 'undefined'; $test{$key} = 'Not set' unless (defined $test{$key}); } @@ -913,6 +1079,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 @@ -944,13 +1124,13 @@ sub get_cgi_page_or_else ($) { } else { l(LL_ERROR, $log_message); - } } return $content_ref; } +# XXX: misleading name sub get_show_request_with_curl ($) { our $privoxy_cgi_url; @@ -958,11 +1138,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; @@ -971,7 +1156,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; @@ -992,19 +1176,20 @@ 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 "; # Let Privoxy emit two log messages less. $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/; $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/; @@ -1012,8 +1197,6 @@ sub get_page_with_curl ($) { $curl_line .= " -s "; # We do care about the failure reason if any. $curl_line .= " -S "; - # We want to see the HTTP status code - $curl_line .= " --include "; # We want to advertise ourselves $curl_line .= " --user-agent '" . PRT_VERSION . "' "; # We aren't too patient @@ -1062,7 +1245,6 @@ sub array_as_string ($) { return $string; } - sub show_test ($) { my $test_ref = shift; log_message('Test is:' . test_content_as_string($test_ref)); @@ -1115,9 +1297,7 @@ sub log_message ($) { $message = $time_stamp . ": " . $message; } - printf(STDERR "%s\n", $message); - } sub log_result ($$) { @@ -1180,14 +1360,25 @@ sub log_result ($$) { $message .= ' and expected status code '; $message .= quote($test{'expected-status-code'}); + } elsif ($test{'type'} == BLOCK_TEST) { + + $message .= ' Supposedly-blocked URL: '; + $message .= quote($test{'data'}); + + } elsif ($test{'type'} == STICKY_ACTIONS_TEST) { + + $message .= ' Sticky Actions: '; + $message .= quote($test{'sticky-actions'}); + $message .= ' and URL: '; + $message .= quote($test{'data'}); + } 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 ($) { @@ -1196,7 +1387,7 @@ sub quote ($) { } sub print_version () { - printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil ' . "\n"; + printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil ' . "\n"; } sub help () { @@ -1209,8 +1400,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'}] @@ -1218,7 +1412,9 @@ Options and their default values if they have any: [--min-level $cli_options{'min-level'}] [--privoxy-address] [--retries $cli_options{'retries'}] - [--silent] + [--show-skipped-tests] + [--test-number] + [--verbose] [--version] see "perldoc $0" for more information EOF @@ -1231,12 +1427,13 @@ 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{'retries'} = CLI_RETRIES; } sub parse_cli_options () { @@ -1247,19 +1444,23 @@ 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=s' => \$cli_options{'debug'}, + 'forks=s' => \$cli_options{'forks'}, + 'fuzzer-address=s' => \$cli_options{'fuzzer-address'}, + 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'}, + 'header-fuzzing' => \$cli_options{'header-fuzzing'}, + 'help' => sub {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'}, + 'privoxy-address=s' => \$cli_options{'privoxy-address'}, + 'retries=s' => \$cli_options{'retries'}, + 'show-skipped-tests' => \$cli_options{'show-skipped-tests'}, + 'test-number=s' => \$cli_options{'test-number'}, + 'verbose' => \$cli_options{'verbose'}, + 'version' => sub {print_version && exit(0)} ); $log_level |= $cli_options{'debug'}; } @@ -1272,7 +1473,6 @@ sub cli_option_is_set ($) { return defined $cli_options{$cli_option}; } - sub get_cli_option ($) { our %cli_options; @@ -1283,13 +1483,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(); } @@ -1301,27 +1535,32 @@ 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<--show-skipped-tests>] [B<--verbose>] +[B<--version>] =head1 DESCRIPTION Privoxy-Regression-Test is supposed to one day become a regression test suite for Privoxy. It's not quite there -yet, however, and can currently only test client header -actions and check the returned status code for requests -to arbitrary URLs. +yet, however, and can currently only test header actions, +check the returned status code for requests to arbitrary +URLs and verify which actions are applied to them. Client header actions are tested by requesting -B and checking whether +B and checking whether or not Privoxy modified the original request as expected. The original request contains both the header the action-to-be-tested acts upon and an additional tagger-triggering header that enables the action to test. +Applied actions are checked through B. + =head1 CONFIGURATION FILE SYNTAX Privoxy-Regression-Test's configuration is embedded in @@ -1366,27 +1605,48 @@ for Valgrind or to verify that the templates are installed correctly. If you want to test CGI pages that require a trusted referer, you can use: - # Trusted CGI Request = http://p.p/edit-actions + # Trusted CGI Request = http://p.p/edit-actions It works like ordinary fetch tests, but sets the referer header to a trusted value. If no explicit status code expectation is set, B<200> is used. -Additionally all tests have test levels to let the user +To verify that a URL is blocked, use: + + # Blocked URL = http://www.example.com/blocked + +To verify that a specific set of actions is applied to an URL, use: + + # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image + # URL = http://www.example.org/my-first-url + +The sticky actions will be checked for all URLs below it +until the next sticky actions directive. + +=head1 TEST LEVELS + +All tests have test levels to let the user control which ones to execute (see I below). Test levels are either set with the B directive, or implicitly through the test type. -Fetch tests default to level 6, tests for trusted -CGI requests to level 3 and client-header-action tests -to level 1. +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. =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 @@ -1397,6 +1657,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. @@ -1423,7 +1686,12 @@ 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<--verbose> Log succesful and skipped tests. B<--version> Print version and exit.