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.110 2008/02/16 12:55:18 fk Exp fk $
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 TRUSTED_CGI_REQUEST => 6,
91 sub init_our_variables () {
93 our $leading_log_time = LEADING_LOG_TIME;
94 our $leading_log_date = LEADING_LOG_DATE;
96 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
98 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
100 our $log_level = get_default_log_level();
104 sub get_default_log_level () {
108 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
109 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
110 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
111 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
112 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
114 # These are intended to be always on.
115 $log_level |= LL_SOFT_ERROR;
116 $log_level |= LL_ERROR;
121 ############################################################################
123 # File loading functions
125 ############################################################################
133 # Unescape brackets and dots
134 $tag =~ s@\\(?=[{}().+])@@g;
136 # log_message("Parsed tag: " . $tag);
138 check_for_forbidden_characters($tag);
143 sub check_for_forbidden_characters ($) {
145 my $tag = shift; # XXX: also used to check values though.
146 my $allowed = '[-=\dA-Za-z{}:.\/();\s,+@"_%\?&]';
148 unless ($tag =~ m/^$allowed*$/) {
149 my $forbidden = $tag;
150 $forbidden =~ s@^$allowed*(.).*@$1@;
152 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
156 sub load_regressions_tests () {
158 our $privoxy_cgi_url;
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);
184 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
186 load_action_files(\@actionfiles);
189 sub token_starts_new_test ($) {
192 my @new_test_directives =
193 ('set header', 'fetch test', 'trusted cgi request', 'request header', 'method test');
195 foreach my $new_test_directive (@new_test_directives) {
196 return 1 if $new_test_directive eq $token;
204 my ($token, $value) = (undef, undef);
206 # Remove leading and trailing white space.
210 # Reverse HTML-encoding
211 # XXX: Seriously imcomplete.
215 if (/^\#\s*([^=]*?)\s*[=]\s*(.*?)\s*$/) {
218 $token =~ tr/[A-Z]/[a-z]/;
221 } elsif (/^TAG\s*:(.*)$/) {
228 return ($token, $value);
231 sub enlist_new_test ($$$$$$) {
233 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
235 if ($token eq 'set header') {
237 l(LL_FILE_LOADING, "Header to set: " . $value);
238 ${$regression_tests}[$si][$ri]{'type'} = CLIENT_HEADER_TEST;
240 $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST;
242 } elsif ($token eq 'request header') {
244 l(LL_FILE_LOADING, "Header to request: " . $value);
245 $$regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST;
247 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
248 $$regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST;
250 } elsif ($token eq 'trusted cgi request') {
252 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
253 $$regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST;
255 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
256 $$regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST;
258 } elsif ($token eq 'fetch test') {
260 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
261 $$regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST;
263 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
264 $$regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST;
266 } elsif ($token eq 'method test') {
268 l(LL_FILE_LOADING, "Method to test: " . $value);
269 $$regression_tests[$si][$ri]{'type'} = METHOD_TEST;
271 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
272 $$regression_tests[$si][$ri]{'level'} = METHOD_TEST;
276 die "Incomplete '" . $token . "' support detected.";
280 check_for_forbidden_characters($value);
282 $$regression_tests[$si][$ri]{'data'} = $value;
284 # For function that only get passed single tests
285 $$regression_tests[$si][$ri]{'section-id'} = $si;
286 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
287 $$regression_tests[$si][$ri]{'number'} = $number - 1;
289 "Regression test " . $number . " (section:" . $si . "):");
292 sub load_action_files ($) {
296 our @regression_tests;
298 my $actionfiles_ref = shift;
299 my @actionfiles = @{$actionfiles_ref};
301 my $si = 0; # Section index
302 my $ri = -1; # Regression test index
307 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
309 for my $file_number (0 .. @actionfiles - 1) {
311 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
312 my $actionfile = undef;
314 foreach (@{get_cgi_page_or_else($curl_url)}) {
319 if (/<h2>Contents of Actions File (.*?)</) {
323 next unless defined $actionfile;
327 my ($token, $value) = tokenize($_);
329 next unless defined $token;
331 # Load regression tests
333 if (token_starts_new_test($token)) {
335 # Beginning of new regression test.
338 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
341 if ($token =~ /level\s+(\d+)/i) {
344 register_dependency($level, $value);
347 if ($si == -1 || $ri == -1) {
348 # No beginning of a test detected yet,
349 # so we don't care about any other test
354 if ($token eq 'expect header') {
356 l(LL_FILE_LOADING, "Detected expectation: " . $value);
357 $regression_tests[$si][$ri]{'expect-header'} = $value;
359 } elsif ($token eq 'tag') {
363 my $tag = parse_tag($value);
365 # We already checked in parse_tag() after filtering
368 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
370 # Save tag for all tests in this section
372 $regression_tests[$si][$ri]{'tag'} = $tag;
378 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
380 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
381 $regression_tests[$si][$ri]{'ignore'} = 1;
384 } elsif ($token eq 'expect status code') {
386 l(LL_FILE_LOADING, "Expecting status code: " . $value);
387 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
389 } elsif ($token eq 'level') { # XXX: stupid name
391 $value =~ s@(\d+).*@$1@;
392 l(LL_FILE_LOADING, "Level: " . $value);
393 $regression_tests[$si][$ri]{'level'} = $value;
395 } elsif ($token eq 'method') {
397 l(LL_FILE_LOADING, "Method: " . $value);
398 $regression_tests[$si][$ri]{'method'} = $value;
402 # We don't use it, so we don't need
406 check_for_forbidden_characters($value) unless $no_checks;
407 check_for_forbidden_characters($token);
411 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
412 . " Of which " . $ignored. " will be ignored)\n");
415 ############################################################################
417 # Regression test executing functions
419 ############################################################################
421 sub execute_regression_tests () {
423 our @regression_tests;
424 my $loops = get_cli_option('loops');
426 my $all_failures = 0;
427 my $all_successes = 0;
429 unless (@regression_tests) {
431 l(LL_STATUS, "No regression tests found.");
435 l(LL_STATUS, "Executing regression tests ...");
437 while ($loops-- > 0) {
444 for my $s (0 .. @regression_tests - 1) {
448 while (defined $regression_tests[$s][$r]) {
450 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
451 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
453 my $number = $regression_tests[$s][$r]{'number'};
455 if ($regression_tests[$s][$r]{'ignore'}
456 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
457 or test_number_is_unacceptable($number)) {
463 my $result = execute_regression_test($regression_tests[$s][$r]);
465 log_result($regression_tests[$s][$r], $result, $tests);
467 $successes += $result;
473 $failures = $tests - $successes;
475 log_message("Executed " . $tests . " regression tests. " .
476 'Skipped ' . $skipped . '. ' .
477 $successes . " successes, " . $failures . " failures.");
479 $all_tests += $tests;
480 $all_failures += $failures;
481 $all_successes += $successes;
485 if (get_cli_option('loops') > 1) {
486 log_message("Total: Executed " . $all_tests . " regression tests. " .
487 $all_successes . " successes, " . $all_failures . " failures.");
491 sub level_is_unacceptable ($) {
493 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
494 or ($level < get_cli_option('min-level'))
495 or ($level > get_cli_option('max-level'))
496 or dependency_unsatisfied($level)
500 sub test_number_is_unacceptable ($) {
501 my $test_number = shift;
502 return (cli_option_is_set('test-number')
503 and get_cli_option('test-number') != $test_number)
506 sub dependency_unsatisfied ($) {
511 my $dependency_problem = 0;
513 if (defined ($dependencies{$level}{'config line'})) {
515 my $dependency = $dependencies{$level}{'config line'};
516 $dependency_problem = 1;
518 foreach (@privoxy_config) {
520 $dependency_problem = 0 if (/$dependency/);
524 return $dependency_problem;
527 sub register_dependency ($$) {
530 my $dependency = shift;
533 if ($dependency =~ /config line\s+(.*)/) {
535 $dependencies{$level}{'config line'} = $1;
539 # XXX: somewhat misleading name
540 sub execute_regression_test ($) {
542 my $test_ref = shift;
543 my %test = %{$test_ref};
546 if ($test{'type'} == CLIENT_HEADER_TEST) {
548 $result = execute_client_header_regression_test($test_ref);
550 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
552 $result = execute_server_header_regression_test($test_ref);
554 } elsif ($test{'type'} == DUMB_FETCH_TEST
555 or $test{'type'} == TRUSTED_CGI_REQUEST) {
557 $result = execute_dumb_fetch_test($test_ref);
559 } elsif ($test{'type'} == METHOD_TEST) {
561 $result = execute_method_test($test_ref);
565 die "Unsuported test type detected: " . $test{'type'};
572 sub execute_method_test ($) {
574 my $test_ref = shift;
575 my %test = %{$test_ref};
579 my $method = $test{'data'};
581 my $curl_parameters = '';
582 my $expected_status_code = $test{'expected-status-code'};
584 $curl_parameters .= '--request ' . $method . ' ';
585 # Don't complain in case about the 'missing' body
586 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
588 $curl_parameters .= PRIVOXY_CGI_URL;
590 $buffer_ref = get_page_with_curl($curl_parameters);
591 $status_code = get_status_code($buffer_ref);
593 $result = check_status_code_result($status_code, $expected_status_code);
598 sub execute_dumb_fetch_test ($) {
600 my $test_ref = shift;
601 my %test = %{$test_ref};
606 my $curl_parameters = '';
607 my $expected_status_code = $test{'expected-status-code'};
609 if (defined $test{method}) {
610 $curl_parameters .= '--request ' . $test{method} . ' ';
612 if ($test{type} == TRUSTED_CGI_REQUEST) {
613 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
616 $curl_parameters .= $test{'data'};
618 $buffer_ref = get_page_with_curl($curl_parameters);
619 $status_code = get_status_code($buffer_ref);
621 $result = check_status_code_result($status_code, $expected_status_code);
626 sub check_status_code_result ($$) {
628 my $status_code = shift;
629 my $expected_status_code = shift;
632 if ($expected_status_code == $status_code) {
635 l(LL_VERBOSE_SUCCESS,
636 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
638 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
640 l(LL_VERBOSE_FAILURE,
641 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
645 l(LL_VERBOSE_FAILURE,
646 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
653 sub execute_client_header_regression_test ($) {
655 my $test_ref = shift;
660 $buffer_ref = get_show_request_with_curl($test_ref);
662 $header = get_header($buffer_ref, $test_ref);
663 $result = check_header_result($test_ref, $header);
668 sub execute_server_header_regression_test ($) {
670 my $test_ref = shift;
675 $buffer_ref = get_head_with_curl($test_ref);
677 $header = get_server_header($buffer_ref, $test_ref);
678 $result = check_header_result($test_ref, $header);
684 sub interpret_result ($) {
686 return $success ? "Success" : "Failure";
689 sub check_header_result ($$) {
691 my $test_ref = shift;
694 my %test = %{$test_ref};
695 my $expect_header = $test{'expect-header'};
698 $header =~ s@ @ @g if defined($header);
700 if ($expect_header eq 'NO CHANGE') {
702 if (defined($header) and $header eq $test{'data'}) {
708 $header //= "REMOVAL";
709 l(LL_VERBOSE_FAILURE,
710 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
713 } elsif ($expect_header eq 'REMOVAL') {
715 if (defined($header) and $header eq $test{'data'}) {
717 l(LL_VERBOSE_FAILURE,
718 "Ooops. Expected removal but: " . $header . " is still there.");
722 # XXX: Use more reliable check here and make sure
723 # the header has a different name.
728 } elsif ($expect_header eq 'SOME CHANGE') {
730 if (defined($header) and not $header eq $test{'data'}) {
736 $header //= "REMOVAL";
737 l(LL_VERBOSE_FAILURE,
738 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
744 if (defined($header) and $header eq $expect_header) {
750 $header //= "'No matching header'"; # XXX: No header detected to be precise
751 l(LL_VERBOSE_FAILURE,
752 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
758 sub get_header_name ($) {
762 $header =~ s@(.*?: ).*@$1@;
767 sub get_header ($$) {
769 our $filtered_request = '';
771 my $buffer_ref = shift;
772 my $test_ref = shift;
774 my %test = %{$test_ref};
775 my @buffer = @{$buffer_ref};
777 my $expect_header = $test{'expect-header'};
780 my $processed_request_reached = 0;
782 my $processed_request = '';
786 if ($expect_header eq 'REMOVAL'
787 or $expect_header eq 'NO CHANGE'
788 or $expect_header eq 'SOME CHANGE') {
790 $expect_header = $test{'data'};
794 $header_to_get = get_header_name($expect_header);
798 # Skip everything before the Processed request
799 if (/Processed Request/) {
800 $processed_request_reached = 1;
803 next unless $processed_request_reached;
805 # End loop after the Processed request
808 # Ditch tags and leading/trailing white space.
812 $filtered_request .= "\n" . $_;
814 if (/^$header_to_get/) {
824 sub get_server_header ($$) {
826 my $buffer_ref = shift;
827 my $test_ref = shift;
829 my %test = %{$test_ref};
830 my @buffer = @{$buffer_ref};
832 my $expect_header = $test{'expect-header'};
836 if ($expect_header eq 'REMOVAL'
837 or $expect_header eq 'NO CHANGE'
838 or $expect_header eq 'SOME CHANGE') {
840 $expect_header = $test{'data'};
844 $header_to_get = get_header_name($expect_header);
848 # XXX: should probably verify that the request
849 # was actually answered by Fellatio.
850 if (/^$header_to_get/) {
852 $header =~ s@\s*$@@g;
860 sub get_status_code ($) {
862 my $buffer_ref = shift;
863 my @buffer = @{$buffer_ref};
867 if (/^HTTP\/\d\.\d (\d{3})/) {
873 return '123' if cli_option_is_set('fuzzer-feeding');
875 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
880 sub get_test_keys () {
881 return ('tag', 'data', 'expect-header', 'ignore');
885 sub test_content_as_string ($) {
887 my $test_ref = shift;
888 my %test = %{$test_ref};
892 foreach my $key (get_test_keys()) {
893 $test{$key} = 'Not set' unless (defined $test{$key});
896 $s .= 'Tag: ' . $test{'tag'};
898 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
900 $s .= 'Expected header: ' . $test{'expect-header'};
902 $s .= 'Ignore: ' . $test{'ignore'};
907 ############################################################################
909 # HTTP fetch functions
911 ############################################################################
913 sub check_for_curl () {
915 l(LL_ERROR, "No curl found.") unless (`which $curl`);
918 sub get_cgi_page_or_else ($) {
921 my $content_ref = get_page_with_curl($cgi_url);
922 my $status_code = get_status_code($content_ref);
924 if (200 != $status_code) {
926 my $log_message = "Failed to fetch Privoxy CGI Page. " .
927 "Received status code ". $status_code .
928 " while only 200 is acceptable.";
930 if (cli_option_is_set('fuzzer-feeding')) {
932 $log_message .= " Ignored due to fuzzer feeding.";
933 l(LL_SOFT_ERROR, $log_message)
937 l(LL_ERROR, $log_message);
945 sub get_show_request_with_curl ($) {
947 our $privoxy_cgi_url;
948 my $test_ref = shift;
949 my %test = %{$test_ref};
951 my $curl_parameters = ' ';
953 # Enable the action to test
954 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
955 # The header to filter
956 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
958 $curl_parameters .= ' ';
959 $curl_parameters .= $privoxy_cgi_url;
960 $curl_parameters .= 'show-request';
962 return get_cgi_page_or_else($curl_parameters);
966 sub get_head_with_curl ($) {
968 our $fellatio_url = FELLATIO_URL;
969 my $test_ref = shift;
970 my %test = %{$test_ref};
972 my $curl_parameters = ' ';
974 # Enable the action to test
975 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
976 # The header to filter
977 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
978 $curl_parameters .= '--head ';
980 $curl_parameters .= ' ';
981 $curl_parameters .= $fellatio_url;
983 return get_page_with_curl($curl_parameters);
987 sub get_page_with_curl ($) {
989 my $parameters = shift;
991 my $curl_line = CURL;
992 my $retries_left = get_cli_option('retries') + 1;
995 if (cli_option_is_set('privoxy-address')) {
996 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
999 # We want to see the HTTP status code
1000 $curl_line .= " --include ";
1001 # Let Privoxy emit two log messages less.
1002 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1003 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1004 # We don't care about fetch statistic.
1005 $curl_line .= " -s ";
1006 # We do care about the failure reason if any.
1007 $curl_line .= " -S ";
1008 # We want to advertise ourselves
1009 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1010 # We aren't too patient
1011 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1013 $curl_line .= $parameters;
1014 # XXX: still necessary?
1015 $curl_line .= ' 2>&1';
1017 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1020 @buffer = `$curl_line`;
1023 $failure_reason = array_as_string(\@buffer);
1024 chomp $failure_reason;
1025 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1027 } while ($? && --$retries_left);
1029 unless ($retries_left) {
1031 "Running curl failed " . get_cli_option('retries') .
1032 " times in a row. Last error: '" . $failure_reason . "'.");
1039 ############################################################################
1043 ############################################################################
1045 sub array_as_string ($) {
1046 my $array_ref = shift;
1049 foreach (@{$array_ref}) {
1058 my $test_ref = shift;
1059 log_message('Test is:' . test_content_as_string($test_ref));
1065 my $this_level = shift;
1066 my $message = shift;
1068 return unless ($log_level & $this_level);
1070 if (LL_ERROR & $this_level) {
1071 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1074 log_message($message);
1076 if (LL_ERROR & $this_level) {
1081 sub log_message ($) {
1083 my $message = shift;
1087 our $leading_log_date;
1088 our $leading_log_time;
1090 my $time_stamp = '';
1091 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1093 if ($leading_log_date || $leading_log_time) {
1095 if ($leading_log_date) {
1098 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1101 if ($leading_log_time) {
1102 $time_stamp .= ' ' if $leading_log_date;
1103 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1106 $message = $time_stamp . ": " . $message;
1110 printf(STDERR "%s\n", $message);
1114 sub log_result ($$) {
1116 our $verbose_test_description;
1117 our $filtered_request;
1119 my $test_ref = shift;
1123 my %test = %{$test_ref};
1126 $message .= interpret_result($result);
1127 $message .= " for test ";
1128 $message .= $number;
1130 $message .= $test{'number'};
1132 $message .= $test{'section-id'};
1134 $message .= $test{'regression-test-id'};
1137 if ($verbose_test_description) {
1139 if ($test{'type'} == CLIENT_HEADER_TEST) {
1141 $message .= ' Header ';
1142 $message .= quote($test{'data'});
1143 $message .= ' and tag ';
1144 $message .= quote($test{'tag'});
1146 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1148 $message .= ' Request Header ';
1149 $message .= quote($test{'data'});
1150 $message .= ' and tag ';
1151 $message .= quote($test{'tag'});
1153 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1155 $message .= ' URL ';
1156 $message .= quote($test{'data'});
1157 $message .= ' and expected status code ';
1158 $message .= quote($test{'expected-status-code'});
1160 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1162 $message .= ' CGI URL ';
1163 $message .= quote($test{'data'});
1164 $message .= ' and expected status code ';
1165 $message .= quote($test{'expected-status-code'});
1167 } elsif ($test{'type'} == METHOD_TEST) {
1169 $message .= ' HTTP method ';
1170 $message .= quote($test{'data'});
1171 $message .= ' and expected status code ';
1172 $message .= quote($test{'expected-status-code'});
1176 die "Incomplete support for test type " . $test{'type'} . " detected.";
1181 log_message($message) unless ($result && cli_option_is_set('silent'));
1186 return '\'' . $s . '\'';
1189 sub print_version () {
1190 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1201 Options and their default values if they have any:
1202 [--debug $cli_options{'debug'}]
1206 [--loops $cli_options{'loops'}]
1207 [--max-level $cli_options{'max-level'}]
1208 [--max-time $cli_options{'max-time'}]
1209 [--min-level $cli_options{'min-level'}]
1211 [--retries $cli_options{'retries'}]
1214 see "perldoc $0" for more information
1220 sub init_cli_options () {
1225 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1226 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1227 $cli_options{'debug'} = $log_level;
1228 $cli_options{'loops'} = CLI_LOOPS;
1229 $cli_options{'max-time'} = CLI_MAX_TIME;
1230 $cli_options{'retries'} = CLI_RETRIES;
1233 sub parse_cli_options () {
1241 'debug=s' => \$cli_options{'debug'},
1242 'help' => sub { help },
1243 'silent' => \$cli_options{'silent'},
1244 'min-level=s' => \$cli_options{'min-level'},
1245 'max-level=s' => \$cli_options{'max-level'},
1246 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1247 'level=s' => \$cli_options{'level'},
1248 'loops=s' => \$cli_options{'loops'},
1249 'test-number=s' => \$cli_options{'test-number'},
1250 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1251 'retries=s' => \$cli_options{'retries'},
1252 'max-time=s' => \$cli_options{'max-time'},
1253 'version' => sub { print_version && exit(0) }
1255 $log_level |= $cli_options{'debug'};
1258 sub cli_option_is_set ($) {
1261 my $cli_option = shift;
1263 return defined $cli_options{$cli_option};
1266 sub get_cli_option ($) {
1269 my $cli_option = shift;
1271 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1273 return $cli_options{$cli_option};
1278 init_our_variables();
1279 parse_cli_options();
1281 load_regressions_tests();
1282 execute_regression_tests();
1289 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1293 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1294 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1295 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1296 [B<--retries retries>] [B<--silent>] [B<--version>]
1300 Privoxy-Regression-Test is supposed to one day become
1301 a regression test suite for Privoxy. It's not quite there
1302 yet, however, and can currently only test client header
1303 actions and check the returned status code for requests
1306 Client header actions are tested by requesting
1307 B<http://config.privoxy.org/show-request> and checking whether
1308 or not Privoxy modified the original request as expected.
1310 The original request contains both the header the action-to-be-tested
1311 acts upon and an additional tagger-triggering header that enables
1314 =head1 CONFIGURATION FILE SYNTAX
1316 Privoxy-Regression-Test's configuration is embedded in
1317 Privoxy action files and loaded through Privoxy's web interface.
1319 It makes testing a Privoxy version running on a remote system easier
1320 and should prevent you from updating your tests without updating Privoxy's
1321 configuration accordingly.
1323 A client-header-action test section looks like this:
1325 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1326 # Expect Header = Referer: http://www.example.org/
1327 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1328 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1330 The example above causes Privoxy-Regression-Test to set
1331 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1332 and to expect it to be modified to
1333 B<Referer: http://www.example.org/>.
1335 When testing this section, Privoxy-Regression-Test will set the header
1336 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1337 causing the B<privoxy-control> tagger to create the tag
1338 B<client-header-filter{hide-tor-exit-notation}> which will finally
1339 cause Privoxy to enable the action section.
1341 Note that the actions itself are only used by Privoxy,
1342 Privoxy-Regression-Test ignores them and will be happy
1343 as long as the expectations are satisfied.
1345 A fetch test looks like this:
1347 # Fetch Test = http://p.p/user-manual
1348 # Expect Status Code = 302
1350 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1351 and to expect a response with the HTTP status code B<302>. Obviously that's
1352 not a very thorough test and mainly useful to get some code coverage
1353 for Valgrind or to verify that the templates are installed correctly.
1355 If you want to test CGI pages that require a trusted
1356 referer, you can use:
1358 # Trusted CGI Request = http://p.p/edit-actions
1360 It works like ordinary fetch tests, but sets the referer
1361 header to a trusted value.
1363 If no explicit status code expectation is set, B<200> is used.
1365 Additionally all tests have test levels to let the user
1366 control which ones to execute (see I<OPTIONS> below).
1367 Test levels are either set with the B<Level> directive,
1368 or implicitly through the test type.
1370 Fetch tests default to level 6, tests for trusted
1371 CGI requests to level 3 and client-header-action tests
1376 B<--debug bitmask> Add the bitmask provided as integer
1377 to the debug settings.
1379 B<--fuzzer-feeding> Ignore some errors that would otherwise
1380 cause Privoxy-Regression-Test to abort the test because
1381 they shouldn't happen in normal operation. This option is
1382 intended to be used if Privoxy-Regression-Test is only
1383 used to feed a fuzzer in which case there's a high chance
1384 that Privoxy gets an invalid request and returns an error
1387 B<--help> Shows available command line options.
1389 B<--level level> Only execute tests with the specified B<level>.
1391 B<--loop count> Loop through the regression tests B<count> times.
1392 Useful to feed a fuzzer, or when doing stress tests with
1393 several Privoxy-Regression-Test instances running at the same
1396 B<--max-level max-level> Only execute tests with a B<level>
1397 below or equal to the numerical B<max-level>.
1399 B<--max-time max-time> Give Privoxy B<max-time> seconds
1400 to return data. Increasing the default may make sense when
1401 Privoxy is run through Valgrind, decreasing the default may
1402 make sense when Privoxy-Regression-Test is used to feed
1405 B<--min-level min-level> Only execute tests with a B<level>
1406 above or equal to the numerical B<min-level>.
1408 B<--privoxy-address proxy-address> Privoxy's listening address.
1409 If it's not set, the value of the environment variable http_proxy
1410 will be used. B<proxy-address> has to be specified in http_proxy
1413 B<--retries retries> Retry B<retries> times.
1415 B<--silent> Don't log succesful test runs.
1417 B<--version> Print version and exit.
1419 The second dash is optional, options can be shortened,
1420 as long as there are no ambiguities.
1422 =head1 PRIVOXY CONFIGURATION
1424 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1425 which aims to test all official client-header modifying actions
1426 and can be used to verify that the templates and the user manual
1427 files are installed correctly.
1429 To use it, it has to be copied in Privoxy's configuration
1430 directory, and afterwards referenced in Privoxy's configuration
1433 actionsfile regression-tests.action
1435 In general, its tests are supposed to work without changing
1436 any other action files, unless you already added lots of
1437 taggers yourself. If you are using taggers that cause problems,
1438 you might have to temporary disable them for Privoxy's CGI pages.
1440 Some of the regression tests rely on Privoxy features that
1441 may be disabled in your configuration. Tests with a level below
1442 7 are supposed to work with all Privoxy configurations (provided
1443 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1445 Tests with level 9 require Privoxy to deliver the User Manual,
1446 tests with level 12 require the CGI editor to be enabled.
1450 Expect the configuration file syntax to change with future releases.
1454 As Privoxy's B<show-request> page only shows client headers,
1455 Privoxy-Regression-Test can't use it to test Privoxy actions
1456 that modify server headers.
1458 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1459 control the actions to test, it currently only works with
1460 Privoxy 3.0.7 or later.
1462 At the moment Privoxy-Regression-Test fetches Privoxy's
1463 configuration page through I<curl>(1), therefore you have to
1464 have I<curl> installed, otherwise you won't be able to run
1465 Privoxy-Regression-Test in a meaningful way.
1473 Fabian Keil <fk@fabiankeil.de>