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.176 2009/05/27 20:26:59 fk 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-2009 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.3',
52 # XXX: why limit at all?
56 PRIVOXY_CGI_URL => 'http://p.p/',
57 FELLATIO_URL => 'http://127.0.0.1:8080/',
58 LEADING_LOG_DATE => 1,
59 LEADING_LOG_TIME => 1,
61 DEBUG_LEVEL_FILE_LOADING => 0,
62 DEBUG_LEVEL_PAGE_FETCHING => 0,
63 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
64 # XXX: Only partly implemented and mostly useless.
65 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
66 DEBUG_LEVEL_STATUS => 1,
68 VERBOSE_TEST_DESCRIPTION => 1,
70 # Internal use, don't modify
71 # Available debug bits:
73 LL_VERBOSE_FAILURE => 2,
74 LL_PAGE_FETCHING => 4,
76 LL_VERBOSE_SUCCESS => 16,
80 CLIENT_HEADER_TEST => 1,
81 SERVER_HEADER_TEST => 2,
84 STICKY_ACTIONS_TEST => 5,
85 TRUSTED_CGI_REQUEST => 6,
89 sub init_our_variables () {
91 our $leading_log_time = LEADING_LOG_TIME;
92 our $leading_log_date = LEADING_LOG_DATE;
94 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
96 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
98 our $log_level = get_default_log_level();
102 sub get_default_log_level () {
106 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
107 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
108 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
109 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
110 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
112 # These are intended to be always on.
113 $log_level |= LL_SOFT_ERROR;
114 $log_level |= LL_ERROR;
119 ############################################################################
121 # File loading functions
123 ############################################################################
131 # Unescape brackets and dots
132 $tag =~ s@\\(?=[{}().+])@@g;
134 # log_message("Parsed tag: " . $tag);
136 check_for_forbidden_characters($tag);
141 sub check_for_forbidden_characters ($) {
144 my $allowed = '[-=\dA-Za-z~{}:./();\s,+@"_%?&*^]';
146 unless ($string =~ m/^$allowed*$/o) {
147 my $forbidden = $string;
148 $forbidden =~ s@^$allowed*(.).*@$1@;
150 l(LL_ERROR, "'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
154 sub load_regressions_tests () {
156 our $privoxy_cgi_url;
158 our %privoxy_features;
164 $curl_url .= $privoxy_cgi_url;
165 $curl_url .= 'show-status';
167 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
169 foreach (@{get_cgi_page_or_else($curl_url)}) {
172 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
174 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
175 $actionfiles[$file_number++] = $url;
177 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
179 my $directive = $1 . " " . $2;
180 push (@privoxy_config, $directive);
182 } elsif (m@<td><code>([^<]*)</code></td>@) {
186 } elsif (m@<td> (Yes|No) </td>@) {
188 $privoxy_features{$feature} = $1 if defined $feature;
193 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
195 load_action_files(\@actionfiles);
198 sub token_starts_new_test ($) {
201 my @new_test_directives = ('set header', 'fetch test',
202 'trusted cgi request', 'request header', 'method test',
203 'blocked url', 'url');
205 foreach my $new_test_directive (@new_test_directives) {
206 return 1 if $new_test_directive eq $token;
214 my ($token, $value) = (undef, undef);
216 # Remove leading and trailing white space.
220 # Reverse HTML-encoding
221 # XXX: Seriously imcomplete.
226 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)$/) {
231 $token =~ s@\s\s+@ @g;
232 $token =~ tr/[A-Z]/[a-z]/;
234 } elsif (/^TAG\s*:(.*)$/) {
240 return ($token, $value);
243 sub enlist_new_test ($$$$$$) {
245 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
248 if ($token eq 'set header') {
250 l(LL_FILE_LOADING, "Header to set: " . $value);
251 $type = CLIENT_HEADER_TEST;
253 } elsif ($token eq 'request header') {
255 l(LL_FILE_LOADING, "Header to request: " . $value);
256 $type = SERVER_HEADER_TEST;
257 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
259 } elsif ($token eq 'trusted cgi request') {
261 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
262 $type = TRUSTED_CGI_REQUEST;
263 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
265 } elsif ($token eq 'fetch test') {
267 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
268 $type = DUMB_FETCH_TEST;
269 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
271 } elsif ($token eq 'method test') {
273 l(LL_FILE_LOADING, "Method to test: " . $value);
275 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
277 } elsif ($token eq 'blocked url') {
279 l(LL_FILE_LOADING, "URL to block-test: " . $value);
282 } elsif ($token eq 'url') {
284 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
285 $type = STICKY_ACTIONS_TEST;
289 die "Incomplete '" . $token . "' support detected.";
292 $$regression_tests[$si][$ri]{'type'} = $type;
293 $$regression_tests[$si][$ri]{'level'} = $type;
295 check_for_forbidden_characters($value);
297 $$regression_tests[$si][$ri]{'data'} = $value;
299 # For function that only get passed single tests
300 $$regression_tests[$si][$ri]{'section-id'} = $si;
301 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
302 $$regression_tests[$si][$ri]{'number'} = $number - 1;
304 "Regression test " . $number . " (section:" . $si . "):");
307 sub load_action_files ($) {
311 our @regression_tests;
313 my $actionfiles_ref = shift;
314 my @actionfiles = @{$actionfiles_ref};
316 my $si = 0; # Section index
317 my $ri = -1; # Regression test index
322 l(LL_STATUS, "Gathering regression tests from " .
323 @actionfiles . " action file(s) delivered by Privoxy.");
325 for my $file_number (0 .. @actionfiles - 1) {
327 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
328 my $actionfile = undef;
329 my $sticky_actions = undef;
331 foreach (@{get_cgi_page_or_else($curl_url)}) {
336 if (/<h2>Contents of Actions File (.*?)</) {
340 next unless defined $actionfile;
344 my ($token, $value) = tokenize($_);
346 next unless defined $token;
348 # Load regression tests
350 if (token_starts_new_test($token)) {
352 # Beginning of new regression test.
355 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
358 if ($token =~ /level\s+(\d+)/i) {
361 register_dependency($level, $value);
364 if ($token eq 'sticky actions') {
366 # Will be used by each following Sticky URL.
367 $sticky_actions = $value;
368 if ($sticky_actions =~ /{[^}]*\s/) {
370 "'Sticky Actions' with whitespace inside the " .
371 "action parameters are currently unsupported.");
375 if ($si == -1 || $ri == -1) {
376 # No beginning of a test detected yet,
377 # so we don't care about any other test
382 if ($token eq 'expect header') {
384 l(LL_FILE_LOADING, "Detected expectation: " . $value);
385 $regression_tests[$si][$ri]{'expect-header'} = $value;
387 } elsif ($token eq 'tag') {
391 my $tag = parse_tag($value);
393 # We already checked in parse_tag() after filtering
396 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
398 # Save tag for all tests in this section
400 $regression_tests[$si][$ri]{'tag'} = $tag;
406 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
408 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
409 $regression_tests[$si][$ri]{'ignore'} = 1;
412 } elsif ($token eq 'expect status code') {
414 l(LL_FILE_LOADING, "Expecting status code: " . $value);
415 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
417 } elsif ($token eq 'level') { # XXX: stupid name
419 $value =~ s@(\d+).*@$1@;
420 l(LL_FILE_LOADING, "Level: " . $value);
421 $regression_tests[$si][$ri]{'level'} = $value;
423 } elsif ($token eq 'method') {
425 l(LL_FILE_LOADING, "Method: " . $value);
426 $regression_tests[$si][$ri]{'method'} = $value;
428 } elsif ($token eq 'url') {
430 if (defined $sticky_actions) {
431 die "WTF? Attempted to overwrite Sticky Actions"
432 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
434 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
435 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
437 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
442 # We don't use it, so we don't need
446 check_for_forbidden_characters($value) unless $no_checks;
447 check_for_forbidden_characters($token);
451 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
452 . " Of which " . $ignored. " will be ignored)\n");
455 ############################################################################
457 # Regression test executing functions
459 ############################################################################
461 sub execute_regression_tests () {
463 our @regression_tests;
464 my $loops = get_cli_option('loops');
466 my $all_failures = 0;
467 my $all_successes = 0;
469 unless (@regression_tests) {
471 l(LL_STATUS, "No regression tests found.");
475 l(LL_STATUS, "Executing regression tests ...");
477 while ($loops-- > 0) {
484 for my $s (0 .. @regression_tests - 1) {
488 while (defined $regression_tests[$s][$r]) {
490 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
491 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
493 my $number = $regression_tests[$s][$r]{'number'};
494 my $skip_reason = undef;
496 if ($regression_tests[$s][$r]{'ignore'}) {
498 $skip_reason = "Ignore flag is set";
500 } elsif (cli_option_is_set('test-number')
501 and get_cli_option('test-number') != $number) {
503 $skip_reason = "Only executing test " . get_cli_option('test-number');
507 $skip_reason = level_is_unacceptable($regression_tests[$s][$r]{'level'});
510 if (defined $skip_reason) {
512 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
513 log_message($message) if (cli_option_is_set('show-skipped-tests'));
518 my $result = execute_regression_test($regression_tests[$s][$r]);
520 log_result($regression_tests[$s][$r], $result, $tests);
522 $successes += $result;
528 $failures = $tests - $successes;
530 log_message("Executed " . $tests . " regression tests. " .
531 'Skipped ' . $skipped . '. ' .
532 $successes . " successes, " . $failures . " failures.");
534 $all_tests += $tests;
535 $all_failures += $failures;
536 $all_successes += $successes;
539 if (get_cli_option('loops') > 1) {
540 log_message("Total: Executed " . $all_tests . " regression tests. " .
541 $all_successes . " successes, " . $all_failures . " failures.");
545 sub level_is_unacceptable ($) {
547 my $min_level = get_cli_option('min-level');
548 my $max_level = get_cli_option('max-level');
549 my $required_level = cli_option_is_set('level') ?
550 get_cli_option('level') : $level;
553 if ($required_level != $level) {
555 $reason = "Level doesn't match (" . $level .
556 " != " . $required_level . ")"
558 } elsif ($level < $min_level) {
560 $reason = "Level to low (" . $level . " < " . $min_level . ")";
562 } elsif ($level > $max_level) {
564 $reason = "Level to high (" . $level . " > " . $max_level . ")";
568 $reason = dependency_unsatisfied($level);
574 sub dependency_unsatisfied ($) {
579 our %privoxy_features;
581 my $dependency_problem = undef;
583 if (defined ($dependencies{$level}{'config line'})) {
585 my $dependency = $dependencies{$level}{'config line'};
586 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
588 foreach (@privoxy_config) {
591 $dependency_problem = undef;
596 } elsif (defined ($dependencies{$level}{'feature status'})) {
598 my $dependency = $dependencies{$level}{'feature status'};
599 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
601 unless (defined($privoxy_features{$feature})
602 and ($privoxy_features{$feature} eq $status))
604 $dependency_problem = "depends on '" . $feature .
605 "' being set to '" . $status . "'";
609 return $dependency_problem;
612 sub register_dependency ($$) {
615 my $dependency = shift;
618 if ($dependency =~ /config line\s+(.*)/) {
620 $dependencies{$level}{'config line'} = $1;
622 } elsif ($dependency =~ /feature status\s+(.*)/) {
624 $dependencies{$level}{'feature status'} = $1;
628 l(LL_ERROR, "Didn't recognize dependency: $dependency.");
632 # XXX: somewhat misleading name
633 sub execute_regression_test ($) {
635 my $test_ref = shift;
636 my %test = %{$test_ref};
639 if ($test{'type'} == CLIENT_HEADER_TEST) {
641 $result = execute_client_header_regression_test($test_ref);
643 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
645 $result = execute_server_header_regression_test($test_ref);
647 } elsif ($test{'type'} == DUMB_FETCH_TEST
648 or $test{'type'} == TRUSTED_CGI_REQUEST) {
650 $result = execute_dumb_fetch_test($test_ref);
652 } elsif ($test{'type'} == METHOD_TEST) {
654 $result = execute_method_test($test_ref);
656 } elsif ($test{'type'} == BLOCK_TEST) {
658 $result = execute_block_test($test_ref);
660 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
662 $result = execute_sticky_actions_test($test_ref);
666 die "Unsupported test type detected: " . $test{'type'};
672 sub execute_method_test ($) {
674 my $test_ref = shift;
675 my %test = %{$test_ref};
678 my $method = $test{'data'};
680 my $curl_parameters = '';
681 my $expected_status_code = $test{'expected-status-code'};
683 $curl_parameters .= '--request ' . $method . ' ';
684 # Don't complain about the 'missing' body
685 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
687 $curl_parameters .= PRIVOXY_CGI_URL;
689 $buffer_ref = get_page_with_curl($curl_parameters);
690 $status_code = get_status_code($buffer_ref);
692 return check_status_code_result($status_code, $expected_status_code);
695 sub execute_dumb_fetch_test ($) {
697 my $test_ref = shift;
698 my %test = %{$test_ref};
702 my $curl_parameters = '';
703 my $expected_status_code = $test{'expected-status-code'};
705 if (defined $test{method}) {
706 $curl_parameters .= '--request ' . $test{method} . ' ';
708 if ($test{type} == TRUSTED_CGI_REQUEST) {
709 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
712 $curl_parameters .= $test{'data'};
714 $buffer_ref = get_page_with_curl($curl_parameters);
715 $status_code = get_status_code($buffer_ref);
717 return check_status_code_result($status_code, $expected_status_code);
720 sub execute_block_test ($) {
723 my $url = $test->{'data'};
724 my $final_results = get_final_results($url);
726 return defined $final_results->{'+block'};
729 sub execute_sticky_actions_test ($) {
732 my $url = $test->{'data'};
733 my $verified_actions = 0;
734 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
735 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
736 my $final_results = get_final_results($url);
738 foreach my $sticky_action (@sticky_actions) {
740 if (defined $final_results->{$sticky_action}) {
744 } elsif ($sticky_action =~ /-.*\{/) {
746 # Disabled multi actions aren't explicitly listed as
747 # disabled and thus have to be checked by verifying
748 # that they aren't enabled.
752 l(LL_VERBOSE_FAILURE,
753 "Ooops. '$sticky_action' is not among the final results.");
757 return $verified_actions == @sticky_actions;
760 sub get_final_results ($) {
763 my $curl_parameters = '';
764 my %final_results = ();
765 my $final_results_reached = 0;
767 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
768 # XXX: should be URL-encoded properly
775 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
777 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
779 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
781 next unless ($final_results_reached);
784 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
788 if (defined $parameter) {
789 # In case the caller needs to check
790 # the action and its parameter
791 $final_results{$action . $parameter} = 1;
793 # In case the action doesn't have parameters
794 # or the caller doesn't care for the parameter.
795 $final_results{$action} = 1;
799 return \%final_results;
802 sub check_status_code_result ($$) {
804 my $status_code = shift;
805 my $expected_status_code = shift;
808 unless (defined $status_code) {
810 # XXX: should probably be caught earlier.
811 l(LL_VERBOSE_FAILURE,
812 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
814 } elsif ($expected_status_code == $status_code) {
817 l(LL_VERBOSE_SUCCESS,
818 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
820 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
822 l(LL_VERBOSE_FAILURE,
823 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
827 l(LL_VERBOSE_FAILURE,
828 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
834 sub execute_client_header_regression_test ($) {
836 my $test_ref = shift;
840 $buffer_ref = get_show_request_with_curl($test_ref);
842 $header = get_header($buffer_ref, $test_ref);
844 return check_header_result($test_ref, $header);
847 sub execute_server_header_regression_test ($) {
849 my $test_ref = shift;
853 $buffer_ref = get_head_with_curl($test_ref);
855 $header = get_server_header($buffer_ref, $test_ref);
857 return check_header_result($test_ref, $header);
860 sub interpret_result ($) {
862 return $success ? "Success" : "Failure";
865 sub check_header_result ($$) {
867 my $test_ref = shift;
870 my %test = %{$test_ref};
871 my $expect_header = $test{'expect-header'};
874 if ($expect_header eq 'NO CHANGE') {
876 if (defined($header) and $header eq $test{'data'}) {
882 $header = "REMOVAL" unless defined $header;
883 l(LL_VERBOSE_FAILURE,
884 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
887 } elsif ($expect_header eq 'REMOVAL') {
889 if (defined($header) and $header eq $test{'data'}) {
891 l(LL_VERBOSE_FAILURE,
892 "Ooops. Expected removal but: '" . $header . "' is still there.");
896 # XXX: Use more reliable check here and make sure
897 # the header has a different name.
901 } elsif ($expect_header eq 'SOME CHANGE') {
903 if (defined($header) and not $header eq $test{'data'}) {
909 $header = "REMOVAL" unless defined $header;
910 l(LL_VERBOSE_FAILURE,
911 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
916 if (defined($header) and $header eq $expect_header) {
922 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
923 l(LL_VERBOSE_FAILURE,
924 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
930 sub get_header_name ($) {
934 $header =~ s@(.*?: ).*@$1@;
939 sub get_header ($$) {
941 our $filtered_request = '';
943 my $buffer_ref = shift;
944 my $test_ref = shift;
946 my %test = %{$test_ref};
947 my @buffer = @{$buffer_ref};
949 my $expect_header = $test{'expect-header'};
951 die "get_header called with no expect header" unless defined $expect_header;
954 my $processed_request_reached = 0;
956 my $processed_request = '';
960 if ($expect_header eq 'REMOVAL'
961 or $expect_header eq 'NO CHANGE'
962 or $expect_header eq 'SOME CHANGE') {
964 $expect_header = $test{'data'};
967 $header_to_get = get_header_name($expect_header);
971 # Skip everything before the Processed request
972 if (/Processed Request/) {
973 $processed_request_reached = 1;
976 next unless $processed_request_reached;
978 # End loop after the Processed request
981 # Ditch tags and leading/trailing white space.
985 # Decode characters we care about.
988 $filtered_request .= "\n" . $_;
990 if (/^$header_to_get/) {
1000 sub get_server_header ($$) {
1002 my $buffer_ref = shift;
1003 my $test_ref = shift;
1005 my %test = %{$test_ref};
1006 my @buffer = @{$buffer_ref};
1008 my $expect_header = $test{'expect-header'};
1012 # XXX: Should be caught before starting to test.
1013 l(LL_ERROR, "No expect header for test " . $test{'number'})
1014 unless defined $expect_header;
1016 if ($expect_header eq 'REMOVAL'
1017 or $expect_header eq 'NO CHANGE'
1018 or $expect_header eq 'SOME CHANGE') {
1020 $expect_header = $test{'data'};
1023 $header_to_get = get_header_name($expect_header);
1027 # XXX: should probably verify that the request
1028 # was actually answered by Fellatio.
1029 if (/^$header_to_get/) {
1031 $header =~ s@\s*$@@g;
1039 sub get_status_code ($) {
1041 my $buffer_ref = shift;
1042 my @buffer = @{$buffer_ref};
1046 if (/^HTTP\/\d\.\d (\d{3})/) {
1052 return '123' if cli_option_is_set('fuzzer-feeding');
1054 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1059 sub get_test_keys () {
1060 return ('tag', 'data', 'expect-header', 'ignore');
1064 sub test_content_as_string ($) {
1066 my $test_ref = shift;
1067 my %test = %{$test_ref};
1071 foreach my $key (get_test_keys()) {
1072 $test{$key} = 'Not set' unless (defined $test{$key});
1075 $s .= 'Tag: ' . $test{'tag'};
1077 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1079 $s .= 'Expected header: ' . $test{'expect-header'};
1081 $s .= 'Ignore: ' . $test{'ignore'};
1086 sub fuzz_header($) {
1088 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1090 $white_space = $white_space x (1 + int(rand(5)));
1092 # Only fuzz white space before the first quoted token.
1093 # (Privoxy doesn't touch white space inside quoted tokens
1094 # and modifying it would cause the tests to fail).
1095 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1100 ############################################################################
1102 # HTTP fetch functions
1104 ############################################################################
1106 sub check_for_curl () {
1108 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1111 sub get_cgi_page_or_else ($) {
1113 my $cgi_url = shift;
1114 my $content_ref = get_page_with_curl($cgi_url);
1115 my $status_code = get_status_code($content_ref);
1117 if (200 != $status_code) {
1119 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1120 "Received status code ". $status_code .
1121 " while only 200 is acceptable.";
1123 if (cli_option_is_set('fuzzer-feeding')) {
1125 $log_message .= " Ignored due to fuzzer feeding.";
1126 l(LL_SOFT_ERROR, $log_message)
1130 l(LL_ERROR, $log_message);
1134 return $content_ref;
1137 # XXX: misleading name
1138 sub get_show_request_with_curl ($) {
1140 our $privoxy_cgi_url;
1141 my $test_ref = shift;
1142 my %test = %{$test_ref};
1144 my $curl_parameters = ' ';
1145 my $header = $test{'data'};
1147 if (cli_option_is_set('header-fuzzing')) {
1148 $header = fuzz_header($header);
1151 # Enable the action to test
1152 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1153 # The header to filter
1154 $curl_parameters .= '-H \'' . $header . '\' ';
1156 $curl_parameters .= ' ';
1157 $curl_parameters .= $privoxy_cgi_url;
1158 $curl_parameters .= 'show-request';
1160 return get_cgi_page_or_else($curl_parameters);
1163 sub get_head_with_curl ($) {
1165 our $fellatio_url = FELLATIO_URL;
1166 my $test_ref = shift;
1167 my %test = %{$test_ref};
1169 my $curl_parameters = ' ';
1171 # Enable the action to test
1172 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1173 # The header to filter
1174 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1175 $curl_parameters .= '--head ';
1177 $curl_parameters .= ' ';
1178 $curl_parameters .= $fellatio_url;
1180 return get_page_with_curl($curl_parameters);
1183 sub get_page_with_curl ($) {
1187 my $parameters = shift;
1189 my $curl_line = CURL;
1190 my $retries_left = get_cli_option('retries') + 1;
1193 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1195 # We want to see the HTTP status code
1196 $curl_line .= " --include ";
1197 # Let Privoxy emit two log messages less.
1198 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1199 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1200 # We don't care about fetch statistic.
1201 $curl_line .= " -s ";
1202 # We do care about the failure reason if any.
1203 $curl_line .= " -S ";
1204 # We want to advertise ourselves
1205 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1206 # We aren't too patient
1207 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1209 $curl_line .= $parameters;
1210 # XXX: still necessary?
1211 $curl_line .= ' 2>&1';
1213 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1216 @buffer = `$curl_line`;
1219 $failure_reason = array_as_string(\@buffer);
1220 chomp $failure_reason;
1221 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1223 } while ($? && --$retries_left);
1225 unless ($retries_left) {
1227 "Running curl failed " . get_cli_option('retries') .
1228 " times in a row. Last error: '" . $failure_reason . "'.");
1235 ############################################################################
1239 ############################################################################
1241 sub array_as_string ($) {
1242 my $array_ref = shift;
1245 foreach (@{$array_ref}) {
1253 my $test_ref = shift;
1254 log_message('Test is:' . test_content_as_string($test_ref));
1260 my $this_level = shift;
1261 my $message = shift;
1263 return unless ($log_level & $this_level);
1265 if (LL_ERROR & $this_level) {
1266 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1269 log_message($message);
1271 if (LL_ERROR & $this_level) {
1276 sub log_message ($) {
1278 my $message = shift;
1282 our $leading_log_date;
1283 our $leading_log_time;
1285 my $time_stamp = '';
1286 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1288 if ($leading_log_date || $leading_log_time) {
1290 if ($leading_log_date) {
1293 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1296 if ($leading_log_time) {
1297 $time_stamp .= ' ' if $leading_log_date;
1298 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1301 $message = $time_stamp . ": " . $message;
1304 printf(STDERR "%s\n", $message);
1307 sub log_result ($$) {
1309 our $verbose_test_description;
1310 our $filtered_request;
1312 my $test_ref = shift;
1316 my %test = %{$test_ref};
1319 $message .= interpret_result($result);
1320 $message .= " for test ";
1321 $message .= $number;
1323 $message .= $test{'number'};
1325 $message .= $test{'section-id'};
1327 $message .= $test{'regression-test-id'};
1330 if ($verbose_test_description) {
1332 if ($test{'type'} == CLIENT_HEADER_TEST) {
1334 $message .= ' Header ';
1335 $message .= quote($test{'data'});
1336 $message .= ' and tag ';
1337 $message .= quote($test{'tag'});
1339 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1341 $message .= ' Request Header ';
1342 $message .= quote($test{'data'});
1343 $message .= ' and tag ';
1344 $message .= quote($test{'tag'});
1346 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1348 $message .= ' URL ';
1349 $message .= quote($test{'data'});
1350 $message .= ' and expected status code ';
1351 $message .= quote($test{'expected-status-code'});
1353 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1355 $message .= ' CGI URL ';
1356 $message .= quote($test{'data'});
1357 $message .= ' and expected status code ';
1358 $message .= quote($test{'expected-status-code'});
1360 } elsif ($test{'type'} == METHOD_TEST) {
1362 $message .= ' HTTP method ';
1363 $message .= quote($test{'data'});
1364 $message .= ' and expected status code ';
1365 $message .= quote($test{'expected-status-code'});
1367 } elsif ($test{'type'} == BLOCK_TEST) {
1369 $message .= ' Supposedly-blocked URL: ';
1370 $message .= quote($test{'data'});
1372 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1374 $message .= ' Sticky Actions: ';
1375 $message .= quote($test{'sticky-actions'});
1376 $message .= ' and URL: ';
1377 $message .= quote($test{'data'});
1381 die "Incomplete support for test type " . $test{'type'} . " detected.";
1385 log_message($message) if (!$result or cli_option_is_set('verbose'));
1390 return '\'' . $s . '\'';
1393 sub print_version () {
1394 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1405 Options and their default values if they have any:
1406 [--debug $cli_options{'debug'}]
1407 [--forks $cli_options{'forks'}]
1413 [--loops $cli_options{'loops'}]
1414 [--max-level $cli_options{'max-level'}]
1415 [--max-time $cli_options{'max-time'}]
1416 [--min-level $cli_options{'min-level'}]
1418 [--retries $cli_options{'retries'}]
1419 [--show-skipped-tests]
1423 see "perldoc $0" for more information
1429 sub init_cli_options () {
1434 $cli_options{'debug'} = $log_level;
1435 $cli_options{'forks'} = CLI_FORKS;
1436 $cli_options{'loops'} = CLI_LOOPS;
1437 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1438 $cli_options{'max-time'} = CLI_MAX_TIME;
1439 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1440 $cli_options{'retries'} = CLI_RETRIES;
1443 sub parse_cli_options () {
1451 'debug=s' => \$cli_options{'debug'},
1452 'forks=s' => \$cli_options{'forks'},
1453 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1454 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1455 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1456 'help' => sub {help},
1457 'level=s' => \$cli_options{'level'},
1458 'loops=s' => \$cli_options{'loops'},
1459 'max-level=s' => \$cli_options{'max-level'},
1460 'max-time=s' => \$cli_options{'max-time'},
1461 'min-level=s' => \$cli_options{'min-level'},
1462 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1463 'retries=s' => \$cli_options{'retries'},
1464 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1465 'test-number=s' => \$cli_options{'test-number'},
1466 'verbose' => \$cli_options{'verbose'},
1467 'version' => sub {print_version && exit(0)}
1469 $log_level |= $cli_options{'debug'};
1472 sub cli_option_is_set ($) {
1475 my $cli_option = shift;
1477 return defined $cli_options{$cli_option};
1480 sub get_cli_option ($) {
1483 my $cli_option = shift;
1485 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1487 return $cli_options{$cli_option};
1490 sub init_proxy_settings($) {
1495 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1496 $proxy = get_cli_option('fuzzer-address');
1499 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1501 if (cli_option_is_set('privoxy-address')) {
1502 $proxy .= get_cli_option('privoxy-address');
1507 sub start_forks($) {
1510 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1512 foreach my $fork (1 .. $forks) {
1513 log_message("Starting fork $fork");
1515 if (defined $pid && !$pid) {
1523 init_our_variables();
1524 parse_cli_options();
1526 init_proxy_settings('vanilla-proxy');
1527 load_regressions_tests();
1528 init_proxy_settings('fuzz-proxy');
1529 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1530 execute_regression_tests();
1537 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1541 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1542 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1543 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1544 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1545 [B<--retries retries>] [B<--test-number test-number>]
1546 [B<--show-skipped-tests>] [B<--verbose>]
1551 Privoxy-Regression-Test is supposed to one day become
1552 a regression test suite for Privoxy. It's not quite there
1553 yet, however, and can currently only test header actions,
1554 check the returned status code for requests to arbitrary
1555 URLs and verify which actions are applied to them.
1557 Client header actions are tested by requesting
1558 B<http://p.p/show-request> and checking whether
1559 or not Privoxy modified the original request as expected.
1561 The original request contains both the header the action-to-be-tested
1562 acts upon and an additional tagger-triggering header that enables
1565 Applied actions are checked through B<http://p.p/show-url-info>.
1567 =head1 CONFIGURATION FILE SYNTAX
1569 Privoxy-Regression-Test's configuration is embedded in
1570 Privoxy action files and loaded through Privoxy's web interface.
1572 It makes testing a Privoxy version running on a remote system easier
1573 and should prevent you from updating your tests without updating Privoxy's
1574 configuration accordingly.
1576 A client-header-action test section looks like this:
1578 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1579 # Expect Header = Referer: http://www.example.org/
1580 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1581 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1583 The example above causes Privoxy-Regression-Test to set
1584 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1585 and to expect it to be modified to
1586 B<Referer: http://www.example.org/>.
1588 When testing this section, Privoxy-Regression-Test will set the header
1589 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1590 causing the B<privoxy-control> tagger to create the tag
1591 B<client-header-filter{hide-tor-exit-notation}> which will finally
1592 cause Privoxy to enable the action section.
1594 Note that the actions itself are only used by Privoxy,
1595 Privoxy-Regression-Test ignores them and will be happy
1596 as long as the expectations are satisfied.
1598 A fetch test looks like this:
1600 # Fetch Test = http://p.p/user-manual
1601 # Expect Status Code = 302
1603 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1604 and to expect a response with the HTTP status code B<302>. Obviously that's
1605 not a very thorough test and mainly useful to get some code coverage
1606 for Valgrind or to verify that the templates are installed correctly.
1608 If you want to test CGI pages that require a trusted
1609 referer, you can use:
1611 # Trusted CGI Request = http://p.p/edit-actions
1613 It works like ordinary fetch tests, but sets the referer
1614 header to a trusted value.
1616 If no explicit status code expectation is set, B<200> is used.
1618 To verify that a URL is blocked, use:
1620 # Blocked URL = http://www.example.com/blocked
1622 To verify that a specific set of actions is applied to an URL, use:
1624 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1625 # URL = http://www.example.org/my-first-url
1627 The sticky actions will be checked for all URLs below it
1628 until the next sticky actions directive.
1632 All tests have test levels to let the user
1633 control which ones to execute (see I<OPTIONS> below).
1634 Test levels are either set with the B<Level> directive,
1635 or implicitly through the test type.
1637 Block tests default to level 7, fetch tests to level 6,
1638 "Sticky Actions" tests default to level 5, tests for trusted CGI
1639 requests to level 3 and client-header-action tests to level 1.
1643 B<--debug bitmask> Add the bitmask provided as integer
1644 to the debug settings.
1646 B<--forks forks> Number of forks to start before executing
1647 the regression tests. This is mainly useful for stress-testing.
1649 B<--fuzzer-address> Listening address used when executing
1650 the regression tests. Useful to make sure that the requests
1651 to load the regression tests don't fail due to fuzzing.
1653 B<--fuzzer-feeding> Ignore some errors that would otherwise
1654 cause Privoxy-Regression-Test to abort the test because
1655 they shouldn't happen in normal operation. This option is
1656 intended to be used if Privoxy-Regression-Test is only
1657 used to feed a fuzzer in which case there's a high chance
1658 that Privoxy gets an invalid request and returns an error
1661 B<--help> Shows available command line options.
1663 B<--header-fuzzing> Modifies linear white space in
1664 headers in a way that should not affect the test result.
1666 B<--level level> Only execute tests with the specified B<level>.
1668 B<--loop count> Loop through the regression tests B<count> times.
1669 Useful to feed a fuzzer, or when doing stress tests with
1670 several Privoxy-Regression-Test instances running at the same
1673 B<--max-level max-level> Only execute tests with a B<level>
1674 below or equal to the numerical B<max-level>.
1676 B<--max-time max-time> Give Privoxy B<max-time> seconds
1677 to return data. Increasing the default may make sense when
1678 Privoxy is run through Valgrind, decreasing the default may
1679 make sense when Privoxy-Regression-Test is used to feed
1682 B<--min-level min-level> Only execute tests with a B<level>
1683 above or equal to the numerical B<min-level>.
1685 B<--privoxy-address proxy-address> Privoxy's listening address.
1686 If it's not set, the value of the environment variable http_proxy
1687 will be used. B<proxy-address> has to be specified in http_proxy
1690 B<--retries retries> Retry B<retries> times.
1692 B<--test-number test-number> Only run the test with the specified
1695 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1697 B<--verbose> Log succesful tests as well. By default only
1698 the failures are logged.
1700 B<--version> Print version and exit.
1702 The second dash is optional, options can be shortened,
1703 as long as there are no ambiguities.
1705 =head1 PRIVOXY CONFIGURATION
1707 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1708 which aims to test all official client-header modifying actions
1709 and can be used to verify that the templates and the user manual
1710 files are installed correctly.
1712 To use it, it has to be copied in Privoxy's configuration
1713 directory, and afterwards referenced in Privoxy's configuration
1716 actionsfile regression-tests.action
1718 In general, its tests are supposed to work without changing
1719 any other action files, unless you already added lots of
1720 taggers yourself. If you are using taggers that cause problems,
1721 you might have to temporary disable them for Privoxy's CGI pages.
1723 Some of the regression tests rely on Privoxy features that
1724 may be disabled in your configuration. Tests with a level below
1725 7 are supposed to work with all Privoxy configurations (provided
1726 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1728 Tests with level 9 require Privoxy to deliver the User Manual,
1729 tests with level 12 require the CGI editor to be enabled.
1733 Expect the configuration file syntax to change with future releases.
1737 As Privoxy's B<show-request> page only shows client headers,
1738 Privoxy-Regression-Test can't use it to test Privoxy actions
1739 that modify server headers.
1741 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1742 control the actions to test, it currently only works with
1743 Privoxy 3.0.7 or later.
1745 At the moment Privoxy-Regression-Test fetches Privoxy's
1746 configuration page through I<curl>(1), therefore you have to
1747 have I<curl> installed, otherwise you won't be able to run
1748 Privoxy-Regression-Test in a meaningful way.
1756 Fabian Keil <fk@fabiankeil.de>