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.94 2016/05/08 10:45:18 fabiankeil Exp $
14 # - Update documentation
15 # - Validate HTTP times.
16 # - Implement a HTTP_VERSION directive or allow to
17 # specify whole request lines.
18 # - Support filter regression tests.
19 # - Document magic Expect Header values
20 # - Internal fuzz support?
22 # Copyright (c) 2007-2013 Fabian Keil <fk@fabiankeil.de>
24 # Permission to use, copy, modify, and distribute this software for any
25 # purpose with or without fee is hereby granted, provided that the above
26 # copyright notice and this permission notice appear in all copies.
28 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
29 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
30 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
31 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
32 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
33 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
34 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
36 ############################################################################
43 PRT_VERSION => 'Privoxy-Regression-Test 0.6',
52 # XXX: why limit at all?
57 PRIVOXY_CGI_URL => 'http://p.p/',
58 FELLATIO_URL => 'http://127.0.0.1:8080/',
59 LEADING_LOG_DATE => 1,
60 LEADING_LOG_TIME => 1,
62 DEBUG_LEVEL_FILE_LOADING => 0,
63 DEBUG_LEVEL_PAGE_FETCHING => 0,
64 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
65 # XXX: Only partly implemented and mostly useless.
66 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
67 DEBUG_LEVEL_STATUS => 1,
69 # 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.
377 # Reverse HTML-encoding
378 # XXX: Seriously incomplete.
383 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
388 $token =~ s@\s\s+@ @g;
389 $token =~ tr/[A-Z]/[a-z]/;
391 } elsif (/^TAG\s*:(.*)$/) {
397 return ($token, $value);
400 sub enlist_new_test ($$$$$$) {
402 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
406 if ($token eq 'set header') {
408 l(LL_FILE_LOADING, "Header to set: " . $value);
409 $type = CLIENT_HEADER_TEST;
410 $executor = \&execute_client_header_regression_test;
412 } elsif ($token eq 'request header') {
414 l(LL_FILE_LOADING, "Header to request: " . $value);
415 $type = SERVER_HEADER_TEST;
416 $executor = \&execute_server_header_regression_test;
417 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
419 } elsif ($token eq 'trusted cgi request') {
421 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
422 $type = TRUSTED_CGI_REQUEST;
423 $executor = \&execute_dumb_fetch_test;
424 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
426 } elsif ($token eq 'fetch test') {
428 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
429 $type = DUMB_FETCH_TEST;
430 $executor = \&execute_dumb_fetch_test;
431 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
433 } elsif ($token eq 'method test') {
435 l(LL_FILE_LOADING, "Method to test: " . $value);
437 $executor = \&execute_method_test;
438 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
440 } elsif ($token eq 'blocked url') {
442 l(LL_FILE_LOADING, "URL to block-test: " . $value);
443 $executor = \&execute_block_test;
446 } elsif ($token eq 'url') {
448 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
449 $type = STICKY_ACTIONS_TEST;
450 $executor = \&execute_sticky_actions_test;
452 } elsif ($token eq 'redirected url') {
454 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
455 $type = REDIRECT_TEST;
456 $executor = \&execute_redirect_test;
460 die "Incomplete '" . $token . "' support detected.";
463 $$regression_tests[$si][$ri]{'type'} = $type;
464 $$regression_tests[$si][$ri]{'level'} = $type;
465 $$regression_tests[$si][$ri]{'executor'} = $executor;
467 check_for_forbidden_characters($value);
469 $$regression_tests[$si][$ri]{'data'} = $value;
471 # For function that only get passed single tests
472 $$regression_tests[$si][$ri]{'section-id'} = $si;
473 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
474 $$regression_tests[$si][$ri]{'number'} = $number - 1;
476 "Regression test " . $number . " (section:" . $si . "):");
479 sub mark_matching_tests_for_skipping($) {
480 my $overwrite_condition = shift;
482 our @regression_tests;
484 for (my $s = 0; $s < @regression_tests; $s++) {
488 while (defined $regression_tests[$s][$r]) {
490 if ($regression_tests[$s][$r]{'data'} eq $overwrite_condition) {
491 my $message = sprintf("Marking test %s for ignoring. Overwrite condition: %s.",
492 $regression_tests[$s][$r]{'number'}, $overwrite_condition);
494 l(LL_FILE_LOADING, $message);
496 # XXX: Should eventually get its own key so get_skip_reason()
497 # can tell about the overwrite condition.
498 $regression_tests[$s][$r]{'ignore'} = 1;
506 # XXX: Shares a lot of code with load_regression_tests_from_file()
507 # that should be factored out.
508 sub load_action_files ($) {
512 our @regression_tests;
514 my $actionfiles_ref = shift;
515 my @actionfiles = @{$actionfiles_ref};
517 my $si = 0; # Section index
518 my $ri = -1; # Regression test index
523 for my $file_number (0 .. @actionfiles - 1) {
525 my $curl_url = quote($actionfiles[$file_number]);
526 my $actionfile = undef;
527 my $sticky_actions = undef;
528 my $level_offset = 0;
530 foreach (@{get_cgi_page_or_else($curl_url)}) {
535 if (/<h2>Contents of Actions File (.*?)</) {
539 next unless defined $actionfile;
543 my ($token, $value) = tokenize($_);
545 next unless defined $token;
547 # Load regression tests
548 if ($token eq 'default level offset') {
550 $level_offset = $value;
551 l(LL_FILE_LOADING, "Setting default level offset to " . $level_offset);
554 if (token_starts_new_test($token)) {
556 # Beginning of new regression test.
559 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
560 $no_checks = 1; # Already validated by enlist_new_test().
561 if ($level_offset != 0) {
562 $regression_tests[$si][$ri]{'level'} += $level_offset;
566 if ($token =~ /level\s+(\d+)/i) {
569 register_dependency($level, $value);
572 if ($token eq 'sticky actions') {
574 # Will be used by each following Sticky URL.
575 $sticky_actions = $value;
576 if ($sticky_actions =~ /{[^}]*\s/) {
577 log_and_die("'Sticky Actions' with whitespace inside the " .
578 "action parameters are currently unsupported.");
582 if ($token eq 'overwrite condition') {
584 l(LL_FILE_LOADING, "Detected overwrite condition: " . $value);
585 # We can only skip matching tests that have already
586 # be loaded but that is exactly what we want anyway.
587 mark_matching_tests_for_skipping($value);
591 if ($si == -1 || $ri == -1) {
592 # No beginning of a test detected yet,
593 # so we don't care about any other test
598 if ($token eq 'expect header') {
600 l(LL_FILE_LOADING, "Detected expectation: " . $value);
601 $regression_tests[$si][$ri]{'expect-header'} = $value;
603 } elsif ($token eq 'tag') {
607 my $tag = parse_tag($value);
609 # We already checked in parse_tag() after filtering
612 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
614 # Save tag for all tests in this section
616 $regression_tests[$si][$ri]{'tag'} = $tag;
622 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
624 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
625 $regression_tests[$si][$ri]{'ignore'} = 1;
628 } elsif ($token eq 'expect status code') {
630 l(LL_FILE_LOADING, "Expecting status code: " . $value);
631 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
633 } elsif ($token eq 'level') { # XXX: stupid name
635 $value =~ s@(\d+).*@$1@;
636 l(LL_FILE_LOADING, "Level: " . $value);
637 $regression_tests[$si][$ri]{'level'} = $value;
639 } elsif ($token eq 'method') {
641 l(LL_FILE_LOADING, "Method: " . $value);
642 $regression_tests[$si][$ri]{'method'} = $value;
644 } elsif ($token eq 'redirect destination') {
646 l(LL_FILE_LOADING, "Redirect destination: " . $value);
647 $regression_tests[$si][$ri]{'redirect destination'} = $value;
649 } elsif ($token eq 'url') {
651 if (defined $sticky_actions) {
652 die "WTF? Attempted to overwrite Sticky Actions"
653 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
655 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
656 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
658 log_and_die("Sticky URL without Sticky Actions: $value");
663 # We don't use it, so we don't need
665 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
669 unless ($no_checks) {
670 check_for_forbidden_characters($value);
671 check_for_forbidden_characters($token);
676 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
677 . " Of which " . $ignored. " will be ignored)\n");
680 ############################################################################
682 # Regression test executing functions
684 ############################################################################
686 # Fisher Yates shuffle from Perl's "How do I shuffle an array randomly?" FAQ
687 sub fisher_yates_shuffle ($) {
691 my $j = int rand($i+1);
692 @$deck[$i,$j] = @$deck[$j,$i];
696 sub execute_regression_tests () {
698 our @regression_tests;
699 my $loops = get_cli_option('loops');
701 my $all_failures = 0;
702 my $all_successes = 0;
704 unless (@regression_tests) {
706 l(LL_STATUS, "No regression tests found.");
710 l(LL_STATUS, "Executing regression tests ...");
712 while ($loops-- > 0) {
719 if (cli_option_is_set('shuffle-tests')) {
721 # Shuffle both the test sections and
722 # the tests they contain.
724 # XXX: With the current data layout, shuffling tests
725 # from different sections isn't possible.
726 # Is this worth changing the layout?
727 fisher_yates_shuffle(\@regression_tests);
728 for (my $s = 0; $s < @regression_tests; $s++) {
729 fisher_yates_shuffle($regression_tests[$s]);
733 for (my $s = 0; $s < @regression_tests; $s++) {
737 while (defined $regression_tests[$s][$r]) {
739 unless (cli_option_is_set('shuffle-tests')) {
740 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
741 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
743 die "Internal error. Test executor missing."
744 unless defined $regression_tests[$s][$r]{executor};
746 my $number = $regression_tests[$s][$r]{'number'};
747 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
749 if (defined $skip_reason) {
751 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
752 log_message($message) if (cli_option_is_set('show-skipped-tests'));
757 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
759 log_result($regression_tests[$s][$r], $result, $tests);
761 $successes += $result;
763 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
768 $failures = $tests - $successes;
770 log_message("Executed " . $tests . " regression tests. " .
771 'Skipped ' . $skipped . '. ' .
772 $successes . " successes, " . $failures . " failures.");
774 $all_tests += $tests;
775 $all_failures += $failures;
776 $all_successes += $successes;
779 if (get_cli_option('loops') > 1) {
780 log_message("Total: Executed " . $all_tests . " regression tests. " .
781 $all_successes . " successes, " . $all_failures . " failures.");
785 sub get_skip_reason ($) {
787 my $skip_reason = undef;
789 if ($test->{'ignore'}) {
791 $skip_reason = "Ignore flag is set";
793 } elsif (cli_option_is_set('test-number') and
794 get_cli_option('test-number') != $test->{'number'}) {
796 $skip_reason = "Only executing test " . get_cli_option('test-number');
800 $skip_reason = level_is_unacceptable($test->{'level'});
806 sub level_is_unacceptable ($) {
808 my $min_level = get_cli_option('min-level');
809 my $max_level = get_cli_option('max-level');
810 my $required_level = cli_option_is_set('level') ?
811 get_cli_option('level') : $level;
814 if ($required_level != $level) {
816 $reason = "Level doesn't match (" . $level .
817 " != " . $required_level . ")"
819 } elsif ($level < $min_level) {
821 $reason = "Level too low (" . $level . " < " . $min_level . ")";
823 } elsif ($level > $max_level) {
825 $reason = "Level too high (" . $level . " > " . $max_level . ")";
829 $reason = dependency_unsatisfied($level);
835 sub dependency_unsatisfied ($) {
840 our %privoxy_features;
842 my $dependency_problem = undef;
844 if (defined ($dependencies{$level}{'config line'})) {
846 my $dependency = $dependencies{$level}{'config line'};
847 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
849 foreach (@privoxy_config) {
852 $dependency_problem = undef;
859 if (defined ($dependencies{$level}{'feature status'})
860 and not defined $dependency_problem) {
862 my $dependency = $dependencies{$level}{'feature status'};
863 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
865 unless (defined($privoxy_features{$feature})
866 and ($privoxy_features{$feature} eq $status))
868 $dependency_problem = "depends on '" . $feature .
869 "' being set to '" . $status . "'";
873 return $dependency_problem;
876 sub register_dependency ($$) {
879 my $dependency = shift;
882 if ($dependency =~ /config line\s+(.*)/) {
884 $dependencies{$level}{'config line'} = $1;
886 } elsif ($dependency =~ /feature status\s+(.*)/) {
888 $dependencies{$level}{'feature status'} = $1;
892 log_and_die("Didn't recognize dependency: $dependency.");
896 sub execute_method_test ($) {
901 my $method = $test->{'data'};
903 my $curl_parameters = '';
904 my $expected_status_code = $test->{'expected-status-code'};
906 $curl_parameters .= '--request ' . $method . ' ';
907 # Don't complain about the 'missing' body
908 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
910 $curl_parameters .= PRIVOXY_CGI_URL;
912 $buffer_ref = get_page_with_curl($curl_parameters);
913 $status_code = get_status_code($buffer_ref);
915 return check_status_code_result($status_code, $expected_status_code);
918 sub execute_redirect_test ($) {
924 my $curl_parameters = '';
925 my $url = $test->{'data'};
926 my $redirect_destination;
927 my $expected_redirect_destination = $test->{'redirect destination'};
929 # XXX: Check if a redirect actually applies before doing the request.
930 # otherwise the test may hit a real server in failure cases.
932 $curl_parameters .= '--head ';
934 $curl_parameters .= quote($url);
936 $buffer_ref = get_page_with_curl($curl_parameters);
937 $status_code = get_status_code($buffer_ref);
939 if ($status_code ne "302") {
940 l(LL_VERBOSE_FAILURE,
941 "Ooops. Expected redirect to: '" . $expected_redirect_destination
942 . "' but got a response with status code: " . $status_code);
945 foreach (@{$buffer_ref}) {
946 if (/^Location: (.*)\r\n/) {
947 $redirect_destination = $1;
952 my $success = ($redirect_destination eq $expected_redirect_destination);
955 l(LL_VERBOSE_FAILURE,
956 "Ooops. Expected redirect to: '" . $expected_redirect_destination
957 . "' but the redirect leads to: '" . $redirect_destination. "'");
963 sub execute_dumb_fetch_test ($) {
969 my $curl_parameters = '';
970 my $expected_status_code = $test->{'expected-status-code'};
972 if (defined $test->{method}) {
973 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
975 if ($test->{type} == TRUSTED_CGI_REQUEST) {
976 $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' ';
979 $curl_parameters .= quote($test->{'data'});
981 $buffer_ref = get_page_with_curl($curl_parameters);
982 $status_code = get_status_code($buffer_ref);
984 return check_status_code_result($status_code, $expected_status_code);
987 sub execute_block_test ($) {
990 my $url = $test->{'data'};
991 my $final_results = get_final_results($url);
993 return defined $final_results->{'+block'};
996 sub execute_sticky_actions_test ($) {
999 my $url = $test->{'data'};
1000 my $verified_actions = 0;
1001 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
1002 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
1003 my $final_results = get_final_results($url);
1005 foreach my $sticky_action (@sticky_actions) {
1007 if (defined $final_results->{$sticky_action}) {
1009 $verified_actions++;
1011 } elsif ($sticky_action =~ /-.*\{/) {
1013 # Disabled multi actions aren't explicitly listed as
1014 # disabled and thus have to be checked by verifying
1015 # that they aren't enabled.
1016 $verified_actions++;
1019 l(LL_VERBOSE_FAILURE,
1020 "Ooops. '$sticky_action' is not among the final results.");
1024 return $verified_actions == @sticky_actions;
1027 sub get_final_results ($) {
1030 my $curl_parameters = '';
1031 my %final_results = ();
1032 my $final_results_reached = 0;
1034 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
1035 # XXX: should be URL-encoded properly
1042 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
1044 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
1046 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
1048 next unless ($final_results_reached);
1051 # Privoxy versions before 3.0.16 add a space
1052 # between action name and parameters, therefore
1054 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
1058 if (defined $parameter) {
1059 # In case the caller needs to check
1060 # the action and its parameter
1061 $final_results{$action . $parameter} = 1;
1063 # In case the action doesn't have parameters
1064 # or the caller doesn't care for the parameter.
1065 $final_results{$action} = 1;
1069 return \%final_results;
1072 sub check_status_code_result ($$) {
1074 my $status_code = shift;
1075 my $expected_status_code = shift;
1078 unless (defined $status_code) {
1080 # XXX: should probably be caught earlier.
1081 l(LL_VERBOSE_FAILURE,
1082 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
1084 } elsif ($expected_status_code == $status_code) {
1087 l(LL_VERBOSE_SUCCESS,
1088 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
1090 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
1092 l(LL_VERBOSE_FAILURE,
1093 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
1097 l(LL_VERBOSE_FAILURE,
1098 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
1104 sub execute_client_header_regression_test ($) {
1110 $buffer_ref = get_show_request_with_curl($test);
1112 $header = get_header($buffer_ref, $test);
1114 return check_header_result($test, $header);
1117 sub execute_server_header_regression_test ($) {
1123 $buffer_ref = get_head_with_curl($test);
1125 $header = get_server_header($buffer_ref, $test);
1127 return check_header_result($test, $header);
1130 sub interpret_result ($) {
1131 my $success = shift;
1132 return $success ? "Success" : "Failure";
1135 sub check_header_result ($$) {
1140 my $expect_header = $test->{'expect-header'};
1143 if ($expect_header eq 'NO CHANGE') {
1145 $success = (defined($header) and $header eq $test->{'data'});
1148 $header = "REMOVAL" unless defined $header;
1149 l(LL_VERBOSE_FAILURE,
1150 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1153 } elsif ($expect_header eq 'REMOVAL') {
1155 # XXX: Use more reliable check here and make sure
1156 # the header has a different name.
1157 $success = not (defined($header) and $header eq $test->{'data'});
1160 l(LL_VERBOSE_FAILURE,
1161 "Ooops. Expected removal but: '" . $header . "' is still there.");
1164 } elsif ($expect_header eq 'SOME CHANGE') {
1166 $success = (defined($header) and $header ne $test->{'data'});
1169 $header = "REMOVAL" unless defined $header;
1170 l(LL_VERBOSE_FAILURE,
1171 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
1176 $success = (defined($header) and $header eq $expect_header);
1179 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
1180 l(LL_VERBOSE_FAILURE,
1181 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
1187 sub get_header_name ($) {
1191 $header =~ s@(.*?: ).*@$1@;
1196 sub get_header ($$) {
1198 our $filtered_request = '';
1200 my $buffer_ref = shift;
1203 my @buffer = @{$buffer_ref};
1205 my $expect_header = $test->{'expect-header'};
1207 die "get_header called with no expect header" unless defined $expect_header;
1210 my $processed_request_reached = 0;
1211 my $read_header = 0;
1212 my $processed_request = '';
1216 if ($expect_header eq 'REMOVAL'
1217 or $expect_header eq 'NO CHANGE'
1218 or $expect_header eq 'SOME CHANGE') {
1220 $expect_header = $test->{'data'};
1223 $header_to_get = get_header_name($expect_header);
1227 # Skip everything before the Processed request
1228 if (/Processed Request/) {
1229 $processed_request_reached = 1;
1232 next unless $processed_request_reached;
1234 # End loop after the Processed request
1235 last if (/<\/pre>/);
1237 # Ditch tags and leading/trailing white space.
1241 # Decode characters we care about.
1244 $filtered_request .= "\n" . $_;
1246 if (/^$header_to_get/) {
1256 sub get_server_header ($$) {
1258 my $buffer_ref = shift;
1261 my @buffer = @{$buffer_ref};
1263 my $expect_header = $test->{'expect-header'};
1267 # XXX: Should be caught before starting to test.
1268 log_and_die("No expect header for test " . $test->{'number'})
1269 unless defined $expect_header;
1271 if ($expect_header eq 'REMOVAL'
1272 or $expect_header eq 'NO CHANGE'
1273 or $expect_header eq 'SOME CHANGE') {
1275 $expect_header = $test->{'data'};
1278 $header_to_get = get_header_name($expect_header);
1282 # XXX: should probably verify that the request
1283 # was actually answered by Fellatio.
1284 if (/^$header_to_get/) {
1286 $header =~ s@\s*$@@g;
1294 sub get_status_code ($) {
1296 my $buffer_ref = shift;
1297 my @buffer = @{$buffer_ref};
1301 if (/^HTTP\/\d\.\d (\d{3})/) {
1307 return '123' if cli_option_is_set('fuzzer-feeding');
1309 log_and_die('Unexpected buffer line: "' . $_ . '"');
1314 sub get_test_keys () {
1315 return ('tag', 'data', 'expect-header', 'ignore');
1319 sub test_content_as_string ($) {
1325 foreach my $key (get_test_keys()) {
1326 $test->{$key} = 'Not set' unless (defined $test->{$key});
1329 $s .= 'Tag: ' . $test->{'tag'};
1331 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1333 $s .= 'Expected header: ' . $test->{'expect-header'};
1335 $s .= 'Ignore: ' . $test->{'ignore'};
1340 sub fuzz_header($) {
1342 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1344 $white_space = $white_space x (1 + int(rand(5)));
1346 # Only fuzz white space before the first quoted token.
1347 # (Privoxy doesn't touch white space inside quoted tokens
1348 # and modifying it would cause the tests to fail).
1349 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1354 ############################################################################
1356 # HTTP fetch functions
1358 ############################################################################
1360 sub get_cgi_page_or_else ($) {
1362 my $cgi_url = shift;
1363 my $content_ref = get_page_with_curl($cgi_url);
1364 my $status_code = get_status_code($content_ref);
1366 if (200 != $status_code) {
1368 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1369 "Received status code ". $status_code .
1370 " while only 200 is acceptable.";
1372 if (cli_option_is_set('fuzzer-feeding')) {
1374 $log_message .= " Ignored due to fuzzer feeding.";
1375 l(LL_SOFT_ERROR, $log_message)
1379 log_and_die($log_message);
1383 return $content_ref;
1386 # XXX: misleading name
1387 sub get_show_request_with_curl ($) {
1389 our $privoxy_cgi_url;
1392 my $curl_parameters = ' ';
1393 my $header = $test->{'data'};
1395 if (cli_option_is_set('header-fuzzing')) {
1396 $header = fuzz_header($header);
1399 # Enable the action to test
1400 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1401 # The header to filter
1402 $curl_parameters .= '-H \'' . $header . '\' ';
1404 $curl_parameters .= ' ';
1405 $curl_parameters .= $privoxy_cgi_url;
1406 $curl_parameters .= 'show-request';
1408 return get_cgi_page_or_else($curl_parameters);
1411 sub get_head_with_curl ($) {
1413 our $fellatio_url = FELLATIO_URL;
1416 my $curl_parameters = ' ';
1418 # Enable the action to test
1419 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1420 # The header to filter
1421 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1422 $curl_parameters .= '--head ';
1424 $curl_parameters .= ' ';
1425 $curl_parameters .= $fellatio_url;
1427 return get_page_with_curl($curl_parameters);
1430 sub get_page_with_curl ($) {
1434 my $parameters = shift;
1436 my $curl_line = CURL;
1437 my $retries_left = get_cli_option('retries') + 1;
1440 if (defined $proxy) {
1441 $curl_line .= ' --proxy ' . quote($proxy);
1443 # We want to see the HTTP status code
1444 $curl_line .= " --include ";
1445 # Let Privoxy emit two log messages less.
1446 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1447 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1448 # We don't care about fetch statistic.
1449 $curl_line .= " -s ";
1450 # We do care about the failure reason if any.
1451 $curl_line .= " -S ";
1452 # We want to advertise ourselves
1453 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1454 # We aren't too patient
1455 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1457 $curl_line .= $parameters;
1458 # XXX: still necessary?
1459 $curl_line .= ' 2>&1';
1461 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1464 @buffer = `$curl_line`;
1467 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1468 $failure_reason = array_as_string(\@buffer);
1469 chomp $failure_reason;
1470 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1472 } while ($? && --$retries_left);
1474 unless ($retries_left) {
1475 log_and_die("Running curl failed " . get_cli_option('retries') .
1476 " times in a row. Last error: '" . $failure_reason . "'.");
1483 ############################################################################
1487 ############################################################################
1489 sub array_as_string ($) {
1490 my $array_ref = shift;
1493 foreach (@{$array_ref}) {
1502 log_message('Test is:' . test_content_as_string($test));
1508 my $this_level = shift;
1509 my $message = shift;
1511 log_message($message) if ($log_level & $this_level);
1514 sub log_and_die ($) {
1515 my $message = shift;
1517 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1521 sub log_message ($) {
1523 my $message = shift;
1527 our $leading_log_date;
1528 our $leading_log_time;
1530 my $time_stamp = '';
1531 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1533 if ($leading_log_date || $leading_log_time) {
1535 if ($leading_log_date) {
1538 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1541 if ($leading_log_time) {
1542 $time_stamp .= ' ' if $leading_log_date;
1543 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1546 $message = $time_stamp . ": " . $message;
1549 printf("%s\n", $message);
1552 sub log_result ($$) {
1554 our $filtered_request;
1560 my $message = sprintf("%s for test %d",
1561 interpret_result($result),
1564 if (cli_option_is_set('verbose')) {
1565 $message .= sprintf(" (%d/%d/%d)", $number,
1566 $test->{'section-id'},
1567 $test->{'regression-test-id'});
1572 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1574 $message .= 'Header ';
1575 $message .= quote($test->{'data'});
1576 $message .= ' and tag ';
1577 $message .= quote($test->{'tag'});
1579 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1581 $message .= 'Request Header ';
1582 $message .= quote($test->{'data'});
1583 $message .= ' and tag ';
1584 $message .= quote($test->{'tag'});
1586 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1589 $message .= quote($test->{'data'});
1590 $message .= ' and expected status code ';
1591 $message .= quote($test->{'expected-status-code'});
1593 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1595 $message .= 'CGI URL ';
1596 $message .= quote($test->{'data'});
1597 $message .= ' and expected status code ';
1598 $message .= quote($test->{'expected-status-code'});
1600 } elsif ($test->{'type'} == METHOD_TEST) {
1602 $message .= 'HTTP method ';
1603 $message .= quote($test->{'data'});
1604 $message .= ' and expected status code ';
1605 $message .= quote($test->{'expected-status-code'});
1607 } elsif ($test->{'type'} == BLOCK_TEST) {
1609 $message .= 'Supposedly-blocked URL: ';
1610 $message .= quote($test->{'data'});
1612 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1614 $message .= 'Sticky Actions: ';
1615 $message .= quote($test->{'sticky-actions'});
1616 $message .= ' and URL: ';
1617 $message .= quote($test->{'data'});
1619 } elsif ($test->{'type'} == REDIRECT_TEST) {
1621 $message .= 'Redirected URL: ';
1622 $message .= quote($test->{'data'});
1623 $message .= ' and redirect destination: ';
1624 $message .= quote($test->{'redirect destination'});
1628 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1631 log_message($message) if (!$result or cli_option_is_set('verbose'));
1636 return '\'' . $s . '\'';
1639 sub print_version () {
1640 printf PRT_VERSION . "\n";
1643 sub list_test_types () {
1645 'Client header test' => CLIENT_HEADER_TEST,
1646 'Server header test' => 2,
1647 'Dumb fetch test' => 3,
1649 'Sticky action test' => 5,
1650 'Trusted CGI test' => 6,
1652 'Redirect test' => 108,
1655 print "\nThe supported test types and their default levels are:\n";
1656 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1657 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1669 Options and their default values if they have any:
1670 [--debug $cli_options{'debug'}]
1671 [--forks $cli_options{'forks'}]
1678 [--loops $cli_options{'loops'}]
1679 [--max-level $cli_options{'max-level'}]
1680 [--max-time $cli_options{'max-time'}]
1681 [--min-level $cli_options{'min-level'}]
1683 [--retries $cli_options{'retries'}]
1684 [--show-skipped-tests]
1686 [--sleep-time $cli_options{'sleep-time'}]
1697 Try "perldoc $0" for more information
1704 sub init_cli_options () {
1709 $cli_options{'debug'} = $log_level;
1710 $cli_options{'forks'} = CLI_FORKS;
1711 $cli_options{'loops'} = CLI_LOOPS;
1712 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1713 $cli_options{'max-time'} = CLI_MAX_TIME;
1714 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1715 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1716 $cli_options{'retries'} = CLI_RETRIES;
1719 sub parse_cli_options () {
1727 'debug=i' => \$cli_options{'debug'},
1728 'forks=i' => \$cli_options{'forks'},
1729 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1730 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1731 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1733 'level=i' => \$cli_options{'level'},
1734 'local-test-file=s' => \$cli_options{'local-test-file'},
1735 'loops=i' => \$cli_options{'loops'},
1736 'max-level=i' => \$cli_options{'max-level'},
1737 'max-time=i' => \$cli_options{'max-time'},
1738 'min-level=i' => \$cli_options{'min-level'},
1739 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1740 'retries=i' => \$cli_options{'retries'},
1741 'shuffle-tests' => \$cli_options{'shuffle-tests'},
1742 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1743 'sleep-time=i' => \$cli_options{'sleep-time'},
1744 'test-number=i' => \$cli_options{'test-number'},
1745 'verbose' => \$cli_options{'verbose'},
1746 'version' => sub {print_version && exit(0)}
1748 $log_level |= $cli_options{'debug'};
1751 sub cli_option_is_set ($) {
1754 my $cli_option = shift;
1756 return defined $cli_options{$cli_option};
1759 sub get_cli_option ($) {
1762 my $cli_option = shift;
1764 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1766 return $cli_options{$cli_option};
1769 sub init_proxy_settings($) {
1774 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1775 $proxy = get_cli_option('fuzzer-address');
1778 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1780 if (cli_option_is_set('privoxy-address')) {
1781 $proxy .= get_cli_option('privoxy-address');
1786 sub start_forks($) {
1789 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1791 foreach my $fork (1 .. $forks) {
1792 log_message("Starting fork $fork");
1794 if (defined $pid && !$pid) {
1802 init_our_variables();
1803 parse_cli_options();
1804 init_proxy_settings('vanilla-proxy');
1805 load_regression_tests();
1806 init_proxy_settings('fuzz-proxy');
1807 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1808 execute_regression_tests();
1815 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1819 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1820 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1821 [B<--local-test-file testfile>] [B<--loops count>] [B<--max-level max-level>]
1822 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1823 [B<--retries retries>] [B<--test-number test-number>]
1824 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1829 Privoxy-Regression-Test is supposed to one day become
1830 a regression test suite for Privoxy. It's not quite there
1831 yet, however, and can currently only test header actions,
1832 check the returned status code for requests to arbitrary
1833 URLs and verify which actions are applied to them.
1835 Client header actions are tested by requesting
1836 B<http://p.p/show-request> and checking whether
1837 or not Privoxy modified the original request as expected.
1839 The original request contains both the header the action-to-be-tested
1840 acts upon and an additional tagger-triggering header that enables
1843 Applied actions are checked through B<http://p.p/show-url-info>.
1845 =head1 CONFIGURATION FILE SYNTAX
1847 Privoxy-Regression-Test's configuration is embedded in
1848 Privoxy action files and loaded through Privoxy's web interface.
1850 It makes testing a Privoxy version running on a remote system easier
1851 and should prevent you from updating your tests without updating Privoxy's
1852 configuration accordingly.
1854 A client-header-action test section looks like this:
1856 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1857 # Expect Header = Referer: http://www.example.org/
1858 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1859 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1861 The example above causes Privoxy-Regression-Test to set
1862 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1863 and to expect it to be modified to
1864 B<Referer: http://www.example.org/>.
1866 When testing this section, Privoxy-Regression-Test will set the header
1867 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1868 causing the B<privoxy-control> tagger to create the tag
1869 B<client-header-filter{hide-tor-exit-notation}> which will finally
1870 cause Privoxy to enable the action section.
1872 Note that the actions itself are only used by Privoxy,
1873 Privoxy-Regression-Test ignores them and will be happy
1874 as long as the expectations are satisfied.
1876 A fetch test looks like this:
1878 # Fetch Test = http://p.p/user-manual
1879 # Expect Status Code = 302
1881 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1882 and to expect a response with the HTTP status code B<302>. Obviously that's
1883 not a very thorough test and mainly useful to get some code coverage
1884 for Valgrind or to verify that the templates are installed correctly.
1886 If you want to test CGI pages that require a trusted
1887 referer, you can use:
1889 # Trusted CGI Request = http://p.p/edit-actions
1891 It works like ordinary fetch tests, but sets the referer
1892 header to a trusted value.
1894 If no explicit status code expectation is set, B<200> is used.
1896 To verify that a URL is blocked, use:
1898 # Blocked URL = http://www.example.com/blocked
1900 To verify that a specific set of actions is applied to an URL, use:
1902 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1903 # URL = http://www.example.org/my-first-url
1905 The sticky actions will be checked for all URLs below it
1906 until the next sticky actions directive.
1908 To verify that requests for a URL get redirected, use:
1910 # Redirected URL = http://www.example.com/redirect-me
1911 # Redirect Destination = http://www.example.org/redirected
1913 To skip a test, add the following line:
1917 The difference between a skipped test and a removed one is that removing
1918 a test affects the numbers of the following tests, while a skipped test
1919 is still loaded and thus keeps the test numbers unchanged.
1921 Sometimes user modifications intentionally conflict with tests in the
1922 default configuration and thus cause test failures. Adding the Ignore
1923 directive to the failing tests works but is inconvenient as the directive
1924 is likely to get lost with the next update.
1926 Overwrite conditions are an alternative and can be added in any action
1927 file as long as the come after the test that is expected to fail.
1928 They causes all previous tests a matching the condition to be skipped.
1930 It is recommended to put the overwrite condition below the custom Privoxy
1931 section that causes the expected test failure and before the custom test
1932 that verifies that tests the now expected behaviour. Example:
1934 # The following section is expected to overwrite a section in
1935 # default.action, whose effect is tested. Thus also disable the
1936 # test that is now expected to fail and add a new one.
1938 {+block{Facebook makes Firefox even more unstable. Do not want.}}
1939 # Overwrite condition = http://apps.facebook.com/onthefarm/track.php?creative=&cat=friendvisit&subcat=weeds&key=a789a971dc687bee4c20c044834fabdd&next=index.php%3Fref%3Dnotif%26visitId%3D898835505
1940 # Blocked URL = http://apps.facebook.com/
1945 All tests have test levels to let the user
1946 control which ones to execute (see I<OPTIONS> below).
1947 Test levels are either set with the B<Level> directive,
1948 or implicitly through the test type.
1950 Redirect tests default to level 108, block tests to level 7,
1951 fetch tests to level 6, "Sticky Actions" tests default to
1952 level 5, tests for trusted CGI requests to level 3 and
1953 client-header-action tests to level 1.
1955 The current redirect test level is above the default
1956 max-level value as failed tests will result in outgoing
1957 connections. Use the B<--max-level> option to run them
1960 The "Default level offset" directive can be used to change
1961 the default level by a given value. This directive affects
1962 all tests located after it until the end of the file or a another
1963 "Default level offset" directive is reached. The purpose of this
1964 directive is to make it more convenient to skip similar tests in
1965 a given file without having to remove or disable the tests completely.
1969 B<--debug bitmask> Add the bitmask provided as integer
1970 to the debug settings.
1972 B<--forks forks> Number of forks to start before executing
1973 the regression tests. This is mainly useful for stress-testing.
1975 B<--fuzzer-address> Listening address used when executing
1976 the regression tests. Useful to make sure that the requests
1977 to load the regression tests don't fail due to fuzzing.
1979 B<--fuzzer-feeding> Ignore some errors that would otherwise
1980 cause Privoxy-Regression-Test to abort the test because
1981 they shouldn't happen in normal operation. This option is
1982 intended to be used if Privoxy-Regression-Test is only
1983 used to feed a fuzzer in which case there's a high chance
1984 that Privoxy gets an invalid request and returns an error
1987 B<--help> Shows available command line options.
1989 B<--header-fuzzing> Modifies linear white space in
1990 headers in a way that should not affect the test result.
1992 B<--level level> Only execute tests with the specified B<level>.
1994 B<--local-test-file test-file> Do not get the tests
1995 through Privoxy's web interface, but use a single local
1996 file. Not recommended for testing Privoxy, but can be useful
1997 to "misappropriate" Privoxy-Regression-Test to test other
1998 stuff, like webserver configurations.
2000 B<--loop count> Loop through the regression tests B<count> times.
2001 Useful to feed a fuzzer, or when doing stress tests with
2002 several Privoxy-Regression-Test instances running at the same
2005 B<--max-level max-level> Only execute tests with a B<level>
2006 below or equal to the numerical B<max-level>.
2008 B<--max-time max-time> Give Privoxy B<max-time> seconds
2009 to return data. Increasing the default may make sense when
2010 Privoxy is run through Valgrind, decreasing the default may
2011 make sense when Privoxy-Regression-Test is used to feed
2014 B<--min-level min-level> Only execute tests with a B<level>
2015 above or equal to the numerical B<min-level>.
2017 B<--privoxy-address proxy-address> Privoxy's listening address.
2018 If it's not set, the value of the environment variable http_proxy
2019 will be used. B<proxy-address> has to be specified in http_proxy
2022 B<--retries retries> Retry B<retries> times.
2024 B<--test-number test-number> Only run the test with the specified
2027 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
2029 B<--shuffle-tests> Shuffle test sections and their tests before
2030 executing them. When combined with B<--forks>, this can increase
2031 the chances of detecting race conditions. Of course some problems
2032 are easier to detect without this option.
2034 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
2035 debugging issues with systems that don't log with millisecond precision.
2037 B<--verbose> Log successful tests as well. By default only
2038 the failures are logged.
2040 B<--version> Print version and exit.
2042 The second dash is optional, options can be shortened,
2043 as long as there are no ambiguities.
2045 =head1 PRIVOXY CONFIGURATION
2047 Privoxy-Regression-Test is shipped with B<regression-tests.action>
2048 which aims to test all official client-header modifying actions
2049 and can be used to verify that the templates and the user manual
2050 files are installed correctly.
2052 To use it, it has to be copied in Privoxy's configuration
2053 directory, and afterwards referenced in Privoxy's configuration
2056 actionsfile regression-tests.action
2058 In general, its tests are supposed to work without changing
2059 any other action files, unless you already added lots of
2060 taggers yourself. If you are using taggers that cause problems,
2061 you might have to temporary disable them for Privoxy's CGI pages.
2063 Some of the regression tests rely on Privoxy features that
2064 may be disabled in your configuration. Tests with a level below
2065 7 are supposed to work with all Privoxy configurations (provided
2066 you didn't build with FEATURE_GRACEFUL_TERMINATION).
2068 Tests with level 9 require Privoxy to deliver the User Manual,
2069 tests with level 12 require the CGI editor to be enabled.
2073 Expect the configuration file syntax to change with future releases.
2077 As Privoxy's B<show-request> page only shows client headers,
2078 Privoxy-Regression-Test can't use it to test Privoxy actions
2079 that modify server headers.
2081 As Privoxy-Regression-Test relies on Privoxy's tag feature to
2082 control the actions to test, it currently only works with
2083 Privoxy 3.0.7 or later.
2085 At the moment Privoxy-Regression-Test fetches Privoxy's
2086 configuration page through I<curl>(1), therefore you have to
2087 have I<curl> installed, otherwise you won't be able to run
2088 Privoxy-Regression-Test in a meaningful way.
2096 Fabian Keil <fk@fabiankeil.de>