3 ############################################################################
5 # Privoxy-Regression-Test
7 # A regression test "framework" for Privoxy. For documentation see:
8 # perldoc privoxy-regression-test.pl
10 # $Id: privoxy-regression-test.pl,v 1.182 2009/06/01 13:21:48 fk Exp $
14 # - Update documentation
15 # - Validate HTTP times.
16 # - Implement a HTTP_VERSION directive or allow to
17 # specify whole request lines.
18 # - Support filter regression tests.
19 # - Document magic Expect Header values
20 # - Internal fuzz support?
22 # Copyright (c) 2007-2009 Fabian Keil <fk@fabiankeil.de>
24 # Permission to use, copy, modify, and distribute this software for any
25 # purpose with or without fee is hereby granted, provided that the above
26 # copyright notice and this permission notice appear in all copies.
28 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
29 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
30 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
31 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
32 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
33 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
34 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
36 ############################################################################
43 PRT_VERSION => 'Privoxy-Regression-Test 0.3',
52 # XXX: why limit at all?
56 PRIVOXY_CGI_URL => 'http://p.p/',
57 FELLATIO_URL => 'http://127.0.0.1:8080/',
58 LEADING_LOG_DATE => 1,
59 LEADING_LOG_TIME => 1,
61 DEBUG_LEVEL_FILE_LOADING => 0,
62 DEBUG_LEVEL_PAGE_FETCHING => 0,
63 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
64 # XXX: Only partly implemented and mostly useless.
65 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
66 DEBUG_LEVEL_STATUS => 1,
68 VERBOSE_TEST_DESCRIPTION => 1,
70 # Internal use, don't modify
71 # Available debug bits:
73 LL_VERBOSE_FAILURE => 2,
74 LL_PAGE_FETCHING => 4,
76 LL_VERBOSE_SUCCESS => 16,
79 CLIENT_HEADER_TEST => 1,
80 SERVER_HEADER_TEST => 2,
83 STICKY_ACTIONS_TEST => 5,
84 TRUSTED_CGI_REQUEST => 6,
88 sub init_our_variables () {
90 our $leading_log_time = LEADING_LOG_TIME;
91 our $leading_log_date = LEADING_LOG_DATE;
93 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
95 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
97 our $log_level = get_default_log_level();
101 sub get_default_log_level () {
105 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
106 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
107 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
108 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
109 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
111 # This one is supposed to be always on.
112 $log_level |= LL_SOFT_ERROR;
117 ############################################################################
119 # File loading functions
121 ############################################################################
129 # Unescape brackets and dots
130 $tag =~ s@\\(?=[{}().+])@@g;
132 # log_message("Parsed tag: " . $tag);
134 check_for_forbidden_characters($tag);
139 sub check_for_forbidden_characters ($) {
142 my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]';
144 unless ($string =~ m/^$allowed*$/o) {
145 my $forbidden = $string;
146 $forbidden =~ s@^$allowed*(.).*@$1@;
148 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
152 sub load_regressions_tests () {
154 our $privoxy_cgi_url;
156 our %privoxy_features;
162 $curl_url .= $privoxy_cgi_url;
163 $curl_url .= 'show-status';
165 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
167 # Dear Privoxy, please reload the config file if necessary ...
168 get_cgi_page_or_else($curl_url);
170 # ... so we get the latest one here.
171 foreach (@{get_cgi_page_or_else($curl_url)}) {
174 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
176 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
177 $actionfiles[$file_number++] = $url;
179 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
181 my $directive = $1 . " " . $2;
182 push (@privoxy_config, $directive);
184 } elsif (m@<td><code>([^<]*)</code></td>@) {
188 } elsif (m@<td> (Yes|No) </td>@) {
190 $privoxy_features{$feature} = $1 if defined $feature;
195 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
197 load_action_files(\@actionfiles);
200 sub token_starts_new_test ($) {
203 my @new_test_directives = ('set header', 'fetch test',
204 'trusted cgi request', 'request header', 'method test',
205 'blocked url', 'url');
207 foreach my $new_test_directive (@new_test_directives) {
208 return 1 if $new_test_directive eq $token;
216 my ($token, $value) = (undef, undef);
218 # Remove leading and trailing white space.
222 # Reverse HTML-encoding
223 # XXX: Seriously imcomplete.
228 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)$/) {
233 $token =~ s@\s\s+@ @g;
234 $token =~ tr/[A-Z]/[a-z]/;
236 } elsif (/^TAG\s*:(.*)$/) {
242 return ($token, $value);
245 sub enlist_new_test ($$$$$$) {
247 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
250 if ($token eq 'set header') {
252 l(LL_FILE_LOADING, "Header to set: " . $value);
253 $type = CLIENT_HEADER_TEST;
255 } elsif ($token eq 'request header') {
257 l(LL_FILE_LOADING, "Header to request: " . $value);
258 $type = SERVER_HEADER_TEST;
259 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
261 } elsif ($token eq 'trusted cgi request') {
263 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
264 $type = TRUSTED_CGI_REQUEST;
265 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
267 } elsif ($token eq 'fetch test') {
269 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
270 $type = DUMB_FETCH_TEST;
271 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
273 } elsif ($token eq 'method test') {
275 l(LL_FILE_LOADING, "Method to test: " . $value);
277 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
279 } elsif ($token eq 'blocked url') {
281 l(LL_FILE_LOADING, "URL to block-test: " . $value);
284 } elsif ($token eq 'url') {
286 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
287 $type = STICKY_ACTIONS_TEST;
291 die "Incomplete '" . $token . "' support detected.";
294 $$regression_tests[$si][$ri]{'type'} = $type;
295 $$regression_tests[$si][$ri]{'level'} = $type;
297 check_for_forbidden_characters($value);
299 $$regression_tests[$si][$ri]{'data'} = $value;
301 # For function that only get passed single tests
302 $$regression_tests[$si][$ri]{'section-id'} = $si;
303 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
304 $$regression_tests[$si][$ri]{'number'} = $number - 1;
306 "Regression test " . $number . " (section:" . $si . "):");
309 sub load_action_files ($) {
313 our @regression_tests;
315 my $actionfiles_ref = shift;
316 my @actionfiles = @{$actionfiles_ref};
318 my $si = 0; # Section index
319 my $ri = -1; # Regression test index
324 l(LL_STATUS, "Gathering regression tests from " .
325 @actionfiles . " action file(s) delivered by Privoxy.");
327 for my $file_number (0 .. @actionfiles - 1) {
329 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
330 my $actionfile = undef;
331 my $sticky_actions = undef;
333 foreach (@{get_cgi_page_or_else($curl_url)}) {
338 if (/<h2>Contents of Actions File (.*?)</) {
342 next unless defined $actionfile;
346 my ($token, $value) = tokenize($_);
348 next unless defined $token;
350 # Load regression tests
352 if (token_starts_new_test($token)) {
354 # Beginning of new regression test.
357 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
360 if ($token =~ /level\s+(\d+)/i) {
363 register_dependency($level, $value);
366 if ($token eq 'sticky actions') {
368 # Will be used by each following Sticky URL.
369 $sticky_actions = $value;
370 if ($sticky_actions =~ /{[^}]*\s/) {
371 log_and_die("'Sticky Actions' with whitespace inside the " .
372 "action parameters are currently unsupported.");
376 if ($si == -1 || $ri == -1) {
377 # No beginning of a test detected yet,
378 # so we don't care about any other test
383 if ($token eq 'expect header') {
385 l(LL_FILE_LOADING, "Detected expectation: " . $value);
386 $regression_tests[$si][$ri]{'expect-header'} = $value;
388 } elsif ($token eq 'tag') {
392 my $tag = parse_tag($value);
394 # We already checked in parse_tag() after filtering
397 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
399 # Save tag for all tests in this section
401 $regression_tests[$si][$ri]{'tag'} = $tag;
407 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
409 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
410 $regression_tests[$si][$ri]{'ignore'} = 1;
413 } elsif ($token eq 'expect status code') {
415 l(LL_FILE_LOADING, "Expecting status code: " . $value);
416 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
418 } elsif ($token eq 'level') { # XXX: stupid name
420 $value =~ s@(\d+).*@$1@;
421 l(LL_FILE_LOADING, "Level: " . $value);
422 $regression_tests[$si][$ri]{'level'} = $value;
424 } elsif ($token eq 'method') {
426 l(LL_FILE_LOADING, "Method: " . $value);
427 $regression_tests[$si][$ri]{'method'} = $value;
429 } elsif ($token eq 'url') {
431 if (defined $sticky_actions) {
432 die "WTF? Attempted to overwrite Sticky Actions"
433 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
435 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
436 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
438 log_and_die("Sticky URL without Sticky Actions: $value");
443 # We don't use it, so we don't need
447 check_for_forbidden_characters($value) unless $no_checks;
448 check_for_forbidden_characters($token);
452 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
453 . " Of which " . $ignored. " will be ignored)\n");
456 ############################################################################
458 # Regression test executing functions
460 ############################################################################
462 sub execute_regression_tests () {
464 our @regression_tests;
465 my $loops = get_cli_option('loops');
467 my $all_failures = 0;
468 my $all_successes = 0;
470 unless (@regression_tests) {
472 l(LL_STATUS, "No regression tests found.");
476 l(LL_STATUS, "Executing regression tests ...");
478 while ($loops-- > 0) {
485 for my $s (0 .. @regression_tests - 1) {
489 while (defined $regression_tests[$s][$r]) {
491 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
492 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
494 my $number = $regression_tests[$s][$r]{'number'};
495 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
497 if (defined $skip_reason) {
499 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
500 log_message($message) if (cli_option_is_set('show-skipped-tests'));
505 my $result = execute_regression_test($regression_tests[$s][$r]);
507 log_result($regression_tests[$s][$r], $result, $tests);
509 $successes += $result;
515 $failures = $tests - $successes;
517 log_message("Executed " . $tests . " regression tests. " .
518 'Skipped ' . $skipped . '. ' .
519 $successes . " successes, " . $failures . " failures.");
521 $all_tests += $tests;
522 $all_failures += $failures;
523 $all_successes += $successes;
526 if (get_cli_option('loops') > 1) {
527 log_message("Total: Executed " . $all_tests . " regression tests. " .
528 $all_successes . " successes, " . $all_failures . " failures.");
532 sub get_skip_reason ($) {
534 my $skip_reason = undef;
536 if ($test->{'ignore'}) {
538 $skip_reason = "Ignore flag is set";
540 } elsif (cli_option_is_set('test-number') and
541 get_cli_option('test-number') != $test->{'number'}) {
543 $skip_reason = "Only executing test " . get_cli_option('test-number');
547 $skip_reason = level_is_unacceptable($test->{'level'});
553 sub level_is_unacceptable ($) {
555 my $min_level = get_cli_option('min-level');
556 my $max_level = get_cli_option('max-level');
557 my $required_level = cli_option_is_set('level') ?
558 get_cli_option('level') : $level;
561 if ($required_level != $level) {
563 $reason = "Level doesn't match (" . $level .
564 " != " . $required_level . ")"
566 } elsif ($level < $min_level) {
568 $reason = "Level to low (" . $level . " < " . $min_level . ")";
570 } elsif ($level > $max_level) {
572 $reason = "Level to high (" . $level . " > " . $max_level . ")";
576 $reason = dependency_unsatisfied($level);
582 sub dependency_unsatisfied ($) {
587 our %privoxy_features;
589 my $dependency_problem = undef;
591 if (defined ($dependencies{$level}{'config line'})) {
593 my $dependency = $dependencies{$level}{'config line'};
594 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
596 foreach (@privoxy_config) {
599 $dependency_problem = undef;
604 } elsif (defined ($dependencies{$level}{'feature status'})) {
606 my $dependency = $dependencies{$level}{'feature status'};
607 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
609 unless (defined($privoxy_features{$feature})
610 and ($privoxy_features{$feature} eq $status))
612 $dependency_problem = "depends on '" . $feature .
613 "' being set to '" . $status . "'";
617 return $dependency_problem;
620 sub register_dependency ($$) {
623 my $dependency = shift;
626 if ($dependency =~ /config line\s+(.*)/) {
628 $dependencies{$level}{'config line'} = $1;
630 } elsif ($dependency =~ /feature status\s+(.*)/) {
632 $dependencies{$level}{'feature status'} = $1;
636 log_and_die("Didn't recognize dependency: $dependency.");
640 # XXX: somewhat misleading name
641 sub execute_regression_test ($) {
643 my $test_ref = shift;
644 my %test = %{$test_ref};
647 if ($test{'type'} == CLIENT_HEADER_TEST) {
649 $result = execute_client_header_regression_test($test_ref);
651 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
653 $result = execute_server_header_regression_test($test_ref);
655 } elsif ($test{'type'} == DUMB_FETCH_TEST
656 or $test{'type'} == TRUSTED_CGI_REQUEST) {
658 $result = execute_dumb_fetch_test($test_ref);
660 } elsif ($test{'type'} == METHOD_TEST) {
662 $result = execute_method_test($test_ref);
664 } elsif ($test{'type'} == BLOCK_TEST) {
666 $result = execute_block_test($test_ref);
668 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
670 $result = execute_sticky_actions_test($test_ref);
674 die "Unsupported test type detected: " . $test{'type'};
680 sub execute_method_test ($) {
682 my $test_ref = shift;
683 my %test = %{$test_ref};
686 my $method = $test{'data'};
688 my $curl_parameters = '';
689 my $expected_status_code = $test{'expected-status-code'};
691 $curl_parameters .= '--request ' . $method . ' ';
692 # Don't complain about the 'missing' body
693 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
695 $curl_parameters .= PRIVOXY_CGI_URL;
697 $buffer_ref = get_page_with_curl($curl_parameters);
698 $status_code = get_status_code($buffer_ref);
700 return check_status_code_result($status_code, $expected_status_code);
703 sub execute_dumb_fetch_test ($) {
705 my $test_ref = shift;
706 my %test = %{$test_ref};
710 my $curl_parameters = '';
711 my $expected_status_code = $test{'expected-status-code'};
713 if (defined $test{method}) {
714 $curl_parameters .= '--request ' . $test{method} . ' ';
716 if ($test{type} == TRUSTED_CGI_REQUEST) {
717 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
720 $curl_parameters .= $test{'data'};
722 $buffer_ref = get_page_with_curl($curl_parameters);
723 $status_code = get_status_code($buffer_ref);
725 return check_status_code_result($status_code, $expected_status_code);
728 sub execute_block_test ($) {
731 my $url = $test->{'data'};
732 my $final_results = get_final_results($url);
734 return defined $final_results->{'+block'};
737 sub execute_sticky_actions_test ($) {
740 my $url = $test->{'data'};
741 my $verified_actions = 0;
742 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
743 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
744 my $final_results = get_final_results($url);
746 foreach my $sticky_action (@sticky_actions) {
748 if (defined $final_results->{$sticky_action}) {
752 } elsif ($sticky_action =~ /-.*\{/) {
754 # Disabled multi actions aren't explicitly listed as
755 # disabled and thus have to be checked by verifying
756 # that they aren't enabled.
760 l(LL_VERBOSE_FAILURE,
761 "Ooops. '$sticky_action' is not among the final results.");
765 return $verified_actions == @sticky_actions;
768 sub get_final_results ($) {
771 my $curl_parameters = '';
772 my %final_results = ();
773 my $final_results_reached = 0;
775 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
776 # XXX: should be URL-encoded properly
783 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
785 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
787 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
789 next unless ($final_results_reached);
792 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
796 if (defined $parameter) {
797 # In case the caller needs to check
798 # the action and its parameter
799 $final_results{$action . $parameter} = 1;
801 # In case the action doesn't have parameters
802 # or the caller doesn't care for the parameter.
803 $final_results{$action} = 1;
807 return \%final_results;
810 sub check_status_code_result ($$) {
812 my $status_code = shift;
813 my $expected_status_code = shift;
816 unless (defined $status_code) {
818 # XXX: should probably be caught earlier.
819 l(LL_VERBOSE_FAILURE,
820 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
822 } elsif ($expected_status_code == $status_code) {
825 l(LL_VERBOSE_SUCCESS,
826 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
828 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
830 l(LL_VERBOSE_FAILURE,
831 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
835 l(LL_VERBOSE_FAILURE,
836 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
842 sub execute_client_header_regression_test ($) {
844 my $test_ref = shift;
848 $buffer_ref = get_show_request_with_curl($test_ref);
850 $header = get_header($buffer_ref, $test_ref);
852 return check_header_result($test_ref, $header);
855 sub execute_server_header_regression_test ($) {
857 my $test_ref = shift;
861 $buffer_ref = get_head_with_curl($test_ref);
863 $header = get_server_header($buffer_ref, $test_ref);
865 return check_header_result($test_ref, $header);
868 sub interpret_result ($) {
870 return $success ? "Success" : "Failure";
873 sub check_header_result ($$) {
875 my $test_ref = shift;
878 my %test = %{$test_ref};
879 my $expect_header = $test{'expect-header'};
882 if ($expect_header eq 'NO CHANGE') {
884 if (defined($header) and $header eq $test{'data'}) {
890 $header = "REMOVAL" unless defined $header;
891 l(LL_VERBOSE_FAILURE,
892 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
895 } elsif ($expect_header eq 'REMOVAL') {
897 if (defined($header) and $header eq $test{'data'}) {
899 l(LL_VERBOSE_FAILURE,
900 "Ooops. Expected removal but: '" . $header . "' is still there.");
904 # XXX: Use more reliable check here and make sure
905 # the header has a different name.
909 } elsif ($expect_header eq 'SOME CHANGE') {
911 if (defined($header) and not $header eq $test{'data'}) {
917 $header = "REMOVAL" unless defined $header;
918 l(LL_VERBOSE_FAILURE,
919 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
924 if (defined($header) and $header eq $expect_header) {
930 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
931 l(LL_VERBOSE_FAILURE,
932 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
938 sub get_header_name ($) {
942 $header =~ s@(.*?: ).*@$1@;
947 sub get_header ($$) {
949 our $filtered_request = '';
951 my $buffer_ref = shift;
952 my $test_ref = shift;
954 my %test = %{$test_ref};
955 my @buffer = @{$buffer_ref};
957 my $expect_header = $test{'expect-header'};
959 die "get_header called with no expect header" unless defined $expect_header;
962 my $processed_request_reached = 0;
964 my $processed_request = '';
968 if ($expect_header eq 'REMOVAL'
969 or $expect_header eq 'NO CHANGE'
970 or $expect_header eq 'SOME CHANGE') {
972 $expect_header = $test{'data'};
975 $header_to_get = get_header_name($expect_header);
979 # Skip everything before the Processed request
980 if (/Processed Request/) {
981 $processed_request_reached = 1;
984 next unless $processed_request_reached;
986 # End loop after the Processed request
989 # Ditch tags and leading/trailing white space.
993 # Decode characters we care about.
996 $filtered_request .= "\n" . $_;
998 if (/^$header_to_get/) {
1008 sub get_server_header ($$) {
1010 my $buffer_ref = shift;
1011 my $test_ref = shift;
1013 my %test = %{$test_ref};
1014 my @buffer = @{$buffer_ref};
1016 my $expect_header = $test{'expect-header'};
1020 # XXX: Should be caught before starting to test.
1021 log_and_die("No expect header for test " . $test{'number'})
1022 unless defined $expect_header;
1024 if ($expect_header eq 'REMOVAL'
1025 or $expect_header eq 'NO CHANGE'
1026 or $expect_header eq 'SOME CHANGE') {
1028 $expect_header = $test{'data'};
1031 $header_to_get = get_header_name($expect_header);
1035 # XXX: should probably verify that the request
1036 # was actually answered by Fellatio.
1037 if (/^$header_to_get/) {
1039 $header =~ s@\s*$@@g;
1047 sub get_status_code ($) {
1049 my $buffer_ref = shift;
1050 my @buffer = @{$buffer_ref};
1054 if (/^HTTP\/\d\.\d (\d{3})/) {
1060 return '123' if cli_option_is_set('fuzzer-feeding');
1062 log_and_die('Unexpected buffer line: "' . $_ . '"');
1067 sub get_test_keys () {
1068 return ('tag', 'data', 'expect-header', 'ignore');
1072 sub test_content_as_string ($) {
1074 my $test_ref = shift;
1075 my %test = %{$test_ref};
1079 foreach my $key (get_test_keys()) {
1080 $test{$key} = 'Not set' unless (defined $test{$key});
1083 $s .= 'Tag: ' . $test{'tag'};
1085 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1087 $s .= 'Expected header: ' . $test{'expect-header'};
1089 $s .= 'Ignore: ' . $test{'ignore'};
1094 sub fuzz_header($) {
1096 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1098 $white_space = $white_space x (1 + int(rand(5)));
1100 # Only fuzz white space before the first quoted token.
1101 # (Privoxy doesn't touch white space inside quoted tokens
1102 # and modifying it would cause the tests to fail).
1103 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1108 ############################################################################
1110 # HTTP fetch functions
1112 ############################################################################
1114 sub check_for_curl () {
1116 log_and_die("No curl found.") unless (`which $curl`);
1119 sub get_cgi_page_or_else ($) {
1121 my $cgi_url = shift;
1122 my $content_ref = get_page_with_curl($cgi_url);
1123 my $status_code = get_status_code($content_ref);
1125 if (200 != $status_code) {
1127 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1128 "Received status code ". $status_code .
1129 " while only 200 is acceptable.";
1131 if (cli_option_is_set('fuzzer-feeding')) {
1133 $log_message .= " Ignored due to fuzzer feeding.";
1134 l(LL_SOFT_ERROR, $log_message)
1138 log_and_die($log_message);
1142 return $content_ref;
1145 # XXX: misleading name
1146 sub get_show_request_with_curl ($) {
1148 our $privoxy_cgi_url;
1149 my $test_ref = shift;
1150 my %test = %{$test_ref};
1152 my $curl_parameters = ' ';
1153 my $header = $test{'data'};
1155 if (cli_option_is_set('header-fuzzing')) {
1156 $header = fuzz_header($header);
1159 # Enable the action to test
1160 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1161 # The header to filter
1162 $curl_parameters .= '-H \'' . $header . '\' ';
1164 $curl_parameters .= ' ';
1165 $curl_parameters .= $privoxy_cgi_url;
1166 $curl_parameters .= 'show-request';
1168 return get_cgi_page_or_else($curl_parameters);
1171 sub get_head_with_curl ($) {
1173 our $fellatio_url = FELLATIO_URL;
1174 my $test_ref = shift;
1175 my %test = %{$test_ref};
1177 my $curl_parameters = ' ';
1179 # Enable the action to test
1180 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1181 # The header to filter
1182 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1183 $curl_parameters .= '--head ';
1185 $curl_parameters .= ' ';
1186 $curl_parameters .= $fellatio_url;
1188 return get_page_with_curl($curl_parameters);
1191 sub get_page_with_curl ($) {
1195 my $parameters = shift;
1197 my $curl_line = CURL;
1198 my $retries_left = get_cli_option('retries') + 1;
1201 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1203 # We want to see the HTTP status code
1204 $curl_line .= " --include ";
1205 # Let Privoxy emit two log messages less.
1206 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1207 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1208 # We don't care about fetch statistic.
1209 $curl_line .= " -s ";
1210 # We do care about the failure reason if any.
1211 $curl_line .= " -S ";
1212 # We want to advertise ourselves
1213 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1214 # We aren't too patient
1215 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1217 $curl_line .= $parameters;
1218 # XXX: still necessary?
1219 $curl_line .= ' 2>&1';
1221 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1224 @buffer = `$curl_line`;
1227 $failure_reason = array_as_string(\@buffer);
1228 chomp $failure_reason;
1229 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1231 } while ($? && --$retries_left);
1233 unless ($retries_left) {
1234 log_and_die("Running curl failed " . get_cli_option('retries') .
1235 " times in a row. Last error: '" . $failure_reason . "'.");
1242 ############################################################################
1246 ############################################################################
1248 sub array_as_string ($) {
1249 my $array_ref = shift;
1252 foreach (@{$array_ref}) {
1260 my $test_ref = shift;
1261 log_message('Test is:' . test_content_as_string($test_ref));
1267 my $this_level = shift;
1268 my $message = shift;
1270 log_message($message) if ($log_level & $this_level);
1273 sub log_and_die ($) {
1274 my $message = shift;
1276 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1280 sub log_message ($) {
1282 my $message = shift;
1286 our $leading_log_date;
1287 our $leading_log_time;
1289 my $time_stamp = '';
1290 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1292 if ($leading_log_date || $leading_log_time) {
1294 if ($leading_log_date) {
1297 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1300 if ($leading_log_time) {
1301 $time_stamp .= ' ' if $leading_log_date;
1302 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1305 $message = $time_stamp . ": " . $message;
1308 printf(STDERR "%s\n", $message);
1311 sub log_result ($$) {
1313 our $verbose_test_description;
1314 our $filtered_request;
1316 my $test_ref = shift;
1320 my %test = %{$test_ref};
1323 $message .= interpret_result($result);
1324 $message .= " for test ";
1325 $message .= $number;
1327 $message .= $test{'number'};
1329 $message .= $test{'section-id'};
1331 $message .= $test{'regression-test-id'};
1334 if ($verbose_test_description) {
1336 if ($test{'type'} == CLIENT_HEADER_TEST) {
1338 $message .= ' Header ';
1339 $message .= quote($test{'data'});
1340 $message .= ' and tag ';
1341 $message .= quote($test{'tag'});
1343 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1345 $message .= ' Request Header ';
1346 $message .= quote($test{'data'});
1347 $message .= ' and tag ';
1348 $message .= quote($test{'tag'});
1350 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1352 $message .= ' URL ';
1353 $message .= quote($test{'data'});
1354 $message .= ' and expected status code ';
1355 $message .= quote($test{'expected-status-code'});
1357 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1359 $message .= ' CGI URL ';
1360 $message .= quote($test{'data'});
1361 $message .= ' and expected status code ';
1362 $message .= quote($test{'expected-status-code'});
1364 } elsif ($test{'type'} == METHOD_TEST) {
1366 $message .= ' HTTP method ';
1367 $message .= quote($test{'data'});
1368 $message .= ' and expected status code ';
1369 $message .= quote($test{'expected-status-code'});
1371 } elsif ($test{'type'} == BLOCK_TEST) {
1373 $message .= ' Supposedly-blocked URL: ';
1374 $message .= quote($test{'data'});
1376 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1378 $message .= ' Sticky Actions: ';
1379 $message .= quote($test{'sticky-actions'});
1380 $message .= ' and URL: ';
1381 $message .= quote($test{'data'});
1385 die "Incomplete support for test type " . $test{'type'} . " detected.";
1389 log_message($message) if (!$result or cli_option_is_set('verbose'));
1394 return '\'' . $s . '\'';
1397 sub print_version () {
1398 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1409 Options and their default values if they have any:
1410 [--debug $cli_options{'debug'}]
1411 [--forks $cli_options{'forks'}]
1417 [--loops $cli_options{'loops'}]
1418 [--max-level $cli_options{'max-level'}]
1419 [--max-time $cli_options{'max-time'}]
1420 [--min-level $cli_options{'min-level'}]
1422 [--retries $cli_options{'retries'}]
1423 [--show-skipped-tests]
1427 see "perldoc $0" for more information
1433 sub init_cli_options () {
1438 $cli_options{'debug'} = $log_level;
1439 $cli_options{'forks'} = CLI_FORKS;
1440 $cli_options{'loops'} = CLI_LOOPS;
1441 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1442 $cli_options{'max-time'} = CLI_MAX_TIME;
1443 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1444 $cli_options{'retries'} = CLI_RETRIES;
1447 sub parse_cli_options () {
1455 'debug=s' => \$cli_options{'debug'},
1456 'forks=s' => \$cli_options{'forks'},
1457 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1458 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1459 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1460 'help' => sub {help},
1461 'level=s' => \$cli_options{'level'},
1462 'loops=s' => \$cli_options{'loops'},
1463 'max-level=s' => \$cli_options{'max-level'},
1464 'max-time=s' => \$cli_options{'max-time'},
1465 'min-level=s' => \$cli_options{'min-level'},
1466 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1467 'retries=s' => \$cli_options{'retries'},
1468 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1469 'test-number=s' => \$cli_options{'test-number'},
1470 'verbose' => \$cli_options{'verbose'},
1471 'version' => sub {print_version && exit(0)}
1473 $log_level |= $cli_options{'debug'};
1476 sub cli_option_is_set ($) {
1479 my $cli_option = shift;
1481 return defined $cli_options{$cli_option};
1484 sub get_cli_option ($) {
1487 my $cli_option = shift;
1489 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1491 return $cli_options{$cli_option};
1494 sub init_proxy_settings($) {
1499 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1500 $proxy = get_cli_option('fuzzer-address');
1503 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1505 if (cli_option_is_set('privoxy-address')) {
1506 $proxy .= get_cli_option('privoxy-address');
1511 sub start_forks($) {
1514 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1516 foreach my $fork (1 .. $forks) {
1517 log_message("Starting fork $fork");
1519 if (defined $pid && !$pid) {
1527 init_our_variables();
1528 parse_cli_options();
1530 init_proxy_settings('vanilla-proxy');
1531 load_regressions_tests();
1532 init_proxy_settings('fuzz-proxy');
1533 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1534 execute_regression_tests();
1541 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1545 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1546 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1547 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1548 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1549 [B<--retries retries>] [B<--test-number test-number>]
1550 [B<--show-skipped-tests>] [B<--verbose>]
1555 Privoxy-Regression-Test is supposed to one day become
1556 a regression test suite for Privoxy. It's not quite there
1557 yet, however, and can currently only test header actions,
1558 check the returned status code for requests to arbitrary
1559 URLs and verify which actions are applied to them.
1561 Client header actions are tested by requesting
1562 B<http://p.p/show-request> and checking whether
1563 or not Privoxy modified the original request as expected.
1565 The original request contains both the header the action-to-be-tested
1566 acts upon and an additional tagger-triggering header that enables
1569 Applied actions are checked through B<http://p.p/show-url-info>.
1571 =head1 CONFIGURATION FILE SYNTAX
1573 Privoxy-Regression-Test's configuration is embedded in
1574 Privoxy action files and loaded through Privoxy's web interface.
1576 It makes testing a Privoxy version running on a remote system easier
1577 and should prevent you from updating your tests without updating Privoxy's
1578 configuration accordingly.
1580 A client-header-action test section looks like this:
1582 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1583 # Expect Header = Referer: http://www.example.org/
1584 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1585 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1587 The example above causes Privoxy-Regression-Test to set
1588 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1589 and to expect it to be modified to
1590 B<Referer: http://www.example.org/>.
1592 When testing this section, Privoxy-Regression-Test will set the header
1593 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1594 causing the B<privoxy-control> tagger to create the tag
1595 B<client-header-filter{hide-tor-exit-notation}> which will finally
1596 cause Privoxy to enable the action section.
1598 Note that the actions itself are only used by Privoxy,
1599 Privoxy-Regression-Test ignores them and will be happy
1600 as long as the expectations are satisfied.
1602 A fetch test looks like this:
1604 # Fetch Test = http://p.p/user-manual
1605 # Expect Status Code = 302
1607 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1608 and to expect a response with the HTTP status code B<302>. Obviously that's
1609 not a very thorough test and mainly useful to get some code coverage
1610 for Valgrind or to verify that the templates are installed correctly.
1612 If you want to test CGI pages that require a trusted
1613 referer, you can use:
1615 # Trusted CGI Request = http://p.p/edit-actions
1617 It works like ordinary fetch tests, but sets the referer
1618 header to a trusted value.
1620 If no explicit status code expectation is set, B<200> is used.
1622 To verify that a URL is blocked, use:
1624 # Blocked URL = http://www.example.com/blocked
1626 To verify that a specific set of actions is applied to an URL, use:
1628 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1629 # URL = http://www.example.org/my-first-url
1631 The sticky actions will be checked for all URLs below it
1632 until the next sticky actions directive.
1636 All tests have test levels to let the user
1637 control which ones to execute (see I<OPTIONS> below).
1638 Test levels are either set with the B<Level> directive,
1639 or implicitly through the test type.
1641 Block tests default to level 7, fetch tests to level 6,
1642 "Sticky Actions" tests default to level 5, tests for trusted CGI
1643 requests to level 3 and client-header-action tests to level 1.
1647 B<--debug bitmask> Add the bitmask provided as integer
1648 to the debug settings.
1650 B<--forks forks> Number of forks to start before executing
1651 the regression tests. This is mainly useful for stress-testing.
1653 B<--fuzzer-address> Listening address used when executing
1654 the regression tests. Useful to make sure that the requests
1655 to load the regression tests don't fail due to fuzzing.
1657 B<--fuzzer-feeding> Ignore some errors that would otherwise
1658 cause Privoxy-Regression-Test to abort the test because
1659 they shouldn't happen in normal operation. This option is
1660 intended to be used if Privoxy-Regression-Test is only
1661 used to feed a fuzzer in which case there's a high chance
1662 that Privoxy gets an invalid request and returns an error
1665 B<--help> Shows available command line options.
1667 B<--header-fuzzing> Modifies linear white space in
1668 headers in a way that should not affect the test result.
1670 B<--level level> Only execute tests with the specified B<level>.
1672 B<--loop count> Loop through the regression tests B<count> times.
1673 Useful to feed a fuzzer, or when doing stress tests with
1674 several Privoxy-Regression-Test instances running at the same
1677 B<--max-level max-level> Only execute tests with a B<level>
1678 below or equal to the numerical B<max-level>.
1680 B<--max-time max-time> Give Privoxy B<max-time> seconds
1681 to return data. Increasing the default may make sense when
1682 Privoxy is run through Valgrind, decreasing the default may
1683 make sense when Privoxy-Regression-Test is used to feed
1686 B<--min-level min-level> Only execute tests with a B<level>
1687 above or equal to the numerical B<min-level>.
1689 B<--privoxy-address proxy-address> Privoxy's listening address.
1690 If it's not set, the value of the environment variable http_proxy
1691 will be used. B<proxy-address> has to be specified in http_proxy
1694 B<--retries retries> Retry B<retries> times.
1696 B<--test-number test-number> Only run the test with the specified
1699 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1701 B<--verbose> Log succesful tests as well. By default only
1702 the failures are logged.
1704 B<--version> Print version and exit.
1706 The second dash is optional, options can be shortened,
1707 as long as there are no ambiguities.
1709 =head1 PRIVOXY CONFIGURATION
1711 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1712 which aims to test all official client-header modifying actions
1713 and can be used to verify that the templates and the user manual
1714 files are installed correctly.
1716 To use it, it has to be copied in Privoxy's configuration
1717 directory, and afterwards referenced in Privoxy's configuration
1720 actionsfile regression-tests.action
1722 In general, its tests are supposed to work without changing
1723 any other action files, unless you already added lots of
1724 taggers yourself. If you are using taggers that cause problems,
1725 you might have to temporary disable them for Privoxy's CGI pages.
1727 Some of the regression tests rely on Privoxy features that
1728 may be disabled in your configuration. Tests with a level below
1729 7 are supposed to work with all Privoxy configurations (provided
1730 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1732 Tests with level 9 require Privoxy to deliver the User Manual,
1733 tests with level 12 require the CGI editor to be enabled.
1737 Expect the configuration file syntax to change with future releases.
1741 As Privoxy's B<show-request> page only shows client headers,
1742 Privoxy-Regression-Test can't use it to test Privoxy actions
1743 that modify server headers.
1745 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1746 control the actions to test, it currently only works with
1747 Privoxy 3.0.7 or later.
1749 At the moment Privoxy-Regression-Test fetches Privoxy's
1750 configuration page through I<curl>(1), therefore you have to
1751 have I<curl> installed, otherwise you won't be able to run
1752 Privoxy-Regression-Test in a meaningful way.
1760 Fabian Keil <fk@fabiankeil.de>