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.109 2008/02/15 16:40:04 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'};
573 sub execute_method_test ($) {
575 my $test_ref = shift;
576 my %test = %{$test_ref};
580 my $method = $test{'data'};
582 my $curl_parameters = '';
583 my $expected_status_code = $test{'expected-status-code'};
585 if ($method =~ /HEAD/i) {
587 $curl_parameters .= '--head ';
591 $curl_parameters .= '-X ' . $method . ' ';
594 $curl_parameters .= PRIVOXY_CGI_URL;
596 $buffer_ref = get_page_with_curl($curl_parameters);
597 $status_code = get_status_code($buffer_ref);
599 $result = check_status_code_result($status_code, $expected_status_code);
605 sub execute_dumb_fetch_test ($) {
607 my $test_ref = shift;
608 my %test = %{$test_ref};
613 my $curl_parameters = '';
614 my $expected_status_code = $test{'expected-status-code'};
616 if (defined $test{method}) {
617 $curl_parameters .= '-X ' . $test{method} . ' ';
619 if ($test{type} == TRUSTED_CGI_REQUEST) {
620 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
623 $curl_parameters .= $test{'data'};
625 $buffer_ref = get_page_with_curl($curl_parameters);
626 $status_code = get_status_code($buffer_ref);
628 $result = check_status_code_result($status_code, $expected_status_code);
633 sub check_status_code_result ($$) {
635 my $status_code = shift;
636 my $expected_status_code = shift;
639 if ($expected_status_code == $status_code) {
642 l(LL_VERBOSE_SUCCESS,
643 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
645 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
647 l(LL_VERBOSE_FAILURE,
648 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
652 l(LL_VERBOSE_FAILURE,
653 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
660 sub execute_client_header_regression_test ($) {
662 my $test_ref = shift;
667 $buffer_ref = get_show_request_with_curl($test_ref);
669 $header = get_header($buffer_ref, $test_ref);
670 $result = check_header_result($test_ref, $header);
675 sub execute_server_header_regression_test ($) {
677 my $test_ref = shift;
682 $buffer_ref = get_head_with_curl($test_ref);
684 $header = get_server_header($buffer_ref, $test_ref);
685 $result = check_header_result($test_ref, $header);
691 sub interpret_result ($) {
693 return $success ? "Success" : "Failure";
696 sub check_header_result ($$) {
698 my $test_ref = shift;
701 my %test = %{$test_ref};
702 my $expect_header = $test{'expect-header'};
705 $header =~ s@ @ @g if defined($header);
707 if ($expect_header eq 'NO CHANGE') {
709 if (defined($header) and $header eq $test{'data'}) {
715 $header //= "REMOVAL";
716 l(LL_VERBOSE_FAILURE,
717 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
720 } elsif ($expect_header eq 'REMOVAL') {
722 if (defined($header) and $header eq $test{'data'}) {
724 l(LL_VERBOSE_FAILURE,
725 "Ooops. Expected removal but: " . $header . " is still there.");
729 # XXX: Use more reliable check here and make sure
730 # the header has a different name.
735 } elsif ($expect_header eq 'SOME CHANGE') {
737 if (defined($header) and not $header eq $test{'data'}) {
743 $header //= "REMOVAL";
744 l(LL_VERBOSE_FAILURE,
745 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
751 if (defined($header) and $header eq $expect_header) {
757 $header //= "'No matching header'"; # XXX: No header detected to be precise
758 l(LL_VERBOSE_FAILURE,
759 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
766 sub get_header_name ($) {
770 $header =~ s@(.*?: ).*@$1@;
775 sub get_header ($$) {
777 our $filtered_request = '';
779 my $buffer_ref = shift;
780 my $test_ref = shift;
782 my %test = %{$test_ref};
783 my @buffer = @{$buffer_ref};
785 my $expect_header = $test{'expect-header'};
788 my $processed_request_reached = 0;
790 my $processed_request = '';
794 if ($expect_header eq 'REMOVAL'
795 or $expect_header eq 'NO CHANGE'
796 or $expect_header eq 'SOME CHANGE') {
798 $expect_header = $test{'data'};
802 $header_to_get = get_header_name($expect_header);
806 # Skip everything before the Processed request
807 if (/Processed Request/) {
808 $processed_request_reached = 1;
811 next unless $processed_request_reached;
813 # End loop after the Processed request
816 # Ditch tags and leading/trailing white space.
820 $filtered_request .= "\n" . $_;
822 if (/^$header_to_get/) {
832 sub get_server_header ($$) {
834 my $buffer_ref = shift;
835 my $test_ref = shift;
837 my %test = %{$test_ref};
838 my @buffer = @{$buffer_ref};
840 my $expect_header = $test{'expect-header'};
844 if ($expect_header eq 'REMOVAL'
845 or $expect_header eq 'NO CHANGE'
846 or $expect_header eq 'SOME CHANGE') {
848 $expect_header = $test{'data'};
852 $header_to_get = get_header_name($expect_header);
856 # XXX: shoul probably verify that the request
857 # was actually answered by Fellatio.
858 if (/^$header_to_get/) {
860 $header =~ s@\s*$@@g;
868 sub get_header_to_check ($) {
870 # No longer in use but not removed yet.
872 my $buffer_ref = shift;
874 my @buffer = @{$buffer_ref};
876 my $processed_request_reached = 0;
878 my $processed_request = '';
880 l(LL_ERROR, "You are not supposed to use get_header_to_()!");
884 # Skip everything before the Processed request
885 if (/Processed Request/) {
886 $processed_request_reached = 1;
889 next unless $processed_request_reached;
891 # End loop after the Processed request
894 # Ditch tags and leading/trailing white space.
898 $processed_request .= $_;
900 if (/^X-Privoxy-Regression-Test/) {
915 sub get_status_code ($) {
917 my $buffer_ref = shift;
918 my @buffer = @{$buffer_ref};
922 if (/^HTTP\/\d\.\d (\d{3})/) {
928 return '123' if cli_option_is_set('fuzzer-feeding');
930 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
935 sub get_test_keys () {
936 return ('tag', 'data', 'expect-header', 'ignore');
940 sub test_content_as_string ($) {
942 my $test_ref = shift;
943 my %test = %{$test_ref};
947 foreach my $key (get_test_keys()) {
948 $test{$key} = 'Not set' unless (defined $test{$key});
951 $s .= 'Tag: ' . $test{'tag'};
953 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
955 $s .= 'Expected header: ' . $test{'expect-header'};
957 $s .= 'Ignore: ' . $test{'ignore'};
962 ############################################################################
964 # HTTP fetch functions
966 ############################################################################
968 sub check_for_curl () {
970 l(LL_ERROR, "No curl found.") unless (`which $curl`);
973 sub get_cgi_page_or_else ($) {
976 my $content_ref = get_page_with_curl($cgi_url);
977 my $status_code = get_status_code($content_ref);
979 if (200 != $status_code) {
981 my $log_message = "Failed to fetch Privoxy CGI Page. " .
982 "Received status code ". $status_code .
983 " while only 200 is acceptable.";
985 if (cli_option_is_set('fuzzer-feeding')) {
987 $log_message .= " Ignored due to fuzzer feeding.";
988 l(LL_SOFT_ERROR, $log_message)
992 l(LL_ERROR, $log_message);
1000 sub get_show_request_with_curl ($) {
1002 our $privoxy_cgi_url;
1003 my $test_ref = shift;
1004 my %test = %{$test_ref};
1006 my $curl_parameters = ' ';
1008 # Enable the action to test
1009 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1010 # The header to filter
1011 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1013 $curl_parameters .= ' ';
1014 $curl_parameters .= $privoxy_cgi_url;
1015 $curl_parameters .= 'show-request';
1017 return get_cgi_page_or_else($curl_parameters);
1021 sub get_head_with_curl ($) {
1023 our $fellatio_url = FELLATIO_URL;
1024 my $test_ref = shift;
1025 my %test = %{$test_ref};
1027 my $curl_parameters = ' ';
1029 # Enable the action to test
1030 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1031 # The header to filter
1032 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1033 $curl_parameters .= '--head ';
1035 $curl_parameters .= ' ';
1036 $curl_parameters .= $fellatio_url;
1038 return get_page_with_curl($curl_parameters);
1042 sub get_page_with_curl ($) {
1044 my $parameters = shift;
1046 my $curl_line = CURL;
1047 my $retries_left = get_cli_option('retries') + 1;
1050 if (cli_option_is_set('privoxy-address')) {
1051 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
1054 # Let Privoxy emit two log messages less.
1055 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1056 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1057 # We don't care about fetch statistic.
1058 $curl_line .= " -s ";
1059 # We do care about the failure reason if any.
1060 $curl_line .= " -S ";
1061 # We want to see the HTTP status code
1062 $curl_line .= " --include ";
1063 # We want to advertise ourselves
1064 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1065 # We aren't too patient
1066 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1068 $curl_line .= $parameters;
1069 # XXX: still necessary?
1070 $curl_line .= ' 2>&1';
1072 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1075 @buffer = `$curl_line`;
1078 $failure_reason = array_as_string(\@buffer);
1079 chomp $failure_reason;
1080 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1082 } while ($? && --$retries_left);
1084 unless ($retries_left) {
1086 "Running curl failed " . get_cli_option('retries') .
1087 " times in a row. Last error: '" . $failure_reason . "'.");
1094 ############################################################################
1098 ############################################################################
1100 sub array_as_string ($) {
1101 my $array_ref = shift;
1104 foreach (@{$array_ref}) {
1113 my $test_ref = shift;
1114 log_message('Test is:' . test_content_as_string($test_ref));
1120 my $this_level = shift;
1121 my $message = shift;
1123 return unless ($log_level & $this_level);
1125 if (LL_ERROR & $this_level) {
1126 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1129 log_message($message);
1131 if (LL_ERROR & $this_level) {
1136 sub log_message ($) {
1138 my $message = shift;
1142 our $leading_log_date;
1143 our $leading_log_time;
1145 my $time_stamp = '';
1146 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1148 if ($leading_log_date || $leading_log_time) {
1150 if ($leading_log_date) {
1153 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1156 if ($leading_log_time) {
1157 $time_stamp .= ' ' if $leading_log_date;
1158 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1161 $message = $time_stamp . ": " . $message;
1165 printf(STDERR "%s\n", $message);
1169 sub log_result ($$) {
1171 our $verbose_test_description;
1172 our $filtered_request;
1174 my $test_ref = shift;
1178 my %test = %{$test_ref};
1181 $message .= interpret_result($result);
1182 $message .= " for test ";
1183 $message .= $number;
1185 $message .= $test{'number'};
1187 $message .= $test{'section-id'};
1189 $message .= $test{'regression-test-id'};
1192 if ($verbose_test_description) {
1194 if ($test{'type'} == CLIENT_HEADER_TEST) {
1196 $message .= ' Header ';
1197 $message .= quote($test{'data'});
1198 $message .= ' and tag ';
1199 $message .= quote($test{'tag'});
1201 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1203 $message .= ' Request Header ';
1204 $message .= quote($test{'data'});
1205 $message .= ' and tag ';
1206 $message .= quote($test{'tag'});
1208 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1210 $message .= ' URL ';
1211 $message .= quote($test{'data'});
1212 $message .= ' and expected status code ';
1213 $message .= quote($test{'expected-status-code'});
1215 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1217 $message .= ' CGI URL ';
1218 $message .= quote($test{'data'});
1219 $message .= ' and expected status code ';
1220 $message .= quote($test{'expected-status-code'});
1222 } elsif ($test{'type'} == METHOD_TEST) {
1224 $message .= ' HTTP method ';
1225 $message .= quote($test{'data'});
1226 $message .= ' and expected status code ';
1227 $message .= quote($test{'expected-status-code'});
1231 die "Incomplete support for test type " . $test{'type'} . " detected.";
1236 log_message($message) unless ($result && cli_option_is_set('silent'));
1241 return '\'' . $s . '\'';
1244 sub print_version () {
1245 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1256 Options and their default values if they have any:
1257 [--debug $cli_options{'debug'}]
1261 [--loops $cli_options{'loops'}]
1262 [--max-level $cli_options{'max-level'}]
1263 [--max-time $cli_options{'max-time'}]
1264 [--min-level $cli_options{'min-level'}]
1266 [--retries $cli_options{'retries'}]
1269 see "perldoc $0" for more information
1275 sub init_cli_options () {
1280 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1281 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1282 $cli_options{'debug'} = $log_level;
1283 $cli_options{'loops'} = CLI_LOOPS;
1284 $cli_options{'max-time'} = CLI_MAX_TIME;
1285 $cli_options{'retries'} = CLI_RETRIES;
1288 sub parse_cli_options () {
1296 'debug=s' => \$cli_options{'debug'},
1297 'help' => sub { help },
1298 'silent' => \$cli_options{'silent'},
1299 'min-level=s' => \$cli_options{'min-level'},
1300 'max-level=s' => \$cli_options{'max-level'},
1301 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1302 'level=s' => \$cli_options{'level'},
1303 'loops=s' => \$cli_options{'loops'},
1304 'test-number=s' => \$cli_options{'test-number'},
1305 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1306 'retries=s' => \$cli_options{'retries'},
1307 'max-time=s' => \$cli_options{'max-time'},
1308 'version' => sub { print_version && exit(0) }
1310 $log_level |= $cli_options{'debug'};
1313 sub cli_option_is_set ($) {
1316 my $cli_option = shift;
1318 return defined $cli_options{$cli_option};
1321 sub get_cli_option ($) {
1324 my $cli_option = shift;
1326 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1328 return $cli_options{$cli_option};
1333 init_our_variables();
1334 parse_cli_options();
1336 load_regressions_tests();
1337 execute_regression_tests();
1344 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1348 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1349 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1350 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1351 [B<--retries retries>] [B<--silent>] [B<--version>]
1355 Privoxy-Regression-Test is supposed to one day become
1356 a regression test suite for Privoxy. It's not quite there
1357 yet, however, and can currently only test client header
1358 actions and check the returned status code for requests
1361 Client header actions are tested by requesting
1362 B<http://config.privoxy.org/show-request> and checking whether
1363 or not Privoxy modified the original request as expected.
1365 The original request contains both the header the action-to-be-tested
1366 acts upon and an additional tagger-triggering header that enables
1369 =head1 CONFIGURATION FILE SYNTAX
1371 Privoxy-Regression-Test's configuration is embedded in
1372 Privoxy action files and loaded through Privoxy's web interface.
1374 It makes testing a Privoxy version running on a remote system easier
1375 and should prevent you from updating your tests without updating Privoxy's
1376 configuration accordingly.
1378 A client-header-action test section looks like this:
1380 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1381 # Expect Header = Referer: http://www.example.org/
1382 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1383 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1385 The example above causes Privoxy-Regression-Test to set
1386 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1387 and to expect it to be modified to
1388 B<Referer: http://www.example.org/>.
1390 When testing this section, Privoxy-Regression-Test will set the header
1391 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1392 causing the B<privoxy-control> tagger to create the tag
1393 B<client-header-filter{hide-tor-exit-notation}> which will finally
1394 cause Privoxy to enable the action section.
1396 Note that the actions itself are only used by Privoxy,
1397 Privoxy-Regression-Test ignores them and will be happy
1398 as long as the expectations are satisfied.
1400 A fetch test looks like this:
1402 # Fetch Test = http://p.p/user-manual
1403 # Expect Status Code = 302
1405 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1406 and to expect a response with the HTTP status code B<302>. Obviously that's
1407 not a very thorough test and mainly useful to get some code coverage
1408 for Valgrind or to verify that the templates are installed correctly.
1410 If you want to test CGI pages that require a trusted
1411 referer, you can use:
1413 # Trusted CGI Request = http://p.p/edit-actions
1415 It works like ordinary fetch tests, but sets the referer
1416 header to a trusted value.
1418 If no explicit status code expectation is set, B<200> is used.
1420 Additionally all tests have test levels to let the user
1421 control which ones to execute (see I<OPTIONS> below).
1422 Test levels are either set with the B<Level> directive,
1423 or implicitly through the test type.
1425 Fetch tests default to level 6, tests for trusted
1426 CGI requests to level 3 and client-header-action tests
1431 B<--debug bitmask> Add the bitmask provided as integer
1432 to the debug settings.
1434 B<--fuzzer-feeding> Ignore some errors that would otherwise
1435 cause Privoxy-Regression-Test to abort the test because
1436 they shouldn't happen in normal operation. This option is
1437 intended to be used if Privoxy-Regression-Test is only
1438 used to feed a fuzzer in which case there's a high chance
1439 that Privoxy gets an invalid request and returns an error
1442 B<--help> Shows available command line options.
1444 B<--level level> Only execute tests with the specified B<level>.
1446 B<--loop count> Loop through the regression tests B<count> times.
1447 Useful to feed a fuzzer, or when doing stress tests with
1448 several Privoxy-Regression-Test instances running at the same
1451 B<--max-level max-level> Only execute tests with a B<level>
1452 below or equal to the numerical B<max-level>.
1454 B<--max-time max-time> Give Privoxy B<max-time> seconds
1455 to return data. Increasing the default may make sense when
1456 Privoxy is run through Valgrind, decreasing the default may
1457 make sense when Privoxy-Regression-Test is used to feed
1460 B<--min-level min-level> Only execute tests with a B<level>
1461 above or equal to the numerical B<min-level>.
1463 B<--privoxy-address proxy-address> Privoxy's listening address.
1464 If it's not set, the value of the environment variable http_proxy
1465 will be used. B<proxy-address> has to be specified in http_proxy
1468 B<--retries retries> Retry B<retries> times.
1470 B<--silent> Don't log succesful test runs.
1472 B<--version> Print version and exit.
1474 The second dash is optional, options can be shortened,
1475 as long as there are no ambiguities.
1477 =head1 PRIVOXY CONFIGURATION
1479 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1480 which aims to test all official client-header modifying actions
1481 and can be used to verify that the templates and the user manual
1482 files are installed correctly.
1484 To use it, it has to be copied in Privoxy's configuration
1485 directory, and afterwards referenced in Privoxy's configuration
1488 actionsfile regression-tests.action
1490 In general, its tests are supposed to work without changing
1491 any other action files, unless you already added lots of
1492 taggers yourself. If you are using taggers that cause problems,
1493 you might have to temporary disable them for Privoxy's CGI pages.
1495 Some of the regression tests rely on Privoxy features that
1496 may be disabled in your configuration. Tests with a level below
1497 7 are supposed to work with all Privoxy configurations (provided
1498 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1500 Tests with level 9 require Privoxy to deliver the User Manual,
1501 tests with level 12 require the CGI editor to be enabled.
1505 Expect the configuration file syntax to change with future releases.
1509 As Privoxy's B<show-request> page only shows client headers,
1510 Privoxy-Regression-Test can't use it to test Privoxy actions
1511 that modify server headers.
1513 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1514 control the actions to test, it currently only works with
1515 Privoxy 3.0.7 or later.
1517 At the moment Privoxy-Regression-Test fetches Privoxy's
1518 configuration page through I<curl>(1), therefore you have to
1519 have I<curl> installed, otherwise you won't be able to run
1520 Privoxy-Regression-Test in a meaningful way.
1528 Fabian Keil <fk@fabiankeil.de>