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.149 2008/05/17 14:11:29 fk Exp $
14 # - Update documentation
15 # - Validate HTTP times.
16 # - Implement a HTTP_VERSION directive or allow to
17 # specify whole request lines.
18 # - Support filter regression tests.
19 # - Add option to fork regression tests and run them in parallel,
20 # possibly optional forever.
21 # - Document magic Expect Header values
22 # - Internal fuzz support?
24 # Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
26 # Permission to use, copy, modify, and distribute this software for any
27 # purpose with or without fee is hereby granted, provided that the above
28 # copyright notice and this permission notice appear in all copies.
30 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
31 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
32 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
33 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
35 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
36 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
38 ############################################################################
45 PRT_VERSION => 'Privoxy-Regression-Test 0.2',
56 PRIVOXY_CGI_URL => 'http://p.p/',
57 FELLATIO_URL => 'http://10.0.0.1:8080/',
58 LEADING_LOG_DATE => 1,
59 LEADING_LOG_TIME => 1,
61 DEBUG_LEVEL_FILE_LOADING => 0,
62 DEBUG_LEVEL_PAGE_FETCHING => 0,
64 VERBOSE_TEST_DESCRIPTION => 1,
66 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
67 # XXX: Only partly implemented and mostly useless.
68 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
69 DEBUG_LEVEL_STATUS => 1,
71 # Internal use, don't modify
72 # Available debug bits:
74 LL_VERBOSE_FAILURE => 2,
75 LL_PAGE_FETCHING => 4,
77 LL_VERBOSE_SUCCESS => 16,
81 CLIENT_HEADER_TEST => 1,
82 SERVER_HEADER_TEST => 2,
85 STICKY_ACTIONS_TEST => 5,
86 TRUSTED_CGI_REQUEST => 6,
90 sub init_our_variables () {
92 our $leading_log_time = LEADING_LOG_TIME;
93 our $leading_log_date = LEADING_LOG_DATE;
95 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
97 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
99 our $log_level = get_default_log_level();
103 sub get_default_log_level () {
107 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
108 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
109 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
110 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
111 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
113 # These are intended to be always on.
114 $log_level |= LL_SOFT_ERROR;
115 $log_level |= LL_ERROR;
120 ############################################################################
122 # File loading functions
124 ############################################################################
132 # Unescape brackets and dots
133 $tag =~ s@\\(?=[{}().+])@@g;
135 # log_message("Parsed tag: " . $tag);
137 check_for_forbidden_characters($tag);
142 sub check_for_forbidden_characters ($) {
144 my $tag = shift; # XXX: also used to check values though.
145 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
147 unless ($tag =~ m/^$allowed*$/) {
148 my $forbidden = $tag;
149 $forbidden =~ s@^$allowed*(.).*@$1@;
151 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
155 sub load_regressions_tests () {
157 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)}) {
171 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
173 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
174 $actionfiles[$file_number++] = $url;
176 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
178 my $directive = $1 . " " . $2;
179 push (@privoxy_config, $directive);
183 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
185 load_action_files(\@actionfiles);
188 sub token_starts_new_test ($) {
191 my @new_test_directives = ('set header', 'fetch test',
192 'trusted cgi request', 'request header', 'method test',
193 'blocked url', 'url');
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.
216 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
221 $token =~ s@\s\s+@ @g;
222 $token =~ tr/[A-Z]/[a-z]/;
224 } elsif (/^TAG\s*:(.*)$/) {
231 return ($token, $value);
234 sub enlist_new_test ($$$$$$) {
236 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
239 if ($token eq 'set header') {
241 l(LL_FILE_LOADING, "Header to set: " . $value);
242 $type = CLIENT_HEADER_TEST;
244 } elsif ($token eq 'request header') {
246 l(LL_FILE_LOADING, "Header to request: " . $value);
247 $type = SERVER_HEADER_TEST;
248 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
250 } elsif ($token eq 'trusted cgi request') {
252 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
253 $type = TRUSTED_CGI_REQUEST;
254 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
256 } elsif ($token eq 'fetch test') {
258 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
259 $type = DUMB_FETCH_TEST;
260 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
262 } elsif ($token eq 'method test') {
264 l(LL_FILE_LOADING, "Method to test: " . $value);
266 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
268 } elsif ($token eq 'blocked url') {
270 l(LL_FILE_LOADING, "URL to block-test: " . $value);
273 } elsif ($token eq 'url') {
275 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
276 $type = STICKY_ACTIONS_TEST;
280 die "Incomplete '" . $token . "' support detected.";
284 $$regression_tests[$si][$ri]{'type'} = $type;
285 $$regression_tests[$si][$ri]{'level'} = $type;
287 check_for_forbidden_characters($value);
289 $$regression_tests[$si][$ri]{'data'} = $value;
291 # For function that only get passed single tests
292 $$regression_tests[$si][$ri]{'section-id'} = $si;
293 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
294 $$regression_tests[$si][$ri]{'number'} = $number - 1;
296 "Regression test " . $number . " (section:" . $si . "):");
299 sub load_action_files ($) {
303 our @regression_tests;
305 my $actionfiles_ref = shift;
306 my @actionfiles = @{$actionfiles_ref};
308 my $si = 0; # Section index
309 my $ri = -1; # Regression test index
314 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
316 for my $file_number (0 .. @actionfiles - 1) {
318 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
319 my $actionfile = undef;
320 my $sticky_actions = undef;
322 foreach (@{get_cgi_page_or_else($curl_url)}) {
327 if (/<h2>Contents of Actions File (.*?)</) {
331 next unless defined $actionfile;
335 my ($token, $value) = tokenize($_);
337 next unless defined $token;
339 # Load regression tests
341 if (token_starts_new_test($token)) {
343 # Beginning of new regression test.
346 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
349 if ($token =~ /level\s+(\d+)/i) {
352 register_dependency($level, $value);
355 if ($token eq 'sticky actions') {
357 # Will be used by each following Sticky URL.
358 $sticky_actions = $value;
359 if ($sticky_actions =~ /{[^}]*\s/) {
361 "'Sticky Actions' with whitespace inside the " .
362 "action parameters are currently unsupported.");
366 if ($si == -1 || $ri == -1) {
367 # No beginning of a test detected yet,
368 # so we don't care about any other test
373 if ($token eq 'expect header') {
375 l(LL_FILE_LOADING, "Detected expectation: " . $value);
376 $regression_tests[$si][$ri]{'expect-header'} = $value;
378 } elsif ($token eq 'tag') {
382 my $tag = parse_tag($value);
384 # We already checked in parse_tag() after filtering
387 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
389 # Save tag for all tests in this section
391 $regression_tests[$si][$ri]{'tag'} = $tag;
397 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
399 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
400 $regression_tests[$si][$ri]{'ignore'} = 1;
403 } elsif ($token eq 'expect status code') {
405 l(LL_FILE_LOADING, "Expecting status code: " . $value);
406 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
408 } elsif ($token eq 'level') { # XXX: stupid name
410 $value =~ s@(\d+).*@$1@;
411 l(LL_FILE_LOADING, "Level: " . $value);
412 $regression_tests[$si][$ri]{'level'} = $value;
414 } elsif ($token eq 'method') {
416 l(LL_FILE_LOADING, "Method: " . $value);
417 $regression_tests[$si][$ri]{'method'} = $value;
419 } elsif ($token eq 'url') {
421 if (defined $sticky_actions) {
422 die "WTF? Attempted to overwrite Sticky Actions"
423 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
425 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
426 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
428 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
433 # We don't use it, so we don't need
437 check_for_forbidden_characters($value) unless $no_checks;
438 check_for_forbidden_characters($token);
442 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
443 . " Of which " . $ignored. " will be ignored)\n");
446 ############################################################################
448 # Regression test executing functions
450 ############################################################################
452 sub execute_regression_tests () {
454 our @regression_tests;
455 my $loops = get_cli_option('loops');
457 my $all_failures = 0;
458 my $all_successes = 0;
460 unless (@regression_tests) {
462 l(LL_STATUS, "No regression tests found.");
466 l(LL_STATUS, "Executing regression tests ...");
468 while ($loops-- > 0) {
475 for my $s (0 .. @regression_tests - 1) {
479 while (defined $regression_tests[$s][$r]) {
481 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
482 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
484 my $number = $regression_tests[$s][$r]{'number'};
486 if ($regression_tests[$s][$r]{'ignore'}
487 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
488 or test_number_is_unacceptable($number)) {
494 my $result = execute_regression_test($regression_tests[$s][$r]);
496 log_result($regression_tests[$s][$r], $result, $tests);
498 $successes += $result;
504 $failures = $tests - $successes;
506 log_message("Executed " . $tests . " regression tests. " .
507 'Skipped ' . $skipped . '. ' .
508 $successes . " successes, " . $failures . " failures.");
510 $all_tests += $tests;
511 $all_failures += $failures;
512 $all_successes += $successes;
516 if (get_cli_option('loops') > 1) {
517 log_message("Total: Executed " . $all_tests . " regression tests. " .
518 $all_successes . " successes, " . $all_failures . " failures.");
522 sub level_is_unacceptable ($) {
524 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
525 or ($level < get_cli_option('min-level'))
526 or ($level > get_cli_option('max-level'))
527 or dependency_unsatisfied($level)
531 sub test_number_is_unacceptable ($) {
532 my $test_number = shift;
533 return (cli_option_is_set('test-number')
534 and get_cli_option('test-number') != $test_number)
537 sub dependency_unsatisfied ($) {
542 my $dependency_problem = 0;
544 if (defined ($dependencies{$level}{'config line'})) {
546 my $dependency = $dependencies{$level}{'config line'};
547 $dependency_problem = 1;
549 foreach (@privoxy_config) {
551 $dependency_problem = 0 if (/$dependency/);
555 return $dependency_problem;
558 sub register_dependency ($$) {
561 my $dependency = shift;
564 if ($dependency =~ /config line\s+(.*)/) {
566 $dependencies{$level}{'config line'} = $1;
570 # XXX: somewhat misleading name
571 sub execute_regression_test ($) {
573 my $test_ref = shift;
574 my %test = %{$test_ref};
577 if ($test{'type'} == CLIENT_HEADER_TEST) {
579 $result = execute_client_header_regression_test($test_ref);
581 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
583 $result = execute_server_header_regression_test($test_ref);
585 } elsif ($test{'type'} == DUMB_FETCH_TEST
586 or $test{'type'} == TRUSTED_CGI_REQUEST) {
588 $result = execute_dumb_fetch_test($test_ref);
590 } elsif ($test{'type'} == METHOD_TEST) {
592 $result = execute_method_test($test_ref);
594 } elsif ($test{'type'} == BLOCK_TEST) {
596 $result = execute_block_test($test_ref);
598 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
600 $result = execute_sticky_actions_test($test_ref);
604 die "Unsupported test type detected: " . $test{'type'};
611 sub execute_method_test ($) {
613 my $test_ref = shift;
614 my %test = %{$test_ref};
617 my $method = $test{'data'};
619 my $curl_parameters = '';
620 my $expected_status_code = $test{'expected-status-code'};
622 $curl_parameters .= '--request ' . $method . ' ';
623 # Don't complain about the 'missing' body
624 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
626 $curl_parameters .= PRIVOXY_CGI_URL;
628 $buffer_ref = get_page_with_curl($curl_parameters);
629 $status_code = get_status_code($buffer_ref);
631 return check_status_code_result($status_code, $expected_status_code);
634 sub execute_dumb_fetch_test ($) {
636 my $test_ref = shift;
637 my %test = %{$test_ref};
641 my $curl_parameters = '';
642 my $expected_status_code = $test{'expected-status-code'};
644 if (defined $test{method}) {
645 $curl_parameters .= '--request ' . $test{method} . ' ';
647 if ($test{type} == TRUSTED_CGI_REQUEST) {
648 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
651 $curl_parameters .= $test{'data'};
653 $buffer_ref = get_page_with_curl($curl_parameters);
654 $status_code = get_status_code($buffer_ref);
656 return check_status_code_result($status_code, $expected_status_code);
659 sub execute_block_test ($) {
662 my $url = $test->{'data'};
663 my $final_results = get_final_results($url);
665 return defined $final_results->{'+block'};
668 sub execute_sticky_actions_test ($) {
671 my $url = $test->{'data'};
672 my $verified_actions = 0;
673 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
674 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
675 my $final_results = get_final_results($url);
677 foreach my $sticky_action (@sticky_actions) {
678 if (defined $final_results->{$sticky_action}) {
681 }elsif ($sticky_action =~ /-.*\{/ and
682 not defined $final_results->{$sticky_action}) {
683 # Disabled multi actions aren't explicitly listed as
684 # disabled and thus have to be checked by verifying
685 # that they aren't enabled.
688 l(LL_VERBOSE_FAILURE,
689 "Ooops. '$sticky_action' is not among the final results.");
693 return $verified_actions == @sticky_actions;
696 sub get_final_results ($) {
699 my $curl_parameters = '';
700 my %final_results = ();
701 my $final_results_reached = 0;
703 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
704 # XXX: should be URL-encoded properly
711 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
713 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
715 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
717 next unless ($final_results_reached);
720 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
724 if (defined $parameter) {
725 # In case the caller needs to check
726 # the action and its parameter
727 $final_results{$action . $parameter} = 1;
729 # In case the action doesn't have parameters
730 # or the caller doesn't care for the parameter.
731 $final_results{$action} = 1;
735 return \%final_results;
738 sub check_status_code_result ($$) {
740 my $status_code = shift;
741 my $expected_status_code = shift;
744 if ($expected_status_code == $status_code) {
747 l(LL_VERBOSE_SUCCESS,
748 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
750 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
752 l(LL_VERBOSE_FAILURE,
753 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
757 l(LL_VERBOSE_FAILURE,
758 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
765 sub execute_client_header_regression_test ($) {
767 my $test_ref = shift;
771 $buffer_ref = get_show_request_with_curl($test_ref);
773 $header = get_header($buffer_ref, $test_ref);
775 return check_header_result($test_ref, $header);
778 sub execute_server_header_regression_test ($) {
780 my $test_ref = shift;
784 $buffer_ref = get_head_with_curl($test_ref);
786 $header = get_server_header($buffer_ref, $test_ref);
788 return check_header_result($test_ref, $header);
792 sub interpret_result ($) {
794 return $success ? "Success" : "Failure";
797 sub check_header_result ($$) {
799 my $test_ref = shift;
802 my %test = %{$test_ref};
803 my $expect_header = $test{'expect-header'};
806 if ($expect_header eq 'NO CHANGE') {
808 if (defined($header) and $header eq $test{'data'}) {
814 $header = "REMOVAL" unless defined $header;
815 l(LL_VERBOSE_FAILURE,
816 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
819 } elsif ($expect_header eq 'REMOVAL') {
821 if (defined($header) and $header eq $test{'data'}) {
823 l(LL_VERBOSE_FAILURE,
824 "Ooops. Expected removal but: " . $header . " is still there.");
828 # XXX: Use more reliable check here and make sure
829 # the header has a different name.
834 } elsif ($expect_header eq 'SOME CHANGE') {
836 if (defined($header) and not $header eq $test{'data'}) {
842 $header = "REMOVAL" unless defined $header;
843 l(LL_VERBOSE_FAILURE,
844 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
850 if (defined($header) and $header eq $expect_header) {
856 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
857 l(LL_VERBOSE_FAILURE,
858 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
864 sub get_header_name ($) {
868 $header =~ s@(.*?: ).*@$1@;
873 sub get_header ($$) {
875 our $filtered_request = '';
877 my $buffer_ref = shift;
878 my $test_ref = shift;
880 my %test = %{$test_ref};
881 my @buffer = @{$buffer_ref};
883 my $expect_header = $test{'expect-header'};
885 die "get_header called with no expect header" unless defined $expect_header;
888 my $processed_request_reached = 0;
890 my $processed_request = '';
894 if ($expect_header eq 'REMOVAL'
895 or $expect_header eq 'NO CHANGE'
896 or $expect_header eq 'SOME CHANGE') {
898 $expect_header = $test{'data'};
902 $header_to_get = get_header_name($expect_header);
906 # Skip everything before the Processed request
907 if (/Processed Request/) {
908 $processed_request_reached = 1;
911 next unless $processed_request_reached;
913 # End loop after the Processed request
916 # Ditch tags and leading/trailing white space.
920 # Decode characters we care about.
923 $filtered_request .= "\n" . $_;
925 if (/^$header_to_get/) {
935 sub get_server_header ($$) {
937 my $buffer_ref = shift;
938 my $test_ref = shift;
940 my %test = %{$test_ref};
941 my @buffer = @{$buffer_ref};
943 my $expect_header = $test{'expect-header'};
947 # XXX: Should be caught before starting to test.
948 l(LL_ERROR, "No expect header for test " . $test{'number'})
949 unless defined $expect_header;
951 if ($expect_header eq 'REMOVAL'
952 or $expect_header eq 'NO CHANGE'
953 or $expect_header eq 'SOME CHANGE') {
955 $expect_header = $test{'data'};
959 $header_to_get = get_header_name($expect_header);
963 # XXX: should probably verify that the request
964 # was actually answered by Fellatio.
965 if (/^$header_to_get/) {
967 $header =~ s@\s*$@@g;
975 sub get_status_code ($) {
977 my $buffer_ref = shift;
978 my @buffer = @{$buffer_ref};
982 if (/^HTTP\/\d\.\d (\d{3})/) {
988 return '123' if cli_option_is_set('fuzzer-feeding');
990 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
995 sub get_test_keys () {
996 return ('tag', 'data', 'expect-header', 'ignore');
1000 sub test_content_as_string ($) {
1002 my $test_ref = shift;
1003 my %test = %{$test_ref};
1007 foreach my $key (get_test_keys()) {
1008 $test{$key} = 'Not set' unless (defined $test{$key});
1011 $s .= 'Tag: ' . $test{'tag'};
1013 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1015 $s .= 'Expected header: ' . $test{'expect-header'};
1017 $s .= 'Ignore: ' . $test{'ignore'};
1022 ############################################################################
1024 # HTTP fetch functions
1026 ############################################################################
1028 sub check_for_curl () {
1030 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1033 sub get_cgi_page_or_else ($) {
1035 my $cgi_url = shift;
1036 my $content_ref = get_page_with_curl($cgi_url);
1037 my $status_code = get_status_code($content_ref);
1039 if (200 != $status_code) {
1041 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1042 "Received status code ". $status_code .
1043 " while only 200 is acceptable.";
1045 if (cli_option_is_set('fuzzer-feeding')) {
1047 $log_message .= " Ignored due to fuzzer feeding.";
1048 l(LL_SOFT_ERROR, $log_message)
1052 l(LL_ERROR, $log_message);
1057 return $content_ref;
1060 sub get_show_request_with_curl ($) {
1062 our $privoxy_cgi_url;
1063 my $test_ref = shift;
1064 my %test = %{$test_ref};
1066 my $curl_parameters = ' ';
1068 # Enable the action to test
1069 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1070 # The header to filter
1071 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1073 $curl_parameters .= ' ';
1074 $curl_parameters .= $privoxy_cgi_url;
1075 $curl_parameters .= 'show-request';
1077 return get_cgi_page_or_else($curl_parameters);
1081 sub get_head_with_curl ($) {
1083 our $fellatio_url = FELLATIO_URL;
1084 my $test_ref = shift;
1085 my %test = %{$test_ref};
1087 my $curl_parameters = ' ';
1089 # Enable the action to test
1090 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1091 # The header to filter
1092 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1093 $curl_parameters .= '--head ';
1095 $curl_parameters .= ' ';
1096 $curl_parameters .= $fellatio_url;
1098 return get_page_with_curl($curl_parameters);
1102 sub get_page_with_curl ($) {
1106 my $parameters = shift;
1108 my $curl_line = CURL;
1109 my $retries_left = get_cli_option('retries') + 1;
1112 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1114 # We want to see the HTTP status code
1115 $curl_line .= " --include ";
1116 # Let Privoxy emit two log messages less.
1117 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1118 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1119 # We don't care about fetch statistic.
1120 $curl_line .= " -s ";
1121 # We do care about the failure reason if any.
1122 $curl_line .= " -S ";
1123 # We want to advertise ourselves
1124 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1125 # We aren't too patient
1126 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1128 $curl_line .= $parameters;
1129 # XXX: still necessary?
1130 $curl_line .= ' 2>&1';
1132 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1135 @buffer = `$curl_line`;
1138 $failure_reason = array_as_string(\@buffer);
1139 chomp $failure_reason;
1140 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1142 } while ($? && --$retries_left);
1144 unless ($retries_left) {
1146 "Running curl failed " . get_cli_option('retries') .
1147 " times in a row. Last error: '" . $failure_reason . "'.");
1154 ############################################################################
1158 ############################################################################
1160 sub array_as_string ($) {
1161 my $array_ref = shift;
1164 foreach (@{$array_ref}) {
1173 my $test_ref = shift;
1174 log_message('Test is:' . test_content_as_string($test_ref));
1180 my $this_level = shift;
1181 my $message = shift;
1183 return unless ($log_level & $this_level);
1185 if (LL_ERROR & $this_level) {
1186 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1189 log_message($message);
1191 if (LL_ERROR & $this_level) {
1196 sub log_message ($) {
1198 my $message = shift;
1202 our $leading_log_date;
1203 our $leading_log_time;
1205 my $time_stamp = '';
1206 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1208 if ($leading_log_date || $leading_log_time) {
1210 if ($leading_log_date) {
1213 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1216 if ($leading_log_time) {
1217 $time_stamp .= ' ' if $leading_log_date;
1218 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1221 $message = $time_stamp . ": " . $message;
1225 printf(STDERR "%s\n", $message);
1229 sub log_result ($$) {
1231 our $verbose_test_description;
1232 our $filtered_request;
1234 my $test_ref = shift;
1238 my %test = %{$test_ref};
1241 $message .= interpret_result($result);
1242 $message .= " for test ";
1243 $message .= $number;
1245 $message .= $test{'number'};
1247 $message .= $test{'section-id'};
1249 $message .= $test{'regression-test-id'};
1252 if ($verbose_test_description) {
1254 if ($test{'type'} == CLIENT_HEADER_TEST) {
1256 $message .= ' Header ';
1257 $message .= quote($test{'data'});
1258 $message .= ' and tag ';
1259 $message .= quote($test{'tag'});
1261 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1263 $message .= ' Request Header ';
1264 $message .= quote($test{'data'});
1265 $message .= ' and tag ';
1266 $message .= quote($test{'tag'});
1268 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1270 $message .= ' URL ';
1271 $message .= quote($test{'data'});
1272 $message .= ' and expected status code ';
1273 $message .= quote($test{'expected-status-code'});
1275 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1277 $message .= ' CGI URL ';
1278 $message .= quote($test{'data'});
1279 $message .= ' and expected status code ';
1280 $message .= quote($test{'expected-status-code'});
1282 } elsif ($test{'type'} == METHOD_TEST) {
1284 $message .= ' HTTP method ';
1285 $message .= quote($test{'data'});
1286 $message .= ' and expected status code ';
1287 $message .= quote($test{'expected-status-code'});
1289 } elsif ($test{'type'} == BLOCK_TEST) {
1291 $message .= ' Supposedly-blocked URL: ';
1292 $message .= quote($test{'data'});
1294 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1296 $message .= ' Sticky Actions: ';
1297 $message .= quote($test{'sticky-actions'});
1298 $message .= ' and URL: ';
1299 $message .= quote($test{'data'});
1303 die "Incomplete support for test type " . $test{'type'} . " detected.";
1308 log_message($message) if (!$result or cli_option_is_set('verbose'));
1313 return '\'' . $s . '\'';
1316 sub print_version () {
1317 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1328 Options and their default values if they have any:
1329 [--debug $cli_options{'debug'}]
1334 [--loops $cli_options{'loops'}]
1335 [--max-level $cli_options{'max-level'}]
1336 [--max-time $cli_options{'max-time'}]
1337 [--min-level $cli_options{'min-level'}]
1339 [--retries $cli_options{'retries'}]
1342 see "perldoc $0" for more information
1348 sub init_cli_options () {
1353 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1354 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1355 $cli_options{'debug'} = $log_level;
1356 $cli_options{'loops'} = CLI_LOOPS;
1357 $cli_options{'max-time'} = CLI_MAX_TIME;
1358 $cli_options{'retries'} = CLI_RETRIES;
1361 sub parse_cli_options () {
1369 'debug=s' => \$cli_options{'debug'},
1370 'help' => sub { help },
1371 'min-level=s' => \$cli_options{'min-level'},
1372 'max-level=s' => \$cli_options{'max-level'},
1373 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1374 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1375 'level=s' => \$cli_options{'level'},
1376 'loops=s' => \$cli_options{'loops'},
1377 'test-number=s' => \$cli_options{'test-number'},
1378 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1379 'retries=s' => \$cli_options{'retries'},
1380 'max-time=s' => \$cli_options{'max-time'},
1381 'verbose' => \$cli_options{'verbose'},
1382 'version' => sub { print_version && exit(0) }
1384 $log_level |= $cli_options{'debug'};
1387 sub cli_option_is_set ($) {
1390 my $cli_option = shift;
1392 return defined $cli_options{$cli_option};
1395 sub get_cli_option ($) {
1398 my $cli_option = shift;
1400 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1402 return $cli_options{$cli_option};
1405 sub init_proxy_settings($) {
1410 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1411 $proxy = get_cli_option('fuzzer-address');
1414 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1416 if (cli_option_is_set('privoxy-address')) {
1417 $proxy .= get_cli_option('privoxy-address');
1425 init_our_variables();
1426 parse_cli_options();
1428 init_proxy_settings('vanilla-proxy');
1429 load_regressions_tests();
1430 init_proxy_settings('fuzz-proxy');
1431 execute_regression_tests();
1438 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1442 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>]
1443 [B<--fuzzer-feeding>] [B<--help>] [B<--level level>] [B<--loops count>]
1444 [B<--max-level max-level>] [B<--max-time max-time>]
1445 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1446 [B<--retries retries>] [B<--verbose>] [B<--version>]
1450 Privoxy-Regression-Test is supposed to one day become
1451 a regression test suite for Privoxy. It's not quite there
1452 yet, however, and can currently only test header actions,
1453 check the returned status code for requests to arbitrary
1454 URLs and verify which actions are applied to them.
1456 Client header actions are tested by requesting
1457 B<http://p.p/show-request> and checking whether
1458 or not Privoxy modified the original request as expected.
1460 The original request contains both the header the action-to-be-tested
1461 acts upon and an additional tagger-triggering header that enables
1464 Applied actions are checked through B<http://p.p/show-url-info>.
1466 =head1 CONFIGURATION FILE SYNTAX
1468 Privoxy-Regression-Test's configuration is embedded in
1469 Privoxy action files and loaded through Privoxy's web interface.
1471 It makes testing a Privoxy version running on a remote system easier
1472 and should prevent you from updating your tests without updating Privoxy's
1473 configuration accordingly.
1475 A client-header-action test section looks like this:
1477 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1478 # Expect Header = Referer: http://www.example.org/
1479 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1480 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1482 The example above causes Privoxy-Regression-Test to set
1483 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1484 and to expect it to be modified to
1485 B<Referer: http://www.example.org/>.
1487 When testing this section, Privoxy-Regression-Test will set the header
1488 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1489 causing the B<privoxy-control> tagger to create the tag
1490 B<client-header-filter{hide-tor-exit-notation}> which will finally
1491 cause Privoxy to enable the action section.
1493 Note that the actions itself are only used by Privoxy,
1494 Privoxy-Regression-Test ignores them and will be happy
1495 as long as the expectations are satisfied.
1497 A fetch test looks like this:
1499 # Fetch Test = http://p.p/user-manual
1500 # Expect Status Code = 302
1502 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1503 and to expect a response with the HTTP status code B<302>. Obviously that's
1504 not a very thorough test and mainly useful to get some code coverage
1505 for Valgrind or to verify that the templates are installed correctly.
1507 If you want to test CGI pages that require a trusted
1508 referer, you can use:
1510 # Trusted CGI Request = http://p.p/edit-actions
1512 It works like ordinary fetch tests, but sets the referer
1513 header to a trusted value.
1515 If no explicit status code expectation is set, B<200> is used.
1517 To verify that a URL is blocked, use:
1519 # Blocked URL = http://www.example.com/blocked
1521 To verify that a specific set of actions is applied to an URL, use:
1523 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1524 # URL = http://www.example.org/my-first-url
1526 The sticky actions will be checked for all URLs below it
1527 until the next sticky actions directive.
1531 All tests have test levels to let the user
1532 control which ones to execute (see I<OPTIONS> below).
1533 Test levels are either set with the B<Level> directive,
1534 or implicitly through the test type.
1536 Block tests default to level 7, fetch tests to level 6,
1537 "Sticky Actions" tests default to level 5, tests for trusted CGI
1538 requests to level 3 and client-header-action tests to level 1.
1542 B<--debug bitmask> Add the bitmask provided as integer
1543 to the debug settings.
1545 B<--fuzzer-address> Listening address used when executing
1546 the regression tests. Useful to make sure that the requests
1547 to load the regression tests don't fail due to fuzzing.
1549 B<--fuzzer-feeding> Ignore some errors that would otherwise
1550 cause Privoxy-Regression-Test to abort the test because
1551 they shouldn't happen in normal operation. This option is
1552 intended to be used if Privoxy-Regression-Test is only
1553 used to feed a fuzzer in which case there's a high chance
1554 that Privoxy gets an invalid request and returns an error
1557 B<--help> Shows available command line options.
1559 B<--level level> Only execute tests with the specified B<level>.
1561 B<--loop count> Loop through the regression tests B<count> times.
1562 Useful to feed a fuzzer, or when doing stress tests with
1563 several Privoxy-Regression-Test instances running at the same
1566 B<--max-level max-level> Only execute tests with a B<level>
1567 below or equal to the numerical B<max-level>.
1569 B<--max-time max-time> Give Privoxy B<max-time> seconds
1570 to return data. Increasing the default may make sense when
1571 Privoxy is run through Valgrind, decreasing the default may
1572 make sense when Privoxy-Regression-Test is used to feed
1575 B<--min-level min-level> Only execute tests with a B<level>
1576 above or equal to the numerical B<min-level>.
1578 B<--privoxy-address proxy-address> Privoxy's listening address.
1579 If it's not set, the value of the environment variable http_proxy
1580 will be used. B<proxy-address> has to be specified in http_proxy
1583 B<--retries retries> Retry B<retries> times.
1585 B<--verbose> Also log succesful test runs.
1587 B<--version> Print version and exit.
1589 The second dash is optional, options can be shortened,
1590 as long as there are no ambiguities.
1592 =head1 PRIVOXY CONFIGURATION
1594 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1595 which aims to test all official client-header modifying actions
1596 and can be used to verify that the templates and the user manual
1597 files are installed correctly.
1599 To use it, it has to be copied in Privoxy's configuration
1600 directory, and afterwards referenced in Privoxy's configuration
1603 actionsfile regression-tests.action
1605 In general, its tests are supposed to work without changing
1606 any other action files, unless you already added lots of
1607 taggers yourself. If you are using taggers that cause problems,
1608 you might have to temporary disable them for Privoxy's CGI pages.
1610 Some of the regression tests rely on Privoxy features that
1611 may be disabled in your configuration. Tests with a level below
1612 7 are supposed to work with all Privoxy configurations (provided
1613 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1615 Tests with level 9 require Privoxy to deliver the User Manual,
1616 tests with level 12 require the CGI editor to be enabled.
1620 Expect the configuration file syntax to change with future releases.
1624 As Privoxy's B<show-request> page only shows client headers,
1625 Privoxy-Regression-Test can't use it to test Privoxy actions
1626 that modify server headers.
1628 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1629 control the actions to test, it currently only works with
1630 Privoxy 3.0.7 or later.
1632 At the moment Privoxy-Regression-Test fetches Privoxy's
1633 configuration page through I<curl>(1), therefore you have to
1634 have I<curl> installed, otherwise you won't be able to run
1635 Privoxy-Regression-Test in a meaningful way.
1643 Fabian Keil <fk@fabiankeil.de>