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.78 2011/10/30 16:20:35 fabiankeil 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-2011 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.4',
52 # XXX: why limit at all?
57 PRIVOXY_CGI_URL => 'http://p.p/',
58 FELLATIO_URL => 'http://127.0.0.1:8080/',
59 LEADING_LOG_DATE => 1,
60 LEADING_LOG_TIME => 1,
62 DEBUG_LEVEL_FILE_LOADING => 0,
63 DEBUG_LEVEL_PAGE_FETCHING => 0,
64 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
65 # XXX: Only partly implemented and mostly useless.
66 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
67 DEBUG_LEVEL_STATUS => 1,
69 VERBOSE_TEST_DESCRIPTION => 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,
80 CLIENT_HEADER_TEST => 1,
81 SERVER_HEADER_TEST => 2,
84 STICKY_ACTIONS_TEST => 5,
85 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;
94 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
95 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
96 our $log_level = get_default_log_level();
99 sub get_default_log_level () {
103 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
104 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
105 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
106 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
107 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
109 # This one is supposed to be always on.
110 $log_level |= LL_SOFT_ERROR;
115 ############################################################################
117 # File loading functions
119 ############################################################################
127 # Unescape brackets and dots
128 $tag =~ s@\\(?=[{}().+])@@g;
130 # log_message("Parsed tag: " . $tag);
132 check_for_forbidden_characters($tag);
137 sub check_for_forbidden_characters ($) {
140 my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]';
142 unless ($string =~ m/^$allowed*$/o) {
143 my $forbidden = $string;
144 $forbidden =~ s@^$allowed*(.).*@$1@;
146 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
150 sub load_regression_tests() {
151 if (cli_option_is_set('local-test-file')) {
152 load_regression_tests_from_file(get_cli_option('local-test-file'));
154 load_regression_tests_through_privoxy();
158 # XXX: Contains a lot of code duplicated from load_action_files()
159 # that should be factored out.
160 sub load_regression_tests_from_file ($) {
161 my $action_file = shift;
165 our @regression_tests;
167 my $si = 0; # Section index
168 my $ri = -1; # Regression test index
173 my $sticky_actions = undef;
175 l(LL_STATUS, "Gathering regression tests from local file " . $action_file);
177 open(my $ACTION_FILE, "<", $action_file)
178 or log_and_die("Failed to open $action_file: $!");
180 while (<$ACTION_FILE>) {
184 my ($token, $value) = tokenize($_);
186 next unless defined $token;
188 # Load regression tests
190 if (token_starts_new_test($token)) {
192 # Beginning of new regression test.
195 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
196 $no_checks = 1; # Already validated by enlist_new_test().
199 if ($token =~ /level\s+(\d+)/i) {
202 register_dependency($level, $value);
205 if ($token eq 'sticky actions') {
207 # Will be used by each following Sticky URL.
208 $sticky_actions = $value;
209 if ($sticky_actions =~ /{[^}]*\s/) {
210 log_and_die("'Sticky Actions' with whitespace inside the " .
211 "action parameters are currently unsupported.");
215 if ($si == -1 || $ri == -1) {
216 # No beginning of a test detected yet,
217 # so we don't care about any other test
222 if ($token eq 'expect header') {
224 l(LL_FILE_LOADING, "Detected expectation: " . $value);
225 $regression_tests[$si][$ri]{'expect-header'} = $value;
227 } elsif ($token eq 'tag') {
231 my $tag = parse_tag($value);
233 # We already checked in parse_tag() after filtering
236 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
238 # Save tag for all tests in this section
240 $regression_tests[$si][$ri]{'tag'} = $tag;
246 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
248 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
249 $regression_tests[$si][$ri]{'ignore'} = 1;
252 } elsif ($token eq 'expect status code') {
254 l(LL_FILE_LOADING, "Expecting status code: " . $value);
255 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
257 } elsif ($token eq 'level') { # XXX: stupid name
259 $value =~ s@(\d+).*@$1@;
260 l(LL_FILE_LOADING, "Level: " . $value);
261 $regression_tests[$si][$ri]{'level'} = $value;
263 } elsif ($token eq 'method') {
265 l(LL_FILE_LOADING, "Method: " . $value);
266 $regression_tests[$si][$ri]{'method'} = $value;
268 } elsif ($token eq 'redirect destination') {
270 l(LL_FILE_LOADING, "Redirect destination: " . $value);
271 $regression_tests[$si][$ri]{'redirect destination'} = $value;
273 } elsif ($token eq 'url') {
275 if (defined $sticky_actions) {
276 die "WTF? Attempted to overwrite Sticky Actions"
277 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
279 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
280 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
282 log_and_die("Sticky URL without Sticky Actions: $value");
287 # We don't use it, so we don't need
289 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
293 unless ($no_checks) {
294 check_for_forbidden_characters($value);
295 check_for_forbidden_characters($token);
299 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
300 . " Of which " . $ignored. " will be ignored)\n");
305 sub load_regression_tests_through_privoxy () {
307 our $privoxy_cgi_url;
309 our %privoxy_features;
315 $curl_url .= $privoxy_cgi_url;
316 $curl_url .= 'show-status';
318 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
320 # Dear Privoxy, please reload the config file if necessary ...
321 get_cgi_page_or_else($curl_url);
323 # ... so we get the latest one here.
324 foreach (@{get_cgi_page_or_else($curl_url)}) {
327 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
329 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
330 $actionfiles[$file_number++] = $url;
332 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
334 my $directive = $1 . " " . $2;
335 push (@privoxy_config, $directive);
337 } elsif (m@<td><code>([^<]*)</code></td>@) {
341 } elsif (m@<td> (Yes|No) </td>@) {
343 $privoxy_features{$feature} = $1 if defined $feature;
348 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
350 load_action_files(\@actionfiles);
353 sub token_starts_new_test ($) {
356 my @new_test_directives = ('set header', 'fetch test',
357 'trusted cgi request', 'request header', 'method test',
358 'blocked url', 'url', 'redirected url');
360 foreach my $new_test_directive (@new_test_directives) {
361 return 1 if $new_test_directive eq $token;
369 my ($token, $value) = (undef, undef);
371 # Remove leading and trailing white space.
375 # Reverse HTML-encoding
376 # XXX: Seriously incomplete.
381 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
386 $token =~ s@\s\s+@ @g;
387 $token =~ tr/[A-Z]/[a-z]/;
389 } elsif (/^TAG\s*:(.*)$/) {
395 return ($token, $value);
398 sub enlist_new_test ($$$$$$) {
400 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
404 if ($token eq 'set header') {
406 l(LL_FILE_LOADING, "Header to set: " . $value);
407 $type = CLIENT_HEADER_TEST;
408 $executor = \&execute_client_header_regression_test;
410 } elsif ($token eq 'request header') {
412 l(LL_FILE_LOADING, "Header to request: " . $value);
413 $type = SERVER_HEADER_TEST;
414 $executor = \&execute_server_header_regression_test;
415 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
417 } elsif ($token eq 'trusted cgi request') {
419 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
420 $type = TRUSTED_CGI_REQUEST;
421 $executor = \&execute_dumb_fetch_test;
422 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
424 } elsif ($token eq 'fetch test') {
426 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
427 $type = DUMB_FETCH_TEST;
428 $executor = \&execute_dumb_fetch_test;
429 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
431 } elsif ($token eq 'method test') {
433 l(LL_FILE_LOADING, "Method to test: " . $value);
435 $executor = \&execute_method_test;
436 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
438 } elsif ($token eq 'blocked url') {
440 l(LL_FILE_LOADING, "URL to block-test: " . $value);
441 $executor = \&execute_block_test;
444 } elsif ($token eq 'url') {
446 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
447 $type = STICKY_ACTIONS_TEST;
448 $executor = \&execute_sticky_actions_test;
450 } elsif ($token eq 'redirected url') {
452 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
453 $type = REDIRECT_TEST;
454 $executor = \&execute_redirect_test;
458 die "Incomplete '" . $token . "' support detected.";
461 $$regression_tests[$si][$ri]{'type'} = $type;
462 $$regression_tests[$si][$ri]{'level'} = $type;
463 $$regression_tests[$si][$ri]{'executor'} = $executor;
465 check_for_forbidden_characters($value);
467 $$regression_tests[$si][$ri]{'data'} = $value;
469 # For function that only get passed single tests
470 $$regression_tests[$si][$ri]{'section-id'} = $si;
471 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
472 $$regression_tests[$si][$ri]{'number'} = $number - 1;
474 "Regression test " . $number . " (section:" . $si . "):");
477 # XXX: Shares a lot of code with load_regression_tests_from_file()
478 # that should be factored out.
479 sub load_action_files ($) {
483 our @regression_tests;
485 my $actionfiles_ref = shift;
486 my @actionfiles = @{$actionfiles_ref};
488 my $si = 0; # Section index
489 my $ri = -1; # Regression test index
494 l(LL_STATUS, "Gathering regression tests from " .
495 @actionfiles . " action file(s) delivered by Privoxy.");
497 for my $file_number (0 .. @actionfiles - 1) {
499 my $curl_url = quote($actionfiles[$file_number]);
500 my $actionfile = undef;
501 my $sticky_actions = undef;
503 foreach (@{get_cgi_page_or_else($curl_url)}) {
508 if (/<h2>Contents of Actions File (.*?)</) {
512 next unless defined $actionfile;
516 my ($token, $value) = tokenize($_);
518 next unless defined $token;
520 # Load regression tests
522 if (token_starts_new_test($token)) {
524 # Beginning of new regression test.
527 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
528 $no_checks = 1; # Already validated by enlist_new_test().
531 if ($token =~ /level\s+(\d+)/i) {
534 register_dependency($level, $value);
537 if ($token eq 'sticky actions') {
539 # Will be used by each following Sticky URL.
540 $sticky_actions = $value;
541 if ($sticky_actions =~ /{[^}]*\s/) {
542 log_and_die("'Sticky Actions' with whitespace inside the " .
543 "action parameters are currently unsupported.");
547 if ($si == -1 || $ri == -1) {
548 # No beginning of a test detected yet,
549 # so we don't care about any other test
554 if ($token eq 'expect header') {
556 l(LL_FILE_LOADING, "Detected expectation: " . $value);
557 $regression_tests[$si][$ri]{'expect-header'} = $value;
559 } elsif ($token eq 'tag') {
563 my $tag = parse_tag($value);
565 # We already checked in parse_tag() after filtering
568 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
570 # Save tag for all tests in this section
572 $regression_tests[$si][$ri]{'tag'} = $tag;
578 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
580 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
581 $regression_tests[$si][$ri]{'ignore'} = 1;
584 } elsif ($token eq 'expect status code') {
586 l(LL_FILE_LOADING, "Expecting status code: " . $value);
587 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
589 } elsif ($token eq 'level') { # XXX: stupid name
591 $value =~ s@(\d+).*@$1@;
592 l(LL_FILE_LOADING, "Level: " . $value);
593 $regression_tests[$si][$ri]{'level'} = $value;
595 } elsif ($token eq 'method') {
597 l(LL_FILE_LOADING, "Method: " . $value);
598 $regression_tests[$si][$ri]{'method'} = $value;
600 } elsif ($token eq 'redirect destination') {
602 l(LL_FILE_LOADING, "Redirect destination: " . $value);
603 $regression_tests[$si][$ri]{'redirect destination'} = $value;
605 } elsif ($token eq 'url') {
607 if (defined $sticky_actions) {
608 die "WTF? Attempted to overwrite Sticky Actions"
609 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
611 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
612 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
614 log_and_die("Sticky URL without Sticky Actions: $value");
619 # We don't use it, so we don't need
621 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
625 unless ($no_checks) {
626 check_for_forbidden_characters($value);
627 check_for_forbidden_characters($token);
632 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
633 . " Of which " . $ignored. " will be ignored)\n");
636 ############################################################################
638 # Regression test executing functions
640 ############################################################################
642 sub execute_regression_tests () {
644 our @regression_tests;
645 my $loops = get_cli_option('loops');
647 my $all_failures = 0;
648 my $all_successes = 0;
650 unless (@regression_tests) {
652 l(LL_STATUS, "No regression tests found.");
656 l(LL_STATUS, "Executing regression tests ...");
658 while ($loops-- > 0) {
665 for (my $s = 0; $s < @regression_tests; $s++) {
669 while (defined $regression_tests[$s][$r]) {
671 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
672 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
673 die "Internal error. Test executor missing."
674 unless defined $regression_tests[$s][$r]{executor};
676 my $number = $regression_tests[$s][$r]{'number'};
677 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
679 if (defined $skip_reason) {
681 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
682 log_message($message) if (cli_option_is_set('show-skipped-tests'));
687 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
689 log_result($regression_tests[$s][$r], $result, $tests);
691 $successes += $result;
693 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
698 $failures = $tests - $successes;
700 log_message("Executed " . $tests . " regression tests. " .
701 'Skipped ' . $skipped . '. ' .
702 $successes . " successes, " . $failures . " failures.");
704 $all_tests += $tests;
705 $all_failures += $failures;
706 $all_successes += $successes;
709 if (get_cli_option('loops') > 1) {
710 log_message("Total: Executed " . $all_tests . " regression tests. " .
711 $all_successes . " successes, " . $all_failures . " failures.");
715 sub get_skip_reason ($) {
717 my $skip_reason = undef;
719 if ($test->{'ignore'}) {
721 $skip_reason = "Ignore flag is set";
723 } elsif (cli_option_is_set('test-number') and
724 get_cli_option('test-number') != $test->{'number'}) {
726 $skip_reason = "Only executing test " . get_cli_option('test-number');
730 $skip_reason = level_is_unacceptable($test->{'level'});
736 sub level_is_unacceptable ($) {
738 my $min_level = get_cli_option('min-level');
739 my $max_level = get_cli_option('max-level');
740 my $required_level = cli_option_is_set('level') ?
741 get_cli_option('level') : $level;
744 if ($required_level != $level) {
746 $reason = "Level doesn't match (" . $level .
747 " != " . $required_level . ")"
749 } elsif ($level < $min_level) {
751 $reason = "Level too low (" . $level . " < " . $min_level . ")";
753 } elsif ($level > $max_level) {
755 $reason = "Level too high (" . $level . " > " . $max_level . ")";
759 $reason = dependency_unsatisfied($level);
765 sub dependency_unsatisfied ($) {
770 our %privoxy_features;
772 my $dependency_problem = undef;
774 if (defined ($dependencies{$level}{'config line'})) {
776 my $dependency = $dependencies{$level}{'config line'};
777 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
779 foreach (@privoxy_config) {
782 $dependency_problem = undef;
789 if (defined ($dependencies{$level}{'feature status'})
790 and not defined $dependency_problem) {
792 my $dependency = $dependencies{$level}{'feature status'};
793 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
795 unless (defined($privoxy_features{$feature})
796 and ($privoxy_features{$feature} eq $status))
798 $dependency_problem = "depends on '" . $feature .
799 "' being set to '" . $status . "'";
803 return $dependency_problem;
806 sub register_dependency ($$) {
809 my $dependency = shift;
812 if ($dependency =~ /config line\s+(.*)/) {
814 $dependencies{$level}{'config line'} = $1;
816 } elsif ($dependency =~ /feature status\s+(.*)/) {
818 $dependencies{$level}{'feature status'} = $1;
822 log_and_die("Didn't recognize dependency: $dependency.");
826 sub execute_method_test ($) {
831 my $method = $test->{'data'};
833 my $curl_parameters = '';
834 my $expected_status_code = $test->{'expected-status-code'};
836 $curl_parameters .= '--request ' . $method . ' ';
837 # Don't complain about the 'missing' body
838 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
840 $curl_parameters .= PRIVOXY_CGI_URL;
842 $buffer_ref = get_page_with_curl($curl_parameters);
843 $status_code = get_status_code($buffer_ref);
845 return check_status_code_result($status_code, $expected_status_code);
848 sub execute_redirect_test ($) {
854 my $curl_parameters = '';
855 my $url = $test->{'data'};
856 my $redirect_destination;
857 my $expected_redirect_destination = $test->{'redirect destination'};
859 # XXX: Check if a redirect actually applies before doing the request.
860 # otherwise the test may hit a real server in failure cases.
862 $curl_parameters .= '--head ';
864 $curl_parameters .= quote($url);
866 $buffer_ref = get_page_with_curl($curl_parameters);
867 $status_code = get_status_code($buffer_ref);
869 if ($status_code ne "302") {
870 l(LL_VERBOSE_FAILURE,
871 "Ooops. Expected redirect to: '" . $expected_redirect_destination
872 . "' but got a response with status code: " . $status_code);
875 foreach (@{$buffer_ref}) {
876 if (/^Location: (.*)\r\n/) {
877 $redirect_destination = $1;
882 my $success = ($redirect_destination eq $expected_redirect_destination);
885 l(LL_VERBOSE_FAILURE,
886 "Ooops. Expected redirect to: '" . $expected_redirect_destination
887 . "' but the redirect leads to: '" . $redirect_destination. "'");
893 sub execute_dumb_fetch_test ($) {
899 my $curl_parameters = '';
900 my $expected_status_code = $test->{'expected-status-code'};
902 if (defined $test->{method}) {
903 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
905 if ($test->{type} == TRUSTED_CGI_REQUEST) {
906 $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' ';
909 $curl_parameters .= quote($test->{'data'});
911 $buffer_ref = get_page_with_curl($curl_parameters);
912 $status_code = get_status_code($buffer_ref);
914 return check_status_code_result($status_code, $expected_status_code);
917 sub execute_block_test ($) {
920 my $url = $test->{'data'};
921 my $final_results = get_final_results($url);
923 return defined $final_results->{'+block'};
926 sub execute_sticky_actions_test ($) {
929 my $url = $test->{'data'};
930 my $verified_actions = 0;
931 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
932 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
933 my $final_results = get_final_results($url);
935 foreach my $sticky_action (@sticky_actions) {
937 if (defined $final_results->{$sticky_action}) {
941 } elsif ($sticky_action =~ /-.*\{/) {
943 # Disabled multi actions aren't explicitly listed as
944 # disabled and thus have to be checked by verifying
945 # that they aren't enabled.
949 l(LL_VERBOSE_FAILURE,
950 "Ooops. '$sticky_action' is not among the final results.");
954 return $verified_actions == @sticky_actions;
957 sub get_final_results ($) {
960 my $curl_parameters = '';
961 my %final_results = ();
962 my $final_results_reached = 0;
964 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
965 # XXX: should be URL-encoded properly
972 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
974 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
976 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
978 next unless ($final_results_reached);
981 # Privoxy versions before 3.0.16 add a space
982 # between action name and parameters, therefore
984 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
988 if (defined $parameter) {
989 # In case the caller needs to check
990 # the action and its parameter
991 $final_results{$action . $parameter} = 1;
993 # In case the action doesn't have parameters
994 # or the caller doesn't care for the parameter.
995 $final_results{$action} = 1;
999 return \%final_results;
1002 sub check_status_code_result ($$) {
1004 my $status_code = shift;
1005 my $expected_status_code = shift;
1008 unless (defined $status_code) {
1010 # XXX: should probably be caught earlier.
1011 l(LL_VERBOSE_FAILURE,
1012 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
1014 } elsif ($expected_status_code == $status_code) {
1017 l(LL_VERBOSE_SUCCESS,
1018 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
1020 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
1022 l(LL_VERBOSE_FAILURE,
1023 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
1027 l(LL_VERBOSE_FAILURE,
1028 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
1034 sub execute_client_header_regression_test ($) {
1040 $buffer_ref = get_show_request_with_curl($test);
1042 $header = get_header($buffer_ref, $test);
1044 return check_header_result($test, $header);
1047 sub execute_server_header_regression_test ($) {
1053 $buffer_ref = get_head_with_curl($test);
1055 $header = get_server_header($buffer_ref, $test);
1057 return check_header_result($test, $header);
1060 sub interpret_result ($) {
1061 my $success = shift;
1062 return $success ? "Success" : "Failure";
1065 sub check_header_result ($$) {
1070 my $expect_header = $test->{'expect-header'};
1073 if ($expect_header eq 'NO CHANGE') {
1075 $success = (defined($header) and $header eq $test->{'data'});
1078 $header = "REMOVAL" unless defined $header;
1079 l(LL_VERBOSE_FAILURE,
1080 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1083 } elsif ($expect_header eq 'REMOVAL') {
1085 # XXX: Use more reliable check here and make sure
1086 # the header has a different name.
1087 $success = not (defined($header) and $header eq $test->{'data'});
1090 l(LL_VERBOSE_FAILURE,
1091 "Ooops. Expected removal but: '" . $header . "' is still there.");
1094 } elsif ($expect_header eq 'SOME CHANGE') {
1096 $success = (defined($header) and $header ne $test->{'data'});
1099 $header = "REMOVAL" unless defined $header;
1100 l(LL_VERBOSE_FAILURE,
1101 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
1106 $success = (defined($header) and $header eq $expect_header);
1109 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
1110 l(LL_VERBOSE_FAILURE,
1111 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1117 sub get_header_name ($) {
1121 $header =~ s@(.*?: ).*@$1@;
1126 sub get_header ($$) {
1128 our $filtered_request = '';
1130 my $buffer_ref = shift;
1133 my @buffer = @{$buffer_ref};
1135 my $expect_header = $test->{'expect-header'};
1137 die "get_header called with no expect header" unless defined $expect_header;
1140 my $processed_request_reached = 0;
1141 my $read_header = 0;
1142 my $processed_request = '';
1146 if ($expect_header eq 'REMOVAL'
1147 or $expect_header eq 'NO CHANGE'
1148 or $expect_header eq 'SOME CHANGE') {
1150 $expect_header = $test->{'data'};
1153 $header_to_get = get_header_name($expect_header);
1157 # Skip everything before the Processed request
1158 if (/Processed Request/) {
1159 $processed_request_reached = 1;
1162 next unless $processed_request_reached;
1164 # End loop after the Processed request
1165 last if (/<\/pre>/);
1167 # Ditch tags and leading/trailing white space.
1171 # Decode characters we care about.
1174 $filtered_request .= "\n" . $_;
1176 if (/^$header_to_get/) {
1186 sub get_server_header ($$) {
1188 my $buffer_ref = shift;
1191 my @buffer = @{$buffer_ref};
1193 my $expect_header = $test->{'expect-header'};
1197 # XXX: Should be caught before starting to test.
1198 log_and_die("No expect header for test " . $test->{'number'})
1199 unless defined $expect_header;
1201 if ($expect_header eq 'REMOVAL'
1202 or $expect_header eq 'NO CHANGE'
1203 or $expect_header eq 'SOME CHANGE') {
1205 $expect_header = $test->{'data'};
1208 $header_to_get = get_header_name($expect_header);
1212 # XXX: should probably verify that the request
1213 # was actually answered by Fellatio.
1214 if (/^$header_to_get/) {
1216 $header =~ s@\s*$@@g;
1224 sub get_status_code ($) {
1226 my $buffer_ref = shift;
1227 my @buffer = @{$buffer_ref};
1231 if (/^HTTP\/\d\.\d (\d{3})/) {
1237 return '123' if cli_option_is_set('fuzzer-feeding');
1239 log_and_die('Unexpected buffer line: "' . $_ . '"');
1244 sub get_test_keys () {
1245 return ('tag', 'data', 'expect-header', 'ignore');
1249 sub test_content_as_string ($) {
1255 foreach my $key (get_test_keys()) {
1256 $test->{$key} = 'Not set' unless (defined $test->{$key});
1259 $s .= 'Tag: ' . $test->{'tag'};
1261 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1263 $s .= 'Expected header: ' . $test->{'expect-header'};
1265 $s .= 'Ignore: ' . $test->{'ignore'};
1270 sub fuzz_header($) {
1272 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1274 $white_space = $white_space x (1 + int(rand(5)));
1276 # Only fuzz white space before the first quoted token.
1277 # (Privoxy doesn't touch white space inside quoted tokens
1278 # and modifying it would cause the tests to fail).
1279 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1284 ############################################################################
1286 # HTTP fetch functions
1288 ############################################################################
1290 sub get_cgi_page_or_else ($) {
1292 my $cgi_url = shift;
1293 my $content_ref = get_page_with_curl($cgi_url);
1294 my $status_code = get_status_code($content_ref);
1296 if (200 != $status_code) {
1298 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1299 "Received status code ". $status_code .
1300 " while only 200 is acceptable.";
1302 if (cli_option_is_set('fuzzer-feeding')) {
1304 $log_message .= " Ignored due to fuzzer feeding.";
1305 l(LL_SOFT_ERROR, $log_message)
1309 log_and_die($log_message);
1313 return $content_ref;
1316 # XXX: misleading name
1317 sub get_show_request_with_curl ($) {
1319 our $privoxy_cgi_url;
1322 my $curl_parameters = ' ';
1323 my $header = $test->{'data'};
1325 if (cli_option_is_set('header-fuzzing')) {
1326 $header = fuzz_header($header);
1329 # Enable the action to test
1330 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1331 # The header to filter
1332 $curl_parameters .= '-H \'' . $header . '\' ';
1334 $curl_parameters .= ' ';
1335 $curl_parameters .= $privoxy_cgi_url;
1336 $curl_parameters .= 'show-request';
1338 return get_cgi_page_or_else($curl_parameters);
1341 sub get_head_with_curl ($) {
1343 our $fellatio_url = FELLATIO_URL;
1346 my $curl_parameters = ' ';
1348 # Enable the action to test
1349 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1350 # The header to filter
1351 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1352 $curl_parameters .= '--head ';
1354 $curl_parameters .= ' ';
1355 $curl_parameters .= $fellatio_url;
1357 return get_page_with_curl($curl_parameters);
1360 sub get_page_with_curl ($) {
1364 my $parameters = shift;
1366 my $curl_line = CURL;
1367 my $retries_left = get_cli_option('retries') + 1;
1370 if (defined $proxy) {
1371 $curl_line .= ' --proxy ' . quote($proxy);
1373 # We want to see the HTTP status code
1374 $curl_line .= " --include ";
1375 # Let Privoxy emit two log messages less.
1376 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1377 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1378 # We don't care about fetch statistic.
1379 $curl_line .= " -s ";
1380 # We do care about the failure reason if any.
1381 $curl_line .= " -S ";
1382 # We want to advertise ourselves
1383 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1384 # We aren't too patient
1385 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1387 $curl_line .= $parameters;
1388 # XXX: still necessary?
1389 $curl_line .= ' 2>&1';
1391 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1394 @buffer = `$curl_line`;
1397 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1398 $failure_reason = array_as_string(\@buffer);
1399 chomp $failure_reason;
1400 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1402 } while ($? && --$retries_left);
1404 unless ($retries_left) {
1405 log_and_die("Running curl failed " . get_cli_option('retries') .
1406 " times in a row. Last error: '" . $failure_reason . "'.");
1413 ############################################################################
1417 ############################################################################
1419 sub array_as_string ($) {
1420 my $array_ref = shift;
1423 foreach (@{$array_ref}) {
1432 log_message('Test is:' . test_content_as_string($test));
1438 my $this_level = shift;
1439 my $message = shift;
1441 log_message($message) if ($log_level & $this_level);
1444 sub log_and_die ($) {
1445 my $message = shift;
1447 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1451 sub log_message ($) {
1453 my $message = shift;
1457 our $leading_log_date;
1458 our $leading_log_time;
1460 my $time_stamp = '';
1461 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1463 if ($leading_log_date || $leading_log_time) {
1465 if ($leading_log_date) {
1468 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1471 if ($leading_log_time) {
1472 $time_stamp .= ' ' if $leading_log_date;
1473 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1476 $message = $time_stamp . ": " . $message;
1479 printf(STDERR "%s\n", $message);
1482 sub log_result ($$) {
1484 our $verbose_test_description;
1485 our $filtered_request;
1493 $message .= interpret_result($result);
1494 $message .= " for test ";
1495 $message .= $number;
1497 $message .= $test->{'number'};
1499 $message .= $test->{'section-id'};
1501 $message .= $test->{'regression-test-id'};
1504 if ($verbose_test_description) {
1506 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1508 $message .= ' Header ';
1509 $message .= quote($test->{'data'});
1510 $message .= ' and tag ';
1511 $message .= quote($test->{'tag'});
1513 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1515 $message .= ' Request Header ';
1516 $message .= quote($test->{'data'});
1517 $message .= ' and tag ';
1518 $message .= quote($test->{'tag'});
1520 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1522 $message .= ' URL ';
1523 $message .= quote($test->{'data'});
1524 $message .= ' and expected status code ';
1525 $message .= quote($test->{'expected-status-code'});
1527 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1529 $message .= ' CGI URL ';
1530 $message .= quote($test->{'data'});
1531 $message .= ' and expected status code ';
1532 $message .= quote($test->{'expected-status-code'});
1534 } elsif ($test->{'type'} == METHOD_TEST) {
1536 $message .= ' HTTP method ';
1537 $message .= quote($test->{'data'});
1538 $message .= ' and expected status code ';
1539 $message .= quote($test->{'expected-status-code'});
1541 } elsif ($test->{'type'} == BLOCK_TEST) {
1543 $message .= ' Supposedly-blocked URL: ';
1544 $message .= quote($test->{'data'});
1546 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1548 $message .= ' Sticky Actions: ';
1549 $message .= quote($test->{'sticky-actions'});
1550 $message .= ' and URL: ';
1551 $message .= quote($test->{'data'});
1553 } elsif ($test->{'type'} == REDIRECT_TEST) {
1555 $message .= ' Redirected URL: ';
1556 $message .= quote($test->{'data'});
1557 $message .= ' and redirect destination: ';
1558 $message .= quote($test->{'redirect destination'});
1562 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1566 log_message($message) if (!$result or cli_option_is_set('verbose'));
1571 return '\'' . $s . '\'';
1574 sub print_version () {
1575 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil <fk@fabiankeil.de>' . "\n";
1578 sub list_test_types () {
1580 'Client header test' => CLIENT_HEADER_TEST,
1581 'Server header test' => 2,
1582 'Dumb fetch test' => 3,
1584 'Sticky action test' => 5,
1585 'Trusted CGI test' => 6,
1587 'Redirect test' => 108,
1590 print "\nThe supported test types and their default levels are:\n";
1591 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1592 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1604 Options and their default values if they have any:
1605 [--debug $cli_options{'debug'}]
1606 [--forks $cli_options{'forks'}]
1613 [--loops $cli_options{'loops'}]
1614 [--max-level $cli_options{'max-level'}]
1615 [--max-time $cli_options{'max-time'}]
1616 [--min-level $cli_options{'min-level'}]
1618 [--retries $cli_options{'retries'}]
1619 [--show-skipped-tests]
1620 [--sleep-time $cli_options{'sleep-time'}]
1631 Try "perldoc $0" for more information
1638 sub init_cli_options () {
1643 $cli_options{'debug'} = $log_level;
1644 $cli_options{'forks'} = CLI_FORKS;
1645 $cli_options{'loops'} = CLI_LOOPS;
1646 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1647 $cli_options{'max-time'} = CLI_MAX_TIME;
1648 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1649 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1650 $cli_options{'retries'} = CLI_RETRIES;
1653 sub parse_cli_options () {
1661 'debug=i' => \$cli_options{'debug'},
1662 'forks=i' => \$cli_options{'forks'},
1663 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1664 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1665 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1667 'level=i' => \$cli_options{'level'},
1668 'local-test-file=s' => \$cli_options{'local-test-file'},
1669 'loops=i' => \$cli_options{'loops'},
1670 'max-level=i' => \$cli_options{'max-level'},
1671 'max-time=i' => \$cli_options{'max-time'},
1672 'min-level=i' => \$cli_options{'min-level'},
1673 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1674 'retries=i' => \$cli_options{'retries'},
1675 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1676 'sleep-time=i' => \$cli_options{'sleep-time'},
1677 'test-number=i' => \$cli_options{'test-number'},
1678 'verbose' => \$cli_options{'verbose'},
1679 'version' => sub {print_version && exit(0)}
1681 $log_level |= $cli_options{'debug'};
1684 sub cli_option_is_set ($) {
1687 my $cli_option = shift;
1689 return defined $cli_options{$cli_option};
1692 sub get_cli_option ($) {
1695 my $cli_option = shift;
1697 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1699 return $cli_options{$cli_option};
1702 sub init_proxy_settings($) {
1707 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1708 $proxy = get_cli_option('fuzzer-address');
1711 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1713 if (cli_option_is_set('privoxy-address')) {
1714 $proxy .= get_cli_option('privoxy-address');
1719 sub start_forks($) {
1722 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1724 foreach my $fork (1 .. $forks) {
1725 log_message("Starting fork $fork");
1727 if (defined $pid && !$pid) {
1735 init_our_variables();
1736 parse_cli_options();
1737 init_proxy_settings('vanilla-proxy');
1738 load_regression_tests();
1739 init_proxy_settings('fuzz-proxy');
1740 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1741 execute_regression_tests();
1748 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1752 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1753 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1754 [B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>]
1755 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1756 [B<--retries retries>] [B<--test-number test-number>]
1757 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1762 Privoxy-Regression-Test is supposed to one day become
1763 a regression test suite for Privoxy. It's not quite there
1764 yet, however, and can currently only test header actions,
1765 check the returned status code for requests to arbitrary
1766 URLs and verify which actions are applied to them.
1768 Client header actions are tested by requesting
1769 B<http://p.p/show-request> and checking whether
1770 or not Privoxy modified the original request as expected.
1772 The original request contains both the header the action-to-be-tested
1773 acts upon and an additional tagger-triggering header that enables
1776 Applied actions are checked through B<http://p.p/show-url-info>.
1778 =head1 CONFIGURATION FILE SYNTAX
1780 Privoxy-Regression-Test's configuration is embedded in
1781 Privoxy action files and loaded through Privoxy's web interface.
1783 It makes testing a Privoxy version running on a remote system easier
1784 and should prevent you from updating your tests without updating Privoxy's
1785 configuration accordingly.
1787 A client-header-action test section looks like this:
1789 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1790 # Expect Header = Referer: http://www.example.org/
1791 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1792 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1794 The example above causes Privoxy-Regression-Test to set
1795 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1796 and to expect it to be modified to
1797 B<Referer: http://www.example.org/>.
1799 When testing this section, Privoxy-Regression-Test will set the header
1800 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1801 causing the B<privoxy-control> tagger to create the tag
1802 B<client-header-filter{hide-tor-exit-notation}> which will finally
1803 cause Privoxy to enable the action section.
1805 Note that the actions itself are only used by Privoxy,
1806 Privoxy-Regression-Test ignores them and will be happy
1807 as long as the expectations are satisfied.
1809 A fetch test looks like this:
1811 # Fetch Test = http://p.p/user-manual
1812 # Expect Status Code = 302
1814 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1815 and to expect a response with the HTTP status code B<302>. Obviously that's
1816 not a very thorough test and mainly useful to get some code coverage
1817 for Valgrind or to verify that the templates are installed correctly.
1819 If you want to test CGI pages that require a trusted
1820 referer, you can use:
1822 # Trusted CGI Request = http://p.p/edit-actions
1824 It works like ordinary fetch tests, but sets the referer
1825 header to a trusted value.
1827 If no explicit status code expectation is set, B<200> is used.
1829 To verify that a URL is blocked, use:
1831 # Blocked URL = http://www.example.com/blocked
1833 To verify that a specific set of actions is applied to an URL, use:
1835 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1836 # URL = http://www.example.org/my-first-url
1838 The sticky actions will be checked for all URLs below it
1839 until the next sticky actions directive.
1841 To verify that requests for a URL get redirected, use:
1843 # Redirected URL = http://www.example.com/redirect-me
1844 # Redirect Destination = http://www.example.org/redirected
1848 All tests have test levels to let the user
1849 control which ones to execute (see I<OPTIONS> below).
1850 Test levels are either set with the B<Level> directive,
1851 or implicitly through the test type.
1853 Redirect tests default to level 108, block tests to level 7,
1854 fetch tests to level 6, "Sticky Actions" tests default to
1855 level 5, tests for trusted CGI requests to level 3 and
1856 client-header-action tests to level 1.
1858 The current redirect test level is above the default
1859 max-level value as failed tests will result in outgoing
1860 connections. Use the B<--max-level> option to run them
1865 B<--debug bitmask> Add the bitmask provided as integer
1866 to the debug settings.
1868 B<--forks forks> Number of forks to start before executing
1869 the regression tests. This is mainly useful for stress-testing.
1871 B<--fuzzer-address> Listening address used when executing
1872 the regression tests. Useful to make sure that the requests
1873 to load the regression tests don't fail due to fuzzing.
1875 B<--fuzzer-feeding> Ignore some errors that would otherwise
1876 cause Privoxy-Regression-Test to abort the test because
1877 they shouldn't happen in normal operation. This option is
1878 intended to be used if Privoxy-Regression-Test is only
1879 used to feed a fuzzer in which case there's a high chance
1880 that Privoxy gets an invalid request and returns an error
1883 B<--help> Shows available command line options.
1885 B<--header-fuzzing> Modifies linear white space in
1886 headers in a way that should not affect the test result.
1888 B<--level level> Only execute tests with the specified B<level>.
1890 B<--local-test-file test-file> Do not get the tests
1891 through Privoxy's web interface, but use a single local
1892 file. Not recommended for testing Privoxy, but can be useful
1893 to "misappropriate" Privoxy-Regression-Test to test other
1894 stuff, like webserver configurations.
1896 B<--loop count> Loop through the regression tests B<count> times.
1897 Useful to feed a fuzzer, or when doing stress tests with
1898 several Privoxy-Regression-Test instances running at the same
1901 B<--max-level max-level> Only execute tests with a B<level>
1902 below or equal to the numerical B<max-level>.
1904 B<--max-time max-time> Give Privoxy B<max-time> seconds
1905 to return data. Increasing the default may make sense when
1906 Privoxy is run through Valgrind, decreasing the default may
1907 make sense when Privoxy-Regression-Test is used to feed
1910 B<--min-level min-level> Only execute tests with a B<level>
1911 above or equal to the numerical B<min-level>.
1913 B<--privoxy-address proxy-address> Privoxy's listening address.
1914 If it's not set, the value of the environment variable http_proxy
1915 will be used. B<proxy-address> has to be specified in http_proxy
1918 B<--retries retries> Retry B<retries> times.
1920 B<--test-number test-number> Only run the test with the specified
1923 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1925 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
1926 debugging issues with systems that don't log with millisecond precision.
1928 B<--verbose> Log successful tests as well. By default only
1929 the failures are logged.
1931 B<--version> Print version and exit.
1933 The second dash is optional, options can be shortened,
1934 as long as there are no ambiguities.
1936 =head1 PRIVOXY CONFIGURATION
1938 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1939 which aims to test all official client-header modifying actions
1940 and can be used to verify that the templates and the user manual
1941 files are installed correctly.
1943 To use it, it has to be copied in Privoxy's configuration
1944 directory, and afterwards referenced in Privoxy's configuration
1947 actionsfile regression-tests.action
1949 In general, its tests are supposed to work without changing
1950 any other action files, unless you already added lots of
1951 taggers yourself. If you are using taggers that cause problems,
1952 you might have to temporary disable them for Privoxy's CGI pages.
1954 Some of the regression tests rely on Privoxy features that
1955 may be disabled in your configuration. Tests with a level below
1956 7 are supposed to work with all Privoxy configurations (provided
1957 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1959 Tests with level 9 require Privoxy to deliver the User Manual,
1960 tests with level 12 require the CGI editor to be enabled.
1964 Expect the configuration file syntax to change with future releases.
1968 As Privoxy's B<show-request> page only shows client headers,
1969 Privoxy-Regression-Test can't use it to test Privoxy actions
1970 that modify server headers.
1972 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1973 control the actions to test, it currently only works with
1974 Privoxy 3.0.7 or later.
1976 At the moment Privoxy-Regression-Test fetches Privoxy's
1977 configuration page through I<curl>(1), therefore you have to
1978 have I<curl> installed, otherwise you won't be able to run
1979 Privoxy-Regression-Test in a meaningful way.
1987 Fabian Keil <fk@fabiankeil.de>