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.98 2016/05/12 08:43:12 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-2016 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.7',
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 # Internal use, don't modify
70 # Available debug bits:
72 LL_VERBOSE_FAILURE => 2,
73 LL_PAGE_FETCHING => 4,
75 LL_VERBOSE_SUCCESS => 16,
78 CLIENT_HEADER_TEST => 1,
79 SERVER_HEADER_TEST => 2,
82 STICKY_ACTIONS_TEST => 5,
83 TRUSTED_CGI_REQUEST => 6,
88 sub init_our_variables () {
90 our $leading_log_time = LEADING_LOG_TIME;
91 our $leading_log_date = LEADING_LOG_DATE;
92 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
93 our $log_level = get_default_log_level();
96 sub get_default_log_level () {
100 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
101 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
102 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
103 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
104 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
106 # This one is supposed to be always on.
107 $log_level |= LL_SOFT_ERROR;
112 ############################################################################
114 # File loading functions
116 ############################################################################
124 # Unescape brackets and dots
125 $tag =~ s@\\(?=[{}().+])@@g;
127 # log_message("Parsed tag: " . $tag);
129 check_for_forbidden_characters($tag);
134 sub check_for_forbidden_characters ($) {
137 my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]';
139 unless ($string =~ m/^$allowed*$/o) {
140 my $forbidden = $string;
141 $forbidden =~ s@^$allowed*(.).*@$1@;
143 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
147 sub load_regression_tests() {
148 if (cli_option_is_set('local-test-file')) {
149 load_regression_tests_from_file(get_cli_option('local-test-file'));
151 load_regression_tests_through_privoxy();
155 # XXX: Contains a lot of code duplicated from load_action_files()
156 # that should be factored out.
157 sub load_regression_tests_from_file ($) {
158 my $action_file = shift;
162 our @regression_tests;
164 my $si = 0; # Section index
165 my $ri = -1; # Regression test index
170 my $sticky_actions = undef;
172 l(LL_STATUS, "Gathering regression tests from local file " . $action_file);
174 open(my $ACTION_FILE, "<", $action_file)
175 or log_and_die("Failed to open $action_file: $!");
177 while (<$ACTION_FILE>) {
181 my ($token, $value) = tokenize($_);
183 next unless defined $token;
185 # Load regression tests
187 if (token_starts_new_test($token)) {
189 # Beginning of new regression test.
192 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
193 $no_checks = 1; # Already validated by enlist_new_test().
196 if ($token =~ /level\s+(\d+)/i) {
199 register_dependency($level, $value);
202 if ($token eq 'sticky actions') {
204 # Will be used by each following Sticky URL.
205 $sticky_actions = $value;
206 if ($sticky_actions =~ /{[^}]*\s/) {
207 log_and_die("'Sticky Actions' with whitespace inside the " .
208 "action parameters are currently unsupported.");
212 if ($si == -1 || $ri == -1) {
213 # No beginning of a test detected yet,
214 # so we don't care about any other test
219 if ($token eq 'expect header') {
221 l(LL_FILE_LOADING, "Detected expectation: " . $value);
222 $regression_tests[$si][$ri]{'expect-header'} = $value;
224 } elsif ($token eq 'tag') {
228 my $tag = parse_tag($value);
230 # We already checked in parse_tag() after filtering
233 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
235 # Save tag for all tests in this section
237 $regression_tests[$si][$ri]{'tag'} = $tag;
243 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
245 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
246 $regression_tests[$si][$ri]{'ignore'} = 1;
249 } elsif ($token eq 'expect status code') {
251 l(LL_FILE_LOADING, "Expecting status code: " . $value);
252 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
254 } elsif ($token eq 'level') { # XXX: stupid name
256 $value =~ s@(\d+).*@$1@;
257 l(LL_FILE_LOADING, "Level: " . $value);
258 $regression_tests[$si][$ri]{'level'} = $value;
260 } elsif ($token eq 'method') {
262 l(LL_FILE_LOADING, "Method: " . $value);
263 $regression_tests[$si][$ri]{'method'} = $value;
265 } elsif ($token eq 'redirect destination') {
267 l(LL_FILE_LOADING, "Redirect destination: " . $value);
268 $regression_tests[$si][$ri]{'redirect destination'} = $value;
270 } elsif ($token eq 'url') {
272 if (defined $sticky_actions) {
273 die "WTF? Attempted to overwrite Sticky Actions"
274 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
276 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
277 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
279 log_and_die("Sticky URL without Sticky Actions: $value");
284 # We don't use it, so we don't need
286 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
290 unless ($no_checks) {
291 check_for_forbidden_characters($value);
292 check_for_forbidden_characters($token);
296 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
297 . " Of which " . $ignored. " will be ignored)\n");
302 sub load_regression_tests_through_privoxy () {
304 our $privoxy_cgi_url;
306 our %privoxy_features;
311 my $privoxy_version = '(Unknown version!)';
313 $curl_url .= $privoxy_cgi_url;
314 $curl_url .= 'show-status';
316 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
318 # Dear Privoxy, please reload the config file if necessary ...
319 get_cgi_page_or_else($curl_url);
321 # ... so we get the latest one here.
322 foreach (@{get_cgi_page_or_else($curl_url)}) {
325 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
327 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
328 $actionfiles[$file_number++] = $url;
330 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
332 my $directive = $1 . " " . $2;
333 push (@privoxy_config, $directive);
335 } elsif (m@<td><code>([^<]*)</code></td>@) {
339 } elsif (m@<td> (Yes|No) </td>@) {
341 $privoxy_features{$feature} = $1 if defined $feature;
344 } elsif (m@This is <a href="https?://www.privoxy.org/">Privoxy</a> (\d+\.\d+\.\d+) on@) {
345 $privoxy_version = $1;
349 l(LL_STATUS, "Gathering regression tests from " .
350 @actionfiles . " action file(s) delivered by Privoxy $privoxy_version.");
352 load_action_files(\@actionfiles);
355 sub token_starts_new_test ($) {
358 my @new_test_directives = ('set header', 'fetch test',
359 'trusted cgi request', 'request header', 'method test',
360 'blocked url', 'url', 'redirected url');
362 foreach my $new_test_directive (@new_test_directives) {
363 return 1 if $new_test_directive eq $token;
371 my ($token, $value) = (undef, undef);
373 # Remove leading and trailing white space and a
374 # a leading <pre> which is part of the first line.
378 # Reverse HTML-encoding
379 # XXX: Seriously incomplete.
384 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
389 $token =~ s@\s\s+@ @g;
390 $token =~ tr/[A-Z]/[a-z]/;
392 } elsif (/^TAG\s*:(.*)$/) {
398 return ($token, $value);
401 sub enlist_new_test ($$$$$$) {
403 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
407 if ($token eq 'set header') {
409 l(LL_FILE_LOADING, "Header to set: " . $value);
410 $type = CLIENT_HEADER_TEST;
411 $executor = \&execute_client_header_regression_test;
413 } elsif ($token eq 'request header') {
415 l(LL_FILE_LOADING, "Header to request: " . $value);
416 $type = SERVER_HEADER_TEST;
417 $executor = \&execute_server_header_regression_test;
418 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
420 } elsif ($token eq 'trusted cgi request') {
422 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
423 $type = TRUSTED_CGI_REQUEST;
424 $executor = \&execute_dumb_fetch_test;
425 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
427 } elsif ($token eq 'fetch test') {
429 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
430 $type = DUMB_FETCH_TEST;
431 $executor = \&execute_dumb_fetch_test;
432 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
434 } elsif ($token eq 'method test') {
436 l(LL_FILE_LOADING, "Method to test: " . $value);
438 $executor = \&execute_method_test;
439 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
441 } elsif ($token eq 'blocked url') {
443 l(LL_FILE_LOADING, "URL to block-test: " . $value);
444 $executor = \&execute_block_test;
447 } elsif ($token eq 'url') {
449 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
450 $type = STICKY_ACTIONS_TEST;
451 $executor = \&execute_sticky_actions_test;
453 } elsif ($token eq 'redirected url') {
455 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
456 $type = REDIRECT_TEST;
457 $executor = \&execute_redirect_test;
461 die "Incomplete '" . $token . "' support detected.";
464 $$regression_tests[$si][$ri]{'type'} = $type;
465 $$regression_tests[$si][$ri]{'level'} = $type;
466 $$regression_tests[$si][$ri]{'executor'} = $executor;
468 check_for_forbidden_characters($value);
470 $$regression_tests[$si][$ri]{'data'} = $value;
472 # For function that only get passed single tests
473 $$regression_tests[$si][$ri]{'section-id'} = $si;
474 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
475 $$regression_tests[$si][$ri]{'number'} = $number - 1;
477 "Regression test " . $number . " (section:" . $si . "):");
480 sub mark_matching_tests_for_skipping($) {
481 my $overwrite_condition = shift;
483 our @regression_tests;
485 for (my $s = 0; $s < @regression_tests; $s++) {
489 while (defined $regression_tests[$s][$r]) {
491 if ($regression_tests[$s][$r]{'data'} eq $overwrite_condition) {
492 my $message = sprintf("Marking test %s for ignoring. Overwrite condition: %s.",
493 $regression_tests[$s][$r]{'number'}, $overwrite_condition);
495 l(LL_FILE_LOADING, $message);
497 # XXX: Should eventually get its own key so get_skip_reason()
498 # can tell about the overwrite condition.
499 $regression_tests[$s][$r]{'ignore'} = 1;
507 # XXX: Shares a lot of code with load_regression_tests_from_file()
508 # that should be factored out.
509 sub load_action_files ($) {
513 our @regression_tests;
515 my $actionfiles_ref = shift;
516 my @actionfiles = @{$actionfiles_ref};
518 my $si = 0; # Section index
519 my $ri = -1; # Regression test index
524 for my $file_number (0 .. @actionfiles - 1) {
526 my $curl_url = quote($actionfiles[$file_number]);
527 my $actionfile = undef;
528 my $sticky_actions = undef;
529 my $level_offset = 0;
531 foreach (@{get_cgi_page_or_else($curl_url)}) {
536 if (/<h2>Contents of Actions File (.*?)</) {
540 next unless defined $actionfile;
544 my ($token, $value) = tokenize($_);
546 next unless defined $token;
548 # Load regression tests
549 if ($token eq 'default level offset') {
551 $level_offset = $value;
552 l(LL_FILE_LOADING, "Setting default level offset to " . $level_offset);
555 if (token_starts_new_test($token)) {
557 # Beginning of new regression test.
560 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
561 $no_checks = 1; # Already validated by enlist_new_test().
562 if ($level_offset != 0) {
563 $regression_tests[$si][$ri]{'level'} += $level_offset;
567 if ($token =~ /level\s+(\d+)/i) {
570 register_dependency($level, $value);
573 if ($token eq 'sticky actions') {
575 # Will be used by each following Sticky URL.
576 $sticky_actions = $value;
577 if ($sticky_actions =~ /{[^}]*\s/) {
578 log_and_die("'Sticky Actions' with whitespace inside the " .
579 "action parameters are currently unsupported.");
583 if ($token eq 'overwrite condition') {
585 l(LL_FILE_LOADING, "Detected overwrite condition: " . $value);
586 # We can only skip matching tests that have already
587 # be loaded but that is exactly what we want anyway.
588 mark_matching_tests_for_skipping($value);
592 if ($si == -1 || $ri == -1) {
593 # No beginning of a test detected yet,
594 # so we don't care about any other test
599 if ($token eq 'expect header') {
601 l(LL_FILE_LOADING, "Detected expectation: " . $value);
602 $regression_tests[$si][$ri]{'expect-header'} = $value;
604 } elsif ($token eq 'tag') {
608 my $tag = parse_tag($value);
610 # We already checked in parse_tag() after filtering
613 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
615 # Save tag for all tests in this section
617 $regression_tests[$si][$ri]{'tag'} = $tag;
623 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
625 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
626 $regression_tests[$si][$ri]{'ignore'} = 1;
629 } elsif ($token eq 'expect status code') {
631 l(LL_FILE_LOADING, "Expecting status code: " . $value);
632 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
634 } elsif ($token eq 'level') { # XXX: stupid name
636 $value =~ s@(\d+).*@$1@;
637 l(LL_FILE_LOADING, "Level: " . $value);
638 $regression_tests[$si][$ri]{'level'} = $value;
640 } elsif ($token eq 'method') {
642 l(LL_FILE_LOADING, "Method: " . $value);
643 $regression_tests[$si][$ri]{'method'} = $value;
645 } elsif ($token eq 'redirect destination') {
647 l(LL_FILE_LOADING, "Redirect destination: " . $value);
648 $regression_tests[$si][$ri]{'redirect destination'} = $value;
650 } elsif ($token eq 'url') {
652 if (defined $sticky_actions) {
653 die "WTF? Attempted to overwrite Sticky Actions"
654 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
656 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
657 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
659 log_and_die("Sticky URL without Sticky Actions: $value");
664 # We don't use it, so we don't need
666 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
670 unless ($no_checks) {
671 check_for_forbidden_characters($value);
672 check_for_forbidden_characters($token);
677 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
678 . " Of which " . $ignored. " will be ignored)\n");
681 ############################################################################
683 # Regression test executing functions
685 ############################################################################
687 # Fisher Yates shuffle from Perl's "How do I shuffle an array randomly?" FAQ
688 sub fisher_yates_shuffle ($) {
692 my $j = int rand($i+1);
693 @$deck[$i,$j] = @$deck[$j,$i];
697 sub execute_regression_tests () {
699 our @regression_tests;
700 my $loops = get_cli_option('loops');
702 my $all_failures = 0;
703 my $all_successes = 0;
705 unless (@regression_tests) {
707 l(LL_STATUS, "No regression tests found.");
711 l(LL_STATUS, "Executing regression tests ...");
713 while ($loops-- > 0) {
720 if (cli_option_is_set('shuffle-tests')) {
722 # Shuffle both the test sections and
723 # the tests they contain.
725 # XXX: With the current data layout, shuffling tests
726 # from different sections isn't possible.
727 # Is this worth changing the layout?
728 fisher_yates_shuffle(\@regression_tests);
729 for (my $s = 0; $s < @regression_tests; $s++) {
730 fisher_yates_shuffle($regression_tests[$s]);
734 for (my $s = 0; $s < @regression_tests; $s++) {
738 while (defined $regression_tests[$s][$r]) {
740 unless (cli_option_is_set('shuffle-tests')) {
741 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
742 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
744 die "Internal error. Test executor missing."
745 unless defined $regression_tests[$s][$r]{executor};
747 my $number = $regression_tests[$s][$r]{'number'};
748 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
750 if (defined $skip_reason) {
752 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
753 log_message($message) if (cli_option_is_set('show-skipped-tests'));
758 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
760 log_result($regression_tests[$s][$r], $result, $tests);
762 $successes += $result;
764 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
769 $failures = $tests - $successes;
771 log_message("Executed " . $tests . " regression tests. " .
772 'Skipped ' . $skipped . '. ' .
773 $successes . " successes, " . $failures . " failures.");
775 $all_tests += $tests;
776 $all_failures += $failures;
777 $all_successes += $successes;
780 if (get_cli_option('loops') > 1) {
781 log_message("Total: Executed " . $all_tests . " regression tests. " .
782 $all_successes . " successes, " . $all_failures . " failures.");
786 sub get_skip_reason ($) {
788 my $skip_reason = undef;
790 if ($test->{'ignore'}) {
792 $skip_reason = "Ignore flag is set";
794 } elsif (cli_option_is_set('test-number') and
795 get_cli_option('test-number') != $test->{'number'}) {
797 $skip_reason = "Only executing test " . get_cli_option('test-number');
801 $skip_reason = level_is_unacceptable($test->{'level'});
807 sub level_is_unacceptable ($) {
809 my $min_level = get_cli_option('min-level');
810 my $max_level = get_cli_option('max-level');
811 my $required_level = cli_option_is_set('level') ?
812 get_cli_option('level') : $level;
815 if ($required_level != $level) {
817 $reason = "Level doesn't match (" . $level .
818 " != " . $required_level . ")"
820 } elsif ($level < $min_level) {
822 $reason = "Level too low (" . $level . " < " . $min_level . ")";
824 } elsif ($level > $max_level) {
826 $reason = "Level too high (" . $level . " > " . $max_level . ")";
830 $reason = dependency_unsatisfied($level);
836 sub dependency_unsatisfied ($) {
841 our %privoxy_features;
843 my $dependency_problem = undef;
845 if (defined ($dependencies{$level}{'config line'})) {
847 my $dependency = $dependencies{$level}{'config line'};
848 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
850 foreach (@privoxy_config) {
853 $dependency_problem = undef;
860 if (defined ($dependencies{$level}{'feature status'})
861 and not defined $dependency_problem) {
863 my $dependency = $dependencies{$level}{'feature status'};
864 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
866 unless (defined($privoxy_features{$feature})
867 and ($privoxy_features{$feature} eq $status))
869 $dependency_problem = "depends on '" . $feature .
870 "' being set to '" . $status . "'";
874 return $dependency_problem;
877 sub register_dependency ($$) {
880 my $dependency = shift;
883 if ($dependency =~ /config line\s+(.*)/) {
885 $dependencies{$level}{'config line'} = $1;
887 } elsif ($dependency =~ /feature status\s+(.*)/) {
889 $dependencies{$level}{'feature status'} = $1;
893 log_and_die("Didn't recognize dependency: $dependency.");
897 sub execute_method_test ($) {
902 my $method = $test->{'data'};
904 my $curl_parameters = '';
905 my $expected_status_code = $test->{'expected-status-code'};
907 $curl_parameters .= '--request ' . $method . ' ';
908 # Don't complain about the 'missing' body
909 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
911 $curl_parameters .= PRIVOXY_CGI_URL;
913 $buffer_ref = get_page_with_curl($curl_parameters);
914 $status_code = get_status_code($buffer_ref);
916 return check_status_code_result($status_code, $expected_status_code);
919 sub execute_redirect_test ($) {
925 my $curl_parameters = '';
926 my $url = $test->{'data'};
927 my $redirect_destination;
928 my $expected_redirect_destination = $test->{'redirect destination'};
930 # XXX: Check if a redirect actually applies before doing the request.
931 # otherwise the test may hit a real server in failure cases.
933 $curl_parameters .= '--head ';
935 $curl_parameters .= quote($url);
937 $buffer_ref = get_page_with_curl($curl_parameters);
938 $status_code = get_status_code($buffer_ref);
940 if ($status_code ne "302") {
941 l(LL_VERBOSE_FAILURE,
942 "Ooops. Expected redirect to: '" . $expected_redirect_destination
943 . "' but got a response with status code: " . $status_code);
946 foreach (@{$buffer_ref}) {
947 if (/^Location: (.*)\r\n/) {
948 $redirect_destination = $1;
953 my $success = ($redirect_destination eq $expected_redirect_destination);
956 l(LL_VERBOSE_FAILURE,
957 "Ooops. Expected redirect to: '" . $expected_redirect_destination
958 . "' but the redirect leads to: '" . $redirect_destination. "'");
964 sub execute_dumb_fetch_test ($) {
970 my $curl_parameters = '';
971 my $expected_status_code = $test->{'expected-status-code'};
973 if (defined $test->{method}) {
974 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
976 if ($test->{type} == TRUSTED_CGI_REQUEST) {
977 $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' ';
980 $curl_parameters .= quote($test->{'data'});
982 $buffer_ref = get_page_with_curl($curl_parameters);
983 $status_code = get_status_code($buffer_ref);
985 return check_status_code_result($status_code, $expected_status_code);
988 sub execute_block_test ($) {
991 my $url = $test->{'data'};
992 my $final_results = get_final_results($url);
994 return defined $final_results->{'+block'};
997 sub execute_sticky_actions_test ($) {
1000 my $url = $test->{'data'};
1001 my $verified_actions = 0;
1002 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
1003 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
1004 my $final_results = get_final_results($url);
1006 foreach my $sticky_action (@sticky_actions) {
1008 if (defined $final_results->{$sticky_action}) {
1010 $verified_actions++;
1012 } elsif ($sticky_action =~ /-.*\{/) {
1014 # Disabled multi actions aren't explicitly listed as
1015 # disabled and thus have to be checked by verifying
1016 # that they aren't enabled.
1017 $verified_actions++;
1020 l(LL_VERBOSE_FAILURE,
1021 "Ooops. '$sticky_action' is not among the final results.");
1025 return $verified_actions == @sticky_actions;
1028 sub get_final_results ($) {
1031 my $curl_parameters = '';
1032 my %final_results = ();
1033 my $final_results_reached = 0;
1035 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
1036 # XXX: should be URL-encoded properly
1043 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
1045 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
1047 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
1049 next unless ($final_results_reached);
1052 # Privoxy versions before 3.0.16 add a space
1053 # between action name and parameters, therefore
1055 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
1059 if (defined $parameter) {
1060 # In case the caller needs to check
1061 # the action and its parameter
1062 $final_results{$action . $parameter} = 1;
1064 # In case the action doesn't have parameters
1065 # or the caller doesn't care for the parameter.
1066 $final_results{$action} = 1;
1070 return \%final_results;
1073 sub check_status_code_result ($$) {
1075 my $status_code = shift;
1076 my $expected_status_code = shift;
1079 unless (defined $status_code) {
1081 # XXX: should probably be caught earlier.
1082 l(LL_VERBOSE_FAILURE,
1083 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
1085 } elsif ($expected_status_code == $status_code) {
1088 l(LL_VERBOSE_SUCCESS,
1089 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
1091 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
1093 l(LL_VERBOSE_FAILURE,
1094 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
1098 l(LL_VERBOSE_FAILURE,
1099 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
1105 sub execute_client_header_regression_test ($) {
1111 $buffer_ref = get_show_request_with_curl($test);
1113 $header = get_header($buffer_ref, $test);
1115 return check_header_result($test, $header);
1118 sub execute_server_header_regression_test ($) {
1124 $buffer_ref = get_head_with_curl($test);
1126 $header = get_server_header($buffer_ref, $test);
1128 return check_header_result($test, $header);
1131 sub interpret_result ($) {
1132 my $success = shift;
1133 return $success ? "Success" : "Failure";
1136 sub check_header_result ($$) {
1141 my $expect_header = $test->{'expect-header'};
1144 if ($expect_header eq 'NO CHANGE') {
1146 $success = (defined($header) and $header eq $test->{'data'});
1149 $header = "REMOVAL" unless defined $header;
1150 l(LL_VERBOSE_FAILURE,
1151 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1154 } elsif ($expect_header eq 'REMOVAL') {
1156 # XXX: Use more reliable check here and make sure
1157 # the header has a different name.
1158 $success = not (defined($header) and $header eq $test->{'data'});
1161 l(LL_VERBOSE_FAILURE,
1162 "Ooops. Expected removal but: '" . $header . "' is still there.");
1165 } elsif ($expect_header eq 'SOME CHANGE') {
1167 $success = (defined($header) and $header ne $test->{'data'});
1170 $header = "REMOVAL" unless defined $header;
1171 l(LL_VERBOSE_FAILURE,
1172 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
1177 $success = (defined($header) and $header eq $expect_header);
1180 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
1181 l(LL_VERBOSE_FAILURE,
1182 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1188 sub get_header_name ($) {
1192 $header =~ s@(.*?: ).*@$1@;
1197 sub get_header ($$) {
1199 our $filtered_request = '';
1201 my $buffer_ref = shift;
1204 my @buffer = @{$buffer_ref};
1206 my $expect_header = $test->{'expect-header'};
1208 die "get_header called with no expect header" unless defined $expect_header;
1211 my $processed_request_reached = 0;
1212 my $read_header = 0;
1213 my $processed_request = '';
1217 if ($expect_header eq 'REMOVAL'
1218 or $expect_header eq 'NO CHANGE'
1219 or $expect_header eq 'SOME CHANGE') {
1221 $expect_header = $test->{'data'};
1224 $header_to_get = get_header_name($expect_header);
1228 # Skip everything before the Processed request
1229 if (/Processed Request/) {
1230 $processed_request_reached = 1;
1233 next unless $processed_request_reached;
1235 # End loop after the Processed request
1236 last if (/<\/pre>/);
1238 # Ditch tags and leading/trailing white space.
1242 # Decode characters we care about.
1245 $filtered_request .= "\n" . $_;
1247 if (/^$header_to_get/) {
1257 sub get_server_header ($$) {
1259 my $buffer_ref = shift;
1262 my @buffer = @{$buffer_ref};
1264 my $expect_header = $test->{'expect-header'};
1268 # XXX: Should be caught before starting to test.
1269 log_and_die("No expect header for test " . $test->{'number'})
1270 unless defined $expect_header;
1272 if ($expect_header eq 'REMOVAL'
1273 or $expect_header eq 'NO CHANGE'
1274 or $expect_header eq 'SOME CHANGE') {
1276 $expect_header = $test->{'data'};
1279 $header_to_get = get_header_name($expect_header);
1283 # XXX: should probably verify that the request
1284 # was actually answered by Fellatio.
1285 if (/^$header_to_get/) {
1287 $header =~ s@\s*$@@g;
1295 sub get_status_code ($) {
1297 my $buffer_ref = shift;
1298 my @buffer = @{$buffer_ref};
1302 if (/^HTTP\/\d\.\d (\d{3})/) {
1308 return '123' if cli_option_is_set('fuzzer-feeding');
1310 log_and_die('Unexpected buffer line: "' . $_ . '"');
1315 sub get_test_keys () {
1316 return ('tag', 'data', 'expect-header', 'ignore');
1320 sub test_content_as_string ($) {
1326 foreach my $key (get_test_keys()) {
1327 $test->{$key} = 'Not set' unless (defined $test->{$key});
1330 $s .= 'Tag: ' . $test->{'tag'};
1332 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1334 $s .= 'Expected header: ' . $test->{'expect-header'};
1336 $s .= 'Ignore: ' . $test->{'ignore'};
1341 sub fuzz_header($) {
1343 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1345 $white_space = $white_space x (1 + int(rand(5)));
1347 # Only fuzz white space before the first quoted token.
1348 # (Privoxy doesn't touch white space inside quoted tokens
1349 # and modifying it would cause the tests to fail).
1350 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1355 ############################################################################
1357 # HTTP fetch functions
1359 ############################################################################
1361 sub get_cgi_page_or_else ($) {
1363 my $cgi_url = shift;
1364 my $content_ref = get_page_with_curl($cgi_url);
1365 my $status_code = get_status_code($content_ref);
1367 if (200 != $status_code) {
1369 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1370 "Received status code ". $status_code .
1371 " while only 200 is acceptable.";
1373 if (cli_option_is_set('fuzzer-feeding')) {
1375 $log_message .= " Ignored due to fuzzer feeding.";
1376 l(LL_SOFT_ERROR, $log_message)
1380 log_and_die($log_message);
1384 return $content_ref;
1387 # XXX: misleading name
1388 sub get_show_request_with_curl ($) {
1390 our $privoxy_cgi_url;
1393 my $curl_parameters = ' ';
1394 my $header = $test->{'data'};
1396 if (cli_option_is_set('header-fuzzing')) {
1397 $header = fuzz_header($header);
1400 # Enable the action to test
1401 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1402 # The header to filter
1403 $curl_parameters .= '-H \'' . $header . '\' ';
1405 $curl_parameters .= ' ';
1406 $curl_parameters .= $privoxy_cgi_url;
1407 $curl_parameters .= 'show-request';
1409 return get_cgi_page_or_else($curl_parameters);
1412 sub get_head_with_curl ($) {
1414 our $fellatio_url = FELLATIO_URL;
1417 my $curl_parameters = ' ';
1419 # Enable the action to test
1420 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1421 # The header to filter
1422 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1423 $curl_parameters .= '--head ';
1425 $curl_parameters .= ' ';
1426 $curl_parameters .= $fellatio_url;
1428 return get_page_with_curl($curl_parameters);
1431 sub get_page_with_curl ($) {
1435 my $parameters = shift;
1437 my $curl_line = CURL;
1438 my $retries_left = get_cli_option('retries') + 1;
1441 if (defined $proxy) {
1442 $curl_line .= ' --proxy ' . quote($proxy);
1444 # We want to see the HTTP status code
1445 $curl_line .= " --include ";
1446 # Let Privoxy emit two log messages less.
1447 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1448 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1449 # We don't care about fetch statistic.
1450 $curl_line .= " -s ";
1451 # We do care about the failure reason if any.
1452 $curl_line .= " -S ";
1453 # We want to advertise ourselves
1454 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1455 # We aren't too patient
1456 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1458 $curl_line .= $parameters;
1459 # XXX: still necessary?
1460 $curl_line .= ' 2>&1';
1462 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1465 @buffer = `$curl_line`;
1468 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1469 $failure_reason = array_as_string(\@buffer);
1470 chomp $failure_reason;
1471 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1473 } while ($? && --$retries_left);
1475 unless ($retries_left) {
1476 log_and_die("Running curl failed " . get_cli_option('retries') .
1477 " times in a row. Last error: '" . $failure_reason . "'.");
1484 ############################################################################
1488 ############################################################################
1490 sub array_as_string ($) {
1491 my $array_ref = shift;
1494 foreach (@{$array_ref}) {
1503 log_message('Test is:' . test_content_as_string($test));
1509 my $this_level = shift;
1510 my $message = shift;
1512 log_message($message) if ($log_level & $this_level);
1515 sub log_and_die ($) {
1516 my $message = shift;
1518 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1522 sub log_message ($) {
1524 my $message = shift;
1528 our $leading_log_date;
1529 our $leading_log_time;
1531 my $time_stamp = '';
1532 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1534 if ($leading_log_date || $leading_log_time) {
1536 if ($leading_log_date) {
1539 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1542 if ($leading_log_time) {
1543 $time_stamp .= ' ' if $leading_log_date;
1544 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1547 $message = $time_stamp . ": " . $message;
1550 printf("%s\n", $message);
1553 sub log_result ($$) {
1555 our $filtered_request;
1561 my $message = sprintf("%s for test %d",
1562 interpret_result($result),
1565 if (cli_option_is_set('verbose')) {
1566 $message .= sprintf(" (%d/%d/%d)", $number,
1567 $test->{'section-id'},
1568 $test->{'regression-test-id'});
1573 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1575 $message .= 'Header ';
1576 $message .= quote($test->{'data'});
1577 $message .= ' and tag ';
1578 $message .= quote($test->{'tag'});
1580 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1582 $message .= 'Request Header ';
1583 $message .= quote($test->{'data'});
1584 $message .= ' and tag ';
1585 $message .= quote($test->{'tag'});
1587 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1590 $message .= quote($test->{'data'});
1591 $message .= ' and expected status code ';
1592 $message .= quote($test->{'expected-status-code'});
1594 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1596 $message .= 'CGI URL ';
1597 $message .= quote($test->{'data'});
1598 $message .= ' and expected status code ';
1599 $message .= quote($test->{'expected-status-code'});
1601 } elsif ($test->{'type'} == METHOD_TEST) {
1603 $message .= 'HTTP method ';
1604 $message .= quote($test->{'data'});
1605 $message .= ' and expected status code ';
1606 $message .= quote($test->{'expected-status-code'});
1608 } elsif ($test->{'type'} == BLOCK_TEST) {
1610 $message .= 'Supposedly-blocked URL: ';
1611 $message .= quote($test->{'data'});
1613 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1615 $message .= 'Sticky Actions: ';
1616 $message .= quote($test->{'sticky-actions'});
1617 $message .= ' and URL: ';
1618 $message .= quote($test->{'data'});
1620 } elsif ($test->{'type'} == REDIRECT_TEST) {
1622 $message .= 'Redirected URL: ';
1623 $message .= quote($test->{'data'});
1624 $message .= ' and redirect destination: ';
1625 $message .= quote($test->{'redirect destination'});
1629 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1632 log_message($message) if (!$result or cli_option_is_set('verbose'));
1637 return '\'' . $s . '\'';
1640 sub print_version () {
1641 printf PRT_VERSION . "\n";
1644 sub list_test_types () {
1646 'Client header test' => CLIENT_HEADER_TEST,
1647 'Server header test' => 2,
1648 'Dumb fetch test' => 3,
1650 'Sticky action test' => 5,
1651 'Trusted CGI test' => 6,
1653 'Redirect test' => 108,
1656 print "\nThe supported test types and their default levels are:\n";
1657 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1658 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1670 Options and their default values if they have any:
1671 [--debug $cli_options{'debug'}]
1672 [--forks $cli_options{'forks'}]
1679 [--loops $cli_options{'loops'}]
1680 [--max-level $cli_options{'max-level'}]
1681 [--max-time $cli_options{'max-time'}]
1682 [--min-level $cli_options{'min-level'}]
1684 [--retries $cli_options{'retries'}]
1685 [--show-skipped-tests]
1687 [--sleep-time $cli_options{'sleep-time'}]
1698 Try "perldoc $0" for more information
1705 sub init_cli_options () {
1710 $cli_options{'debug'} = $log_level;
1711 $cli_options{'forks'} = CLI_FORKS;
1712 $cli_options{'loops'} = CLI_LOOPS;
1713 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1714 $cli_options{'max-time'} = CLI_MAX_TIME;
1715 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1716 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1717 $cli_options{'retries'} = CLI_RETRIES;
1720 sub parse_cli_options () {
1728 'debug=i' => \$cli_options{'debug'},
1729 'forks=i' => \$cli_options{'forks'},
1730 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1731 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1732 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1734 'level=i' => \$cli_options{'level'},
1735 'local-test-file=s' => \$cli_options{'local-test-file'},
1736 'loops=i' => \$cli_options{'loops'},
1737 'max-level=i' => \$cli_options{'max-level'},
1738 'max-time=i' => \$cli_options{'max-time'},
1739 'min-level=i' => \$cli_options{'min-level'},
1740 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1741 'retries=i' => \$cli_options{'retries'},
1742 'shuffle-tests' => \$cli_options{'shuffle-tests'},
1743 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1744 'sleep-time=i' => \$cli_options{'sleep-time'},
1745 'test-number=i' => \$cli_options{'test-number'},
1746 'verbose' => \$cli_options{'verbose'},
1747 'version' => sub {print_version && exit(0)}
1749 $log_level |= $cli_options{'debug'};
1752 sub cli_option_is_set ($) {
1755 my $cli_option = shift;
1757 return defined $cli_options{$cli_option};
1760 sub get_cli_option ($) {
1763 my $cli_option = shift;
1765 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1767 return $cli_options{$cli_option};
1770 sub init_proxy_settings($) {
1775 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1776 $proxy = get_cli_option('fuzzer-address');
1779 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1781 if (cli_option_is_set('privoxy-address')) {
1782 $proxy .= get_cli_option('privoxy-address');
1787 sub start_forks($) {
1790 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1792 foreach my $fork (1 .. $forks) {
1793 log_message("Starting fork $fork");
1795 if (defined $pid && !$pid) {
1803 init_our_variables();
1804 parse_cli_options();
1805 init_proxy_settings('vanilla-proxy');
1806 load_regression_tests();
1807 init_proxy_settings('fuzz-proxy');
1808 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1809 execute_regression_tests();
1816 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1820 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1821 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1822 [B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>]
1823 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1824 [B<--retries retries>] [B<--test-number test-number>]
1825 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1830 Privoxy-Regression-Test is supposed to one day become
1831 a regression test suite for Privoxy. It's not quite there
1832 yet, however, and can currently only test header actions,
1833 check the returned status code for requests to arbitrary
1834 URLs and verify which actions are applied to them.
1836 Client header actions are tested by requesting
1837 B<http://p.p/show-request> and checking whether
1838 or not Privoxy modified the original request as expected.
1840 The original request contains both the header the action-to-be-tested
1841 acts upon and an additional tagger-triggering header that enables
1844 Applied actions are checked through B<http://p.p/show-url-info>.
1846 =head1 CONFIGURATION FILE SYNTAX
1848 Privoxy-Regression-Test's configuration is embedded in
1849 Privoxy action files and loaded through Privoxy's web interface.
1851 It makes testing a Privoxy version running on a remote system easier
1852 and should prevent you from updating your tests without updating Privoxy's
1853 configuration accordingly.
1855 A client-header-action test section looks like this:
1857 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1858 # Expect Header = Referer: http://www.example.org/
1859 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1860 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1862 The example above causes Privoxy-Regression-Test to set
1863 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1864 and to expect it to be modified to
1865 B<Referer: http://www.example.org/>.
1867 When testing this section, Privoxy-Regression-Test will set the header
1868 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1869 causing the B<privoxy-control> tagger to create the tag
1870 B<client-header-filter{hide-tor-exit-notation}> which will finally
1871 cause Privoxy to enable the action section.
1873 Note that the actions itself are only used by Privoxy,
1874 Privoxy-Regression-Test ignores them and will be happy
1875 as long as the expectations are satisfied.
1877 A fetch test looks like this:
1879 # Fetch Test = http://p.p/user-manual
1880 # Expect Status Code = 302
1882 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1883 and to expect a response with the HTTP status code B<302>. Obviously that's
1884 not a very thorough test and mainly useful to get some code coverage
1885 for Valgrind or to verify that the templates are installed correctly.
1887 If you want to test CGI pages that require a trusted
1888 referer, you can use:
1890 # Trusted CGI Request = http://p.p/edit-actions
1892 It works like ordinary fetch tests, but sets the referer
1893 header to a trusted value.
1895 If no explicit status code expectation is set, B<200> is used.
1897 To verify that a URL is blocked, use:
1899 # Blocked URL = http://www.example.com/blocked
1901 To verify that a specific set of actions is applied to an URL, use:
1903 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1904 # URL = http://www.example.org/my-first-url
1906 The sticky actions will be checked for all URLs below it
1907 until the next sticky actions directive.
1909 To verify that requests for a URL get redirected, use:
1911 # Redirected URL = http://www.example.com/redirect-me
1912 # Redirect Destination = http://www.example.org/redirected
1914 To skip a test, add the following line:
1918 The difference between a skipped test and a removed one is that removing
1919 a test affects the numbers of the following tests, while a skipped test
1920 is still loaded and thus keeps the test numbers unchanged.
1922 Sometimes user modifications intentionally conflict with tests in the
1923 default configuration and thus cause test failures. Adding the Ignore
1924 directive to the failing tests works but is inconvenient as the directive
1925 is likely to get lost with the next update.
1927 Overwrite conditions are an alternative and can be added in any action
1928 file as long as the come after the test that is expected to fail.
1929 They causes all previous tests a matching the condition to be skipped.
1931 It is recommended to put the overwrite condition below the custom Privoxy
1932 section that causes the expected test failure and before the custom test
1933 that verifies that tests the now expected behaviour. Example:
1935 # The following section is expected to overwrite a section in
1936 # default.action, whose effect is being tested. Thus also disable
1937 # the test that is now expected to fail and add a new one.
1939 {+block{Facebook makes Firefox even more unstable. Do not want.}}
1940 # Overwrite condition = http://apps.facebook.com/onthefarm/track.php?creative=&cat=friendvisit&subcat=weeds&key=a789a971dc687bee4c20c044834fabdd&next=index.php%3Fref%3Dnotif%26visitId%3D898835505
1941 # Blocked URL = http://apps.facebook.com/
1946 All tests have test levels to let the user
1947 control which ones to execute (see I<OPTIONS> below).
1948 Test levels are either set with the B<Level> directive,
1949 or implicitly through the test type.
1951 Redirect tests default to level 108, block tests to level 7,
1952 fetch tests to level 6, "Sticky Actions" tests default to
1953 level 5, tests for trusted CGI requests to level 3 and
1954 client-header-action tests to level 1.
1956 The current redirect test level is above the default
1957 max-level value as failed tests will result in outgoing
1958 connections. Use the B<--max-level> option to run them
1961 The "Default level offset" directive can be used to change
1962 the default level by a given value. This directive affects
1963 all tests located after it until the end of the file or a another
1964 "Default level offset" directive is reached. The purpose of this
1965 directive is to make it more convenient to skip similar tests in
1966 a given file without having to remove or disable the tests completely.
1970 B<--debug bitmask> Add the bitmask provided as integer
1971 to the debug settings.
1973 B<--forks forks> Number of forks to start before executing
1974 the regression tests. This is mainly useful for stress-testing.
1976 B<--fuzzer-address> Listening address used when executing
1977 the regression tests. Useful to make sure that the requests
1978 to load the regression tests don't fail due to fuzzing.
1980 B<--fuzzer-feeding> Ignore some errors that would otherwise
1981 cause Privoxy-Regression-Test to abort the test because
1982 they shouldn't happen in normal operation. This option is
1983 intended to be used if Privoxy-Regression-Test is only
1984 used to feed a fuzzer in which case there's a high chance
1985 that Privoxy gets an invalid request and returns an error
1988 B<--help> Shows available command line options.
1990 B<--header-fuzzing> Modifies linear white space in
1991 headers in a way that should not affect the test result.
1993 B<--level level> Only execute tests with the specified B<level>.
1995 B<--local-test-file test-file> Do not get the tests
1996 through Privoxy's web interface, but use a single local
1997 file. Not recommended for testing Privoxy, but can be useful
1998 to "misappropriate" Privoxy-Regression-Test to test other
1999 stuff, like webserver configurations.
2001 B<--loop count> Loop through the regression tests B<count> times.
2002 Useful to feed a fuzzer, or when doing stress tests with
2003 several Privoxy-Regression-Test instances running at the same
2006 B<--max-level max-level> Only execute tests with a B<level>
2007 below or equal to the numerical B<max-level>.
2009 B<--max-time max-time> Give Privoxy B<max-time> seconds
2010 to return data. Increasing the default may make sense when
2011 Privoxy is run through Valgrind, decreasing the default may
2012 make sense when Privoxy-Regression-Test is used to feed
2015 B<--min-level min-level> Only execute tests with a B<level>
2016 above or equal to the numerical B<min-level>.
2018 B<--privoxy-address proxy-address> Privoxy's listening address.
2019 If it's not set, the value of the environment variable http_proxy
2020 will be used. B<proxy-address> has to be specified in http_proxy
2023 B<--retries retries> Retry B<retries> times.
2025 B<--test-number test-number> Only run the test with the specified
2028 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
2030 B<--shuffle-tests> Shuffle test sections and their tests before
2031 executing them. When combined with B<--forks>, this can increase
2032 the chances of detecting race conditions. Of course some problems
2033 are easier to detect without this option.
2035 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
2036 debugging issues with systems that don't log with millisecond precision.
2038 B<--verbose> Log successful tests as well. By default only
2039 the failures are logged.
2041 B<--version> Print version and exit.
2043 The second dash is optional, options can be shortened,
2044 as long as there are no ambiguities.
2046 =head1 PRIVOXY CONFIGURATION
2048 Privoxy-Regression-Test is shipped with B<regression-tests.action>
2049 which aims to test all official client-header modifying actions
2050 and can be used to verify that the templates and the user manual
2051 files are installed correctly.
2053 To use it, it has to be copied in Privoxy's configuration
2054 directory, and afterwards referenced in Privoxy's configuration
2057 actionsfile regression-tests.action
2059 In general, its tests are supposed to work without changing
2060 any other action files, unless you already added lots of
2061 taggers yourself. If you are using taggers that cause problems,
2062 you might have to temporary disable them for Privoxy's CGI pages.
2064 Some of the regression tests rely on Privoxy features that
2065 may be disabled in your configuration. Tests with a level below
2066 7 are supposed to work with all Privoxy configurations (provided
2067 you didn't build with FEATURE_GRACEFUL_TERMINATION).
2069 Tests with level 9 require Privoxy to deliver the User Manual,
2070 tests with level 12 require the CGI editor to be enabled.
2074 Expect the configuration file syntax to change with future releases.
2078 As Privoxy's B<show-request> page only shows client headers,
2079 Privoxy-Regression-Test can't use it to test Privoxy actions
2080 that modify server headers.
2082 As Privoxy-Regression-Test relies on Privoxy's tag feature to
2083 control the actions to test, it currently only works with
2084 Privoxy 3.0.7 or later.
2086 At the moment Privoxy-Regression-Test fetches Privoxy's
2087 configuration page through I<curl>(1), therefore you have to
2088 have I<curl> installed, otherwise you won't be able to run
2089 Privoxy-Regression-Test in a meaningful way.
2097 Fabian Keil <fk@fabiankeil.de>