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 fk $
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 # XXX: somewhat misleading name
629 sub execute_regression_test ($) {
631 my $test_ref = shift;
632 my %test = %{$test_ref};
635 if ($test{'type'} == CLIENT_HEADER_TEST) {
637 $result = execute_client_header_regression_test($test_ref);
639 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
641 $result = execute_server_header_regression_test($test_ref);
643 } elsif ($test{'type'} == DUMB_FETCH_TEST
644 or $test{'type'} == TRUSTED_CGI_REQUEST) {
646 $result = execute_dumb_fetch_test($test_ref);
648 } elsif ($test{'type'} == METHOD_TEST) {
650 $result = execute_method_test($test_ref);
652 } elsif ($test{'type'} == BLOCK_TEST) {
654 $result = execute_block_test($test_ref);
656 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
658 $result = execute_sticky_actions_test($test_ref);
662 die "Unsupported test type detected: " . $test{'type'};
668 sub execute_method_test ($) {
670 my $test_ref = shift;
671 my %test = %{$test_ref};
674 my $method = $test{'data'};
676 my $curl_parameters = '';
677 my $expected_status_code = $test{'expected-status-code'};
679 $curl_parameters .= '--request ' . $method . ' ';
680 # Don't complain about the 'missing' body
681 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
683 $curl_parameters .= PRIVOXY_CGI_URL;
685 $buffer_ref = get_page_with_curl($curl_parameters);
686 $status_code = get_status_code($buffer_ref);
688 return check_status_code_result($status_code, $expected_status_code);
691 sub execute_dumb_fetch_test ($) {
693 my $test_ref = shift;
694 my %test = %{$test_ref};
698 my $curl_parameters = '';
699 my $expected_status_code = $test{'expected-status-code'};
701 if (defined $test{method}) {
702 $curl_parameters .= '--request ' . $test{method} . ' ';
704 if ($test{type} == TRUSTED_CGI_REQUEST) {
705 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
708 $curl_parameters .= $test{'data'};
710 $buffer_ref = get_page_with_curl($curl_parameters);
711 $status_code = get_status_code($buffer_ref);
713 return check_status_code_result($status_code, $expected_status_code);
716 sub execute_block_test ($) {
719 my $url = $test->{'data'};
720 my $final_results = get_final_results($url);
722 return defined $final_results->{'+block'};
725 sub execute_sticky_actions_test ($) {
728 my $url = $test->{'data'};
729 my $verified_actions = 0;
730 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
731 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
732 my $final_results = get_final_results($url);
734 foreach my $sticky_action (@sticky_actions) {
736 if (defined $final_results->{$sticky_action}) {
740 } elsif ($sticky_action =~ /-.*\{/) {
742 # Disabled multi actions aren't explicitly listed as
743 # disabled and thus have to be checked by verifying
744 # that they aren't enabled.
748 l(LL_VERBOSE_FAILURE,
749 "Ooops. '$sticky_action' is not among the final results.");
753 return $verified_actions == @sticky_actions;
756 sub get_final_results ($) {
759 my $curl_parameters = '';
760 my %final_results = ();
761 my $final_results_reached = 0;
763 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
764 # XXX: should be URL-encoded properly
771 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
773 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
775 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
777 next unless ($final_results_reached);
780 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
784 if (defined $parameter) {
785 # In case the caller needs to check
786 # the action and its parameter
787 $final_results{$action . $parameter} = 1;
789 # In case the action doesn't have parameters
790 # or the caller doesn't care for the parameter.
791 $final_results{$action} = 1;
795 return \%final_results;
798 sub check_status_code_result ($$) {
800 my $status_code = shift;
801 my $expected_status_code = shift;
804 unless (defined $status_code) {
806 # XXX: should probably be caught earlier.
807 l(LL_VERBOSE_FAILURE,
808 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
810 } elsif ($expected_status_code == $status_code) {
813 l(LL_VERBOSE_SUCCESS,
814 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
816 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
818 l(LL_VERBOSE_FAILURE,
819 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
823 l(LL_VERBOSE_FAILURE,
824 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
830 sub execute_client_header_regression_test ($) {
832 my $test_ref = shift;
836 $buffer_ref = get_show_request_with_curl($test_ref);
838 $header = get_header($buffer_ref, $test_ref);
840 return check_header_result($test_ref, $header);
843 sub execute_server_header_regression_test ($) {
845 my $test_ref = shift;
849 $buffer_ref = get_head_with_curl($test_ref);
851 $header = get_server_header($buffer_ref, $test_ref);
853 return check_header_result($test_ref, $header);
856 sub interpret_result ($) {
858 return $success ? "Success" : "Failure";
861 sub check_header_result ($$) {
863 my $test_ref = shift;
866 my %test = %{$test_ref};
867 my $expect_header = $test{'expect-header'};
870 if ($expect_header eq 'NO CHANGE') {
872 if (defined($header) and $header eq $test{'data'}) {
878 $header = "REMOVAL" unless defined $header;
879 l(LL_VERBOSE_FAILURE,
880 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
883 } elsif ($expect_header eq 'REMOVAL') {
885 if (defined($header) and $header eq $test{'data'}) {
887 l(LL_VERBOSE_FAILURE,
888 "Ooops. Expected removal but: '" . $header . "' is still there.");
892 # XXX: Use more reliable check here and make sure
893 # the header has a different name.
897 } elsif ($expect_header eq 'SOME CHANGE') {
899 if (defined($header) and not $header eq $test{'data'}) {
905 $header = "REMOVAL" unless defined $header;
906 l(LL_VERBOSE_FAILURE,
907 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
912 if (defined($header) and $header eq $expect_header) {
918 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
919 l(LL_VERBOSE_FAILURE,
920 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
926 sub get_header_name ($) {
930 $header =~ s@(.*?: ).*@$1@;
935 sub get_header ($$) {
937 our $filtered_request = '';
939 my $buffer_ref = shift;
940 my $test_ref = shift;
942 my %test = %{$test_ref};
943 my @buffer = @{$buffer_ref};
945 my $expect_header = $test{'expect-header'};
947 die "get_header called with no expect header" unless defined $expect_header;
950 my $processed_request_reached = 0;
952 my $processed_request = '';
956 if ($expect_header eq 'REMOVAL'
957 or $expect_header eq 'NO CHANGE'
958 or $expect_header eq 'SOME CHANGE') {
960 $expect_header = $test{'data'};
963 $header_to_get = get_header_name($expect_header);
967 # Skip everything before the Processed request
968 if (/Processed Request/) {
969 $processed_request_reached = 1;
972 next unless $processed_request_reached;
974 # End loop after the Processed request
977 # Ditch tags and leading/trailing white space.
981 # Decode characters we care about.
984 $filtered_request .= "\n" . $_;
986 if (/^$header_to_get/) {
996 sub get_server_header ($$) {
998 my $buffer_ref = shift;
999 my $test_ref = shift;
1001 my %test = %{$test_ref};
1002 my @buffer = @{$buffer_ref};
1004 my $expect_header = $test{'expect-header'};
1008 # XXX: Should be caught before starting to test.
1009 l(LL_ERROR, "No expect header for test " . $test{'number'})
1010 unless defined $expect_header;
1012 if ($expect_header eq 'REMOVAL'
1013 or $expect_header eq 'NO CHANGE'
1014 or $expect_header eq 'SOME CHANGE') {
1016 $expect_header = $test{'data'};
1019 $header_to_get = get_header_name($expect_header);
1023 # XXX: should probably verify that the request
1024 # was actually answered by Fellatio.
1025 if (/^$header_to_get/) {
1027 $header =~ s@\s*$@@g;
1035 sub get_status_code ($) {
1037 my $buffer_ref = shift;
1038 my @buffer = @{$buffer_ref};
1042 if (/^HTTP\/\d\.\d (\d{3})/) {
1048 return '123' if cli_option_is_set('fuzzer-feeding');
1050 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1055 sub get_test_keys () {
1056 return ('tag', 'data', 'expect-header', 'ignore');
1060 sub test_content_as_string ($) {
1062 my $test_ref = shift;
1063 my %test = %{$test_ref};
1067 foreach my $key (get_test_keys()) {
1068 $test{$key} = 'Not set' unless (defined $test{$key});
1071 $s .= 'Tag: ' . $test{'tag'};
1073 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1075 $s .= 'Expected header: ' . $test{'expect-header'};
1077 $s .= 'Ignore: ' . $test{'ignore'};
1082 sub fuzz_header($) {
1084 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1086 $white_space = $white_space x (1 + int(rand(5)));
1088 # Only fuzz white space before the first quoted token.
1089 # (Privoxy doesn't touch white space inside quoted tokens
1090 # and modifying it would cause the tests to fail).
1091 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1096 ############################################################################
1098 # HTTP fetch functions
1100 ############################################################################
1102 sub check_for_curl () {
1104 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1107 sub get_cgi_page_or_else ($) {
1109 my $cgi_url = shift;
1110 my $content_ref = get_page_with_curl($cgi_url);
1111 my $status_code = get_status_code($content_ref);
1113 if (200 != $status_code) {
1115 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1116 "Received status code ". $status_code .
1117 " while only 200 is acceptable.";
1119 if (cli_option_is_set('fuzzer-feeding')) {
1121 $log_message .= " Ignored due to fuzzer feeding.";
1122 l(LL_SOFT_ERROR, $log_message)
1126 l(LL_ERROR, $log_message);
1130 return $content_ref;
1133 # XXX: misleading name
1134 sub get_show_request_with_curl ($) {
1136 our $privoxy_cgi_url;
1137 my $test_ref = shift;
1138 my %test = %{$test_ref};
1140 my $curl_parameters = ' ';
1141 my $header = $test{'data'};
1143 if (cli_option_is_set('header-fuzzing')) {
1144 $header = fuzz_header($header);
1147 # Enable the action to test
1148 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1149 # The header to filter
1150 $curl_parameters .= '-H \'' . $header . '\' ';
1152 $curl_parameters .= ' ';
1153 $curl_parameters .= $privoxy_cgi_url;
1154 $curl_parameters .= 'show-request';
1156 return get_cgi_page_or_else($curl_parameters);
1159 sub get_head_with_curl ($) {
1161 our $fellatio_url = FELLATIO_URL;
1162 my $test_ref = shift;
1163 my %test = %{$test_ref};
1165 my $curl_parameters = ' ';
1167 # Enable the action to test
1168 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1169 # The header to filter
1170 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1171 $curl_parameters .= '--head ';
1173 $curl_parameters .= ' ';
1174 $curl_parameters .= $fellatio_url;
1176 return get_page_with_curl($curl_parameters);
1179 sub get_page_with_curl ($) {
1183 my $parameters = shift;
1185 my $curl_line = CURL;
1186 my $retries_left = get_cli_option('retries') + 1;
1189 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1191 # We want to see the HTTP status code
1192 $curl_line .= " --include ";
1193 # Let Privoxy emit two log messages less.
1194 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1195 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1196 # We don't care about fetch statistic.
1197 $curl_line .= " -s ";
1198 # We do care about the failure reason if any.
1199 $curl_line .= " -S ";
1200 # We want to advertise ourselves
1201 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1202 # We aren't too patient
1203 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1205 $curl_line .= $parameters;
1206 # XXX: still necessary?
1207 $curl_line .= ' 2>&1';
1209 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1212 @buffer = `$curl_line`;
1215 $failure_reason = array_as_string(\@buffer);
1216 chomp $failure_reason;
1217 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1219 } while ($? && --$retries_left);
1221 unless ($retries_left) {
1223 "Running curl failed " . get_cli_option('retries') .
1224 " times in a row. Last error: '" . $failure_reason . "'.");
1231 ############################################################################
1235 ############################################################################
1237 sub array_as_string ($) {
1238 my $array_ref = shift;
1241 foreach (@{$array_ref}) {
1249 my $test_ref = shift;
1250 log_message('Test is:' . test_content_as_string($test_ref));
1256 my $this_level = shift;
1257 my $message = shift;
1259 return unless ($log_level & $this_level);
1261 if (LL_ERROR & $this_level) {
1262 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1265 log_message($message);
1267 if (LL_ERROR & $this_level) {
1272 sub log_message ($) {
1274 my $message = shift;
1278 our $leading_log_date;
1279 our $leading_log_time;
1281 my $time_stamp = '';
1282 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1284 if ($leading_log_date || $leading_log_time) {
1286 if ($leading_log_date) {
1289 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1292 if ($leading_log_time) {
1293 $time_stamp .= ' ' if $leading_log_date;
1294 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1297 $message = $time_stamp . ": " . $message;
1300 printf(STDERR "%s\n", $message);
1303 sub log_result ($$) {
1305 our $verbose_test_description;
1306 our $filtered_request;
1308 my $test_ref = shift;
1312 my %test = %{$test_ref};
1315 $message .= interpret_result($result);
1316 $message .= " for test ";
1317 $message .= $number;
1319 $message .= $test{'number'};
1321 $message .= $test{'section-id'};
1323 $message .= $test{'regression-test-id'};
1326 if ($verbose_test_description) {
1328 if ($test{'type'} == CLIENT_HEADER_TEST) {
1330 $message .= ' Header ';
1331 $message .= quote($test{'data'});
1332 $message .= ' and tag ';
1333 $message .= quote($test{'tag'});
1335 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1337 $message .= ' Request Header ';
1338 $message .= quote($test{'data'});
1339 $message .= ' and tag ';
1340 $message .= quote($test{'tag'});
1342 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1344 $message .= ' URL ';
1345 $message .= quote($test{'data'});
1346 $message .= ' and expected status code ';
1347 $message .= quote($test{'expected-status-code'});
1349 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1351 $message .= ' CGI URL ';
1352 $message .= quote($test{'data'});
1353 $message .= ' and expected status code ';
1354 $message .= quote($test{'expected-status-code'});
1356 } elsif ($test{'type'} == METHOD_TEST) {
1358 $message .= ' HTTP method ';
1359 $message .= quote($test{'data'});
1360 $message .= ' and expected status code ';
1361 $message .= quote($test{'expected-status-code'});
1363 } elsif ($test{'type'} == BLOCK_TEST) {
1365 $message .= ' Supposedly-blocked URL: ';
1366 $message .= quote($test{'data'});
1368 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1370 $message .= ' Sticky Actions: ';
1371 $message .= quote($test{'sticky-actions'});
1372 $message .= ' and URL: ';
1373 $message .= quote($test{'data'});
1377 die "Incomplete support for test type " . $test{'type'} . " detected.";
1381 log_message($message) if (!$result or cli_option_is_set('verbose'));
1386 return '\'' . $s . '\'';
1389 sub print_version () {
1390 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1401 Options and their default values if they have any:
1402 [--debug $cli_options{'debug'}]
1403 [--forks $cli_options{'forks'}]
1409 [--loops $cli_options{'loops'}]
1410 [--max-level $cli_options{'max-level'}]
1411 [--max-time $cli_options{'max-time'}]
1412 [--min-level $cli_options{'min-level'}]
1414 [--retries $cli_options{'retries'}]
1415 [--show-skipped-tests]
1419 see "perldoc $0" for more information
1425 sub init_cli_options () {
1430 $cli_options{'debug'} = $log_level;
1431 $cli_options{'forks'} = CLI_FORKS;
1432 $cli_options{'loops'} = CLI_LOOPS;
1433 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1434 $cli_options{'max-time'} = CLI_MAX_TIME;
1435 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1436 $cli_options{'retries'} = CLI_RETRIES;
1439 sub parse_cli_options () {
1447 'debug=s' => \$cli_options{'debug'},
1448 'forks=s' => \$cli_options{'forks'},
1449 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1450 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1451 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1452 'help' => sub {help},
1453 'level=s' => \$cli_options{'level'},
1454 'loops=s' => \$cli_options{'loops'},
1455 'max-level=s' => \$cli_options{'max-level'},
1456 'max-time=s' => \$cli_options{'max-time'},
1457 'min-level=s' => \$cli_options{'min-level'},
1458 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1459 'retries=s' => \$cli_options{'retries'},
1460 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1461 'test-number=s' => \$cli_options{'test-number'},
1462 'verbose' => \$cli_options{'verbose'},
1463 'version' => sub {print_version && exit(0)}
1465 $log_level |= $cli_options{'debug'};
1468 sub cli_option_is_set ($) {
1471 my $cli_option = shift;
1473 return defined $cli_options{$cli_option};
1476 sub get_cli_option ($) {
1479 my $cli_option = shift;
1481 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1483 return $cli_options{$cli_option};
1486 sub init_proxy_settings($) {
1491 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1492 $proxy = get_cli_option('fuzzer-address');
1495 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1497 if (cli_option_is_set('privoxy-address')) {
1498 $proxy .= get_cli_option('privoxy-address');
1503 sub start_forks($) {
1506 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1508 foreach my $fork (1 .. $forks) {
1509 log_message("Starting fork $fork");
1511 if (defined $pid && !$pid) {
1519 init_our_variables();
1520 parse_cli_options();
1522 init_proxy_settings('vanilla-proxy');
1523 load_regressions_tests();
1524 init_proxy_settings('fuzz-proxy');
1525 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1526 execute_regression_tests();
1533 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1537 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1538 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1539 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1540 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1541 [B<--retries retries>] [B<--test-number test-number>]
1542 [B<--show-skipped-tests>] [B<--verbose>]
1547 Privoxy-Regression-Test is supposed to one day become
1548 a regression test suite for Privoxy. It's not quite there
1549 yet, however, and can currently only test header actions,
1550 check the returned status code for requests to arbitrary
1551 URLs and verify which actions are applied to them.
1553 Client header actions are tested by requesting
1554 B<http://p.p/show-request> and checking whether
1555 or not Privoxy modified the original request as expected.
1557 The original request contains both the header the action-to-be-tested
1558 acts upon and an additional tagger-triggering header that enables
1561 Applied actions are checked through B<http://p.p/show-url-info>.
1563 =head1 CONFIGURATION FILE SYNTAX
1565 Privoxy-Regression-Test's configuration is embedded in
1566 Privoxy action files and loaded through Privoxy's web interface.
1568 It makes testing a Privoxy version running on a remote system easier
1569 and should prevent you from updating your tests without updating Privoxy's
1570 configuration accordingly.
1572 A client-header-action test section looks like this:
1574 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1575 # Expect Header = Referer: http://www.example.org/
1576 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1577 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1579 The example above causes Privoxy-Regression-Test to set
1580 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1581 and to expect it to be modified to
1582 B<Referer: http://www.example.org/>.
1584 When testing this section, Privoxy-Regression-Test will set the header
1585 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1586 causing the B<privoxy-control> tagger to create the tag
1587 B<client-header-filter{hide-tor-exit-notation}> which will finally
1588 cause Privoxy to enable the action section.
1590 Note that the actions itself are only used by Privoxy,
1591 Privoxy-Regression-Test ignores them and will be happy
1592 as long as the expectations are satisfied.
1594 A fetch test looks like this:
1596 # Fetch Test = http://p.p/user-manual
1597 # Expect Status Code = 302
1599 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1600 and to expect a response with the HTTP status code B<302>. Obviously that's
1601 not a very thorough test and mainly useful to get some code coverage
1602 for Valgrind or to verify that the templates are installed correctly.
1604 If you want to test CGI pages that require a trusted
1605 referer, you can use:
1607 # Trusted CGI Request = http://p.p/edit-actions
1609 It works like ordinary fetch tests, but sets the referer
1610 header to a trusted value.
1612 If no explicit status code expectation is set, B<200> is used.
1614 To verify that a URL is blocked, use:
1616 # Blocked URL = http://www.example.com/blocked
1618 To verify that a specific set of actions is applied to an URL, use:
1620 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1621 # URL = http://www.example.org/my-first-url
1623 The sticky actions will be checked for all URLs below it
1624 until the next sticky actions directive.
1628 All tests have test levels to let the user
1629 control which ones to execute (see I<OPTIONS> below).
1630 Test levels are either set with the B<Level> directive,
1631 or implicitly through the test type.
1633 Block tests default to level 7, fetch tests to level 6,
1634 "Sticky Actions" tests default to level 5, tests for trusted CGI
1635 requests to level 3 and client-header-action tests to level 1.
1639 B<--debug bitmask> Add the bitmask provided as integer
1640 to the debug settings.
1642 B<--forks forks> Number of forks to start before executing
1643 the regression tests. This is mainly useful for stress-testing.
1645 B<--fuzzer-address> Listening address used when executing
1646 the regression tests. Useful to make sure that the requests
1647 to load the regression tests don't fail due to fuzzing.
1649 B<--fuzzer-feeding> Ignore some errors that would otherwise
1650 cause Privoxy-Regression-Test to abort the test because
1651 they shouldn't happen in normal operation. This option is
1652 intended to be used if Privoxy-Regression-Test is only
1653 used to feed a fuzzer in which case there's a high chance
1654 that Privoxy gets an invalid request and returns an error
1657 B<--help> Shows available command line options.
1659 B<--header-fuzzing> Modifies linear white space in
1660 headers in a way that should not affect the test result.
1662 B<--level level> Only execute tests with the specified B<level>.
1664 B<--loop count> Loop through the regression tests B<count> times.
1665 Useful to feed a fuzzer, or when doing stress tests with
1666 several Privoxy-Regression-Test instances running at the same
1669 B<--max-level max-level> Only execute tests with a B<level>
1670 below or equal to the numerical B<max-level>.
1672 B<--max-time max-time> Give Privoxy B<max-time> seconds
1673 to return data. Increasing the default may make sense when
1674 Privoxy is run through Valgrind, decreasing the default may
1675 make sense when Privoxy-Regression-Test is used to feed
1678 B<--min-level min-level> Only execute tests with a B<level>
1679 above or equal to the numerical B<min-level>.
1681 B<--privoxy-address proxy-address> Privoxy's listening address.
1682 If it's not set, the value of the environment variable http_proxy
1683 will be used. B<proxy-address> has to be specified in http_proxy
1686 B<--retries retries> Retry B<retries> times.
1688 B<--test-number test-number> Only run the test with the specified
1691 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1693 B<--verbose> Log succesful tests as well. By default only
1694 the failures are logged.
1696 B<--version> Print version and exit.
1698 The second dash is optional, options can be shortened,
1699 as long as there are no ambiguities.
1701 =head1 PRIVOXY CONFIGURATION
1703 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1704 which aims to test all official client-header modifying actions
1705 and can be used to verify that the templates and the user manual
1706 files are installed correctly.
1708 To use it, it has to be copied in Privoxy's configuration
1709 directory, and afterwards referenced in Privoxy's configuration
1712 actionsfile regression-tests.action
1714 In general, its tests are supposed to work without changing
1715 any other action files, unless you already added lots of
1716 taggers yourself. If you are using taggers that cause problems,
1717 you might have to temporary disable them for Privoxy's CGI pages.
1719 Some of the regression tests rely on Privoxy features that
1720 may be disabled in your configuration. Tests with a level below
1721 7 are supposed to work with all Privoxy configurations (provided
1722 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1724 Tests with level 9 require Privoxy to deliver the User Manual,
1725 tests with level 12 require the CGI editor to be enabled.
1729 Expect the configuration file syntax to change with future releases.
1733 As Privoxy's B<show-request> page only shows client headers,
1734 Privoxy-Regression-Test can't use it to test Privoxy actions
1735 that modify server headers.
1737 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1738 control the actions to test, it currently only works with
1739 Privoxy 3.0.7 or later.
1741 At the moment Privoxy-Regression-Test fetches Privoxy's
1742 configuration page through I<curl>(1), therefore you have to
1743 have I<curl> installed, otherwise you won't be able to run
1744 Privoxy-Regression-Test in a meaningful way.
1752 Fabian Keil <fk@fabiankeil.de>