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.102 2008/01/18 18:30:25 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 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;
163 $curl_url .= $privoxy_cgi_url;
164 $curl_url .= 'show-status';
166 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
168 foreach (@{get_cgi_page_or_else($curl_url)}) {
170 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
172 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
173 $actionfiles[$file_number++] = $url;
177 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
179 load_action_files(\@actionfiles);
182 sub token_starts_new_test ($) {
185 my @new_test_directives =
186 ('set header', 'fetch test', 'trusted cgi request', 'request header', 'method test');
188 foreach my $new_test_directive (@new_test_directives) {
189 return 1 if $new_test_directive eq $token;
197 my ($token, $value) = (undef, undef);
199 # Remove leading and trailing white space.
203 # Reverse HTML-encoding
204 # XXX: Seriously imcomplete.
208 if (/^\#\s*([^=]*?)\s*[=]\s*(.*?)\s*$/) {
211 $token =~ tr/[A-Z]/[a-z]/;
214 } elsif (/^TAG\s*:(.*)$/) {
221 return ($token, $value);
224 sub load_action_files ($) {
228 our @regression_tests;
230 my $actionfiles_ref = shift;
231 my @actionfiles = @{$actionfiles_ref};
234 my $si = 0; # Section index
235 my $ri = -1; # Regression test index
236 my $number_of_regression_tests = 0;
240 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
242 for my $file_number (0 .. @actionfiles - 1) {
244 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
245 my $actionfile = undef;
247 foreach (@{get_cgi_page_or_else($curl_url)}) {
252 if (/<h2>Contents of Actions File (.*?)</) {
256 next unless defined $actionfile;
260 my ($token, $value) = tokenize($_);
262 next unless defined $token;
264 # Load regression tests
266 if (token_starts_new_test($token)) {
268 # Beginning of new regression test.
270 $number_of_regression_tests++;
272 l(LL_FILE_LOADING, "Regression test " . $number_of_regression_tests . " (section:" . $si . "):");
274 if ($token eq 'set header') {
276 l(LL_FILE_LOADING, "Header to set: " . $value);
277 $regression_tests[$si][$ri]{'type'} = CLIENT_HEADER_TEST;
279 $regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST;
281 } elsif ($token eq 'request header') {
283 l(LL_FILE_LOADING, "Header to request: " . $value);
284 $regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST;
286 $regression_tests[$si][$ri]{'expected-status-code'} = 200;
287 $regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST;
289 } elsif ($token eq 'trusted cgi request') {
291 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
292 $regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST;
294 $regression_tests[$si][$ri]{'expected-status-code'} = 200;
295 $regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST;
297 } elsif ($token eq 'fetch test') {
299 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
300 $regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST;
302 $regression_tests[$si][$ri]{'expected-status-code'} = 200;
303 $regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST;
305 } elsif ($token eq 'method test') {
307 l(LL_FILE_LOADING, "Method to test: " . $value);
308 $regression_tests[$si][$ri]{'type'} = METHOD_TEST;
310 $regression_tests[$si][$ri]{'expected-status-code'} = 200;
311 $regression_tests[$si][$ri]{'level'} = METHOD_TEST;
315 die "Incomplete '" . $token . "' support detected.";
319 check_for_forbidden_characters($value);
321 $regression_tests[$si][$ri]{'data'} = $value;
323 # For function that only get passed single tests
324 $regression_tests[$si][$ri]{'section-id'} = $si;
325 $regression_tests[$si][$ri]{'regression-test-id'} = $ri;
326 $regression_tests[$si][$ri]{'file'} = $actionfile;
330 if ($si == -1 || $ri == -1) {
331 # No beginning of a test detected yet,
332 # so we don't care about any other test
337 if ($token eq 'expect header') {
339 l(LL_FILE_LOADING, "Detected expectation: " . $value);
340 $regression_tests[$si][$ri]{'expect-header'} = $value;
342 } elsif ($token eq 'tag') {
346 my $tag = parse_tag($value);
348 # We already checked in parse_tag() after filtering
351 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
353 # Save tag for all tests in this section
355 $regression_tests[$si][$ri]{'tag'} = $tag;
361 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
363 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
364 $regression_tests[$si][$ri]{'ignore'} = 1;
367 } elsif ($token eq 'expect status code') {
369 l(LL_FILE_LOADING, "Expecting status code: " . $value);
370 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
372 } elsif ($token eq 'level') { # XXX: stupid name
374 $value =~ s@(\d+).*@$1@;
375 l(LL_FILE_LOADING, "Level: " . $value);
376 $regression_tests[$si][$ri]{'level'} = $value;
378 } elsif ($token eq 'method') {
380 l(LL_FILE_LOADING, "Method: " . $value);
381 $regression_tests[$si][$ri]{'method'} = $value;
383 # We don't use it, so we don't need
387 check_for_forbidden_characters($value) unless $no_checks;
388 check_for_forbidden_characters($token);
392 l(LL_FILE_LOADING, "Done loading " . $number_of_regression_tests . " regression tests."
393 . " Of which " . $ignored. " will be ignored)\n");
396 ############################################################################
398 # Regression test executing functions
400 ############################################################################
402 sub execute_regression_tests () {
404 our @regression_tests;
405 my $loops = get_cli_option('loops');
407 my $all_failures = 0;
408 my $all_successes = 0;
410 unless (@regression_tests) {
412 l(LL_STATUS, "No regression tests found.");
416 l(LL_STATUS, "Executing regression tests ...");
418 while ($loops-- > 0) {
426 for my $s (0 .. @regression_tests - 1) {
430 while (defined $regression_tests[$s][$r]) {
432 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
433 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
435 if ($regression_tests[$s][$r]{'ignore'}
436 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
437 or test_number_is_unacceptable($test_number)) {
443 my $result = execute_regression_test($regression_tests[$s][$r]);
445 log_result($regression_tests[$s][$r], $result, $tests);
447 $successes += $result;
454 $failures = $tests - $successes;
456 log_message("Executed " . $tests . " regression tests. " .
457 'Skipped ' . $skipped . '. ' .
458 $successes . " successes, " . $failures . " failures.");
460 $all_tests += $tests;
461 $all_failures += $failures;
462 $all_successes += $successes;
467 if (get_cli_option('loops') > 1) {
468 log_message("Total: Executed " . $all_tests . " regression tests. " .
469 $all_successes . " successes, " . $all_failures . " failures.");
473 sub level_is_unacceptable ($) {
475 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
476 or ($level < get_cli_option('min-level'))
477 or ($level > get_cli_option('max-level'))
481 sub test_number_is_unacceptable ($) {
482 my $test_number = shift;
483 return (cli_option_is_set('test-number')
484 and get_cli_option('test-number') != $test_number)
488 # XXX: somewhat misleading name
489 sub execute_regression_test ($) {
491 my $test_ref = shift;
492 my %test = %{$test_ref};
495 if ($test{'type'} == CLIENT_HEADER_TEST) {
497 $result = execute_client_header_regression_test($test_ref);
499 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
501 $result = execute_server_header_regression_test($test_ref);
503 } elsif ($test{'type'} == DUMB_FETCH_TEST
504 or $test{'type'} == TRUSTED_CGI_REQUEST) {
506 $result = execute_dumb_fetch_test($test_ref);
508 } elsif ($test{'type'} == METHOD_TEST) {
510 $result = execute_method_test($test_ref);
514 die "Unsuported test type detected: " . $test{'type'};
522 sub execute_method_test ($) {
524 my $test_ref = shift;
525 my %test = %{$test_ref};
529 my $method = $test{'data'};
531 my $curl_parameters = '';
532 my $expected_status_code = $test{'expected-status-code'};
534 if ($method =~ /HEAD/i) {
536 $curl_parameters .= '--head ';
540 $curl_parameters .= '-X ' . $method . ' ';
543 $curl_parameters .= PRIVOXY_CGI_URL;
545 $buffer_ref = get_page_with_curl($curl_parameters);
546 $status_code = get_status_code($buffer_ref);
548 $result = check_status_code_result($status_code, $expected_status_code);
554 sub execute_dumb_fetch_test ($) {
556 my $test_ref = shift;
557 my %test = %{$test_ref};
562 my $curl_parameters = '';
563 my $expected_status_code = $test{'expected-status-code'};
565 if (defined $test{method}) {
566 $curl_parameters .= '-X ' . $test{method} . ' ';
568 if ($test{type} == TRUSTED_CGI_REQUEST) {
569 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
572 $curl_parameters .= $test{'data'};
574 $buffer_ref = get_page_with_curl($curl_parameters);
575 $status_code = get_status_code($buffer_ref);
577 $result = check_status_code_result($status_code, $expected_status_code);
582 sub check_status_code_result ($$) {
584 my $status_code = shift;
585 my $expected_status_code = shift;
588 if ($expected_status_code == $status_code) {
591 l(LL_VERBOSE_SUCCESS,
592 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
594 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
596 l(LL_VERBOSE_FAILURE,
597 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
601 l(LL_VERBOSE_FAILURE,
602 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
609 sub execute_client_header_regression_test ($) {
611 my $test_ref = shift;
616 $buffer_ref = get_show_request_with_curl($test_ref);
618 $header = get_header($buffer_ref, $test_ref);
619 $result = check_header_result($test_ref, $header);
624 sub execute_server_header_regression_test ($) {
626 my $test_ref = shift;
631 $buffer_ref = get_head_with_curl($test_ref);
633 $header = get_server_header($buffer_ref, $test_ref);
634 $result = check_header_result($test_ref, $header);
640 sub interpret_result ($) {
642 return $success ? "Success" : "Failure";
645 sub check_header_result ($$) {
647 my $test_ref = shift;
650 my %test = %{$test_ref};
651 my $expect_header = $test{'expect-header'};
654 $header =~ s@ @ @g if defined($header);
656 if ($expect_header eq 'NO CHANGE') {
658 if (defined($header) and $header eq $test{'data'}) {
664 $header //= "REMOVAL";
665 l(LL_VERBOSE_FAILURE,
666 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
669 } elsif ($expect_header eq 'REMOVAL') {
671 if (defined($header) and $header eq $test{'data'}) {
673 l(LL_VERBOSE_FAILURE,
674 "Ooops. Expected removal but: " . $header . " is still there.");
678 # XXX: Use more reliable check here and make sure
679 # the header has a different name.
684 } elsif ($expect_header eq 'SOME CHANGE') {
686 if (defined($header) and not $header eq $test{'data'}) {
692 $header //= "REMOVAL";
693 l(LL_VERBOSE_FAILURE,
694 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
700 if (defined($header) and $header eq $expect_header) {
706 $header //= "'No matching header'"; # XXX: No header detected to be precise
707 l(LL_VERBOSE_FAILURE,
708 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
715 sub get_header_name ($) {
719 $header =~ s@(.*?: ).*@$1@;
724 sub get_header ($$) {
726 our $filtered_request = '';
728 my $buffer_ref = shift;
729 my $test_ref = shift;
731 my %test = %{$test_ref};
732 my @buffer = @{$buffer_ref};
734 my $expect_header = $test{'expect-header'};
737 my $processed_request_reached = 0;
739 my $processed_request = '';
743 if ($expect_header eq 'REMOVAL'
744 or $expect_header eq 'NO CHANGE'
745 or $expect_header eq 'SOME CHANGE') {
747 $expect_header = $test{'data'};
751 $header_to_get = get_header_name($expect_header);
755 # Skip everything before the Processed request
756 if (/Processed Request/) {
757 $processed_request_reached = 1;
760 next unless $processed_request_reached;
762 # End loop after the Processed request
765 # Ditch tags and leading/trailing white space.
769 $filtered_request .= "\n" . $_;
771 if (/^$header_to_get/) {
781 sub get_server_header ($$) {
783 my $buffer_ref = shift;
784 my $test_ref = shift;
786 my %test = %{$test_ref};
787 my @buffer = @{$buffer_ref};
789 my $expect_header = $test{'expect-header'};
793 if ($expect_header eq 'REMOVAL'
794 or $expect_header eq 'NO CHANGE'
795 or $expect_header eq 'SOME CHANGE') {
797 $expect_header = $test{'data'};
801 $header_to_get = get_header_name($expect_header);
805 # XXX: shoul probably verify that the request
806 # was actually answered by Fellatio.
807 if (/^$header_to_get/) {
809 $header =~ s@\s*$@@g;
817 sub get_header_to_check ($) {
819 # No longer in use but not removed yet.
821 my $buffer_ref = shift;
823 my @buffer = @{$buffer_ref};
825 my $processed_request_reached = 0;
827 my $processed_request = '';
829 l(LL_ERROR, "You are not supposed to use get_header_to_()!");
833 # Skip everything before the Processed request
834 if (/Processed Request/) {
835 $processed_request_reached = 1;
838 next unless $processed_request_reached;
840 # End loop after the Processed request
843 # Ditch tags and leading/trailing white space.
847 $processed_request .= $_;
849 if (/^X-Privoxy-Regression-Test/) {
864 sub get_status_code ($) {
866 my $buffer_ref = shift;
867 my @buffer = @{$buffer_ref};
871 if (/^HTTP\/\d\.\d (\d{3})/) {
877 return '123' if cli_option_is_set('fuzzer-feeding');
879 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
884 sub get_test_keys () {
885 return ('tag', 'data', 'expect-header', 'ignore');
889 sub test_content_as_string ($) {
891 my $test_ref = shift;
892 my %test = %{$test_ref};
896 foreach my $key (get_test_keys()) {
897 #$test{$key} = $test{$key} // 'undefined';
898 $test{$key} = 'Not set' unless (defined $test{$key});
901 $s .= 'Tag: ' . $test{'tag'};
903 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
905 $s .= 'Expected header: ' . $test{'expect-header'};
907 $s .= 'Ignore: ' . $test{'ignore'};
912 ############################################################################
914 # HTTP fetch functions
916 ############################################################################
918 sub check_for_curl () {
920 l(LL_ERROR, "No curl found.") unless (`which $curl`);
923 sub get_cgi_page_or_else ($) {
926 my $content_ref = get_page_with_curl($cgi_url);
927 my $status_code = get_status_code($content_ref);
929 if (200 != $status_code) {
931 my $log_message = "Failed to fetch Privoxy CGI Page. " .
932 "Received status code ". $status_code .
933 " while only 200 is acceptable.";
935 if (cli_option_is_set('fuzzer-feeding')) {
937 $log_message .= " Ignored due to fuzzer feeding.";
938 l(LL_SOFT_ERROR, $log_message)
942 l(LL_ERROR, $log_message);
950 sub get_show_request_with_curl ($) {
952 our $privoxy_cgi_url;
953 my $test_ref = shift;
954 my %test = %{$test_ref};
956 my $curl_parameters = ' ';
958 # Enable the action to test
959 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
960 # The header to filter
961 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
963 $curl_parameters .= ' ';
964 $curl_parameters .= $privoxy_cgi_url;
965 $curl_parameters .= 'show-request';
967 return get_cgi_page_or_else($curl_parameters);
971 sub get_head_with_curl ($) {
973 our $fellatio_url = FELLATIO_URL;
974 my $test_ref = shift;
975 my %test = %{$test_ref};
977 my $curl_parameters = ' ';
979 # Enable the action to test
980 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
981 # The header to filter
982 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
983 $curl_parameters .= '--head ';
985 $curl_parameters .= ' ';
986 $curl_parameters .= $fellatio_url;
988 return get_page_with_curl($curl_parameters);
992 sub get_page_with_curl ($) {
994 my $parameters = shift;
996 my $curl_line = CURL;
997 my $retries_left = get_cli_option('retries') + 1;
1000 if (cli_option_is_set('privoxy-address')) {
1001 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
1004 # Let Privoxy emit two log messages less.
1005 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1006 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1007 # We don't care about fetch statistic.
1008 $curl_line .= " -s ";
1009 # We do care about the failure reason if any.
1010 $curl_line .= " -S ";
1011 # We want to see the HTTP status code
1012 $curl_line .= " --include ";
1013 # We want to advertise ourselves
1014 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1015 # We aren't too patient
1016 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1018 $curl_line .= $parameters;
1019 # XXX: still necessary?
1020 $curl_line .= ' 2>&1';
1022 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1025 @buffer = `$curl_line`;
1028 $failure_reason = array_as_string(\@buffer);
1029 chomp $failure_reason;
1030 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1032 } while ($? && --$retries_left);
1034 unless ($retries_left) {
1036 "Running curl failed " . get_cli_option('retries') .
1037 " times in a row. Last error: '" . $failure_reason . "'.");
1044 ############################################################################
1048 ############################################################################
1050 sub array_as_string ($) {
1051 my $array_ref = shift;
1054 foreach (@{$array_ref}) {
1063 my $test_ref = shift;
1064 log_message('Test is:' . test_content_as_string($test_ref));
1070 my $this_level = shift;
1071 my $message = shift;
1073 return unless ($log_level & $this_level);
1075 if (LL_ERROR & $this_level) {
1076 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1079 log_message($message);
1081 if (LL_ERROR & $this_level) {
1086 sub log_message ($) {
1088 my $message = shift;
1092 our $leading_log_date;
1093 our $leading_log_time;
1095 my $time_stamp = '';
1096 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1098 if ($leading_log_date || $leading_log_time) {
1100 if ($leading_log_date) {
1103 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1106 if ($leading_log_time) {
1107 $time_stamp .= ' ' if $leading_log_date;
1108 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1111 $message = $time_stamp . ": " . $message;
1115 printf(STDERR "%s\n", $message);
1119 sub log_result ($$) {
1121 our $verbose_test_description;
1122 our $filtered_request;
1124 my $test_ref = shift;
1128 my %test = %{$test_ref};
1131 $message .= interpret_result($result);
1132 $message .= " for test ";
1133 $message .= $number;
1135 $message .= $test{'section-id'};
1137 $message .= $test{'regression-test-id'};
1140 if ($verbose_test_description) {
1142 if ($test{'type'} == CLIENT_HEADER_TEST) {
1144 $message .= ' Header ';
1145 $message .= quote($test{'data'});
1146 $message .= ' and tag ';
1147 $message .= quote($test{'tag'});
1149 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1151 $message .= ' Request Header ';
1152 $message .= quote($test{'data'});
1153 $message .= ' and tag ';
1154 $message .= quote($test{'tag'});
1156 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1158 $message .= ' URL ';
1159 $message .= quote($test{'data'});
1160 $message .= ' and expected status code ';
1161 $message .= quote($test{'expected-status-code'});
1163 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1165 $message .= ' CGI URL ';
1166 $message .= quote($test{'data'});
1167 $message .= ' and expected status code ';
1168 $message .= quote($test{'expected-status-code'});
1170 } elsif ($test{'type'} == METHOD_TEST) {
1172 $message .= ' HTTP method ';
1173 $message .= quote($test{'data'});
1174 $message .= ' and expected status code ';
1175 $message .= quote($test{'expected-status-code'});
1179 die "Incomplete support for test type " . $test{'type'} . " detected.";
1184 log_message($message) unless ($result && cli_option_is_set('silent'));
1189 return '\'' . $s . '\'';
1192 sub print_version () {
1193 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1204 Options and their default values if they have any:
1205 [--debug $cli_options{'debug'}]
1209 [--loops $cli_options{'loops'}]
1210 [--max-level $cli_options{'max-level'}]
1211 [--max-time $cli_options{'max-time'}]
1212 [--min-level $cli_options{'min-level'}]
1214 [--retries $cli_options{'retries'}]
1217 see "perldoc $0" for more information
1223 sub init_cli_options () {
1228 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1229 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1230 $cli_options{'debug'} = $log_level;
1231 $cli_options{'loops'} = CLI_LOOPS;
1232 $cli_options{'max-time'} = CLI_MAX_TIME;
1233 $cli_options{'retries'} = CLI_RETRIES;
1236 sub parse_cli_options () {
1244 'debug=s' => \$cli_options{'debug'},
1245 'help' => sub { help },
1246 'silent' => \$cli_options{'silent'},
1247 'min-level=s' => \$cli_options{'min-level'},
1248 'max-level=s' => \$cli_options{'max-level'},
1249 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1250 'level=s' => \$cli_options{'level'},
1251 'loops=s' => \$cli_options{'loops'},
1252 'test-number=s' => \$cli_options{'test-number'},
1253 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1254 'retries=s' => \$cli_options{'retries'},
1255 'max-time=s' => \$cli_options{'max-time'},
1256 'version' => sub { print_version && exit(0) }
1258 $log_level |= $cli_options{'debug'};
1261 sub cli_option_is_set ($) {
1264 my $cli_option = shift;
1266 return defined $cli_options{$cli_option};
1270 sub get_cli_option ($) {
1273 my $cli_option = shift;
1275 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1277 return $cli_options{$cli_option};
1283 init_our_variables();
1284 parse_cli_options();
1286 load_regressions_tests();
1287 execute_regression_tests();
1294 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1298 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1299 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1300 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1301 [B<--retries retries>] [B<--silent>] [B<--version>]
1305 Privoxy-Regression-Test is supposed to one day become
1306 a regression test suite for Privoxy. It's not quite there
1307 yet, however, and can currently only test client header
1308 actions and check the returned status code for requests
1311 Client header actions are tested by requesting
1312 B<http://config.privoxy.org/show-request> and checking whether
1313 or not Privoxy modified the original request as expected.
1315 The original request contains both the header the action-to-be-tested
1316 acts upon and an additional tagger-triggering header that enables
1319 =head1 CONFIGURATION FILE SYNTAX
1321 Privoxy-Regression-Test's configuration is embedded in
1322 Privoxy action files and loaded through Privoxy's web interface.
1324 It makes testing a Privoxy version running on a remote system easier
1325 and should prevent you from updating your tests without updating Privoxy's
1326 configuration accordingly.
1328 A client-header-action test section looks like this:
1330 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1331 # Expect Header = Referer: http://www.example.org/
1332 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1333 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1335 The example above causes Privoxy-Regression-Test to set
1336 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1337 and to expect it to be modified to
1338 B<Referer: http://www.example.org/>.
1340 When testing this section, Privoxy-Regression-Test will set the header
1341 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1342 causing the B<privoxy-control> tagger to create the tag
1343 B<client-header-filter{hide-tor-exit-notation}> which will finally
1344 cause Privoxy to enable the action section.
1346 Note that the actions itself are only used by Privoxy,
1347 Privoxy-Regression-Test ignores them and will be happy
1348 as long as the expectations are satisfied.
1350 A fetch test looks like this:
1352 # Fetch Test = http://p.p/user-manual
1353 # Expect Status Code = 302
1355 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1356 and to expect a response with the HTTP status code B<302>. Obviously that's
1357 not a very thorough test and mainly useful to get some code coverage
1358 for Valgrind or to verify that the templates are installed correctly.
1360 If you want to test CGI pages that require a trusted
1361 referer, you can use:
1363 # Trusted CGI Request = http://p.p/edit-actions
1365 It works like ordinary fetch tests, but sets the referer
1366 header to a trusted value.
1368 If no explicit status code expectation is set, B<200> is used.
1370 Additionally all tests have test levels to let the user
1371 control which ones to execute (see I<OPTIONS> below).
1372 Test levels are either set with the B<Level> directive,
1373 or implicitly through the test type.
1375 Fetch tests default to level 6, tests for trusted
1376 CGI requests to level 3 and client-header-action tests
1381 B<--debug bitmask> Add the bitmask provided as integer
1382 to the debug settings.
1384 B<--fuzzer-feeding> Ignore some errors that would otherwise
1385 cause Privoxy-Regression-Test to abort the test because
1386 they shouldn't happen in normal operation. This option is
1387 intended to be used if Privoxy-Regression-Test is only
1388 used to feed a fuzzer in which case there's a high chance
1389 that Privoxy gets an invalid request and returns an error
1392 B<--help> Shows available command line options.
1394 B<--level level> Only execute tests with the specified B<level>.
1396 B<--loop count> Loop through the regression tests B<count> times.
1397 Useful to feed a fuzzer, or when doing stress tests with
1398 several Privoxy-Regression-Test instances running at the same
1401 B<--max-level max-level> Only execute tests with a B<level>
1402 below or equal to the numerical B<max-level>.
1404 B<--max-time max-time> Give Privoxy B<max-time> seconds
1405 to return data. Increasing the default may make sense when
1406 Privoxy is run through Valgrind, decreasing the default may
1407 make sense when Privoxy-Regression-Test is used to feed
1410 B<--min-level min-level> Only execute tests with a B<level>
1411 above or equal to the numerical B<min-level>.
1413 B<--privoxy-address proxy-address> Privoxy's listening address.
1414 If it's not set, the value of the environment variable http_proxy
1415 will be used. B<proxy-address> has to be specified in http_proxy
1418 B<--retries retries> Retry B<retries> times.
1420 B<--silent> Don't log succesful test runs.
1422 B<--version> Print version and exit.
1424 The second dash is optional, options can be shortened,
1425 as long as there are no ambiguities.
1427 =head1 PRIVOXY CONFIGURATION
1429 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1430 which aims to test all official client-header modifying actions
1431 and can be used to verify that the templates and the user manual
1432 files are installed correctly.
1434 To use it, it has to be copied in Privoxy's configuration
1435 directory, and afterwards referenced in Privoxy's configuration
1438 actionsfile regression-tests.action
1440 In general, its tests are supposed to work without changing
1441 any other action files, unless you already added lots of
1442 taggers yourself. If you are using taggers that cause problems,
1443 you might have to temporary disable them for Privoxy's CGI pages.
1445 Some of the regression tests rely on Privoxy features that
1446 may be disabled in your configuration. Tests with a level below
1447 7 are supposed to work with all Privoxy configurations (provided
1448 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1450 Tests with level 9 require Privoxy to deliver the User Manual,
1451 tests with level 12 require the CGI editor to be enabled.
1455 Expect the configuration file syntax to change with future releases.
1459 As Privoxy's B<show-request> page only shows client headers,
1460 Privoxy-Regression-Test can't use it to test Privoxy actions
1461 that modify server headers.
1463 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1464 control the actions to test, it currently only works with
1465 Privoxy 3.0.7 or later.
1467 At the moment Privoxy-Regression-Test fetches Privoxy's
1468 configuration page through I<curl>(1), therefore you have to
1469 have I<curl> installed, otherwise you won't be able to run
1470 Privoxy-Regression-Test in a meaningful way.
1478 Fabian Keil <fk@fabiankeil.de>