X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=tools%2Fprivoxy-regression-test.pl;h=b30a39fcc1922d5ab294009e93765dbddd2f926b;hb=d3114ed7ffa9f68291d0d7bffbe438aba724c441;hp=a89c644878630923852aff6f59b71ac7f07c2b8b;hpb=b041cc96c7126f0cc3aecbb3b6c36637625638f5;p=privoxy.git diff --git a/tools/privoxy-regression-test.pl b/tools/privoxy-regression-test.pl index a89c6448..b30a39fc 100755 --- a/tools/privoxy-regression-test.pl +++ b/tools/privoxy-regression-test.pl @@ -7,7 +7,7 @@ # A regression test "framework" for Privoxy. For documentation see: # perldoc privoxy-regression-test.pl # -# $Id: privoxy-regression-test.pl,v 1.119 2008/03/21 12:56:20 fk Exp $ +# $Id: privoxy-regression-test.pl,v 1.143 2008/04/04 17:17:32 fk Exp $ # # Wish list: # @@ -85,6 +85,7 @@ use constant { SERVER_HEADER_TEST => 2, DUMB_FETCH_TEST => 3, METHOD_TEST => 4, + STICKY_ACTIONS_TEST => 5, TRUSTED_CGI_REQUEST => 6, BLOCK_TEST => 7, }; @@ -144,7 +145,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; @@ -190,8 +191,9 @@ 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'); foreach my $new_test_directive (@new_test_directives) { return 1 if $new_test_directive eq $token; @@ -235,53 +237,46 @@ 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); - $$regression_tests[$si][$ri]{'type'} = BLOCK_TEST; - # Implicit default - $$regression_tests[$si][$ri]{'expected-status-code'} = 403; - $$regression_tests[$si][$ri]{'level'} = BLOCK_TEST; + $type = BLOCK_TEST; + + } elsif ($token eq 'url') { + + l(LL_FILE_LOADING, "Sticky URL to test: " . $value); + $type = STICKY_ACTIONS_TEST; } else { @@ -289,6 +284,9 @@ sub enlist_new_test ($$$$$$) { } + $$regression_tests[$si][$ri]{'type'} = $type; + $$regression_tests[$si][$ri]{'level'} = $type; + check_for_forbidden_characters($value); $$regression_tests[$si][$ri]{'data'} = $value; @@ -322,12 +320,13 @@ sub load_action_files ($) { 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 (.*?){'+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; @@ -656,7 +704,12 @@ sub get_final_results ($) { my $final_results_reached = 0; die "Unacceptable characterss 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 . "'"; @@ -667,10 +720,18 @@ sub get_final_results ($) { next unless ($final_results_reached); last if (m@@); - if (m@
([-+])([^>]*)( \{.*\})@) { + 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 it's parameter + $final_results{$action . $parameter} = 1; + } + # In case the action doesn't have paramters + # or the caller doesn't care for the parameter. + $final_results{$action} = 1; } } @@ -709,14 +770,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 ($) { @@ -724,14 +783,12 @@ 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); } @@ -759,7 +816,7 @@ sub check_header_result ($$) { } else { - $header //= "REMOVAL"; + $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, "Ooops. Got: " . $header . " while expecting: " . $expect_header); } @@ -787,7 +844,7 @@ sub check_header_result ($$) { } else { - $header //= "REMOVAL"; + $header = "REMOVAL" unless defined $header; l(LL_VERBOSE_FAILURE, "Ooops. Got: " . $header . " while expecting: SOME CHANGE"); } @@ -801,7 +858,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); } @@ -830,6 +887,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; @@ -887,6 +946,10 @@ 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') { @@ -1230,6 +1293,13 @@ sub log_result ($$) { $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."; @@ -1358,18 +1428,20 @@ B [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help> 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,21 +1486,35 @@ 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