3 ############################################################################
5 # Privoxy-Regression-Test
7 # A regression test "framework" for Privoxy. For documentation see:
8 # perldoc privoxy-regression-test.pl
12 # - Update documentation
13 # - Validate HTTP times.
14 # - Implement a HTTP_VERSION directive or allow to
15 # specify whole request lines.
16 # - Support filter regression tests.
17 # - Document magic Expect Header values
18 # - Internal fuzz support?
20 # Copyright (c) 2007-2020 Fabian Keil <fk@fabiankeil.de>
22 # Permission to use, copy, modify, and distribute this software for any
23 # purpose with or without fee is hereby granted, provided that the above
24 # copyright notice and this permission notice appear in all copies.
26 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
27 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
28 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
29 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
30 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
31 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
32 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34 ############################################################################
41 PRT_VERSION => 'Privoxy-Regression-Test 0.7.2',
50 # XXX: why limit at all?
55 PRIVOXY_CGI_URL => 'http://p.p/',
56 FELLATIO_URL => 'http://127.0.0.1:8080/',
57 LEADING_LOG_DATE => 1,
58 LEADING_LOG_TIME => 1,
60 DEBUG_LEVEL_FILE_LOADING => 0,
61 DEBUG_LEVEL_PAGE_FETCHING => 0,
62 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
63 # XXX: Only partly implemented and mostly useless.
64 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
65 DEBUG_LEVEL_STATUS => 1,
67 # Internal use, don't modify
68 # Available debug bits:
70 LL_VERBOSE_FAILURE => 2,
71 LL_PAGE_FETCHING => 4,
73 LL_VERBOSE_SUCCESS => 16,
76 CLIENT_HEADER_TEST => 1,
77 SERVER_HEADER_TEST => 2,
80 STICKY_ACTIONS_TEST => 5,
81 TRUSTED_CGI_REQUEST => 6,
86 sub init_our_variables() {
88 our $leading_log_time = LEADING_LOG_TIME;
89 our $leading_log_date = LEADING_LOG_DATE;
90 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
91 our $log_level = get_default_log_level();
94 sub get_default_log_level() {
98 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
99 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
100 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
101 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
102 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
104 # This one is supposed to be always on.
105 $log_level |= LL_SOFT_ERROR;
110 ############################################################################
112 # File loading functions
114 ############################################################################
122 # Unescape brackets and dots
123 $tag =~ s@\\(?=[{}().+])@@g;
125 # log_message("Parsed tag: " . $tag);
127 check_for_forbidden_characters($tag);
132 sub check_for_forbidden_characters($) {
135 my $allowed = '[-=\dA-Za-z~{}\[\]:./();\t ,+@"_%?&*^|]';
137 unless ($string =~ m/^$allowed*$/o) {
138 my $forbidden = $string;
139 $forbidden =~ s@^$allowed*(.).*@$1@;
141 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
145 sub load_regression_tests() {
146 if (cli_option_is_set('local-test-file')) {
147 load_regression_tests_from_file(get_cli_option('local-test-file'));
149 load_regression_tests_through_privoxy();
153 # XXX: Contains a lot of code duplicated from load_action_files()
154 # that should be factored out.
155 sub load_regression_tests_from_file($) {
156 my $action_file = shift;
160 our @regression_tests;
162 my $si = 0; # Section index
163 my $ri = -1; # Regression test index
168 my $sticky_actions = undef;
170 l(LL_STATUS, "Gathering regression tests from local file " . $action_file);
172 open(my $ACTION_FILE, "<", $action_file)
173 or log_and_die("Failed to open $action_file: $!");
175 while (<$ACTION_FILE>) {
179 my ($token, $value) = tokenize($_);
181 next unless defined $token;
183 # Load regression tests
185 if (token_starts_new_test($token)) {
187 # Beginning of new regression test.
190 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
191 $no_checks = 1; # Already validated by enlist_new_test().
194 if ($token =~ /level\s+(\d+)/i) {
197 register_dependency($level, $value);
200 if ($token eq 'sticky actions') {
202 # Will be used by each following Sticky URL.
203 $sticky_actions = $value;
204 if ($sticky_actions =~ /{[^}]*\s/) {
205 log_and_die("'Sticky Actions' with whitespace inside the " .
206 "action parameters are currently unsupported.");
210 if ($si == -1 || $ri == -1) {
211 # No beginning of a test detected yet,
212 # so we don't care about any other test
217 if ($token eq 'expect header') {
219 l(LL_FILE_LOADING, "Detected expectation: " . $value);
220 $regression_tests[$si][$ri]{'expect-header'} = $value;
222 } elsif ($token eq 'tag') {
226 my $tag = parse_tag($value);
228 # We already checked in parse_tag() after filtering
231 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
233 # Save tag for all tests in this section
235 $regression_tests[$si][$ri]{'tag'} = $tag;
241 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
243 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
244 $regression_tests[$si][$ri]{'ignore'} = 1;
247 } elsif ($token eq 'expect status code') {
249 l(LL_FILE_LOADING, "Expecting status code: " . $value);
250 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
252 } elsif ($token eq 'level') { # XXX: stupid name
254 $value =~ s@(\d+).*@$1@;
255 l(LL_FILE_LOADING, "Level: " . $value);
256 $regression_tests[$si][$ri]{'level'} = $value;
258 } elsif ($token eq 'method') {
260 l(LL_FILE_LOADING, "Method: " . $value);
261 $regression_tests[$si][$ri]{'method'} = $value;
263 } elsif ($token eq 'redirect destination') {
265 l(LL_FILE_LOADING, "Redirect destination: " . $value);
266 $regression_tests[$si][$ri]{'redirect destination'} = $value;
268 } elsif ($token eq 'url') {
270 if (defined $sticky_actions) {
271 die "WTF? Attempted to overwrite Sticky Actions"
272 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
274 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
275 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
277 log_and_die("Sticky URL without Sticky Actions in $action_file: $value");
282 # We don't use it, so we don't need
284 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
288 unless ($no_checks) {
289 check_for_forbidden_characters($value);
290 check_for_forbidden_characters($token);
294 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
295 . " Of which " . $ignored. " will be ignored)\n");
300 sub load_regression_tests_through_privoxy() {
302 our $privoxy_cgi_url;
304 our %privoxy_features;
309 my $privoxy_version = '(Unknown version!)';
311 $curl_url .= $privoxy_cgi_url;
312 $curl_url .= 'show-status';
314 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
316 # Dear Privoxy, please reload the config file if necessary ...
317 get_cgi_page_or_else($curl_url);
319 # ... so we get the latest one here.
320 foreach (@{get_cgi_page_or_else($curl_url)}) {
323 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
325 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
326 $actionfiles[$file_number++] = $url;
328 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
330 my $directive = $1 . " " . $2;
331 push (@privoxy_config, $directive);
333 } elsif (m@<td><code>([^<]*)</code></td>@) {
337 } elsif (m@<td> (Yes|No) </td>@) {
339 $privoxy_features{$feature} = $1 if defined $feature;
342 } elsif (m@This is <a href="https?://www.privoxy.org/">Privoxy</a> (\d+\.\d+\.\d+) on@) {
343 $privoxy_version = $1;
347 l(LL_STATUS, "Gathering regression tests from " .
348 @actionfiles . " action file(s) delivered by Privoxy $privoxy_version.");
350 load_action_files(\@actionfiles);
353 sub token_starts_new_test($) {
356 my @new_test_directives = ('set header', 'fetch test',
357 'trusted cgi request', 'request header', 'method test',
358 'blocked url', 'url', 'redirected url');
360 foreach my $new_test_directive (@new_test_directives) {
361 return 1 if $new_test_directive eq $token;
369 my ($token, $value) = (undef, undef);
371 # Remove leading and trailing white space and a
372 # a leading <pre> which is part of the first line.
376 # Reverse HTML-encoding
377 # XXX: Seriously incomplete.
382 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
387 $token =~ s@\s\s+@ @g;
388 $token =~ tr/[A-Z]/[a-z]/;
390 } elsif (/^TAG\s*:(.*)$/) {
396 return ($token, $value);
399 sub enlist_new_test($$$$$$) {
401 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
405 if ($token eq 'set header') {
407 l(LL_FILE_LOADING, "Header to set: " . $value);
408 $type = CLIENT_HEADER_TEST;
409 $executor = \&execute_client_header_regression_test;
411 } elsif ($token eq 'request header') {
413 l(LL_FILE_LOADING, "Header to request: " . $value);
414 $type = SERVER_HEADER_TEST;
415 $executor = \&execute_server_header_regression_test;
416 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
418 } elsif ($token eq 'trusted cgi request') {
420 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
421 $type = TRUSTED_CGI_REQUEST;
422 $executor = \&execute_dumb_fetch_test;
423 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
425 } elsif ($token eq 'fetch test') {
427 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
428 $type = DUMB_FETCH_TEST;
429 $executor = \&execute_dumb_fetch_test;
430 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
432 } elsif ($token eq 'method test') {
434 l(LL_FILE_LOADING, "Method to test: " . $value);
436 $executor = \&execute_method_test;
437 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
439 } elsif ($token eq 'blocked url') {
441 l(LL_FILE_LOADING, "URL to block-test: " . $value);
442 $executor = \&execute_block_test;
445 } elsif ($token eq 'url') {
447 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
448 $type = STICKY_ACTIONS_TEST;
449 $executor = \&execute_sticky_actions_test;
451 } elsif ($token eq 'redirected url') {
453 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
454 $type = REDIRECT_TEST;
455 $executor = \&execute_redirect_test;
459 die "Incomplete '" . $token . "' support detected.";
462 $$regression_tests[$si][$ri]{'type'} = $type;
463 $$regression_tests[$si][$ri]{'level'} = $type;
464 $$regression_tests[$si][$ri]{'executor'} = $executor;
466 check_for_forbidden_characters($value);
468 $$regression_tests[$si][$ri]{'data'} = $value;
470 # For function that only get passed single tests
471 $$regression_tests[$si][$ri]{'section-id'} = $si;
472 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
473 $$regression_tests[$si][$ri]{'number'} = $number - 1;
475 "Regression test " . $number . " (section:" . $si . "):");
478 sub mark_matching_tests_for_skipping($) {
479 my $overwrite_condition = shift;
481 our @regression_tests;
483 for (my $s = 0; $s < @regression_tests; $s++) {
487 while (defined $regression_tests[$s][$r]) {
489 if ($regression_tests[$s][$r]{'data'} eq $overwrite_condition) {
490 my $message = sprintf("Marking test %s for ignoring. Overwrite condition: %s.",
491 $regression_tests[$s][$r]{'number'}, $overwrite_condition);
493 l(LL_FILE_LOADING, $message);
495 # XXX: Should eventually get its own key so get_skip_reason()
496 # can tell about the overwrite condition.
497 $regression_tests[$s][$r]{'ignore'} = 1;
505 # XXX: Shares a lot of code with load_regression_tests_from_file()
506 # that should be factored out.
507 sub load_action_files($) {
511 our @regression_tests;
513 my $actionfiles_ref = shift;
514 my @actionfiles = @{$actionfiles_ref};
516 my $si = 0; # Section index
517 my $ri = -1; # Regression test index
522 for my $file_number (0 .. @actionfiles - 1) {
524 my $curl_url = quote($actionfiles[$file_number]);
525 my $actionfile = undef;
526 my $sticky_actions = undef;
527 my $level_offset = 0;
529 foreach (@{get_cgi_page_or_else($curl_url)}) {
534 if (/<h2>Contents of Actions File (.*?)</) {
538 next unless defined $actionfile;
542 my ($token, $value) = tokenize($_);
544 next unless defined $token;
546 # Load regression tests
547 if ($token eq 'default level offset') {
549 $level_offset = $value;
550 l(LL_FILE_LOADING, "Setting default level offset to " . $level_offset);
553 if (token_starts_new_test($token)) {
555 # Beginning of new regression test.
558 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
559 $no_checks = 1; # Already validated by enlist_new_test().
560 if ($level_offset != 0) {
561 $regression_tests[$si][$ri]{'level'} += $level_offset;
565 if ($token =~ /level\s+(\d+)/i) {
568 register_dependency($level, $value);
571 if ($token eq 'sticky actions') {
573 # Will be used by each following Sticky URL.
574 $sticky_actions = $value;
575 if ($sticky_actions =~ /{[^}]*\s/) {
576 log_and_die("'Sticky Actions' with whitespace inside the " .
577 "action parameters are currently unsupported.");
581 if ($token eq 'overwrite condition') {
583 l(LL_FILE_LOADING, "Detected overwrite condition: " . $value);
584 # We can only skip matching tests that have already
585 # be loaded but that is exactly what we want anyway.
586 mark_matching_tests_for_skipping($value);
590 if ($si == -1 || $ri == -1) {
591 # No beginning of a test detected yet,
592 # so we don't care about any other test
597 if ($token eq 'expect header') {
599 l(LL_FILE_LOADING, "Detected expectation: " . $value);
600 $regression_tests[$si][$ri]{'expect-header'} = $value;
602 } elsif ($token eq 'tag') {
606 my $tag = parse_tag($value);
608 # We already checked in parse_tag() after filtering
611 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
613 # Save tag for all tests in this section
615 $regression_tests[$si][$ri]{'tag'} = $tag;
621 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
623 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
624 $regression_tests[$si][$ri]{'ignore'} = 1;
627 } elsif ($token eq 'expect status code') {
629 l(LL_FILE_LOADING, "Expecting status code: " . $value);
630 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
632 } elsif ($token eq 'level') { # XXX: stupid name
634 $value =~ s@(\d+).*@$1@;
635 l(LL_FILE_LOADING, "Level: " . $value);
636 $regression_tests[$si][$ri]{'level'} = $value;
638 } elsif ($token eq 'method') {
640 l(LL_FILE_LOADING, "Method: " . $value);
641 $regression_tests[$si][$ri]{'method'} = $value;
643 } elsif ($token eq 'redirect destination') {
645 l(LL_FILE_LOADING, "Redirect destination: " . $value);
646 $regression_tests[$si][$ri]{'redirect destination'} = $value;
648 } elsif ($token eq 'url') {
650 if (defined $sticky_actions) {
651 die "WTF? Attempted to overwrite Sticky Actions"
652 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
654 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
655 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
657 log_and_die("Sticky URL without Sticky Actions in $actionfile: $value");
662 # We don't use it, so we don't need
664 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
668 unless ($no_checks) {
669 check_for_forbidden_characters($value);
670 check_for_forbidden_characters($token);
675 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
676 . " Of which " . $ignored. " will be ignored)\n");
679 ############################################################################
681 # Regression test executing functions
683 ############################################################################
685 # Fisher Yates shuffle from Perl's "How do I shuffle an array randomly?" FAQ
686 sub fisher_yates_shuffle($) {
690 my $j = int rand($i+1);
691 @$deck[$i,$j] = @$deck[$j,$i];
695 sub execute_regression_tests() {
697 our @regression_tests;
698 my $loops = get_cli_option('loops');
700 my $all_failures = 0;
701 my $all_successes = 0;
703 unless (@regression_tests) {
705 l(LL_STATUS, "No regression tests found.");
709 l(LL_STATUS, "Executing regression tests ...");
711 while ($loops-- > 0) {
718 if (cli_option_is_set('shuffle-tests')) {
720 # Shuffle both the test sections and
721 # the tests they contain.
723 # XXX: With the current data layout, shuffling tests
724 # from different sections isn't possible.
725 # Is this worth changing the layout?
726 fisher_yates_shuffle(\@regression_tests);
727 for (my $s = 0; $s < @regression_tests; $s++) {
728 fisher_yates_shuffle($regression_tests[$s]);
732 for (my $s = 0; $s < @regression_tests; $s++) {
736 while (defined $regression_tests[$s][$r]) {
738 unless (cli_option_is_set('shuffle-tests')) {
739 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
740 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
742 die "Internal error. Test executor missing."
743 unless defined $regression_tests[$s][$r]{executor};
745 my $number = $regression_tests[$s][$r]{'number'};
746 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
748 if (defined $skip_reason) {
750 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
751 log_message($message) if (cli_option_is_set('show-skipped-tests'));
756 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
758 log_result($regression_tests[$s][$r], $result, $tests);
760 $successes += $result;
762 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
767 $failures = $tests - $successes;
769 log_message("Executed " . $tests . " regression tests. " .
770 'Skipped ' . $skipped . '. ' .
771 $successes . " successes, " . $failures . " failures.");
773 $all_tests += $tests;
774 $all_failures += $failures;
775 $all_successes += $successes;
778 if (get_cli_option('loops') > 1) {
779 log_message("Total: Executed " . $all_tests . " regression tests. " .
780 $all_successes . " successes, " . $all_failures . " failures.");
784 sub get_skip_reason($) {
786 my $skip_reason = undef;
788 if ($test->{'ignore'}) {
790 $skip_reason = "Ignore flag is set";
792 } elsif (cli_option_is_set('test-number') and
793 get_cli_option('test-number') != $test->{'number'}) {
795 $skip_reason = "Only executing test " . get_cli_option('test-number');
799 $skip_reason = level_is_unacceptable($test->{'level'});
805 sub level_is_unacceptable($) {
807 my $min_level = get_cli_option('min-level');
808 my $max_level = get_cli_option('max-level');
809 my $required_level = cli_option_is_set('level') ?
810 get_cli_option('level') : $level;
813 if ($required_level != $level) {
815 $reason = "Level doesn't match (" . $level .
816 " != " . $required_level . ")"
818 } elsif ($level < $min_level) {
820 $reason = "Level too low (" . $level . " < " . $min_level . ")";
822 } elsif ($level > $max_level) {
824 $reason = "Level too high (" . $level . " > " . $max_level . ")";
828 $reason = dependency_unsatisfied($level);
834 sub dependency_unsatisfied($) {
839 our %privoxy_features;
841 my $dependency_problem = undef;
843 if (defined ($dependencies{$level}{'config line'})) {
845 my $dependency = $dependencies{$level}{'config line'};
846 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
848 foreach (@privoxy_config) {
851 $dependency_problem = undef;
858 if (defined ($dependencies{$level}{'feature status'})
859 and not defined $dependency_problem) {
861 my $dependency = $dependencies{$level}{'feature status'};
862 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
864 unless (defined($privoxy_features{$feature})
865 and ($privoxy_features{$feature} eq $status))
867 $dependency_problem = "depends on '" . $feature .
868 "' being set to '" . $status . "'";
872 return $dependency_problem;
875 sub register_dependency($$) {
878 my $dependency = shift;
881 if ($dependency =~ /config line\s+(.*)/) {
883 $dependencies{$level}{'config line'} = $1;
885 } elsif ($dependency =~ /feature status\s+(.*)/) {
887 $dependencies{$level}{'feature status'} = $1;
891 log_and_die("Didn't recognize dependency: $dependency.");
895 sub execute_method_test($) {
898 our $privoxy_cgi_url;
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($) {
967 our $privoxy_cgi_url;
972 my $curl_parameters = '';
973 my $expected_status_code = $test->{'expected-status-code'};
975 if (defined $test->{method}) {
976 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
978 if ($test->{type} == TRUSTED_CGI_REQUEST) {
979 $curl_parameters .= '--referer ' . quote($privoxy_cgi_url) . ' ';
982 $curl_parameters .= quote($test->{'data'});
984 $buffer_ref = get_page_with_curl($curl_parameters);
985 $status_code = get_status_code($buffer_ref);
987 return check_status_code_result($status_code, $expected_status_code);
990 sub execute_block_test($) {
993 my $url = $test->{'data'};
994 my $final_results = get_final_results($url);
996 return defined $final_results->{'+block'};
999 sub execute_sticky_actions_test($) {
1002 my $url = $test->{'data'};
1003 my $verified_actions = 0;
1004 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
1005 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
1006 my $final_results = get_final_results($url);
1008 foreach my $sticky_action (@sticky_actions) {
1010 if (defined $final_results->{$sticky_action}) {
1012 $verified_actions++;
1014 } elsif ($sticky_action =~ /-.*\{/) {
1016 # Disabled multi actions aren't explicitly listed as
1017 # disabled and thus have to be checked by verifying
1018 # that they aren't enabled.
1019 $verified_actions++;
1022 l(LL_VERBOSE_FAILURE,
1023 "Ooops. '$sticky_action' is not among the final results.");
1027 return $verified_actions == @sticky_actions;
1030 sub get_final_results($) {
1033 our $privoxy_cgi_url;
1035 my $curl_parameters = '';
1036 my %final_results = ();
1037 my $final_results_reached = 0;
1039 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
1040 # XXX: should be URL-encoded properly
1047 $curl_parameters .= quote($privoxy_cgi_url . 'show-url-info?url=' . $url);
1049 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
1051 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
1053 next unless ($final_results_reached);
1056 # Privoxy versions before 3.0.16 add a space
1057 # between action name and parameters, therefore
1059 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
1063 if (defined $parameter) {
1064 # In case the caller needs to check
1065 # the action and its parameter
1066 $final_results{$action . $parameter} = 1;
1068 # In case the action doesn't have parameters
1069 # or the caller doesn't care for the parameter.
1070 $final_results{$action} = 1;
1074 return \%final_results;
1077 sub check_status_code_result($$) {
1079 my $status_code = shift;
1080 my $expected_status_code = shift;
1083 unless (defined $status_code) {
1085 # XXX: should probably be caught earlier.
1086 l(LL_VERBOSE_FAILURE,
1087 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
1089 } elsif ($expected_status_code == $status_code) {
1092 l(LL_VERBOSE_SUCCESS,
1093 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
1095 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
1097 l(LL_VERBOSE_FAILURE,
1098 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
1102 l(LL_VERBOSE_FAILURE,
1103 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
1109 sub execute_client_header_regression_test($) {
1115 $buffer_ref = get_show_request_with_curl($test);
1117 $header = get_header($buffer_ref, $test);
1119 return check_header_result($test, $header);
1122 sub execute_server_header_regression_test($) {
1128 $buffer_ref = get_head_with_curl($test);
1130 $header = get_server_header($buffer_ref, $test);
1132 return check_header_result($test, $header);
1135 sub interpret_result($) {
1136 my $success = shift;
1137 return $success ? "Success" : "Failure";
1140 sub check_header_result($$) {
1145 my $expect_header = $test->{'expect-header'};
1148 if ($expect_header eq 'NO CHANGE') {
1150 $success = (defined($header) and $header eq $test->{'data'});
1153 $header = "REMOVAL" unless defined $header;
1154 l(LL_VERBOSE_FAILURE,
1155 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1158 } elsif ($expect_header eq 'REMOVAL') {
1160 # XXX: Use more reliable check here and make sure
1161 # the header has a different name.
1162 $success = not (defined($header) and $header eq $test->{'data'});
1165 l(LL_VERBOSE_FAILURE,
1166 "Ooops. Expected removal but: '" . $header . "' is still there.");
1169 } elsif ($expect_header eq 'SOME CHANGE') {
1171 $success = (defined($header) and $header ne $test->{'data'});
1174 $header = "REMOVAL" unless defined $header;
1175 l(LL_VERBOSE_FAILURE,
1176 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
1181 $success = (defined($header) and $header eq $expect_header);
1184 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
1185 l(LL_VERBOSE_FAILURE,
1186 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1192 sub get_header_name($) {
1196 $header =~ s@(.*?: ).*@$1@;
1201 sub get_header($$) {
1203 our $filtered_request = '';
1205 my $buffer_ref = shift;
1208 my @buffer = @{$buffer_ref};
1210 my $expect_header = $test->{'expect-header'};
1212 die "get_header called with no expect header" unless defined $expect_header;
1215 my $processed_request_reached = 0;
1216 my $read_header = 0;
1217 my $processed_request = '';
1221 if ($expect_header eq 'REMOVAL'
1222 or $expect_header eq 'NO CHANGE'
1223 or $expect_header eq 'SOME CHANGE') {
1225 $expect_header = $test->{'data'};
1228 $header_to_get = get_header_name($expect_header);
1232 # Skip everything before the Processed request
1233 if (/Processed Request/) {
1234 $processed_request_reached = 1;
1237 next unless $processed_request_reached;
1239 # End loop after the Processed request
1240 last if (/<\/pre>/);
1242 # Ditch tags and leading/trailing white space.
1246 # Decode characters we care about.
1249 $filtered_request .= "\n" . $_;
1251 if (/^$header_to_get/) {
1261 sub get_server_header($$) {
1263 my $buffer_ref = shift;
1266 my @buffer = @{$buffer_ref};
1268 my $expect_header = $test->{'expect-header'};
1272 # XXX: Should be caught before starting to test.
1273 log_and_die("No expect header for test " . $test->{'number'})
1274 unless defined $expect_header;
1276 if ($expect_header eq 'REMOVAL'
1277 or $expect_header eq 'NO CHANGE'
1278 or $expect_header eq 'SOME CHANGE') {
1280 $expect_header = $test->{'data'};
1283 $header_to_get = get_header_name($expect_header);
1287 # XXX: should probably verify that the request
1288 # was actually answered by Fellatio.
1289 if (/^$header_to_get/) {
1291 $header =~ s@\s*$@@g;
1299 sub get_status_code($) {
1301 my $buffer_ref = shift;
1302 my @buffer = @{$buffer_ref};
1306 if (/^HTTP\/\d\.\d (\d{3})/) {
1312 return '123' if cli_option_is_set('fuzzer-feeding');
1314 log_and_die('Unexpected buffer line: "' . $_ . '"');
1319 sub get_test_keys() {
1320 return ('tag', 'data', 'expect-header', 'ignore');
1324 sub test_content_as_string($) {
1330 foreach my $key (get_test_keys()) {
1331 $test->{$key} = 'Not set' unless (defined $test->{$key});
1334 $s .= 'Tag: ' . $test->{'tag'};
1336 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1338 $s .= 'Expected header: ' . $test->{'expect-header'};
1340 $s .= 'Ignore: ' . $test->{'ignore'};
1345 sub fuzz_header($) {
1347 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1349 $white_space = $white_space x (1 + int(rand(5)));
1351 # Only fuzz white space before the first quoted token.
1352 # (Privoxy doesn't touch white space inside quoted tokens
1353 # and modifying it would cause the tests to fail).
1354 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1359 ############################################################################
1361 # HTTP fetch functions
1363 ############################################################################
1365 sub get_cgi_page_or_else($) {
1367 my $cgi_url = shift;
1368 my $content_ref = get_page_with_curl($cgi_url);
1369 my $status_code = get_status_code($content_ref);
1371 if (200 != $status_code) {
1373 my $log_message = "Failed to fetch Privoxy CGI page '$cgi_url'. " .
1374 "Received status code ". $status_code .
1375 " while only 200 is acceptable.";
1377 if (cli_option_is_set('fuzzer-feeding')) {
1379 $log_message .= " Ignored due to fuzzer feeding.";
1380 l(LL_SOFT_ERROR, $log_message)
1384 log_and_die($log_message);
1388 return $content_ref;
1391 # XXX: misleading name
1392 sub get_show_request_with_curl($) {
1394 our $privoxy_cgi_url;
1397 my $curl_parameters = ' ';
1398 my $header = $test->{'data'};
1400 if (cli_option_is_set('header-fuzzing')) {
1401 $header = fuzz_header($header);
1404 # Enable the action to test
1405 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1406 # The header to filter
1407 $curl_parameters .= '-H \'' . $header . '\' ';
1409 $curl_parameters .= ' ';
1410 $curl_parameters .= $privoxy_cgi_url;
1411 $curl_parameters .= 'show-request';
1413 return get_cgi_page_or_else($curl_parameters);
1416 sub get_head_with_curl($) {
1418 our $fellatio_url = FELLATIO_URL;
1421 my $curl_parameters = ' ';
1423 # Enable the action to test
1424 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1425 # The header to filter
1426 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1427 $curl_parameters .= '--head ';
1429 $curl_parameters .= ' ';
1430 $curl_parameters .= $fellatio_url;
1432 return get_page_with_curl($curl_parameters);
1435 sub get_page_with_curl($) {
1439 my $parameters = shift;
1441 my $curl_line = CURL;
1442 my $retries_left = get_cli_option('retries') + 1;
1445 if (defined $proxy) {
1446 $curl_line .= ' --proxy ' . quote($proxy);
1448 # We want to see the HTTP status code
1449 $curl_line .= " --include ";
1450 # Let Privoxy emit two log messages less.
1451 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1452 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1453 # We don't care about fetch statistic.
1454 $curl_line .= " -s ";
1455 # We do care about the failure reason if any.
1456 $curl_line .= " -S ";
1457 # We want to advertise ourselves
1458 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1459 # We aren't too patient
1460 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1461 # We don't want curl to treat "[]", "{}" etc. special
1462 $curl_line .= " --globoff ";
1464 $curl_line .= $parameters;
1465 # XXX: still necessary?
1466 $curl_line .= ' 2>&1';
1468 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1471 @buffer = `$curl_line`;
1474 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1475 $failure_reason = array_as_string(\@buffer);
1476 chomp $failure_reason;
1477 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1479 } while ($? && --$retries_left);
1481 unless ($retries_left) {
1482 log_and_die("Running curl failed " . get_cli_option('retries') .
1483 " times in a row. Last error: '" . $failure_reason . "'.");
1490 ############################################################################
1494 ############################################################################
1496 sub array_as_string($) {
1497 my $array_ref = shift;
1500 foreach (@{$array_ref}) {
1509 log_message('Test is:' . test_content_as_string($test));
1515 my $this_level = shift;
1516 my $message = shift;
1518 log_message($message) if ($log_level & $this_level);
1521 sub log_and_die($) {
1522 my $message = shift;
1524 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1528 sub log_message($) {
1530 my $message = shift;
1534 our $leading_log_date;
1535 our $leading_log_time;
1537 my $time_stamp = '';
1538 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1540 if ($leading_log_date || $leading_log_time) {
1542 if ($leading_log_date) {
1545 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1548 if ($leading_log_time) {
1549 $time_stamp .= ' ' if $leading_log_date;
1550 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1553 $message = $time_stamp . ": " . $message;
1556 printf("%s\n", $message);
1559 sub log_result($$) {
1561 our $filtered_request;
1567 my $message = sprintf("%s for test %d",
1568 interpret_result($result),
1571 if (cli_option_is_set('verbose')) {
1572 $message .= sprintf(" (%d/%d/%d)", $number,
1573 $test->{'section-id'},
1574 $test->{'regression-test-id'});
1579 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1581 $message .= 'Header ';
1582 $message .= quote($test->{'data'});
1583 $message .= ' and tag ';
1584 $message .= quote($test->{'tag'});
1586 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1588 $message .= 'Request Header ';
1589 $message .= quote($test->{'data'});
1590 $message .= ' and tag ';
1591 $message .= quote($test->{'tag'});
1593 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1596 $message .= quote($test->{'data'});
1597 $message .= ' and expected status code ';
1598 $message .= quote($test->{'expected-status-code'});
1600 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1602 $message .= 'CGI URL ';
1603 $message .= quote($test->{'data'});
1604 $message .= ' and expected status code ';
1605 $message .= quote($test->{'expected-status-code'});
1607 } elsif ($test->{'type'} == METHOD_TEST) {
1609 $message .= 'HTTP method ';
1610 $message .= quote($test->{'data'});
1611 $message .= ' and expected status code ';
1612 $message .= quote($test->{'expected-status-code'});
1614 } elsif ($test->{'type'} == BLOCK_TEST) {
1616 $message .= 'Supposedly-blocked URL: ';
1617 $message .= quote($test->{'data'});
1619 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1621 $message .= 'Sticky Actions: ';
1622 $message .= quote($test->{'sticky-actions'});
1623 $message .= ' and URL: ';
1624 $message .= quote($test->{'data'});
1626 } elsif ($test->{'type'} == REDIRECT_TEST) {
1628 $message .= 'Redirected URL: ';
1629 $message .= quote($test->{'data'});
1630 $message .= ' and redirect destination: ';
1631 $message .= quote($test->{'redirect destination'});
1635 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1638 log_message($message) if (!$result or cli_option_is_set('verbose'));
1643 return '\'' . $s . '\'';
1646 sub print_version() {
1647 printf PRT_VERSION . "\n";
1650 sub list_test_types() {
1652 'Client header test' => CLIENT_HEADER_TEST,
1653 'Server header test' => 2,
1654 'Dumb fetch test' => 3,
1656 'Sticky action test' => 5,
1657 'Trusted CGI test' => 6,
1659 'Redirect test' => 108,
1662 print "\nThe supported test types and their default levels are:\n";
1663 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1664 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1671 our $privoxy_cgi_url;
1677 Options and their default values if they have any:
1678 [--debug $cli_options{'debug'}]
1679 [--forks $cli_options{'forks'}]
1686 [--loops $cli_options{'loops'}]
1687 [--max-level $cli_options{'max-level'}]
1688 [--max-time $cli_options{'max-time'}]
1689 [--min-level $cli_options{'min-level'}]
1691 [--privoxy-cgi-prefix $privoxy_cgi_url]
1692 [--retries $cli_options{'retries'}]
1693 [--show-skipped-tests]
1695 [--sleep-time $cli_options{'sleep-time'}]
1706 Try "perldoc $0" for more information
1713 sub init_cli_options() {
1718 $cli_options{'debug'} = $log_level;
1719 $cli_options{'forks'} = CLI_FORKS;
1720 $cli_options{'loops'} = CLI_LOOPS;
1721 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1722 $cli_options{'max-time'} = CLI_MAX_TIME;
1723 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1724 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1725 $cli_options{'retries'} = CLI_RETRIES;
1728 sub parse_cli_options() {
1732 our $privoxy_cgi_url;
1737 'debug=i' => \$cli_options{'debug'},
1738 'forks=i' => \$cli_options{'forks'},
1739 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1740 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1741 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1743 'level=i' => \$cli_options{'level'},
1744 'local-test-file=s' => \$cli_options{'local-test-file'},
1745 'loops=i' => \$cli_options{'loops'},
1746 'max-level=i' => \$cli_options{'max-level'},
1747 'max-time=i' => \$cli_options{'max-time'},
1748 'min-level=i' => \$cli_options{'min-level'},
1749 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1750 'privoxy-cgi-prefix=s' => \$privoxy_cgi_url, # XXX: Should use cli_options()
1751 'retries=i' => \$cli_options{'retries'},
1752 'shuffle-tests' => \$cli_options{'shuffle-tests'},
1753 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1754 'sleep-time=i' => \$cli_options{'sleep-time'},
1755 'test-number=i' => \$cli_options{'test-number'},
1756 'verbose' => \$cli_options{'verbose'},
1757 'version' => sub {print_version && exit(0)}
1759 $log_level |= $cli_options{'debug'};
1762 sub cli_option_is_set($) {
1765 my $cli_option = shift;
1767 return defined $cli_options{$cli_option};
1770 sub get_cli_option($) {
1773 my $cli_option = shift;
1775 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1777 return $cli_options{$cli_option};
1780 sub init_proxy_settings($) {
1785 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1786 $proxy = get_cli_option('fuzzer-address');
1789 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1791 if (cli_option_is_set('privoxy-address')) {
1792 $proxy .= get_cli_option('privoxy-address');
1797 sub start_forks($) {
1800 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1802 foreach my $fork (1 .. $forks) {
1803 log_message("Starting fork $fork");
1805 if (defined $pid && !$pid) {
1813 init_our_variables();
1814 parse_cli_options();
1815 init_proxy_settings('vanilla-proxy');
1816 load_regression_tests();
1817 init_proxy_settings('fuzz-proxy');
1818 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1819 execute_regression_tests();
1826 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1830 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1831 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1832 [B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>]
1833 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1834 B<--privoxy-cgi-prefix cgi-prefix> [B<--retries retries>] [B<--test-number test-number>]
1835 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1840 Privoxy-Regression-Test is supposed to one day become
1841 a regression test suite for Privoxy. It's not quite there
1842 yet, however, and can currently only test header actions,
1843 check the returned status code for requests to arbitrary
1844 URLs and verify which actions are applied to them.
1846 Client header actions are tested by requesting
1847 B<http://p.p/show-request> and checking whether
1848 or not Privoxy modified the original request as expected.
1850 The original request contains both the header the action-to-be-tested
1851 acts upon and an additional tagger-triggering header that enables
1854 Applied actions are checked through B<http://p.p/show-url-info>.
1856 =head1 CONFIGURATION FILE SYNTAX
1858 Privoxy-Regression-Test's configuration is embedded in
1859 Privoxy action files and loaded through Privoxy's web interface.
1861 It makes testing a Privoxy version running on a remote system easier
1862 and should prevent you from updating your tests without updating Privoxy's
1863 configuration accordingly.
1865 A client-header-action test section looks like this:
1867 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1868 # Expect Header = Referer: http://www.example.org/
1869 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1870 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1872 The example above causes Privoxy-Regression-Test to set
1873 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1874 and to expect it to be modified to
1875 B<Referer: http://www.example.org/>.
1877 When testing this section, Privoxy-Regression-Test will set the header
1878 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1879 causing the B<privoxy-control> tagger to create the tag
1880 B<client-header-filter{hide-tor-exit-notation}> which will finally
1881 cause Privoxy to enable the action section.
1883 Note that the actions itself are only used by Privoxy,
1884 Privoxy-Regression-Test ignores them and will be happy
1885 as long as the expectations are satisfied.
1887 A fetch test looks like this:
1889 # Fetch Test = http://p.p/user-manual
1890 # Expect Status Code = 302
1892 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1893 and to expect a response with the HTTP status code B<302>. Obviously that's
1894 not a very thorough test and mainly useful to get some code coverage
1895 for Valgrind or to verify that the templates are installed correctly.
1897 If you want to test CGI pages that require a trusted
1898 referer, you can use:
1900 # Trusted CGI Request = http://p.p/edit-actions
1902 It works like ordinary fetch tests, but sets the referer
1903 header to a trusted value.
1905 If no explicit status code expectation is set, B<200> is used.
1907 To verify that a URL is blocked, use:
1909 # Blocked URL = http://www.example.com/blocked
1911 To verify that a specific set of actions is applied to an URL, use:
1913 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1914 # URL = http://www.example.org/my-first-url
1916 The sticky actions will be checked for all URLs below it
1917 until the next sticky actions directive.
1919 To verify that requests for a URL get redirected, use:
1921 # Redirected URL = http://www.example.com/redirect-me
1922 # Redirect Destination = http://www.example.org/redirected
1924 To skip a test, add the following line:
1928 The difference between a skipped test and a removed one is that removing
1929 a test affects the numbers of the following tests, while a skipped test
1930 is still loaded and thus keeps the test numbers unchanged.
1932 Sometimes user modifications intentionally conflict with tests in the
1933 default configuration and thus cause test failures. Adding the Ignore
1934 directive to the failing tests works but is inconvenient as the directive
1935 is likely to get lost with the next update.
1937 Overwrite conditions are an alternative and can be added in any action
1938 file as long as the come after the test that is expected to fail.
1939 They cause all previous tests that match the condition to be skipped.
1941 It is recommended to put the overwrite condition below the custom Privoxy
1942 section that causes the expected test failure and before the custom test
1943 that verifies that tests the now expected behaviour. Example:
1945 # The following section is expected to overwrite a section in
1946 # default.action, whose effect is being tested. Thus also disable
1947 # the test that is now expected to fail and add a new one.
1949 {+block{Facebook makes Firefox even more unstable. Do not want.}}
1950 # Overwrite condition = http://apps.facebook.com/onthefarm/track.php?creative=&cat=friendvisit&subcat=weeds&key=a789a971dc687bee4c20c044834fabdd&next=index.php%3Fref%3Dnotif%26visitId%3D898835505
1951 # Blocked URL = http://apps.facebook.com/
1956 All tests have test levels to let the user
1957 control which ones to execute (see I<OPTIONS> below).
1958 Test levels are either set with the B<Level> directive,
1959 or implicitly through the test type.
1961 Redirect tests default to level 108, block tests to level 7,
1962 fetch tests to level 6, "Sticky Actions" tests default to
1963 level 5, tests for trusted CGI requests to level 3 and
1964 client-header-action tests to level 1.
1966 The current redirect test level is above the default
1967 max-level value as failed tests will result in outgoing
1968 connections. Use the B<--max-level> option to run them
1971 The "Default level offset" directive can be used to change
1972 the default level by a given value. This directive affects
1973 all tests located after it until the end of the file or a another
1974 "Default level offset" directive is reached. The purpose of this
1975 directive is to make it more convenient to skip similar tests in
1976 a given file without having to remove or disable the tests completely.
1980 B<--debug bitmask> Add the bitmask provided as integer
1981 to the debug settings.
1983 B<--forks forks> Number of forks to start before executing
1984 the regression tests. This is mainly useful for stress-testing.
1986 B<--fuzzer-address> Listening address used when executing
1987 the regression tests. Useful to make sure that the requests
1988 to load the regression tests don't fail due to fuzzing.
1990 B<--fuzzer-feeding> Ignore some errors that would otherwise
1991 cause Privoxy-Regression-Test to abort the test because
1992 they shouldn't happen in normal operation. This option is
1993 intended to be used if Privoxy-Regression-Test is only
1994 used to feed a fuzzer in which case there's a high chance
1995 that Privoxy gets an invalid request and returns an error
1998 B<--help> Shows available command line options.
2000 B<--header-fuzzing> Modifies linear white space in
2001 headers in a way that should not affect the test result.
2003 B<--level level> Only execute tests with the specified B<level>.
2005 B<--local-test-file test-file> Do not get the tests
2006 through Privoxy's web interface, but use a single local
2007 file. Not recommended for testing Privoxy, but can be useful
2008 to "misappropriate" Privoxy-Regression-Test to test other
2009 stuff, like webserver configurations.
2011 B<--loop count> Loop through the regression tests B<count> times.
2012 Useful to feed a fuzzer, or when doing stress tests with
2013 several Privoxy-Regression-Test instances running at the same
2016 B<--max-level max-level> Only execute tests with a B<level>
2017 below or equal to the numerical B<max-level>.
2019 B<--max-time max-time> Give Privoxy B<max-time> seconds
2020 to return data. Increasing the default may make sense when
2021 Privoxy is run through Valgrind, decreasing the default may
2022 make sense when Privoxy-Regression-Test is used to feed
2025 B<--min-level min-level> Only execute tests with a B<level>
2026 above or equal to the numerical B<min-level>.
2028 B<--privoxy-address proxy-address> Privoxy's listening address.
2029 If it's not set, the value of the environment variable http_proxy
2030 will be used. B<proxy-address> has to be specified in http_proxy
2033 B<--privoxy-cgi-prefix privoxy-cgi-prefix> The prefix to use when
2034 building URLs that are supposed to reach Privoxy's CGI interface.
2035 If it's not set, B<http://p.p/> is used, which is supposed to work
2036 with the default Privoxy configuration.
2037 If Privoxy has been built with B<FEATURE_HTTPS_INSPECTION> enabled,
2038 and if https inspection is activated with the B<+https-inspection>
2039 action, this option can be used with
2040 B<https://p.p/> provided the system running Privoxy-Regression-Test
2041 has been configured to trust the certificate used by Privoxy.
2042 Note that there are currently two tests in the official
2043 B<regression-tests.action> file that are expected to fail when
2044 using a B<privoxy-cgi-prefix> with B<https://> and aren't automatically
2047 B<--retries retries> Retry B<retries> times.
2049 B<--test-number test-number> Only run the test with the specified
2052 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
2054 B<--shuffle-tests> Shuffle test sections and their tests before
2055 executing them. When combined with B<--forks>, this can increase
2056 the chances of detecting race conditions. Of course some problems
2057 are easier to detect without this option.
2059 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
2060 debugging issues with systems that don't log with millisecond precision.
2062 B<--verbose> Log successful tests as well. By default only
2063 the failures are logged.
2065 B<--version> Print version and exit.
2067 The second dash is optional, options can be shortened,
2068 as long as there are no ambiguities.
2070 =head1 PRIVOXY CONFIGURATION
2072 Privoxy-Regression-Test is shipped with B<regression-tests.action>
2073 which aims to test all official client-header modifying actions
2074 and can be used to verify that the templates and the user manual
2075 files are installed correctly.
2077 To use it, it has to be copied in Privoxy's configuration
2078 directory, and afterwards referenced in Privoxy's configuration
2081 actionsfile regression-tests.action
2083 In general, its tests are supposed to work without changing
2084 any other action files, unless you already added lots of
2085 taggers yourself. If you are using taggers that cause problems,
2086 you might have to temporary disable them for Privoxy's CGI pages.
2088 Some of the regression tests rely on Privoxy features that
2089 may be disabled in your configuration. Tests with a level below
2090 7 are supposed to work with all Privoxy configurations (provided
2091 you didn't build with FEATURE_GRACEFUL_TERMINATION).
2093 Tests with level 9 require Privoxy to deliver the User Manual,
2094 tests with level 12 require the CGI editor to be enabled.
2098 Expect the configuration file syntax to change with future releases.
2102 As Privoxy's B<show-request> page only shows client headers,
2103 Privoxy-Regression-Test can't use it to test Privoxy actions
2104 that modify server headers.
2106 As Privoxy-Regression-Test relies on Privoxy's tag feature to
2107 control the actions to test, it currently only works with
2108 Privoxy 3.0.7 or later.
2110 At the moment Privoxy-Regression-Test fetches Privoxy's
2111 configuration page through I<curl>(1), therefore you have to
2112 have I<curl> installed, otherwise you won't be able to run
2113 Privoxy-Regression-Test in a meaningful way.
2121 Fabian Keil <fk@fabiankeil.de>