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.88 2013/01/06 18:19:24 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-2013 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.6',
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;
314 my $privoxy_version = '(Unknown version!)';
316 $curl_url .= $privoxy_cgi_url;
317 $curl_url .= 'show-status';
319 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
321 # Dear Privoxy, please reload the config file if necessary ...
322 get_cgi_page_or_else($curl_url);
324 # ... so we get the latest one here.
325 foreach (@{get_cgi_page_or_else($curl_url)}) {
328 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
330 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
331 $actionfiles[$file_number++] = $url;
333 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
335 my $directive = $1 . " " . $2;
336 push (@privoxy_config, $directive);
338 } elsif (m@<td><code>([^<]*)</code></td>@) {
342 } elsif (m@<td> (Yes|No) </td>@) {
344 $privoxy_features{$feature} = $1 if defined $feature;
347 } elsif (m@This is <a href="http://www.privoxy.org/">Privoxy</a> (\d+\.\d+\.\d+) on@) {
348 $privoxy_version = $1;
352 l(LL_STATUS, "Gathering regression tests from " .
353 @actionfiles . " action file(s) delivered by Privoxy $privoxy_version.");
355 load_action_files(\@actionfiles);
358 sub token_starts_new_test ($) {
361 my @new_test_directives = ('set header', 'fetch test',
362 'trusted cgi request', 'request header', 'method test',
363 'blocked url', 'url', 'redirected url');
365 foreach my $new_test_directive (@new_test_directives) {
366 return 1 if $new_test_directive eq $token;
374 my ($token, $value) = (undef, undef);
376 # Remove leading and trailing white space.
380 # Reverse HTML-encoding
381 # XXX: Seriously incomplete.
386 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
391 $token =~ s@\s\s+@ @g;
392 $token =~ tr/[A-Z]/[a-z]/;
394 } elsif (/^TAG\s*:(.*)$/) {
400 return ($token, $value);
403 sub enlist_new_test ($$$$$$) {
405 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
409 if ($token eq 'set header') {
411 l(LL_FILE_LOADING, "Header to set: " . $value);
412 $type = CLIENT_HEADER_TEST;
413 $executor = \&execute_client_header_regression_test;
415 } elsif ($token eq 'request header') {
417 l(LL_FILE_LOADING, "Header to request: " . $value);
418 $type = SERVER_HEADER_TEST;
419 $executor = \&execute_server_header_regression_test;
420 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
422 } elsif ($token eq 'trusted cgi request') {
424 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
425 $type = TRUSTED_CGI_REQUEST;
426 $executor = \&execute_dumb_fetch_test;
427 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
429 } elsif ($token eq 'fetch test') {
431 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
432 $type = DUMB_FETCH_TEST;
433 $executor = \&execute_dumb_fetch_test;
434 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
436 } elsif ($token eq 'method test') {
438 l(LL_FILE_LOADING, "Method to test: " . $value);
440 $executor = \&execute_method_test;
441 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
443 } elsif ($token eq 'blocked url') {
445 l(LL_FILE_LOADING, "URL to block-test: " . $value);
446 $executor = \&execute_block_test;
449 } elsif ($token eq 'url') {
451 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
452 $type = STICKY_ACTIONS_TEST;
453 $executor = \&execute_sticky_actions_test;
455 } elsif ($token eq 'redirected url') {
457 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
458 $type = REDIRECT_TEST;
459 $executor = \&execute_redirect_test;
463 die "Incomplete '" . $token . "' support detected.";
466 $$regression_tests[$si][$ri]{'type'} = $type;
467 $$regression_tests[$si][$ri]{'level'} = $type;
468 $$regression_tests[$si][$ri]{'executor'} = $executor;
470 check_for_forbidden_characters($value);
472 $$regression_tests[$si][$ri]{'data'} = $value;
474 # For function that only get passed single tests
475 $$regression_tests[$si][$ri]{'section-id'} = $si;
476 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
477 $$regression_tests[$si][$ri]{'number'} = $number - 1;
479 "Regression test " . $number . " (section:" . $si . "):");
482 sub mark_matching_tests_for_skipping($) {
483 my $overwrite_condition = shift;
485 our @regression_tests;
487 for (my $s = 0; $s < @regression_tests; $s++) {
491 while (defined $regression_tests[$s][$r]) {
493 if ($regression_tests[$s][$r]{'data'} eq $overwrite_condition) {
494 my $message = sprintf("Marking test %s for ignoring. Overwrite condition: %s.",
495 $regression_tests[$s][$r]{'number'}, $overwrite_condition);
497 # XXX: Should eventually be downgraded to LL_FILE_LOADING.
498 log_message($message);
500 # XXX: Should eventually get its own key so get_skip_reason()
501 # can tell about the overwrite condition.
502 $regression_tests[$s][$r]{'ignore'} = 1;
510 # XXX: Shares a lot of code with load_regression_tests_from_file()
511 # that should be factored out.
512 sub load_action_files ($) {
516 our @regression_tests;
518 my $actionfiles_ref = shift;
519 my @actionfiles = @{$actionfiles_ref};
521 my $si = 0; # Section index
522 my $ri = -1; # Regression test index
527 for my $file_number (0 .. @actionfiles - 1) {
529 my $curl_url = quote($actionfiles[$file_number]);
530 my $actionfile = undef;
531 my $sticky_actions = undef;
533 foreach (@{get_cgi_page_or_else($curl_url)}) {
538 if (/<h2>Contents of Actions File (.*?)</) {
542 next unless defined $actionfile;
546 my ($token, $value) = tokenize($_);
548 next unless defined $token;
550 # Load regression tests
552 if (token_starts_new_test($token)) {
554 # Beginning of new regression test.
557 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
558 $no_checks = 1; # Already validated by enlist_new_test().
561 if ($token =~ /level\s+(\d+)/i) {
564 register_dependency($level, $value);
567 if ($token eq 'sticky actions') {
569 # Will be used by each following Sticky URL.
570 $sticky_actions = $value;
571 if ($sticky_actions =~ /{[^}]*\s/) {
572 log_and_die("'Sticky Actions' with whitespace inside the " .
573 "action parameters are currently unsupported.");
577 if ($token eq 'overwrite condition') {
579 l(LL_FILE_LOADING, "Detected overwrite condition: " . $value);
580 # We can only skip matching tests that have already
581 # be loaded but that is exactly what we want anyway.
582 mark_matching_tests_for_skipping($value);
586 if ($si == -1 || $ri == -1) {
587 # No beginning of a test detected yet,
588 # so we don't care about any other test
593 if ($token eq 'expect header') {
595 l(LL_FILE_LOADING, "Detected expectation: " . $value);
596 $regression_tests[$si][$ri]{'expect-header'} = $value;
598 } elsif ($token eq 'tag') {
602 my $tag = parse_tag($value);
604 # We already checked in parse_tag() after filtering
607 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
609 # Save tag for all tests in this section
611 $regression_tests[$si][$ri]{'tag'} = $tag;
617 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
619 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
620 $regression_tests[$si][$ri]{'ignore'} = 1;
623 } elsif ($token eq 'expect status code') {
625 l(LL_FILE_LOADING, "Expecting status code: " . $value);
626 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
628 } elsif ($token eq 'level') { # XXX: stupid name
630 $value =~ s@(\d+).*@$1@;
631 l(LL_FILE_LOADING, "Level: " . $value);
632 $regression_tests[$si][$ri]{'level'} = $value;
634 } elsif ($token eq 'method') {
636 l(LL_FILE_LOADING, "Method: " . $value);
637 $regression_tests[$si][$ri]{'method'} = $value;
639 } elsif ($token eq 'redirect destination') {
641 l(LL_FILE_LOADING, "Redirect destination: " . $value);
642 $regression_tests[$si][$ri]{'redirect destination'} = $value;
644 } elsif ($token eq 'url') {
646 if (defined $sticky_actions) {
647 die "WTF? Attempted to overwrite Sticky Actions"
648 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
650 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
651 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
653 log_and_die("Sticky URL without Sticky Actions: $value");
658 # We don't use it, so we don't need
660 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
664 unless ($no_checks) {
665 check_for_forbidden_characters($value);
666 check_for_forbidden_characters($token);
671 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
672 . " Of which " . $ignored. " will be ignored)\n");
675 ############################################################################
677 # Regression test executing functions
679 ############################################################################
681 # Fisher Yates shuffle from Perl's "How do I shuffle an array randomly?" FAQ
682 sub fisher_yates_shuffle ($) {
686 my $j = int rand($i+1);
687 @$deck[$i,$j] = @$deck[$j,$i];
691 sub execute_regression_tests () {
693 our @regression_tests;
694 my $loops = get_cli_option('loops');
696 my $all_failures = 0;
697 my $all_successes = 0;
699 unless (@regression_tests) {
701 l(LL_STATUS, "No regression tests found.");
705 l(LL_STATUS, "Executing regression tests ...");
707 while ($loops-- > 0) {
714 if (cli_option_is_set('shuffle-tests')) {
716 # Shuffle both the test sections and
717 # the tests they contain.
719 # XXX: With the current data layout, shuffling tests
720 # from different sections isn't possible.
721 # Is this worth changing the layout?
722 fisher_yates_shuffle(\@regression_tests);
723 for (my $s = 0; $s < @regression_tests; $s++) {
724 fisher_yates_shuffle($regression_tests[$s]);
728 for (my $s = 0; $s < @regression_tests; $s++) {
732 while (defined $regression_tests[$s][$r]) {
734 unless (cli_option_is_set('shuffle-tests')) {
735 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
736 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
738 die "Internal error. Test executor missing."
739 unless defined $regression_tests[$s][$r]{executor};
741 my $number = $regression_tests[$s][$r]{'number'};
742 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
744 if (defined $skip_reason) {
746 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
747 log_message($message) if (cli_option_is_set('show-skipped-tests'));
752 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
754 log_result($regression_tests[$s][$r], $result, $tests);
756 $successes += $result;
758 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
763 $failures = $tests - $successes;
765 log_message("Executed " . $tests . " regression tests. " .
766 'Skipped ' . $skipped . '. ' .
767 $successes . " successes, " . $failures . " failures.");
769 $all_tests += $tests;
770 $all_failures += $failures;
771 $all_successes += $successes;
774 if (get_cli_option('loops') > 1) {
775 log_message("Total: Executed " . $all_tests . " regression tests. " .
776 $all_successes . " successes, " . $all_failures . " failures.");
780 sub get_skip_reason ($) {
782 my $skip_reason = undef;
784 if ($test->{'ignore'}) {
786 $skip_reason = "Ignore flag is set";
788 } elsif (cli_option_is_set('test-number') and
789 get_cli_option('test-number') != $test->{'number'}) {
791 $skip_reason = "Only executing test " . get_cli_option('test-number');
795 $skip_reason = level_is_unacceptable($test->{'level'});
801 sub level_is_unacceptable ($) {
803 my $min_level = get_cli_option('min-level');
804 my $max_level = get_cli_option('max-level');
805 my $required_level = cli_option_is_set('level') ?
806 get_cli_option('level') : $level;
809 if ($required_level != $level) {
811 $reason = "Level doesn't match (" . $level .
812 " != " . $required_level . ")"
814 } elsif ($level < $min_level) {
816 $reason = "Level too low (" . $level . " < " . $min_level . ")";
818 } elsif ($level > $max_level) {
820 $reason = "Level too high (" . $level . " > " . $max_level . ")";
824 $reason = dependency_unsatisfied($level);
830 sub dependency_unsatisfied ($) {
835 our %privoxy_features;
837 my $dependency_problem = undef;
839 if (defined ($dependencies{$level}{'config line'})) {
841 my $dependency = $dependencies{$level}{'config line'};
842 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
844 foreach (@privoxy_config) {
847 $dependency_problem = undef;
854 if (defined ($dependencies{$level}{'feature status'})
855 and not defined $dependency_problem) {
857 my $dependency = $dependencies{$level}{'feature status'};
858 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
860 unless (defined($privoxy_features{$feature})
861 and ($privoxy_features{$feature} eq $status))
863 $dependency_problem = "depends on '" . $feature .
864 "' being set to '" . $status . "'";
868 return $dependency_problem;
871 sub register_dependency ($$) {
874 my $dependency = shift;
877 if ($dependency =~ /config line\s+(.*)/) {
879 $dependencies{$level}{'config line'} = $1;
881 } elsif ($dependency =~ /feature status\s+(.*)/) {
883 $dependencies{$level}{'feature status'} = $1;
887 log_and_die("Didn't recognize dependency: $dependency.");
891 sub execute_method_test ($) {
896 my $method = $test->{'data'};
898 my $curl_parameters = '';
899 my $expected_status_code = $test->{'expected-status-code'};
901 $curl_parameters .= '--request ' . $method . ' ';
902 # Don't complain about the 'missing' body
903 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
905 $curl_parameters .= PRIVOXY_CGI_URL;
907 $buffer_ref = get_page_with_curl($curl_parameters);
908 $status_code = get_status_code($buffer_ref);
910 return check_status_code_result($status_code, $expected_status_code);
913 sub execute_redirect_test ($) {
919 my $curl_parameters = '';
920 my $url = $test->{'data'};
921 my $redirect_destination;
922 my $expected_redirect_destination = $test->{'redirect destination'};
924 # XXX: Check if a redirect actually applies before doing the request.
925 # otherwise the test may hit a real server in failure cases.
927 $curl_parameters .= '--head ';
929 $curl_parameters .= quote($url);
931 $buffer_ref = get_page_with_curl($curl_parameters);
932 $status_code = get_status_code($buffer_ref);
934 if ($status_code ne "302") {
935 l(LL_VERBOSE_FAILURE,
936 "Ooops. Expected redirect to: '" . $expected_redirect_destination
937 . "' but got a response with status code: " . $status_code);
940 foreach (@{$buffer_ref}) {
941 if (/^Location: (.*)\r\n/) {
942 $redirect_destination = $1;
947 my $success = ($redirect_destination eq $expected_redirect_destination);
950 l(LL_VERBOSE_FAILURE,
951 "Ooops. Expected redirect to: '" . $expected_redirect_destination
952 . "' but the redirect leads to: '" . $redirect_destination. "'");
958 sub execute_dumb_fetch_test ($) {
964 my $curl_parameters = '';
965 my $expected_status_code = $test->{'expected-status-code'};
967 if (defined $test->{method}) {
968 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
970 if ($test->{type} == TRUSTED_CGI_REQUEST) {
971 $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' ';
974 $curl_parameters .= quote($test->{'data'});
976 $buffer_ref = get_page_with_curl($curl_parameters);
977 $status_code = get_status_code($buffer_ref);
979 return check_status_code_result($status_code, $expected_status_code);
982 sub execute_block_test ($) {
985 my $url = $test->{'data'};
986 my $final_results = get_final_results($url);
988 return defined $final_results->{'+block'};
991 sub execute_sticky_actions_test ($) {
994 my $url = $test->{'data'};
995 my $verified_actions = 0;
996 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
997 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
998 my $final_results = get_final_results($url);
1000 foreach my $sticky_action (@sticky_actions) {
1002 if (defined $final_results->{$sticky_action}) {
1004 $verified_actions++;
1006 } elsif ($sticky_action =~ /-.*\{/) {
1008 # Disabled multi actions aren't explicitly listed as
1009 # disabled and thus have to be checked by verifying
1010 # that they aren't enabled.
1011 $verified_actions++;
1014 l(LL_VERBOSE_FAILURE,
1015 "Ooops. '$sticky_action' is not among the final results.");
1019 return $verified_actions == @sticky_actions;
1022 sub get_final_results ($) {
1025 my $curl_parameters = '';
1026 my %final_results = ();
1027 my $final_results_reached = 0;
1029 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
1030 # XXX: should be URL-encoded properly
1037 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
1039 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
1041 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
1043 next unless ($final_results_reached);
1046 # Privoxy versions before 3.0.16 add a space
1047 # between action name and parameters, therefore
1049 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
1053 if (defined $parameter) {
1054 # In case the caller needs to check
1055 # the action and its parameter
1056 $final_results{$action . $parameter} = 1;
1058 # In case the action doesn't have parameters
1059 # or the caller doesn't care for the parameter.
1060 $final_results{$action} = 1;
1064 return \%final_results;
1067 sub check_status_code_result ($$) {
1069 my $status_code = shift;
1070 my $expected_status_code = shift;
1073 unless (defined $status_code) {
1075 # XXX: should probably be caught earlier.
1076 l(LL_VERBOSE_FAILURE,
1077 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
1079 } elsif ($expected_status_code == $status_code) {
1082 l(LL_VERBOSE_SUCCESS,
1083 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
1085 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
1087 l(LL_VERBOSE_FAILURE,
1088 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
1092 l(LL_VERBOSE_FAILURE,
1093 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
1099 sub execute_client_header_regression_test ($) {
1105 $buffer_ref = get_show_request_with_curl($test);
1107 $header = get_header($buffer_ref, $test);
1109 return check_header_result($test, $header);
1112 sub execute_server_header_regression_test ($) {
1118 $buffer_ref = get_head_with_curl($test);
1120 $header = get_server_header($buffer_ref, $test);
1122 return check_header_result($test, $header);
1125 sub interpret_result ($) {
1126 my $success = shift;
1127 return $success ? "Success" : "Failure";
1130 sub check_header_result ($$) {
1135 my $expect_header = $test->{'expect-header'};
1138 if ($expect_header eq 'NO CHANGE') {
1140 $success = (defined($header) and $header eq $test->{'data'});
1143 $header = "REMOVAL" unless defined $header;
1144 l(LL_VERBOSE_FAILURE,
1145 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1148 } elsif ($expect_header eq 'REMOVAL') {
1150 # XXX: Use more reliable check here and make sure
1151 # the header has a different name.
1152 $success = not (defined($header) and $header eq $test->{'data'});
1155 l(LL_VERBOSE_FAILURE,
1156 "Ooops. Expected removal but: '" . $header . "' is still there.");
1159 } elsif ($expect_header eq 'SOME CHANGE') {
1161 $success = (defined($header) and $header ne $test->{'data'});
1164 $header = "REMOVAL" unless defined $header;
1165 l(LL_VERBOSE_FAILURE,
1166 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
1171 $success = (defined($header) and $header eq $expect_header);
1174 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
1175 l(LL_VERBOSE_FAILURE,
1176 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1182 sub get_header_name ($) {
1186 $header =~ s@(.*?: ).*@$1@;
1191 sub get_header ($$) {
1193 our $filtered_request = '';
1195 my $buffer_ref = shift;
1198 my @buffer = @{$buffer_ref};
1200 my $expect_header = $test->{'expect-header'};
1202 die "get_header called with no expect header" unless defined $expect_header;
1205 my $processed_request_reached = 0;
1206 my $read_header = 0;
1207 my $processed_request = '';
1211 if ($expect_header eq 'REMOVAL'
1212 or $expect_header eq 'NO CHANGE'
1213 or $expect_header eq 'SOME CHANGE') {
1215 $expect_header = $test->{'data'};
1218 $header_to_get = get_header_name($expect_header);
1222 # Skip everything before the Processed request
1223 if (/Processed Request/) {
1224 $processed_request_reached = 1;
1227 next unless $processed_request_reached;
1229 # End loop after the Processed request
1230 last if (/<\/pre>/);
1232 # Ditch tags and leading/trailing white space.
1236 # Decode characters we care about.
1239 $filtered_request .= "\n" . $_;
1241 if (/^$header_to_get/) {
1251 sub get_server_header ($$) {
1253 my $buffer_ref = shift;
1256 my @buffer = @{$buffer_ref};
1258 my $expect_header = $test->{'expect-header'};
1262 # XXX: Should be caught before starting to test.
1263 log_and_die("No expect header for test " . $test->{'number'})
1264 unless defined $expect_header;
1266 if ($expect_header eq 'REMOVAL'
1267 or $expect_header eq 'NO CHANGE'
1268 or $expect_header eq 'SOME CHANGE') {
1270 $expect_header = $test->{'data'};
1273 $header_to_get = get_header_name($expect_header);
1277 # XXX: should probably verify that the request
1278 # was actually answered by Fellatio.
1279 if (/^$header_to_get/) {
1281 $header =~ s@\s*$@@g;
1289 sub get_status_code ($) {
1291 my $buffer_ref = shift;
1292 my @buffer = @{$buffer_ref};
1296 if (/^HTTP\/\d\.\d (\d{3})/) {
1302 return '123' if cli_option_is_set('fuzzer-feeding');
1304 log_and_die('Unexpected buffer line: "' . $_ . '"');
1309 sub get_test_keys () {
1310 return ('tag', 'data', 'expect-header', 'ignore');
1314 sub test_content_as_string ($) {
1320 foreach my $key (get_test_keys()) {
1321 $test->{$key} = 'Not set' unless (defined $test->{$key});
1324 $s .= 'Tag: ' . $test->{'tag'};
1326 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1328 $s .= 'Expected header: ' . $test->{'expect-header'};
1330 $s .= 'Ignore: ' . $test->{'ignore'};
1335 sub fuzz_header($) {
1337 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1339 $white_space = $white_space x (1 + int(rand(5)));
1341 # Only fuzz white space before the first quoted token.
1342 # (Privoxy doesn't touch white space inside quoted tokens
1343 # and modifying it would cause the tests to fail).
1344 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1349 ############################################################################
1351 # HTTP fetch functions
1353 ############################################################################
1355 sub get_cgi_page_or_else ($) {
1357 my $cgi_url = shift;
1358 my $content_ref = get_page_with_curl($cgi_url);
1359 my $status_code = get_status_code($content_ref);
1361 if (200 != $status_code) {
1363 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1364 "Received status code ". $status_code .
1365 " while only 200 is acceptable.";
1367 if (cli_option_is_set('fuzzer-feeding')) {
1369 $log_message .= " Ignored due to fuzzer feeding.";
1370 l(LL_SOFT_ERROR, $log_message)
1374 log_and_die($log_message);
1378 return $content_ref;
1381 # XXX: misleading name
1382 sub get_show_request_with_curl ($) {
1384 our $privoxy_cgi_url;
1387 my $curl_parameters = ' ';
1388 my $header = $test->{'data'};
1390 if (cli_option_is_set('header-fuzzing')) {
1391 $header = fuzz_header($header);
1394 # Enable the action to test
1395 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1396 # The header to filter
1397 $curl_parameters .= '-H \'' . $header . '\' ';
1399 $curl_parameters .= ' ';
1400 $curl_parameters .= $privoxy_cgi_url;
1401 $curl_parameters .= 'show-request';
1403 return get_cgi_page_or_else($curl_parameters);
1406 sub get_head_with_curl ($) {
1408 our $fellatio_url = FELLATIO_URL;
1411 my $curl_parameters = ' ';
1413 # Enable the action to test
1414 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1415 # The header to filter
1416 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1417 $curl_parameters .= '--head ';
1419 $curl_parameters .= ' ';
1420 $curl_parameters .= $fellatio_url;
1422 return get_page_with_curl($curl_parameters);
1425 sub get_page_with_curl ($) {
1429 my $parameters = shift;
1431 my $curl_line = CURL;
1432 my $retries_left = get_cli_option('retries') + 1;
1435 if (defined $proxy) {
1436 $curl_line .= ' --proxy ' . quote($proxy);
1438 # We want to see the HTTP status code
1439 $curl_line .= " --include ";
1440 # Let Privoxy emit two log messages less.
1441 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1442 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1443 # We don't care about fetch statistic.
1444 $curl_line .= " -s ";
1445 # We do care about the failure reason if any.
1446 $curl_line .= " -S ";
1447 # We want to advertise ourselves
1448 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1449 # We aren't too patient
1450 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1452 $curl_line .= $parameters;
1453 # XXX: still necessary?
1454 $curl_line .= ' 2>&1';
1456 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1459 @buffer = `$curl_line`;
1462 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1463 $failure_reason = array_as_string(\@buffer);
1464 chomp $failure_reason;
1465 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1467 } while ($? && --$retries_left);
1469 unless ($retries_left) {
1470 log_and_die("Running curl failed " . get_cli_option('retries') .
1471 " times in a row. Last error: '" . $failure_reason . "'.");
1478 ############################################################################
1482 ############################################################################
1484 sub array_as_string ($) {
1485 my $array_ref = shift;
1488 foreach (@{$array_ref}) {
1497 log_message('Test is:' . test_content_as_string($test));
1503 my $this_level = shift;
1504 my $message = shift;
1506 log_message($message) if ($log_level & $this_level);
1509 sub log_and_die ($) {
1510 my $message = shift;
1512 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1516 sub log_message ($) {
1518 my $message = shift;
1522 our $leading_log_date;
1523 our $leading_log_time;
1525 my $time_stamp = '';
1526 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1528 if ($leading_log_date || $leading_log_time) {
1530 if ($leading_log_date) {
1533 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1536 if ($leading_log_time) {
1537 $time_stamp .= ' ' if $leading_log_date;
1538 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1541 $message = $time_stamp . ": " . $message;
1544 printf("%s\n", $message);
1547 sub log_result ($$) {
1549 our $verbose_test_description;
1550 our $filtered_request;
1556 my $message = sprintf("%s for test %d",
1557 interpret_result($result),
1560 if (cli_option_is_set('verbose')) {
1561 $message = sprintf(" (%d/%d/%d)", $number,
1562 $test->{'section-id'},
1563 $test->{'regression-test-id'});
1568 if ($verbose_test_description) {
1570 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1572 $message .= ' Header ';
1573 $message .= quote($test->{'data'});
1574 $message .= ' and tag ';
1575 $message .= quote($test->{'tag'});
1577 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1579 $message .= ' Request Header ';
1580 $message .= quote($test->{'data'});
1581 $message .= ' and tag ';
1582 $message .= quote($test->{'tag'});
1584 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1586 $message .= ' URL ';
1587 $message .= quote($test->{'data'});
1588 $message .= ' and expected status code ';
1589 $message .= quote($test->{'expected-status-code'});
1591 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1593 $message .= ' CGI URL ';
1594 $message .= quote($test->{'data'});
1595 $message .= ' and expected status code ';
1596 $message .= quote($test->{'expected-status-code'});
1598 } elsif ($test->{'type'} == METHOD_TEST) {
1600 $message .= ' HTTP method ';
1601 $message .= quote($test->{'data'});
1602 $message .= ' and expected status code ';
1603 $message .= quote($test->{'expected-status-code'});
1605 } elsif ($test->{'type'} == BLOCK_TEST) {
1607 $message .= ' Supposedly-blocked URL: ';
1608 $message .= quote($test->{'data'});
1610 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1612 $message .= ' Sticky Actions: ';
1613 $message .= quote($test->{'sticky-actions'});
1614 $message .= ' and URL: ';
1615 $message .= quote($test->{'data'});
1617 } elsif ($test->{'type'} == REDIRECT_TEST) {
1619 $message .= ' Redirected URL: ';
1620 $message .= quote($test->{'data'});
1621 $message .= ' and redirect destination: ';
1622 $message .= quote($test->{'redirect destination'});
1626 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1630 log_message($message) if (!$result or cli_option_is_set('verbose'));
1635 return '\'' . $s . '\'';
1638 sub print_version () {
1639 printf PRT_VERSION . "\n";
1642 sub list_test_types () {
1644 'Client header test' => CLIENT_HEADER_TEST,
1645 'Server header test' => 2,
1646 'Dumb fetch test' => 3,
1648 'Sticky action test' => 5,
1649 'Trusted CGI test' => 6,
1651 'Redirect test' => 108,
1654 print "\nThe supported test types and their default levels are:\n";
1655 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1656 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1668 Options and their default values if they have any:
1669 [--debug $cli_options{'debug'}]
1670 [--forks $cli_options{'forks'}]
1677 [--loops $cli_options{'loops'}]
1678 [--max-level $cli_options{'max-level'}]
1679 [--max-time $cli_options{'max-time'}]
1680 [--min-level $cli_options{'min-level'}]
1682 [--retries $cli_options{'retries'}]
1683 [--show-skipped-tests]
1685 [--sleep-time $cli_options{'sleep-time'}]
1696 Try "perldoc $0" for more information
1703 sub init_cli_options () {
1708 $cli_options{'debug'} = $log_level;
1709 $cli_options{'forks'} = CLI_FORKS;
1710 $cli_options{'loops'} = CLI_LOOPS;
1711 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1712 $cli_options{'max-time'} = CLI_MAX_TIME;
1713 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1714 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1715 $cli_options{'retries'} = CLI_RETRIES;
1718 sub parse_cli_options () {
1726 'debug=i' => \$cli_options{'debug'},
1727 'forks=i' => \$cli_options{'forks'},
1728 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1729 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1730 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1732 'level=i' => \$cli_options{'level'},
1733 'local-test-file=s' => \$cli_options{'local-test-file'},
1734 'loops=i' => \$cli_options{'loops'},
1735 'max-level=i' => \$cli_options{'max-level'},
1736 'max-time=i' => \$cli_options{'max-time'},
1737 'min-level=i' => \$cli_options{'min-level'},
1738 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1739 'retries=i' => \$cli_options{'retries'},
1740 'shuffle-tests' => \$cli_options{'shuffle-tests'},
1741 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1742 'sleep-time=i' => \$cli_options{'sleep-time'},
1743 'test-number=i' => \$cli_options{'test-number'},
1744 'verbose' => \$cli_options{'verbose'},
1745 'version' => sub {print_version && exit(0)}
1747 $log_level |= $cli_options{'debug'};
1750 sub cli_option_is_set ($) {
1753 my $cli_option = shift;
1755 return defined $cli_options{$cli_option};
1758 sub get_cli_option ($) {
1761 my $cli_option = shift;
1763 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1765 return $cli_options{$cli_option};
1768 sub init_proxy_settings($) {
1773 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1774 $proxy = get_cli_option('fuzzer-address');
1777 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1779 if (cli_option_is_set('privoxy-address')) {
1780 $proxy .= get_cli_option('privoxy-address');
1785 sub start_forks($) {
1788 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1790 foreach my $fork (1 .. $forks) {
1791 log_message("Starting fork $fork");
1793 if (defined $pid && !$pid) {
1801 init_our_variables();
1802 parse_cli_options();
1803 init_proxy_settings('vanilla-proxy');
1804 load_regression_tests();
1805 init_proxy_settings('fuzz-proxy');
1806 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1807 execute_regression_tests();
1814 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1818 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1819 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1820 [B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>]
1821 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1822 [B<--retries retries>] [B<--test-number test-number>]
1823 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1828 Privoxy-Regression-Test is supposed to one day become
1829 a regression test suite for Privoxy. It's not quite there
1830 yet, however, and can currently only test header actions,
1831 check the returned status code for requests to arbitrary
1832 URLs and verify which actions are applied to them.
1834 Client header actions are tested by requesting
1835 B<http://p.p/show-request> and checking whether
1836 or not Privoxy modified the original request as expected.
1838 The original request contains both the header the action-to-be-tested
1839 acts upon and an additional tagger-triggering header that enables
1842 Applied actions are checked through B<http://p.p/show-url-info>.
1844 =head1 CONFIGURATION FILE SYNTAX
1846 Privoxy-Regression-Test's configuration is embedded in
1847 Privoxy action files and loaded through Privoxy's web interface.
1849 It makes testing a Privoxy version running on a remote system easier
1850 and should prevent you from updating your tests without updating Privoxy's
1851 configuration accordingly.
1853 A client-header-action test section looks like this:
1855 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1856 # Expect Header = Referer: http://www.example.org/
1857 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1858 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1860 The example above causes Privoxy-Regression-Test to set
1861 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1862 and to expect it to be modified to
1863 B<Referer: http://www.example.org/>.
1865 When testing this section, Privoxy-Regression-Test will set the header
1866 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1867 causing the B<privoxy-control> tagger to create the tag
1868 B<client-header-filter{hide-tor-exit-notation}> which will finally
1869 cause Privoxy to enable the action section.
1871 Note that the actions itself are only used by Privoxy,
1872 Privoxy-Regression-Test ignores them and will be happy
1873 as long as the expectations are satisfied.
1875 A fetch test looks like this:
1877 # Fetch Test = http://p.p/user-manual
1878 # Expect Status Code = 302
1880 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1881 and to expect a response with the HTTP status code B<302>. Obviously that's
1882 not a very thorough test and mainly useful to get some code coverage
1883 for Valgrind or to verify that the templates are installed correctly.
1885 If you want to test CGI pages that require a trusted
1886 referer, you can use:
1888 # Trusted CGI Request = http://p.p/edit-actions
1890 It works like ordinary fetch tests, but sets the referer
1891 header to a trusted value.
1893 If no explicit status code expectation is set, B<200> is used.
1895 To verify that a URL is blocked, use:
1897 # Blocked URL = http://www.example.com/blocked
1899 To verify that a specific set of actions is applied to an URL, use:
1901 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1902 # URL = http://www.example.org/my-first-url
1904 The sticky actions will be checked for all URLs below it
1905 until the next sticky actions directive.
1907 To verify that requests for a URL get redirected, use:
1909 # Redirected URL = http://www.example.com/redirect-me
1910 # Redirect Destination = http://www.example.org/redirected
1912 To skip a test, add the following line:
1916 The difference between a skipped test and a removed one is that removing
1917 a test affects the numbers of the following tests, while a skipped test
1918 is still loaded and thus keeps the test numbers unchanged.
1920 Sometimes user modifications intentionally conflict with tests in the
1921 default configuration and thus cause test failures. Adding the Ignore
1922 directive to the failing tests works but is inconvenient as the directive
1923 is likely to get lost with the next update.
1925 Overwrite conditions are an alternative and can be added in any action
1926 file as long as the come after the test that is expected to fail.
1927 They causes all previous tests a matching the condition to be skipped.
1929 It is recommended to put the overwrite condition below the custom Privoxy
1930 section that causes the expected test failure and before the custom test
1931 that verifies that tests the now expected behaviour. Example:
1933 # The following section is expected to overwrite a section in
1934 # default.action, whose effect is tested. Thus also disable the
1935 # test that is now expected to fail and add a new one.
1937 {+block{Facebook makes Firefox even more unstable. Do not want.}}
1938 # Overwrite condition = http://apps.facebook.com/onthefarm/track.php?creative=&cat=friendvisit&subcat=weeds&key=a789a971dc687bee4c20c044834fabdd&next=index.php%3Fref%3Dnotif%26visitId%3D898835505
1939 # Blocked URL = http://apps.facebook.com/
1944 All tests have test levels to let the user
1945 control which ones to execute (see I<OPTIONS> below).
1946 Test levels are either set with the B<Level> directive,
1947 or implicitly through the test type.
1949 Redirect tests default to level 108, block tests to level 7,
1950 fetch tests to level 6, "Sticky Actions" tests default to
1951 level 5, tests for trusted CGI requests to level 3 and
1952 client-header-action tests to level 1.
1954 The current redirect test level is above the default
1955 max-level value as failed tests will result in outgoing
1956 connections. Use the B<--max-level> option to run them
1961 B<--debug bitmask> Add the bitmask provided as integer
1962 to the debug settings.
1964 B<--forks forks> Number of forks to start before executing
1965 the regression tests. This is mainly useful for stress-testing.
1967 B<--fuzzer-address> Listening address used when executing
1968 the regression tests. Useful to make sure that the requests
1969 to load the regression tests don't fail due to fuzzing.
1971 B<--fuzzer-feeding> Ignore some errors that would otherwise
1972 cause Privoxy-Regression-Test to abort the test because
1973 they shouldn't happen in normal operation. This option is
1974 intended to be used if Privoxy-Regression-Test is only
1975 used to feed a fuzzer in which case there's a high chance
1976 that Privoxy gets an invalid request and returns an error
1979 B<--help> Shows available command line options.
1981 B<--header-fuzzing> Modifies linear white space in
1982 headers in a way that should not affect the test result.
1984 B<--level level> Only execute tests with the specified B<level>.
1986 B<--local-test-file test-file> Do not get the tests
1987 through Privoxy's web interface, but use a single local
1988 file. Not recommended for testing Privoxy, but can be useful
1989 to "misappropriate" Privoxy-Regression-Test to test other
1990 stuff, like webserver configurations.
1992 B<--loop count> Loop through the regression tests B<count> times.
1993 Useful to feed a fuzzer, or when doing stress tests with
1994 several Privoxy-Regression-Test instances running at the same
1997 B<--max-level max-level> Only execute tests with a B<level>
1998 below or equal to the numerical B<max-level>.
2000 B<--max-time max-time> Give Privoxy B<max-time> seconds
2001 to return data. Increasing the default may make sense when
2002 Privoxy is run through Valgrind, decreasing the default may
2003 make sense when Privoxy-Regression-Test is used to feed
2006 B<--min-level min-level> Only execute tests with a B<level>
2007 above or equal to the numerical B<min-level>.
2009 B<--privoxy-address proxy-address> Privoxy's listening address.
2010 If it's not set, the value of the environment variable http_proxy
2011 will be used. B<proxy-address> has to be specified in http_proxy
2014 B<--retries retries> Retry B<retries> times.
2016 B<--test-number test-number> Only run the test with the specified
2019 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
2021 B<--shuffle-tests> Shuffle test sections and their tests before
2022 executing them. When combined with B<--forks>, this can increase
2023 the chances of detecting race conditions. Of course some problems
2024 are easier to detect without this option.
2026 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
2027 debugging issues with systems that don't log with millisecond precision.
2029 B<--verbose> Log successful tests as well. By default only
2030 the failures are logged.
2032 B<--version> Print version and exit.
2034 The second dash is optional, options can be shortened,
2035 as long as there are no ambiguities.
2037 =head1 PRIVOXY CONFIGURATION
2039 Privoxy-Regression-Test is shipped with B<regression-tests.action>
2040 which aims to test all official client-header modifying actions
2041 and can be used to verify that the templates and the user manual
2042 files are installed correctly.
2044 To use it, it has to be copied in Privoxy's configuration
2045 directory, and afterwards referenced in Privoxy's configuration
2048 actionsfile regression-tests.action
2050 In general, its tests are supposed to work without changing
2051 any other action files, unless you already added lots of
2052 taggers yourself. If you are using taggers that cause problems,
2053 you might have to temporary disable them for Privoxy's CGI pages.
2055 Some of the regression tests rely on Privoxy features that
2056 may be disabled in your configuration. Tests with a level below
2057 7 are supposed to work with all Privoxy configurations (provided
2058 you didn't build with FEATURE_GRACEFUL_TERMINATION).
2060 Tests with level 9 require Privoxy to deliver the User Manual,
2061 tests with level 12 require the CGI editor to be enabled.
2065 Expect the configuration file syntax to change with future releases.
2069 As Privoxy's B<show-request> page only shows client headers,
2070 Privoxy-Regression-Test can't use it to test Privoxy actions
2071 that modify server headers.
2073 As Privoxy-Regression-Test relies on Privoxy's tag feature to
2074 control the actions to test, it currently only works with
2075 Privoxy 3.0.7 or later.
2077 At the moment Privoxy-Regression-Test fetches Privoxy's
2078 configuration page through I<curl>(1), therefore you have to
2079 have I<curl> installed, otherwise you won't be able to run
2080 Privoxy-Regression-Test in a meaningful way.
2088 Fabian Keil <fk@fabiankeil.de>