X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=a8ee05174a1329e595926f84b7f9628d1c7fd29b;hp=a89c644878630923852aff6f59b71ac7f07c2b8b;hb=c5245d06d667d761dc6b19f6a3b810dbdf9e5c9b;hpb=b041cc96c7126f0cc3aecbb3b6c36637625638f5 diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index a89c6448..a8ee0517 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.119 2008/03/21 12:56:20 fk Exp $ +# $Id: privoxy-regression-test.pl,v 1.73 2011/06/29 18:34:38 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-2011 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,61 +40,60 @@ use strict; use Getopt::Long; use constant { - PRT_VERSION => 'Privoxy-Regression-Test 0.2', + PRT_VERSION => 'Privoxy-Regression-Test 0.4', - 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, - 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, + + VERBOSE_TEST_DESCRIPTION => 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 () { @@ -112,9 +106,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; } @@ -143,14 +136,14 @@ 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."); } } @@ -158,15 +151,21 @@ sub load_regressions_tests () { our $privoxy_cgi_url; our @privoxy_config; + our %privoxy_features; my @actionfiles; my $curl_url = ''; my $file_number = 0; + my $feature; $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; @@ -179,6 +178,15 @@ 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; } } @@ -190,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', 'blocked url'); + my @new_test_directives = ('set header', 'fetch test', + 'trusted cgi request', 'request header', 'method test', + '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 ($) { @@ -209,12 +218,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; @@ -226,7 +235,6 @@ sub tokenize ($) { $token = 'tag'; $value = $1; - } return ($token, $value); @@ -235,60 +243,70 @@ sub tokenize ($) { 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); - ${$regression_tests}[$si][$ri]{'type'} = CLIENT_HEADER_TEST; - # Implicit default - $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST; + $type = CLIENT_HEADER_TEST; + $executor = \&execute_client_header_regression_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; + $executor = \&execute_server_header_regression_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; + $executor = \&execute_dumb_fetch_test; $$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; + $executor = \&execute_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; + $executor = \&execute_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); - $$regression_tests[$si][$ri]{'type'} = BLOCK_TEST; - # Implicit default - $$regression_tests[$si][$ri]{'expected-status-code'} = 403; - $$regression_tests[$si][$ri]{'level'} = BLOCK_TEST; + $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); $$regression_tests[$si][$ri]{'data'} = $value; @@ -316,18 +334,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 $curl_url = quote($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) { @@ -500,19 +555,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; -sub test_number_is_unacceptable ($) { - my $test_number = shift; - return (cli_option_is_set('test-number') - and get_cli_option('test-number') != $test_number) + 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 { + + $reason = dependency_unsatisfied($level); + } + + return $reason; } sub dependency_unsatisfied ($) { @@ -520,16 +610,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 . "'"; } } @@ -544,99 +654,107 @@ 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); + $dependencies{$level}{'config line'} = $1; - } elsif ($test{'type'} == SERVER_HEADER_TEST) { + } elsif ($dependency =~ /feature status\s+(.*)/) { - $result = execute_server_header_regression_test($test_ref); + $dependencies{$level}{'feature status'} = $1; - } elsif ($test{'type'} == DUMB_FETCH_TEST - or $test{'type'} == TRUSTED_CGI_REQUEST) { - - $result = execute_dumb_fetch_test($test_ref); + } else { - } elsif ($test{'type'} == METHOD_TEST) { + log_and_die("Didn't recognize dependency: $dependency."); + } +} - $result = execute_method_test($test_ref); +sub execute_method_test ($) { - } elsif ($test{'type'} == BLOCK_TEST) { + my $test = shift; + my $buffer_ref; + my $status_code; + my $method = $test->{'data'}; - $result = execute_block_test($test_ref); + my $curl_parameters = ''; + my $expected_status_code = $test->{'expected-status-code'}; - } else { + $curl_parameters .= '--request ' . $method . ' '; + # Don't complain about the 'missing' body + $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i); - die "Unsupported test type detected: " . $test{'type'}; + $curl_parameters .= PRIVOXY_CGI_URL; - } + $buffer_ref = get_page_with_curl($curl_parameters); + $status_code = get_status_code($buffer_ref); - return $result; + return check_status_code_result($status_code, $expected_status_code); } -sub execute_method_test ($) { +sub execute_redirect_test ($) { - my $test_ref = shift; - my %test = %{$test_ref}; + my $test = shift; my $buffer_ref; - my $result = 0; my $status_code; - my $method = $test{'data'}; my $curl_parameters = ''; - my $expected_status_code = $test{'expected-status-code'}; + my $url = $test->{'data'}; + my $redirect_destination; + my $expected_redirect_destination = $test->{'redirect destination'}; - $curl_parameters .= '--request ' . $method . ' '; - # Don't complain in case about the 'missing' body - $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i); + # XXX: Check if a redirect actually applies before doing the request. + # otherwise the test may hit a real server in failure cases. - $curl_parameters .= PRIVOXY_CGI_URL; + $curl_parameters .= '--head '; + + $curl_parameters .= quote($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); + 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; + } + } - return $result; + 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 $result = 0; 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 .= quote('--request') . quote($test->{method}) . ' '; } - if ($test{type} == TRUSTED_CGI_REQUEST) { - $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' '; + if ($test->{type} == TRUSTED_CGI_REQUEST) { + $curl_parameters .= quote('--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); - $result = check_status_code_result($status_code, $expected_status_code); - - return $result; + return check_status_code_result($status_code, $expected_status_code); } sub execute_block_test ($) { @@ -648,6 +766,37 @@ sub execute_block_test ($) { 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 =~ /-.*\{/) { + + # 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; @@ -655,10 +804,15 @@ 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; + $url =~ s@&@%26@g; + $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)}) { @@ -667,10 +821,21 @@ 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 $value = $3; - $final_results{$action} = $value; + 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; } } @@ -683,7 +848,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, @@ -698,7 +869,6 @@ sub check_status_code_result ($$) { l(LL_VERBOSE_FAILURE, "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.'); - } return $result; @@ -706,35 +876,30 @@ sub check_status_code_result ($$) { sub execute_client_header_regression_test ($) { - my $test_ref = shift; + my $test = shift; my $buffer_ref; my $header; - my $result = 0; - $buffer_ref = get_show_request_with_curl($test_ref); + $buffer_ref = get_show_request_with_curl($test); - $header = get_header($buffer_ref, $test_ref); - $result = check_header_result($test_ref, $header); + $header = get_header($buffer_ref, $test); - return $result; + return check_header_result($test, $header); } sub execute_server_header_regression_test ($) { - my $test_ref = shift; + my $test = shift; my $buffer_ref; my $header; - my $result = 0; - $buffer_ref = get_head_with_curl($test_ref); + $buffer_ref = get_head_with_curl($test); - $header = get_server_header($buffer_ref, $test_ref); - $result = check_header_result($test_ref, $header); + $header = get_server_header($buffer_ref, $test); - return $result; + return check_header_result($test, $header); } - sub interpret_result ($) { my $success = shift; return $success ? "Success" : "Failure"; @@ -742,68 +907,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'}); - $header //= "REMOVAL"; + 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'}); - $header //= "REMOVAL"; + 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; - - } else { + $success = (defined($header) and $header eq $expect_header); - $header //= "'No matching 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; @@ -823,12 +971,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; @@ -839,10 +988,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); @@ -863,6 +1011,9 @@ sub get_header ($$) { s@^\s*<.*?>@@g; s@\s*$@@g; + # Decode characters we care about. + s@"@"@g; + $filtered_request .= "\n" . $_; if (/^$header_to_get/) { @@ -878,21 +1029,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); @@ -926,7 +1079,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: "' . $_ . '"'); } } } @@ -938,37 +1091,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; @@ -988,26 +1149,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; @@ -1016,19 +1181,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 .= ' '; @@ -1037,18 +1200,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 "; @@ -1074,6 +1236,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 . $! ."'"); @@ -1081,9 +1244,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; @@ -1107,10 +1269,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 @@ -1119,17 +1280,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 ($) { @@ -1149,7 +1307,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) { @@ -1160,9 +1318,7 @@ sub log_message ($) { $message = $time_stamp . ": " . $message; } - printf(STDERR "%s\n", $message); - } sub log_result ($$) { @@ -1170,74 +1326,86 @@ 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 = ''; $message .= interpret_result($result); $message .= " for test "; $message .= $number; $message .= '/'; - $message .= $test{'number'}; + $message .= $test->{'number'}; $message .= '/'; - $message .= $test{'section-id'}; + $message .= $test->{'section-id'}; $message .= '/'; - $message .= $test{'regression-test-id'}; + $message .= $test->{'regression-test-id'}; $message .= '.'; if ($verbose_test_description) { - if ($test{'type'} == CLIENT_HEADER_TEST) { + if ($test->{'type'} == CLIENT_HEADER_TEST) { $message .= ' Header '; - $message .= quote($test{'data'}); + $message .= quote($test->{'data'}); $message .= ' and tag '; - $message .= quote($test{'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 .= quote($test->{'data'}); $message .= ' and tag '; - $message .= quote($test{'tag'}); + $message .= quote($test->{'tag'}); - } elsif ($test{'type'} == DUMB_FETCH_TEST) { + } elsif ($test->{'type'} == DUMB_FETCH_TEST) { $message .= ' URL '; - $message .= quote($test{'data'}); + $message .= quote($test->{'data'}); $message .= ' and expected status code '; - $message .= quote($test{'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 .= quote($test->{'data'}); $message .= ' and expected status code '; - $message .= quote($test{'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 .= quote($test->{'data'}); $message .= ' and expected status code '; - $message .= quote($test{'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 .= quote($test->{'data'}); - } else { + } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) { + + $message .= ' Sticky Actions: '; + $message .= quote($test->{'sticky-actions'}); + $message .= ' and URL: '; + $message .= quote($test->{'data'}); - die "Incomplete support for test type " . $test{'type'} . " detected."; + } elsif ($test->{'type'} == REDIRECT_TEST) { + $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 ($) { @@ -1246,7 +1414,25 @@ sub quote ($) { } sub print_version () { - printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil ' . "\n"; + printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil ' . "\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 () { @@ -1259,8 +1445,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'}] @@ -1268,11 +1457,22 @@ 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] + [--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); } @@ -1281,12 +1481,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 () { @@ -1297,20 +1499,25 @@ 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' => \&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'}, + 'sleep-time=s' => \$cli_options{'sleep-time'}, + 'test-number=s' => \$cli_options{'test-number'}, + 'verbose' => \$cli_options{'verbose'}, + 'version' => sub {print_version && exit(0)} + ) or exit(1); $log_level |= $cli_options{'debug'}; } @@ -1332,12 +1539,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(); + 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(); } @@ -1349,27 +1589,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<--sleep-time> seconds] [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 @@ -1414,27 +1659,59 @@ 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. + +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 + +=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. +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 @@ -1445,6 +1722,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. @@ -1471,7 +1751,16 @@ 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<--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.