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.147 2008/05/04 18:17:45 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 # - Add option to fork regression tests and run them in parallel,
20 # possibly optional forever.
21 # - Document magic Expect Header values
22 # - Internal fuzz support?
24 # Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
26 # Permission to use, copy, modify, and distribute this software for any
27 # purpose with or without fee is hereby granted, provided that the above
28 # copyright notice and this permission notice appear in all copies.
30 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
31 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
32 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
33 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
35 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
36 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
38 ############################################################################
45 PRT_VERSION => 'Privoxy-Regression-Test 0.2',
56 PRIVOXY_CGI_URL => 'http://p.p/',
57 FELLATIO_URL => 'http://10.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,
64 VERBOSE_TEST_DESCRIPTION => 1,
66 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
67 # XXX: Only partly implemented and mostly useless.
68 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
69 DEBUG_LEVEL_STATUS => 1,
71 # Internal use, don't modify
72 # Available debug bits:
74 LL_VERBOSE_FAILURE => 2,
75 LL_PAGE_FETCHING => 4,
77 LL_VERBOSE_SUCCESS => 16,
81 CLIENT_HEADER_TEST => 1,
82 SERVER_HEADER_TEST => 2,
85 STICKY_ACTIONS_TEST => 5,
86 TRUSTED_CGI_REQUEST => 6,
90 sub init_our_variables () {
92 our $leading_log_time = LEADING_LOG_TIME;
93 our $leading_log_date = LEADING_LOG_DATE;
95 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
97 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
99 our $log_level = get_default_log_level();
103 sub get_default_log_level () {
107 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
108 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
109 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
110 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
111 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
113 # These are intended to be always on.
114 $log_level |= LL_SOFT_ERROR;
115 $log_level |= LL_ERROR;
120 ############################################################################
122 # File loading functions
124 ############################################################################
132 # Unescape brackets and dots
133 $tag =~ s@\\(?=[{}().+])@@g;
135 # log_message("Parsed tag: " . $tag);
137 check_for_forbidden_characters($tag);
142 sub check_for_forbidden_characters ($) {
144 my $tag = shift; # XXX: also used to check values though.
145 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
147 unless ($tag =~ m/^$allowed*$/) {
148 my $forbidden = $tag;
149 $forbidden =~ s@^$allowed*(.).*@$1@;
151 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
155 sub load_regressions_tests () {
157 our $privoxy_cgi_url;
163 $curl_url .= $privoxy_cgi_url;
164 $curl_url .= 'show-status';
166 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
168 foreach (@{get_cgi_page_or_else($curl_url)}) {
171 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
173 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
174 $actionfiles[$file_number++] = $url;
176 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
178 my $directive = $1 . " " . $2;
179 push (@privoxy_config, $directive);
183 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
185 load_action_files(\@actionfiles);
188 sub token_starts_new_test ($) {
191 my @new_test_directives = ('set header', 'fetch test',
192 'trusted cgi request', 'request header', 'method test',
193 'blocked url', 'url');
195 foreach my $new_test_directive (@new_test_directives) {
196 return 1 if $new_test_directive eq $token;
204 my ($token, $value) = (undef, undef);
206 # Remove leading and trailing white space.
210 # Reverse HTML-encoding
211 # XXX: Seriously imcomplete.
216 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
221 $token =~ s@\s\s+@ @g;
222 $token =~ tr/[A-Z]/[a-z]/;
224 } elsif (/^TAG\s*:(.*)$/) {
231 return ($token, $value);
234 sub enlist_new_test ($$$$$$) {
236 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
239 if ($token eq 'set header') {
241 l(LL_FILE_LOADING, "Header to set: " . $value);
242 $type = CLIENT_HEADER_TEST;
244 } elsif ($token eq 'request header') {
246 l(LL_FILE_LOADING, "Header to request: " . $value);
247 $type = SERVER_HEADER_TEST;
248 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
250 } elsif ($token eq 'trusted cgi request') {
252 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
253 $type = TRUSTED_CGI_REQUEST;
254 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
256 } elsif ($token eq 'fetch test') {
258 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
259 $type = DUMB_FETCH_TEST;
260 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
262 } elsif ($token eq 'method test') {
264 l(LL_FILE_LOADING, "Method to test: " . $value);
266 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
268 } elsif ($token eq 'blocked url') {
270 l(LL_FILE_LOADING, "URL to block-test: " . $value);
273 } elsif ($token eq 'url') {
275 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
276 $type = STICKY_ACTIONS_TEST;
280 die "Incomplete '" . $token . "' support detected.";
284 $$regression_tests[$si][$ri]{'type'} = $type;
285 $$regression_tests[$si][$ri]{'level'} = $type;
287 check_for_forbidden_characters($value);
289 $$regression_tests[$si][$ri]{'data'} = $value;
291 # For function that only get passed single tests
292 $$regression_tests[$si][$ri]{'section-id'} = $si;
293 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
294 $$regression_tests[$si][$ri]{'number'} = $number - 1;
296 "Regression test " . $number . " (section:" . $si . "):");
299 sub load_action_files ($) {
303 our @regression_tests;
305 my $actionfiles_ref = shift;
306 my @actionfiles = @{$actionfiles_ref};
308 my $si = 0; # Section index
309 my $ri = -1; # Regression test index
314 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
316 for my $file_number (0 .. @actionfiles - 1) {
318 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
319 my $actionfile = undef;
320 my $sticky_actions = undef;
322 foreach (@{get_cgi_page_or_else($curl_url)}) {
327 if (/<h2>Contents of Actions File (.*?)</) {
331 next unless defined $actionfile;
335 my ($token, $value) = tokenize($_);
337 next unless defined $token;
339 # Load regression tests
341 if (token_starts_new_test($token)) {
343 # Beginning of new regression test.
346 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
349 if ($token =~ /level\s+(\d+)/i) {
352 register_dependency($level, $value);
355 if ($token eq 'sticky actions') {
357 # Will be used by each following Sticky URL.
358 $sticky_actions = $value;
359 if ($sticky_actions =~ /{[^}]*\s/) {
361 "'Sticky Actions' with whitespace inside the " .
362 "action parameters are currently unsupported.");
366 if ($si == -1 || $ri == -1) {
367 # No beginning of a test detected yet,
368 # so we don't care about any other test
373 if ($token eq 'expect header') {
375 l(LL_FILE_LOADING, "Detected expectation: " . $value);
376 $regression_tests[$si][$ri]{'expect-header'} = $value;
378 } elsif ($token eq 'tag') {
382 my $tag = parse_tag($value);
384 # We already checked in parse_tag() after filtering
387 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
389 # Save tag for all tests in this section
391 $regression_tests[$si][$ri]{'tag'} = $tag;
397 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
399 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
400 $regression_tests[$si][$ri]{'ignore'} = 1;
403 } elsif ($token eq 'expect status code') {
405 l(LL_FILE_LOADING, "Expecting status code: " . $value);
406 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
408 } elsif ($token eq 'level') { # XXX: stupid name
410 $value =~ s@(\d+).*@$1@;
411 l(LL_FILE_LOADING, "Level: " . $value);
412 $regression_tests[$si][$ri]{'level'} = $value;
414 } elsif ($token eq 'method') {
416 l(LL_FILE_LOADING, "Method: " . $value);
417 $regression_tests[$si][$ri]{'method'} = $value;
419 } elsif ($token eq 'url') {
421 if (defined $sticky_actions) {
422 die "WTF? Attempted to overwrite Sticky Actions"
423 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
425 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
426 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
428 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
433 # We don't use it, so we don't need
437 check_for_forbidden_characters($value) unless $no_checks;
438 check_for_forbidden_characters($token);
442 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
443 . " Of which " . $ignored. " will be ignored)\n");
446 ############################################################################
448 # Regression test executing functions
450 ############################################################################
452 sub execute_regression_tests () {
454 our @regression_tests;
455 my $loops = get_cli_option('loops');
457 my $all_failures = 0;
458 my $all_successes = 0;
460 unless (@regression_tests) {
462 l(LL_STATUS, "No regression tests found.");
466 l(LL_STATUS, "Executing regression tests ...");
468 while ($loops-- > 0) {
475 for my $s (0 .. @regression_tests - 1) {
479 while (defined $regression_tests[$s][$r]) {
481 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
482 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
484 my $number = $regression_tests[$s][$r]{'number'};
486 if ($regression_tests[$s][$r]{'ignore'}
487 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
488 or test_number_is_unacceptable($number)) {
494 my $result = execute_regression_test($regression_tests[$s][$r]);
496 log_result($regression_tests[$s][$r], $result, $tests);
498 $successes += $result;
504 $failures = $tests - $successes;
506 log_message("Executed " . $tests . " regression tests. " .
507 'Skipped ' . $skipped . '. ' .
508 $successes . " successes, " . $failures . " failures.");
510 $all_tests += $tests;
511 $all_failures += $failures;
512 $all_successes += $successes;
516 if (get_cli_option('loops') > 1) {
517 log_message("Total: Executed " . $all_tests . " regression tests. " .
518 $all_successes . " successes, " . $all_failures . " failures.");
522 sub level_is_unacceptable ($) {
524 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
525 or ($level < get_cli_option('min-level'))
526 or ($level > get_cli_option('max-level'))
527 or dependency_unsatisfied($level)
531 sub test_number_is_unacceptable ($) {
532 my $test_number = shift;
533 return (cli_option_is_set('test-number')
534 and get_cli_option('test-number') != $test_number)
537 sub dependency_unsatisfied ($) {
542 my $dependency_problem = 0;
544 if (defined ($dependencies{$level}{'config line'})) {
546 my $dependency = $dependencies{$level}{'config line'};
547 $dependency_problem = 1;
549 foreach (@privoxy_config) {
551 $dependency_problem = 0 if (/$dependency/);
555 return $dependency_problem;
558 sub register_dependency ($$) {
561 my $dependency = shift;
564 if ($dependency =~ /config line\s+(.*)/) {
566 $dependencies{$level}{'config line'} = $1;
570 # XXX: somewhat misleading name
571 sub execute_regression_test ($) {
573 my $test_ref = shift;
574 my %test = %{$test_ref};
577 if ($test{'type'} == CLIENT_HEADER_TEST) {
579 $result = execute_client_header_regression_test($test_ref);
581 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
583 $result = execute_server_header_regression_test($test_ref);
585 } elsif ($test{'type'} == DUMB_FETCH_TEST
586 or $test{'type'} == TRUSTED_CGI_REQUEST) {
588 $result = execute_dumb_fetch_test($test_ref);
590 } elsif ($test{'type'} == METHOD_TEST) {
592 $result = execute_method_test($test_ref);
594 } elsif ($test{'type'} == BLOCK_TEST) {
596 $result = execute_block_test($test_ref);
598 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
600 $result = execute_sticky_actions_test($test_ref);
604 die "Unsupported test type detected: " . $test{'type'};
611 sub execute_method_test ($) {
613 my $test_ref = shift;
614 my %test = %{$test_ref};
617 my $method = $test{'data'};
619 my $curl_parameters = '';
620 my $expected_status_code = $test{'expected-status-code'};
622 $curl_parameters .= '--request ' . $method . ' ';
623 # Don't complain about the 'missing' body
624 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
626 $curl_parameters .= PRIVOXY_CGI_URL;
628 $buffer_ref = get_page_with_curl($curl_parameters);
629 $status_code = get_status_code($buffer_ref);
631 return check_status_code_result($status_code, $expected_status_code);
634 sub execute_dumb_fetch_test ($) {
636 my $test_ref = shift;
637 my %test = %{$test_ref};
641 my $curl_parameters = '';
642 my $expected_status_code = $test{'expected-status-code'};
644 if (defined $test{method}) {
645 $curl_parameters .= '--request ' . $test{method} . ' ';
647 if ($test{type} == TRUSTED_CGI_REQUEST) {
648 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
651 $curl_parameters .= $test{'data'};
653 $buffer_ref = get_page_with_curl($curl_parameters);
654 $status_code = get_status_code($buffer_ref);
656 return check_status_code_result($status_code, $expected_status_code);
659 sub execute_block_test ($) {
662 my $url = $test->{'data'};
663 my $final_results = get_final_results($url);
665 return defined $final_results->{'+block'};
668 sub execute_sticky_actions_test ($) {
671 my $url = $test->{'data'};
672 my $verified_actions = 0;
673 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
674 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
675 my $final_results = get_final_results($url);
677 foreach my $sticky_action (@sticky_actions) {
678 if (defined $final_results->{$sticky_action}) {
681 }elsif ($sticky_action =~ /-.*\{/ and
682 not defined $final_results->{$sticky_action}) {
683 # Disabled multi actions aren't explicitly listed as
684 # disabled and thus have to be checked by verifying
685 # that they aren't enabled.
688 l(LL_VERBOSE_FAILURE,
689 "Ooops. '$sticky_action' is not among the final results.");
693 return $verified_actions == @sticky_actions;
696 sub get_final_results ($) {
699 my $curl_parameters = '';
700 my %final_results = ();
701 my $final_results_reached = 0;
703 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
704 # XXX: should be URL-encoded properly
711 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
713 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
715 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
717 next unless ($final_results_reached);
720 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
724 if (defined $parameter) {
725 # In case the caller needs to check
726 # the action and its parameter
727 $final_results{$action . $parameter} = 1;
729 # In case the action doesn't have parameters
730 # or the caller doesn't care for the parameter.
731 $final_results{$action} = 1;
735 return \%final_results;
738 sub check_status_code_result ($$) {
740 my $status_code = shift;
741 my $expected_status_code = shift;
744 if ($expected_status_code == $status_code) {
747 l(LL_VERBOSE_SUCCESS,
748 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
750 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
752 l(LL_VERBOSE_FAILURE,
753 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
757 l(LL_VERBOSE_FAILURE,
758 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
765 sub execute_client_header_regression_test ($) {
767 my $test_ref = shift;
771 $buffer_ref = get_show_request_with_curl($test_ref);
773 $header = get_header($buffer_ref, $test_ref);
775 return check_header_result($test_ref, $header);
778 sub execute_server_header_regression_test ($) {
780 my $test_ref = shift;
784 $buffer_ref = get_head_with_curl($test_ref);
786 $header = get_server_header($buffer_ref, $test_ref);
788 return check_header_result($test_ref, $header);
792 sub interpret_result ($) {
794 return $success ? "Success" : "Failure";
797 sub check_header_result ($$) {
799 my $test_ref = shift;
802 my %test = %{$test_ref};
803 my $expect_header = $test{'expect-header'};
806 $header =~ s@ @ @g if defined($header);
808 if ($expect_header eq 'NO CHANGE') {
810 if (defined($header) and $header eq $test{'data'}) {
816 $header = "REMOVAL" unless defined $header;
817 l(LL_VERBOSE_FAILURE,
818 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
821 } elsif ($expect_header eq 'REMOVAL') {
823 if (defined($header) and $header eq $test{'data'}) {
825 l(LL_VERBOSE_FAILURE,
826 "Ooops. Expected removal but: " . $header . " is still there.");
830 # XXX: Use more reliable check here and make sure
831 # the header has a different name.
836 } elsif ($expect_header eq 'SOME CHANGE') {
838 if (defined($header) and not $header eq $test{'data'}) {
844 $header = "REMOVAL" unless defined $header;
845 l(LL_VERBOSE_FAILURE,
846 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
852 if (defined($header) and $header eq $expect_header) {
858 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
859 l(LL_VERBOSE_FAILURE,
860 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
866 sub get_header_name ($) {
870 $header =~ s@(.*?: ).*@$1@;
875 sub get_header ($$) {
877 our $filtered_request = '';
879 my $buffer_ref = shift;
880 my $test_ref = shift;
882 my %test = %{$test_ref};
883 my @buffer = @{$buffer_ref};
885 my $expect_header = $test{'expect-header'};
887 die "get_header called with no expect header" unless defined $expect_header;
890 my $processed_request_reached = 0;
892 my $processed_request = '';
896 if ($expect_header eq 'REMOVAL'
897 or $expect_header eq 'NO CHANGE'
898 or $expect_header eq 'SOME CHANGE') {
900 $expect_header = $test{'data'};
904 $header_to_get = get_header_name($expect_header);
908 # Skip everything before the Processed request
909 if (/Processed Request/) {
910 $processed_request_reached = 1;
913 next unless $processed_request_reached;
915 # End loop after the Processed request
918 # Ditch tags and leading/trailing white space.
922 $filtered_request .= "\n" . $_;
924 if (/^$header_to_get/) {
934 sub get_server_header ($$) {
936 my $buffer_ref = shift;
937 my $test_ref = shift;
939 my %test = %{$test_ref};
940 my @buffer = @{$buffer_ref};
942 my $expect_header = $test{'expect-header'};
946 # XXX: Should be caught before starting to test.
947 l(LL_ERROR, "No expect header for test " . $test{'number'})
948 unless defined $expect_header;
950 if ($expect_header eq 'REMOVAL'
951 or $expect_header eq 'NO CHANGE'
952 or $expect_header eq 'SOME CHANGE') {
954 $expect_header = $test{'data'};
958 $header_to_get = get_header_name($expect_header);
962 # XXX: should probably verify that the request
963 # was actually answered by Fellatio.
964 if (/^$header_to_get/) {
966 $header =~ s@\s*$@@g;
974 sub get_status_code ($) {
976 my $buffer_ref = shift;
977 my @buffer = @{$buffer_ref};
981 if (/^HTTP\/\d\.\d (\d{3})/) {
987 return '123' if cli_option_is_set('fuzzer-feeding');
989 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
994 sub get_test_keys () {
995 return ('tag', 'data', 'expect-header', 'ignore');
999 sub test_content_as_string ($) {
1001 my $test_ref = shift;
1002 my %test = %{$test_ref};
1006 foreach my $key (get_test_keys()) {
1007 $test{$key} = 'Not set' unless (defined $test{$key});
1010 $s .= 'Tag: ' . $test{'tag'};
1012 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1014 $s .= 'Expected header: ' . $test{'expect-header'};
1016 $s .= 'Ignore: ' . $test{'ignore'};
1021 ############################################################################
1023 # HTTP fetch functions
1025 ############################################################################
1027 sub check_for_curl () {
1029 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1032 sub get_cgi_page_or_else ($) {
1034 my $cgi_url = shift;
1035 my $content_ref = get_page_with_curl($cgi_url);
1036 my $status_code = get_status_code($content_ref);
1038 if (200 != $status_code) {
1040 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1041 "Received status code ". $status_code .
1042 " while only 200 is acceptable.";
1044 if (cli_option_is_set('fuzzer-feeding')) {
1046 $log_message .= " Ignored due to fuzzer feeding.";
1047 l(LL_SOFT_ERROR, $log_message)
1051 l(LL_ERROR, $log_message);
1056 return $content_ref;
1059 sub get_show_request_with_curl ($) {
1061 our $privoxy_cgi_url;
1062 my $test_ref = shift;
1063 my %test = %{$test_ref};
1065 my $curl_parameters = ' ';
1067 # Enable the action to test
1068 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1069 # The header to filter
1070 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1072 $curl_parameters .= ' ';
1073 $curl_parameters .= $privoxy_cgi_url;
1074 $curl_parameters .= 'show-request';
1076 return get_cgi_page_or_else($curl_parameters);
1080 sub get_head_with_curl ($) {
1082 our $fellatio_url = FELLATIO_URL;
1083 my $test_ref = shift;
1084 my %test = %{$test_ref};
1086 my $curl_parameters = ' ';
1088 # Enable the action to test
1089 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1090 # The header to filter
1091 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1092 $curl_parameters .= '--head ';
1094 $curl_parameters .= ' ';
1095 $curl_parameters .= $fellatio_url;
1097 return get_page_with_curl($curl_parameters);
1101 sub get_page_with_curl ($) {
1105 my $parameters = shift;
1107 my $curl_line = CURL;
1108 my $retries_left = get_cli_option('retries') + 1;
1111 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1113 # We want to see the HTTP status code
1114 $curl_line .= " --include ";
1115 # Let Privoxy emit two log messages less.
1116 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1117 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1118 # We don't care about fetch statistic.
1119 $curl_line .= " -s ";
1120 # We do care about the failure reason if any.
1121 $curl_line .= " -S ";
1122 # We want to advertise ourselves
1123 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1124 # We aren't too patient
1125 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1127 $curl_line .= $parameters;
1128 # XXX: still necessary?
1129 $curl_line .= ' 2>&1';
1131 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1134 @buffer = `$curl_line`;
1137 $failure_reason = array_as_string(\@buffer);
1138 chomp $failure_reason;
1139 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1141 } while ($? && --$retries_left);
1143 unless ($retries_left) {
1145 "Running curl failed " . get_cli_option('retries') .
1146 " times in a row. Last error: '" . $failure_reason . "'.");
1153 ############################################################################
1157 ############################################################################
1159 sub array_as_string ($) {
1160 my $array_ref = shift;
1163 foreach (@{$array_ref}) {
1172 my $test_ref = shift;
1173 log_message('Test is:' . test_content_as_string($test_ref));
1179 my $this_level = shift;
1180 my $message = shift;
1182 return unless ($log_level & $this_level);
1184 if (LL_ERROR & $this_level) {
1185 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1188 log_message($message);
1190 if (LL_ERROR & $this_level) {
1195 sub log_message ($) {
1197 my $message = shift;
1201 our $leading_log_date;
1202 our $leading_log_time;
1204 my $time_stamp = '';
1205 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1207 if ($leading_log_date || $leading_log_time) {
1209 if ($leading_log_date) {
1212 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1215 if ($leading_log_time) {
1216 $time_stamp .= ' ' if $leading_log_date;
1217 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1220 $message = $time_stamp . ": " . $message;
1224 printf(STDERR "%s\n", $message);
1228 sub log_result ($$) {
1230 our $verbose_test_description;
1231 our $filtered_request;
1233 my $test_ref = shift;
1237 my %test = %{$test_ref};
1240 $message .= interpret_result($result);
1241 $message .= " for test ";
1242 $message .= $number;
1244 $message .= $test{'number'};
1246 $message .= $test{'section-id'};
1248 $message .= $test{'regression-test-id'};
1251 if ($verbose_test_description) {
1253 if ($test{'type'} == CLIENT_HEADER_TEST) {
1255 $message .= ' Header ';
1256 $message .= quote($test{'data'});
1257 $message .= ' and tag ';
1258 $message .= quote($test{'tag'});
1260 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1262 $message .= ' Request Header ';
1263 $message .= quote($test{'data'});
1264 $message .= ' and tag ';
1265 $message .= quote($test{'tag'});
1267 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1269 $message .= ' URL ';
1270 $message .= quote($test{'data'});
1271 $message .= ' and expected status code ';
1272 $message .= quote($test{'expected-status-code'});
1274 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1276 $message .= ' CGI URL ';
1277 $message .= quote($test{'data'});
1278 $message .= ' and expected status code ';
1279 $message .= quote($test{'expected-status-code'});
1281 } elsif ($test{'type'} == METHOD_TEST) {
1283 $message .= ' HTTP method ';
1284 $message .= quote($test{'data'});
1285 $message .= ' and expected status code ';
1286 $message .= quote($test{'expected-status-code'});
1288 } elsif ($test{'type'} == BLOCK_TEST) {
1290 $message .= ' Supposedly-blocked URL: ';
1291 $message .= quote($test{'data'});
1293 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1295 $message .= ' Sticky Actions: ';
1296 $message .= quote($test{'sticky-actions'});
1297 $message .= ' and URL: ';
1298 $message .= quote($test{'data'});
1302 die "Incomplete support for test type " . $test{'type'} . " detected.";
1307 log_message($message) if (!$result or cli_option_is_set('verbose'));
1312 return '\'' . $s . '\'';
1315 sub print_version () {
1316 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1327 Options and their default values if they have any:
1328 [--debug $cli_options{'debug'}]
1333 [--loops $cli_options{'loops'}]
1334 [--max-level $cli_options{'max-level'}]
1335 [--max-time $cli_options{'max-time'}]
1336 [--min-level $cli_options{'min-level'}]
1338 [--retries $cli_options{'retries'}]
1341 see "perldoc $0" for more information
1347 sub init_cli_options () {
1352 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1353 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1354 $cli_options{'debug'} = $log_level;
1355 $cli_options{'loops'} = CLI_LOOPS;
1356 $cli_options{'max-time'} = CLI_MAX_TIME;
1357 $cli_options{'retries'} = CLI_RETRIES;
1360 sub parse_cli_options () {
1368 'debug=s' => \$cli_options{'debug'},
1369 'help' => sub { help },
1370 'min-level=s' => \$cli_options{'min-level'},
1371 'max-level=s' => \$cli_options{'max-level'},
1372 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1373 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1374 'level=s' => \$cli_options{'level'},
1375 'loops=s' => \$cli_options{'loops'},
1376 'test-number=s' => \$cli_options{'test-number'},
1377 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1378 'retries=s' => \$cli_options{'retries'},
1379 'max-time=s' => \$cli_options{'max-time'},
1380 'verbose' => \$cli_options{'verbose'},
1381 'version' => sub { print_version && exit(0) }
1383 $log_level |= $cli_options{'debug'};
1386 sub cli_option_is_set ($) {
1389 my $cli_option = shift;
1391 return defined $cli_options{$cli_option};
1394 sub get_cli_option ($) {
1397 my $cli_option = shift;
1399 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1401 return $cli_options{$cli_option};
1404 sub init_proxy_settings($) {
1409 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1410 $proxy = get_cli_option('fuzzer-address');
1413 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1415 if (cli_option_is_set('privoxy-address')) {
1416 $proxy .= get_cli_option('privoxy-address');
1424 init_our_variables();
1425 parse_cli_options();
1427 init_proxy_settings('vanilla-proxy');
1428 load_regressions_tests();
1429 init_proxy_settings('fuzz-proxy');
1430 execute_regression_tests();
1437 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1441 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>]
1442 [B<--fuzzer-feeding>] [B<--help>] [B<--level level>] [B<--loops count>]
1443 [B<--max-level max-level>] [B<--max-time max-time>]
1444 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1445 [B<--retries retries>] [B<--verbose>] [B<--version>]
1449 Privoxy-Regression-Test is supposed to one day become
1450 a regression test suite for Privoxy. It's not quite there
1451 yet, however, and can currently only test header actions,
1452 check the returned status code for requests to arbitrary
1453 URLs and verify which actions are applied to them.
1455 Client header actions are tested by requesting
1456 B<http://p.p/show-request> and checking whether
1457 or not Privoxy modified the original request as expected.
1459 The original request contains both the header the action-to-be-tested
1460 acts upon and an additional tagger-triggering header that enables
1463 Applied actions are checked through B<http://p.p/show-url-info>.
1465 =head1 CONFIGURATION FILE SYNTAX
1467 Privoxy-Regression-Test's configuration is embedded in
1468 Privoxy action files and loaded through Privoxy's web interface.
1470 It makes testing a Privoxy version running on a remote system easier
1471 and should prevent you from updating your tests without updating Privoxy's
1472 configuration accordingly.
1474 A client-header-action test section looks like this:
1476 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1477 # Expect Header = Referer: http://www.example.org/
1478 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1479 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1481 The example above causes Privoxy-Regression-Test to set
1482 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1483 and to expect it to be modified to
1484 B<Referer: http://www.example.org/>.
1486 When testing this section, Privoxy-Regression-Test will set the header
1487 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1488 causing the B<privoxy-control> tagger to create the tag
1489 B<client-header-filter{hide-tor-exit-notation}> which will finally
1490 cause Privoxy to enable the action section.
1492 Note that the actions itself are only used by Privoxy,
1493 Privoxy-Regression-Test ignores them and will be happy
1494 as long as the expectations are satisfied.
1496 A fetch test looks like this:
1498 # Fetch Test = http://p.p/user-manual
1499 # Expect Status Code = 302
1501 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1502 and to expect a response with the HTTP status code B<302>. Obviously that's
1503 not a very thorough test and mainly useful to get some code coverage
1504 for Valgrind or to verify that the templates are installed correctly.
1506 If you want to test CGI pages that require a trusted
1507 referer, you can use:
1509 # Trusted CGI Request = http://p.p/edit-actions
1511 It works like ordinary fetch tests, but sets the referer
1512 header to a trusted value.
1514 If no explicit status code expectation is set, B<200> is used.
1516 To verify that a URL is blocked, use:
1518 # Blocked URL = http://www.example.com/blocked
1520 To verify that a specific set of actions is applied to an URL, use:
1522 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1523 # URL = http://www.example.org/my-first-url
1525 The sticky actions will be checked for all URLs below it
1526 until the next sticky actions directive.
1530 All tests have test levels to let the user
1531 control which ones to execute (see I<OPTIONS> below).
1532 Test levels are either set with the B<Level> directive,
1533 or implicitly through the test type.
1535 Block tests default to level 7, fetch tests to level 6,
1536 "Sticky Actions" tests default to level 5, tests for trusted CGI
1537 requests to level 3 and client-header-action tests to level 1.
1541 B<--debug bitmask> Add the bitmask provided as integer
1542 to the debug settings.
1544 B<--fuzzer-address> Listening address used when executing
1545 the regression tests. Useful to make sure that the requests
1546 to load the regression tests don't fail due to fuzzing.
1548 B<--fuzzer-feeding> Ignore some errors that would otherwise
1549 cause Privoxy-Regression-Test to abort the test because
1550 they shouldn't happen in normal operation. This option is
1551 intended to be used if Privoxy-Regression-Test is only
1552 used to feed a fuzzer in which case there's a high chance
1553 that Privoxy gets an invalid request and returns an error
1556 B<--help> Shows available command line options.
1558 B<--level level> Only execute tests with the specified B<level>.
1560 B<--loop count> Loop through the regression tests B<count> times.
1561 Useful to feed a fuzzer, or when doing stress tests with
1562 several Privoxy-Regression-Test instances running at the same
1565 B<--max-level max-level> Only execute tests with a B<level>
1566 below or equal to the numerical B<max-level>.
1568 B<--max-time max-time> Give Privoxy B<max-time> seconds
1569 to return data. Increasing the default may make sense when
1570 Privoxy is run through Valgrind, decreasing the default may
1571 make sense when Privoxy-Regression-Test is used to feed
1574 B<--min-level min-level> Only execute tests with a B<level>
1575 above or equal to the numerical B<min-level>.
1577 B<--privoxy-address proxy-address> Privoxy's listening address.
1578 If it's not set, the value of the environment variable http_proxy
1579 will be used. B<proxy-address> has to be specified in http_proxy
1582 B<--retries retries> Retry B<retries> times.
1584 B<--verbose> Also log succesful test runs.
1586 B<--version> Print version and exit.
1588 The second dash is optional, options can be shortened,
1589 as long as there are no ambiguities.
1591 =head1 PRIVOXY CONFIGURATION
1593 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1594 which aims to test all official client-header modifying actions
1595 and can be used to verify that the templates and the user manual
1596 files are installed correctly.
1598 To use it, it has to be copied in Privoxy's configuration
1599 directory, and afterwards referenced in Privoxy's configuration
1602 actionsfile regression-tests.action
1604 In general, its tests are supposed to work without changing
1605 any other action files, unless you already added lots of
1606 taggers yourself. If you are using taggers that cause problems,
1607 you might have to temporary disable them for Privoxy's CGI pages.
1609 Some of the regression tests rely on Privoxy features that
1610 may be disabled in your configuration. Tests with a level below
1611 7 are supposed to work with all Privoxy configurations (provided
1612 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1614 Tests with level 9 require Privoxy to deliver the User Manual,
1615 tests with level 12 require the CGI editor to be enabled.
1619 Expect the configuration file syntax to change with future releases.
1623 As Privoxy's B<show-request> page only shows client headers,
1624 Privoxy-Regression-Test can't use it to test Privoxy actions
1625 that modify server headers.
1627 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1628 control the actions to test, it currently only works with
1629 Privoxy 3.0.7 or later.
1631 At the moment Privoxy-Regression-Test fetches Privoxy's
1632 configuration page through I<curl>(1), therefore you have to
1633 have I<curl> installed, otherwise you won't be able to run
1634 Privoxy-Regression-Test in a meaningful way.
1642 Fabian Keil <fk@fabiankeil.de>