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.138 2008/03/27 19:06:34 fk Exp $
14 # - Update documentation
15 # - Validate HTTP times.
16 # - Understand default.action.master comment syntax
17 # and verify that we actually block and unblock what
18 # the comments claim we do.
19 # - Implement a HTTP_VERSION directive or allow to
20 # specify whole request lines.
21 # - Support filter regression tests.
22 # - Add option to fork regression tests and run them in parallel,
23 # possibly optional forever.
24 # - Document magic Expect Header values
25 # - Internal fuzz support?
27 # Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
29 # Permission to use, copy, modify, and distribute this software for any
30 # purpose with or without fee is hereby granted, provided that the above
31 # copyright notice and this permission notice appear in all copies.
33 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
34 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
35 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
36 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
37 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
38 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
39 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 ############################################################################
48 PRT_VERSION => 'Privoxy-Regression-Test 0.2',
59 PRIVOXY_CGI_URL => 'http://p.p/',
60 FELLATIO_URL => 'http://10.0.0.1:8080/',
61 LEADING_LOG_DATE => 1,
62 LEADING_LOG_TIME => 1,
64 DEBUG_LEVEL_FILE_LOADING => 0,
65 DEBUG_LEVEL_PAGE_FETCHING => 0,
67 VERBOSE_TEST_DESCRIPTION => 1,
69 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
70 # XXX: Only partly implemented and mostly useless.
71 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
72 DEBUG_LEVEL_STATUS => 1,
74 # Internal use, don't modify
75 # Available debug bits:
77 LL_VERBOSE_FAILURE => 2,
78 LL_PAGE_FETCHING => 4,
80 LL_VERBOSE_SUCCESS => 16,
84 CLIENT_HEADER_TEST => 1,
85 SERVER_HEADER_TEST => 2,
88 STICKY_ACTIONS_TEST => 5,
89 TRUSTED_CGI_REQUEST => 6,
93 sub init_our_variables () {
95 our $leading_log_time = LEADING_LOG_TIME;
96 our $leading_log_date = LEADING_LOG_DATE;
98 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
100 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
102 our $log_level = get_default_log_level();
106 sub get_default_log_level () {
110 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
111 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
112 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
113 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
114 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
116 # These are intended to be always on.
117 $log_level |= LL_SOFT_ERROR;
118 $log_level |= LL_ERROR;
123 ############################################################################
125 # File loading functions
127 ############################################################################
135 # Unescape brackets and dots
136 $tag =~ s@\\(?=[{}().+])@@g;
138 # log_message("Parsed tag: " . $tag);
140 check_for_forbidden_characters($tag);
145 sub check_for_forbidden_characters ($) {
147 my $tag = shift; # XXX: also used to check values though.
148 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
150 unless ($tag =~ m/^$allowed*$/) {
151 my $forbidden = $tag;
152 $forbidden =~ s@^$allowed*(.).*@$1@;
154 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
158 sub load_regressions_tests () {
160 our $privoxy_cgi_url;
166 $curl_url .= $privoxy_cgi_url;
167 $curl_url .= 'show-status';
169 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
171 foreach (@{get_cgi_page_or_else($curl_url)}) {
174 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
176 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
177 $actionfiles[$file_number++] = $url;
179 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
181 my $directive = $1 . " " . $2;
182 push (@privoxy_config, $directive);
186 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
188 load_action_files(\@actionfiles);
191 sub token_starts_new_test ($) {
194 my @new_test_directives = ('set header', 'fetch test',
195 'trusted cgi request', 'request header', 'method test',
196 'blocked url', 'url');
198 foreach my $new_test_directive (@new_test_directives) {
199 return 1 if $new_test_directive eq $token;
207 my ($token, $value) = (undef, undef);
209 # Remove leading and trailing white space.
213 # Reverse HTML-encoding
214 # XXX: Seriously imcomplete.
219 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
224 $token =~ s@\s\s+@ @g;
225 $token =~ tr/[A-Z]/[a-z]/;
227 } elsif (/^TAG\s*:(.*)$/) {
234 return ($token, $value);
237 sub enlist_new_test ($$$$$$) {
239 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
241 if ($token eq 'set header') {
243 l(LL_FILE_LOADING, "Header to set: " . $value);
244 $$regression_tests[$si][$ri]{'type'} = CLIENT_HEADER_TEST;
246 $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST;
248 } elsif ($token eq 'request header') {
250 l(LL_FILE_LOADING, "Header to request: " . $value);
251 $$regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST;
253 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
254 $$regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST;
256 } elsif ($token eq 'trusted cgi request') {
258 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
259 $$regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST;
261 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
262 $$regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST;
264 } elsif ($token eq 'fetch test') {
266 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
267 $$regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST;
269 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
270 $$regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST;
272 } elsif ($token eq 'method test') {
274 l(LL_FILE_LOADING, "Method to test: " . $value);
275 $$regression_tests[$si][$ri]{'type'} = METHOD_TEST;
277 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
278 $$regression_tests[$si][$ri]{'level'} = METHOD_TEST;
280 } elsif ($token eq 'blocked url') {
282 l(LL_FILE_LOADING, "URL to block-test: " . $value);
283 $$regression_tests[$si][$ri]{'type'} = BLOCK_TEST;
285 $$regression_tests[$si][$ri]{'expected-status-code'} = 403;
286 $$regression_tests[$si][$ri]{'level'} = BLOCK_TEST;
288 } elsif ($token eq 'url') {
290 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
291 $$regression_tests[$si][$ri]{'type'} = STICKY_ACTIONS_TEST;
293 $$regression_tests[$si][$ri]{'level'} = STICKY_ACTIONS_TEST;
294 $$regression_tests[$si][$ri]{'url'} = '';
298 die "Incomplete '" . $token . "' support detected.";
302 check_for_forbidden_characters($value);
304 $$regression_tests[$si][$ri]{'data'} = $value;
306 # For function that only get passed single tests
307 $$regression_tests[$si][$ri]{'section-id'} = $si;
308 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
309 $$regression_tests[$si][$ri]{'number'} = $number - 1;
311 "Regression test " . $number . " (section:" . $si . "):");
314 sub load_action_files ($) {
318 our @regression_tests;
320 my $actionfiles_ref = shift;
321 my @actionfiles = @{$actionfiles_ref};
323 my $si = 0; # Section index
324 my $ri = -1; # Regression test index
329 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
331 for my $file_number (0 .. @actionfiles - 1) {
333 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
334 my $actionfile = undef;
335 my $sticky_actions = undef;
337 foreach (@{get_cgi_page_or_else($curl_url)}) {
342 if (/<h2>Contents of Actions File (.*?)</) {
346 next unless defined $actionfile;
350 my ($token, $value) = tokenize($_);
352 next unless defined $token;
354 # Load regression tests
356 if (token_starts_new_test($token)) {
358 # Beginning of new regression test.
361 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
364 if ($token =~ /level\s+(\d+)/i) {
367 register_dependency($level, $value);
370 if ($si == -1 || $ri == -1) {
371 # No beginning of a test detected yet,
372 # so we don't care about any other test
377 if ($token eq 'expect header') {
379 l(LL_FILE_LOADING, "Detected expectation: " . $value);
380 $regression_tests[$si][$ri]{'expect-header'} = $value;
382 } elsif ($token eq 'tag') {
386 my $tag = parse_tag($value);
388 # We already checked in parse_tag() after filtering
391 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
393 # Save tag for all tests in this section
395 $regression_tests[$si][$ri]{'tag'} = $tag;
401 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
403 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
404 $regression_tests[$si][$ri]{'ignore'} = 1;
407 } elsif ($token eq 'expect status code') {
409 l(LL_FILE_LOADING, "Expecting status code: " . $value);
410 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
412 } elsif ($token eq 'level') { # XXX: stupid name
414 $value =~ s@(\d+).*@$1@;
415 l(LL_FILE_LOADING, "Level: " . $value);
416 $regression_tests[$si][$ri]{'level'} = $value;
418 } elsif ($token eq 'method') {
420 l(LL_FILE_LOADING, "Method: " . $value);
421 $regression_tests[$si][$ri]{'method'} = $value;
423 } elsif ($token eq 'sticky actions') {
425 # Will be used by each following Sticky URL.
426 $sticky_actions = $value;
427 if ($sticky_actions =~ /{[^}]*\s/) {
429 "'Sticky Actions' with whitespace inside the " .
430 "action parameters are currently unsupported.");
433 } elsif ($token eq 'url') {
435 if (defined $sticky_actions) {
436 die "What" if defined ($regression_tests[$si][$ri]{'sticky-actions'});
437 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
438 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
440 l(LL_FILE_LOADING, "Sticky URL without Sticky Actions");
445 # We don't use it, so we don't need
449 check_for_forbidden_characters($value) unless $no_checks;
450 check_for_forbidden_characters($token);
454 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
455 . " Of which " . $ignored. " will be ignored)\n");
458 ############################################################################
460 # Regression test executing functions
462 ############################################################################
464 sub execute_regression_tests () {
466 our @regression_tests;
467 my $loops = get_cli_option('loops');
469 my $all_failures = 0;
470 my $all_successes = 0;
472 unless (@regression_tests) {
474 l(LL_STATUS, "No regression tests found.");
478 l(LL_STATUS, "Executing regression tests ...");
480 while ($loops-- > 0) {
487 for my $s (0 .. @regression_tests - 1) {
491 while (defined $regression_tests[$s][$r]) {
493 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
494 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
496 my $number = $regression_tests[$s][$r]{'number'};
498 if ($regression_tests[$s][$r]{'ignore'}
499 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
500 or test_number_is_unacceptable($number)) {
506 my $result = execute_regression_test($regression_tests[$s][$r]);
508 log_result($regression_tests[$s][$r], $result, $tests);
510 $successes += $result;
516 $failures = $tests - $successes;
518 log_message("Executed " . $tests . " regression tests. " .
519 'Skipped ' . $skipped . '. ' .
520 $successes . " successes, " . $failures . " failures.");
522 $all_tests += $tests;
523 $all_failures += $failures;
524 $all_successes += $successes;
528 if (get_cli_option('loops') > 1) {
529 log_message("Total: Executed " . $all_tests . " regression tests. " .
530 $all_successes . " successes, " . $all_failures . " failures.");
534 sub level_is_unacceptable ($) {
536 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
537 or ($level < get_cli_option('min-level'))
538 or ($level > get_cli_option('max-level'))
539 or dependency_unsatisfied($level)
543 sub test_number_is_unacceptable ($) {
544 my $test_number = shift;
545 return (cli_option_is_set('test-number')
546 and get_cli_option('test-number') != $test_number)
549 sub dependency_unsatisfied ($) {
554 my $dependency_problem = 0;
556 if (defined ($dependencies{$level}{'config line'})) {
558 my $dependency = $dependencies{$level}{'config line'};
559 $dependency_problem = 1;
561 foreach (@privoxy_config) {
563 $dependency_problem = 0 if (/$dependency/);
567 return $dependency_problem;
570 sub register_dependency ($$) {
573 my $dependency = shift;
576 if ($dependency =~ /config line\s+(.*)/) {
578 $dependencies{$level}{'config line'} = $1;
582 # XXX: somewhat misleading name
583 sub execute_regression_test ($) {
585 my $test_ref = shift;
586 my %test = %{$test_ref};
589 if ($test{'type'} == CLIENT_HEADER_TEST) {
591 $result = execute_client_header_regression_test($test_ref);
593 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
595 $result = execute_server_header_regression_test($test_ref);
597 } elsif ($test{'type'} == DUMB_FETCH_TEST
598 or $test{'type'} == TRUSTED_CGI_REQUEST) {
600 $result = execute_dumb_fetch_test($test_ref);
602 } elsif ($test{'type'} == METHOD_TEST) {
604 $result = execute_method_test($test_ref);
606 } elsif ($test{'type'} == BLOCK_TEST) {
608 $result = execute_block_test($test_ref);
610 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
612 $result = execute_sticky_actions_test($test_ref);
616 die "Unsupported test type detected: " . $test{'type'};
623 sub execute_method_test ($) {
625 my $test_ref = shift;
626 my %test = %{$test_ref};
629 my $method = $test{'data'};
631 my $curl_parameters = '';
632 my $expected_status_code = $test{'expected-status-code'};
634 $curl_parameters .= '--request ' . $method . ' ';
635 # Don't complain about the 'missing' body
636 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
638 $curl_parameters .= PRIVOXY_CGI_URL;
640 $buffer_ref = get_page_with_curl($curl_parameters);
641 $status_code = get_status_code($buffer_ref);
643 return check_status_code_result($status_code, $expected_status_code);
646 sub execute_dumb_fetch_test ($) {
648 my $test_ref = shift;
649 my %test = %{$test_ref};
653 my $curl_parameters = '';
654 my $expected_status_code = $test{'expected-status-code'};
656 if (defined $test{method}) {
657 $curl_parameters .= '--request ' . $test{method} . ' ';
659 if ($test{type} == TRUSTED_CGI_REQUEST) {
660 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
663 $curl_parameters .= $test{'data'};
665 $buffer_ref = get_page_with_curl($curl_parameters);
666 $status_code = get_status_code($buffer_ref);
668 return check_status_code_result($status_code, $expected_status_code);
671 sub execute_block_test ($) {
674 my $url = $test->{'data'};
675 my $final_results = get_final_results($url);
677 return defined $final_results->{'+block'};
680 sub execute_sticky_actions_test ($) {
683 my $url = $test->{'data'};
684 my $verified_actions = 0;
685 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
686 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
687 my $final_results = get_final_results($url);
689 foreach my $sticky_action (@sticky_actions) {
690 if (defined $final_results->{$sticky_action}) {
693 }elsif ($sticky_action =~ /-.*\{/ and
694 not defined $final_results->{$sticky_action}) {
695 # Disabled multi actions aren't explicitly listed as
696 # disabled and thus have to be checked by verifying
697 # that they aren't enabled.
700 l(LL_VERBOSE_FAILURE,
701 "Ooops. '$sticky_action' is not among the final results.");
705 return $verified_actions == @sticky_actions;
708 sub get_final_results ($) {
711 my $curl_parameters = '';
712 my %final_results = ();
713 my $final_results_reached = 0;
715 die "Unacceptable characterss in $url" if $url =~ m@[\\'"]@;
716 # XXX: should be URL-encoded properly
723 $curl_parameters .= "'" . PRIVOXY_CGI_URL . 'show-url-info?url=' . $url . "'";
725 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
727 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
729 next unless ($final_results_reached);
732 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
736 if (defined $parameter) {
737 # In case the caller needs to check
738 # the action and it's parameter
739 $final_results{$action . $parameter} = 1;
741 # In case the action doesn't have paramters
742 # or the caller doesn't care for the parameter.
743 $final_results{$action} = 1;
747 return \%final_results;
750 sub check_status_code_result ($$) {
752 my $status_code = shift;
753 my $expected_status_code = shift;
756 if ($expected_status_code == $status_code) {
759 l(LL_VERBOSE_SUCCESS,
760 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
762 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
764 l(LL_VERBOSE_FAILURE,
765 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
769 l(LL_VERBOSE_FAILURE,
770 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
777 sub execute_client_header_regression_test ($) {
779 my $test_ref = shift;
783 $buffer_ref = get_show_request_with_curl($test_ref);
785 $header = get_header($buffer_ref, $test_ref);
787 return check_header_result($test_ref, $header);
790 sub execute_server_header_regression_test ($) {
792 my $test_ref = shift;
796 $buffer_ref = get_head_with_curl($test_ref);
798 $header = get_server_header($buffer_ref, $test_ref);
800 return check_header_result($test_ref, $header);
804 sub interpret_result ($) {
806 return $success ? "Success" : "Failure";
809 sub check_header_result ($$) {
811 my $test_ref = shift;
814 my %test = %{$test_ref};
815 my $expect_header = $test{'expect-header'};
818 $header =~ s@ @ @g if defined($header);
820 if ($expect_header eq 'NO CHANGE') {
822 if (defined($header) and $header eq $test{'data'}) {
828 $header = "REMOVAL" unless defined $header;
829 l(LL_VERBOSE_FAILURE,
830 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
833 } elsif ($expect_header eq 'REMOVAL') {
835 if (defined($header) and $header eq $test{'data'}) {
837 l(LL_VERBOSE_FAILURE,
838 "Ooops. Expected removal but: " . $header . " is still there.");
842 # XXX: Use more reliable check here and make sure
843 # the header has a different name.
848 } elsif ($expect_header eq 'SOME CHANGE') {
850 if (defined($header) and not $header eq $test{'data'}) {
856 $header = "REMOVAL" unless defined $header;
857 l(LL_VERBOSE_FAILURE,
858 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
864 if (defined($header) and $header eq $expect_header) {
870 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
871 l(LL_VERBOSE_FAILURE,
872 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
878 sub get_header_name ($) {
882 $header =~ s@(.*?: ).*@$1@;
887 sub get_header ($$) {
889 our $filtered_request = '';
891 my $buffer_ref = shift;
892 my $test_ref = shift;
894 my %test = %{$test_ref};
895 my @buffer = @{$buffer_ref};
897 my $expect_header = $test{'expect-header'};
900 my $processed_request_reached = 0;
902 my $processed_request = '';
906 if ($expect_header eq 'REMOVAL'
907 or $expect_header eq 'NO CHANGE'
908 or $expect_header eq 'SOME CHANGE') {
910 $expect_header = $test{'data'};
914 $header_to_get = get_header_name($expect_header);
918 # Skip everything before the Processed request
919 if (/Processed Request/) {
920 $processed_request_reached = 1;
923 next unless $processed_request_reached;
925 # End loop after the Processed request
928 # Ditch tags and leading/trailing white space.
932 $filtered_request .= "\n" . $_;
934 if (/^$header_to_get/) {
944 sub get_server_header ($$) {
946 my $buffer_ref = shift;
947 my $test_ref = shift;
949 my %test = %{$test_ref};
950 my @buffer = @{$buffer_ref};
952 my $expect_header = $test{'expect-header'};
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'};
964 $header_to_get = get_header_name($expect_header);
968 # XXX: should probably verify that the request
969 # was actually answered by Fellatio.
970 if (/^$header_to_get/) {
972 $header =~ s@\s*$@@g;
980 sub get_status_code ($) {
982 my $buffer_ref = shift;
983 my @buffer = @{$buffer_ref};
987 if (/^HTTP\/\d\.\d (\d{3})/) {
993 return '123' if cli_option_is_set('fuzzer-feeding');
995 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1000 sub get_test_keys () {
1001 return ('tag', 'data', 'expect-header', 'ignore');
1005 sub test_content_as_string ($) {
1007 my $test_ref = shift;
1008 my %test = %{$test_ref};
1012 foreach my $key (get_test_keys()) {
1013 $test{$key} = 'Not set' unless (defined $test{$key});
1016 $s .= 'Tag: ' . $test{'tag'};
1018 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1020 $s .= 'Expected header: ' . $test{'expect-header'};
1022 $s .= 'Ignore: ' . $test{'ignore'};
1027 ############################################################################
1029 # HTTP fetch functions
1031 ############################################################################
1033 sub check_for_curl () {
1035 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1038 sub get_cgi_page_or_else ($) {
1040 my $cgi_url = shift;
1041 my $content_ref = get_page_with_curl($cgi_url);
1042 my $status_code = get_status_code($content_ref);
1044 if (200 != $status_code) {
1046 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1047 "Received status code ". $status_code .
1048 " while only 200 is acceptable.";
1050 if (cli_option_is_set('fuzzer-feeding')) {
1052 $log_message .= " Ignored due to fuzzer feeding.";
1053 l(LL_SOFT_ERROR, $log_message)
1057 l(LL_ERROR, $log_message);
1062 return $content_ref;
1065 sub get_show_request_with_curl ($) {
1067 our $privoxy_cgi_url;
1068 my $test_ref = shift;
1069 my %test = %{$test_ref};
1071 my $curl_parameters = ' ';
1073 # Enable the action to test
1074 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1075 # The header to filter
1076 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1078 $curl_parameters .= ' ';
1079 $curl_parameters .= $privoxy_cgi_url;
1080 $curl_parameters .= 'show-request';
1082 return get_cgi_page_or_else($curl_parameters);
1086 sub get_head_with_curl ($) {
1088 our $fellatio_url = FELLATIO_URL;
1089 my $test_ref = shift;
1090 my %test = %{$test_ref};
1092 my $curl_parameters = ' ';
1094 # Enable the action to test
1095 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1096 # The header to filter
1097 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1098 $curl_parameters .= '--head ';
1100 $curl_parameters .= ' ';
1101 $curl_parameters .= $fellatio_url;
1103 return get_page_with_curl($curl_parameters);
1107 sub get_page_with_curl ($) {
1109 my $parameters = shift;
1111 my $curl_line = CURL;
1112 my $retries_left = get_cli_option('retries') + 1;
1115 if (cli_option_is_set('privoxy-address')) {
1116 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
1119 # We want to see the HTTP status code
1120 $curl_line .= " --include ";
1121 # Let Privoxy emit two log messages less.
1122 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1123 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1124 # We don't care about fetch statistic.
1125 $curl_line .= " -s ";
1126 # We do care about the failure reason if any.
1127 $curl_line .= " -S ";
1128 # We want to advertise ourselves
1129 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1130 # We aren't too patient
1131 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1133 $curl_line .= $parameters;
1134 # XXX: still necessary?
1135 $curl_line .= ' 2>&1';
1137 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1140 @buffer = `$curl_line`;
1143 $failure_reason = array_as_string(\@buffer);
1144 chomp $failure_reason;
1145 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1147 } while ($? && --$retries_left);
1149 unless ($retries_left) {
1151 "Running curl failed " . get_cli_option('retries') .
1152 " times in a row. Last error: '" . $failure_reason . "'.");
1159 ############################################################################
1163 ############################################################################
1165 sub array_as_string ($) {
1166 my $array_ref = shift;
1169 foreach (@{$array_ref}) {
1178 my $test_ref = shift;
1179 log_message('Test is:' . test_content_as_string($test_ref));
1185 my $this_level = shift;
1186 my $message = shift;
1188 return unless ($log_level & $this_level);
1190 if (LL_ERROR & $this_level) {
1191 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1194 log_message($message);
1196 if (LL_ERROR & $this_level) {
1201 sub log_message ($) {
1203 my $message = shift;
1207 our $leading_log_date;
1208 our $leading_log_time;
1210 my $time_stamp = '';
1211 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1213 if ($leading_log_date || $leading_log_time) {
1215 if ($leading_log_date) {
1218 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1221 if ($leading_log_time) {
1222 $time_stamp .= ' ' if $leading_log_date;
1223 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1226 $message = $time_stamp . ": " . $message;
1230 printf(STDERR "%s\n", $message);
1234 sub log_result ($$) {
1236 our $verbose_test_description;
1237 our $filtered_request;
1239 my $test_ref = shift;
1243 my %test = %{$test_ref};
1246 $message .= interpret_result($result);
1247 $message .= " for test ";
1248 $message .= $number;
1250 $message .= $test{'number'};
1252 $message .= $test{'section-id'};
1254 $message .= $test{'regression-test-id'};
1257 if ($verbose_test_description) {
1259 if ($test{'type'} == CLIENT_HEADER_TEST) {
1261 $message .= ' Header ';
1262 $message .= quote($test{'data'});
1263 $message .= ' and tag ';
1264 $message .= quote($test{'tag'});
1266 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1268 $message .= ' Request Header ';
1269 $message .= quote($test{'data'});
1270 $message .= ' and tag ';
1271 $message .= quote($test{'tag'});
1273 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1275 $message .= ' URL ';
1276 $message .= quote($test{'data'});
1277 $message .= ' and expected status code ';
1278 $message .= quote($test{'expected-status-code'});
1280 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1282 $message .= ' CGI URL ';
1283 $message .= quote($test{'data'});
1284 $message .= ' and expected status code ';
1285 $message .= quote($test{'expected-status-code'});
1287 } elsif ($test{'type'} == METHOD_TEST) {
1289 $message .= ' HTTP method ';
1290 $message .= quote($test{'data'});
1291 $message .= ' and expected status code ';
1292 $message .= quote($test{'expected-status-code'});
1294 } elsif ($test{'type'} == BLOCK_TEST) {
1296 $message .= ' Supposedly-blocked URL: ';
1297 $message .= quote($test{'data'});
1299 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1301 $message .= ' Sticky Actions: ';
1302 $message .= quote($test{'sticky-actions'});
1303 $message .= ' and URL: ';
1304 $message .= quote($test{'data'});
1308 die "Incomplete support for test type " . $test{'type'} . " detected.";
1313 log_message($message) unless ($result && cli_option_is_set('silent'));
1318 return '\'' . $s . '\'';
1321 sub print_version () {
1322 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1333 Options and their default values if they have any:
1334 [--debug $cli_options{'debug'}]
1338 [--loops $cli_options{'loops'}]
1339 [--max-level $cli_options{'max-level'}]
1340 [--max-time $cli_options{'max-time'}]
1341 [--min-level $cli_options{'min-level'}]
1343 [--retries $cli_options{'retries'}]
1346 see "perldoc $0" for more information
1352 sub init_cli_options () {
1357 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1358 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1359 $cli_options{'debug'} = $log_level;
1360 $cli_options{'loops'} = CLI_LOOPS;
1361 $cli_options{'max-time'} = CLI_MAX_TIME;
1362 $cli_options{'retries'} = CLI_RETRIES;
1365 sub parse_cli_options () {
1373 'debug=s' => \$cli_options{'debug'},
1374 'help' => sub { help },
1375 'silent' => \$cli_options{'silent'},
1376 'min-level=s' => \$cli_options{'min-level'},
1377 'max-level=s' => \$cli_options{'max-level'},
1378 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1379 'level=s' => \$cli_options{'level'},
1380 'loops=s' => \$cli_options{'loops'},
1381 'test-number=s' => \$cli_options{'test-number'},
1382 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1383 'retries=s' => \$cli_options{'retries'},
1384 'max-time=s' => \$cli_options{'max-time'},
1385 'version' => sub { print_version && exit(0) }
1387 $log_level |= $cli_options{'debug'};
1390 sub cli_option_is_set ($) {
1393 my $cli_option = shift;
1395 return defined $cli_options{$cli_option};
1398 sub get_cli_option ($) {
1401 my $cli_option = shift;
1403 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1405 return $cli_options{$cli_option};
1410 init_our_variables();
1411 parse_cli_options();
1413 load_regressions_tests();
1414 execute_regression_tests();
1421 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1425 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1426 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1427 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1428 [B<--retries retries>] [B<--silent>] [B<--version>]
1432 Privoxy-Regression-Test is supposed to one day become
1433 a regression test suite for Privoxy. It's not quite there
1434 yet, however, and can currently only test header actions,
1435 check the returned status code for requests to arbitrary
1436 URLs and verify which actions are applied to them.
1438 Client header actions are tested by requesting
1439 B<http://p.p/show-request> and checking whether
1440 or not Privoxy modified the original request as expected.
1442 The original request contains both the header the action-to-be-tested
1443 acts upon and an additional tagger-triggering header that enables
1446 Applied actions are checked through B<http://p.p/show-url-info>.
1448 =head1 CONFIGURATION FILE SYNTAX
1450 Privoxy-Regression-Test's configuration is embedded in
1451 Privoxy action files and loaded through Privoxy's web interface.
1453 It makes testing a Privoxy version running on a remote system easier
1454 and should prevent you from updating your tests without updating Privoxy's
1455 configuration accordingly.
1457 A client-header-action test section looks like this:
1459 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1460 # Expect Header = Referer: http://www.example.org/
1461 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1462 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1464 The example above causes Privoxy-Regression-Test to set
1465 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1466 and to expect it to be modified to
1467 B<Referer: http://www.example.org/>.
1469 When testing this section, Privoxy-Regression-Test will set the header
1470 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1471 causing the B<privoxy-control> tagger to create the tag
1472 B<client-header-filter{hide-tor-exit-notation}> which will finally
1473 cause Privoxy to enable the action section.
1475 Note that the actions itself are only used by Privoxy,
1476 Privoxy-Regression-Test ignores them and will be happy
1477 as long as the expectations are satisfied.
1479 A fetch test looks like this:
1481 # Fetch Test = http://p.p/user-manual
1482 # Expect Status Code = 302
1484 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1485 and to expect a response with the HTTP status code B<302>. Obviously that's
1486 not a very thorough test and mainly useful to get some code coverage
1487 for Valgrind or to verify that the templates are installed correctly.
1489 If you want to test CGI pages that require a trusted
1490 referer, you can use:
1492 # Trusted CGI Request = http://p.p/edit-actions
1494 It works like ordinary fetch tests, but sets the referer
1495 header to a trusted value.
1497 If no explicit status code expectation is set, B<200> is used.
1499 To verify that a URL is blocked, use:
1501 # Blocked URL = http://www.example.com/blocked
1503 To verify that a specific set of actions is applied to an URL, use:
1505 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1506 # URL = http://www.example.org/my-first-url
1508 The sticky actions will be checked for all URLs below it
1509 until the next sticky actions directive.
1513 All tests have test levels to let the user
1514 control which ones to execute (see I<OPTIONS> below).
1515 Test levels are either set with the B<Level> directive,
1516 or implicitly through the test type.
1518 Block tests default to level 7, fetch tests to level 6,
1519 "Sticky Actions" tests default to level 5, tests for trusted CGI
1520 requests to level 3 and client-header-action tests to level 1.
1524 B<--debug bitmask> Add the bitmask provided as integer
1525 to the debug settings.
1527 B<--fuzzer-feeding> Ignore some errors that would otherwise
1528 cause Privoxy-Regression-Test to abort the test because
1529 they shouldn't happen in normal operation. This option is
1530 intended to be used if Privoxy-Regression-Test is only
1531 used to feed a fuzzer in which case there's a high chance
1532 that Privoxy gets an invalid request and returns an error
1535 B<--help> Shows available command line options.
1537 B<--level level> Only execute tests with the specified B<level>.
1539 B<--loop count> Loop through the regression tests B<count> times.
1540 Useful to feed a fuzzer, or when doing stress tests with
1541 several Privoxy-Regression-Test instances running at the same
1544 B<--max-level max-level> Only execute tests with a B<level>
1545 below or equal to the numerical B<max-level>.
1547 B<--max-time max-time> Give Privoxy B<max-time> seconds
1548 to return data. Increasing the default may make sense when
1549 Privoxy is run through Valgrind, decreasing the default may
1550 make sense when Privoxy-Regression-Test is used to feed
1553 B<--min-level min-level> Only execute tests with a B<level>
1554 above or equal to the numerical B<min-level>.
1556 B<--privoxy-address proxy-address> Privoxy's listening address.
1557 If it's not set, the value of the environment variable http_proxy
1558 will be used. B<proxy-address> has to be specified in http_proxy
1561 B<--retries retries> Retry B<retries> times.
1563 B<--silent> Don't log succesful test runs.
1565 B<--version> Print version and exit.
1567 The second dash is optional, options can be shortened,
1568 as long as there are no ambiguities.
1570 =head1 PRIVOXY CONFIGURATION
1572 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1573 which aims to test all official client-header modifying actions
1574 and can be used to verify that the templates and the user manual
1575 files are installed correctly.
1577 To use it, it has to be copied in Privoxy's configuration
1578 directory, and afterwards referenced in Privoxy's configuration
1581 actionsfile regression-tests.action
1583 In general, its tests are supposed to work without changing
1584 any other action files, unless you already added lots of
1585 taggers yourself. If you are using taggers that cause problems,
1586 you might have to temporary disable them for Privoxy's CGI pages.
1588 Some of the regression tests rely on Privoxy features that
1589 may be disabled in your configuration. Tests with a level below
1590 7 are supposed to work with all Privoxy configurations (provided
1591 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1593 Tests with level 9 require Privoxy to deliver the User Manual,
1594 tests with level 12 require the CGI editor to be enabled.
1598 Expect the configuration file syntax to change with future releases.
1602 As Privoxy's B<show-request> page only shows client headers,
1603 Privoxy-Regression-Test can't use it to test Privoxy actions
1604 that modify server headers.
1606 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1607 control the actions to test, it currently only works with
1608 Privoxy 3.0.7 or later.
1610 At the moment Privoxy-Regression-Test fetches Privoxy's
1611 configuration page through I<curl>(1), therefore you have to
1612 have I<curl> installed, otherwise you won't be able to run
1613 Privoxy-Regression-Test in a meaningful way.
1621 Fabian Keil <fk@fabiankeil.de>