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.160 2008/10/25 15:39:27 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 # - Document magic Expect Header values
20 # - Internal fuzz support?
22 # Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
24 # Permission to use, copy, modify, and distribute this software for any
25 # purpose with or without fee is hereby granted, provided that the above
26 # copyright notice and this permission notice appear in all copies.
28 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
29 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
30 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
31 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
32 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
33 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
34 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
36 ############################################################################
43 PRT_VERSION => 'Privoxy-Regression-Test 0.3',
55 PRIVOXY_CGI_URL => 'http://p.p/',
56 FELLATIO_URL => 'http://127.0.0.1:8080/',
57 LEADING_LOG_DATE => 1,
58 LEADING_LOG_TIME => 1,
60 DEBUG_LEVEL_FILE_LOADING => 0,
61 DEBUG_LEVEL_PAGE_FETCHING => 0,
63 VERBOSE_TEST_DESCRIPTION => 1,
65 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
66 # XXX: Only partly implemented and mostly useless.
67 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
68 DEBUG_LEVEL_STATUS => 1,
70 # Internal use, don't modify
71 # Available debug bits:
73 LL_VERBOSE_FAILURE => 2,
74 LL_PAGE_FETCHING => 4,
76 LL_VERBOSE_SUCCESS => 16,
80 CLIENT_HEADER_TEST => 1,
81 SERVER_HEADER_TEST => 2,
84 STICKY_ACTIONS_TEST => 5,
85 TRUSTED_CGI_REQUEST => 6,
89 sub init_our_variables () {
91 our $leading_log_time = LEADING_LOG_TIME;
92 our $leading_log_date = LEADING_LOG_DATE;
94 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
96 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
98 our $log_level = get_default_log_level();
102 sub get_default_log_level () {
106 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
107 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
108 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
109 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
110 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
112 # These are intended to be always on.
113 $log_level |= LL_SOFT_ERROR;
114 $log_level |= LL_ERROR;
119 ############################################################################
121 # File loading functions
123 ############################################################################
131 # Unescape brackets and dots
132 $tag =~ s@\\(?=[{}().+])@@g;
134 # log_message("Parsed tag: " . $tag);
136 check_for_forbidden_characters($tag);
141 sub check_for_forbidden_characters ($) {
143 my $tag = shift; # XXX: also used to check values though.
144 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
146 unless ($tag =~ m/^$allowed*$/) {
147 my $forbidden = $tag;
148 $forbidden =~ s@^$allowed*(.).*@$1@;
150 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
154 sub load_regressions_tests () {
156 our $privoxy_cgi_url;
158 our %privoxy_features;
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);
182 } elsif (m@<td><code>([^<]*)</code></td>@) {
186 } elsif (m@<td> (Yes|No) </td>@) {
188 $privoxy_features{$feature} = $1 if defined $feature;
193 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
195 load_action_files(\@actionfiles);
198 sub token_starts_new_test ($) {
201 my @new_test_directives = ('set header', 'fetch test',
202 'trusted cgi request', 'request header', 'method test',
203 'blocked url', 'url');
205 foreach my $new_test_directive (@new_test_directives) {
206 return 1 if $new_test_directive eq $token;
214 my ($token, $value) = (undef, undef);
216 # Remove leading and trailing white space.
220 # Reverse HTML-encoding
221 # XXX: Seriously imcomplete.
226 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
231 $token =~ s@\s\s+@ @g;
232 $token =~ tr/[A-Z]/[a-z]/;
234 } elsif (/^TAG\s*:(.*)$/) {
241 return ($token, $value);
244 sub enlist_new_test ($$$$$$) {
246 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
249 if ($token eq 'set header') {
251 l(LL_FILE_LOADING, "Header to set: " . $value);
252 $type = CLIENT_HEADER_TEST;
254 } elsif ($token eq 'request header') {
256 l(LL_FILE_LOADING, "Header to request: " . $value);
257 $type = SERVER_HEADER_TEST;
258 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
260 } elsif ($token eq 'trusted cgi request') {
262 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
263 $type = TRUSTED_CGI_REQUEST;
264 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
266 } elsif ($token eq 'fetch test') {
268 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
269 $type = DUMB_FETCH_TEST;
270 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
272 } elsif ($token eq 'method test') {
274 l(LL_FILE_LOADING, "Method to test: " . $value);
276 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
278 } elsif ($token eq 'blocked url') {
280 l(LL_FILE_LOADING, "URL to block-test: " . $value);
283 } elsif ($token eq 'url') {
285 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
286 $type = STICKY_ACTIONS_TEST;
290 die "Incomplete '" . $token . "' support detected.";
294 $$regression_tests[$si][$ri]{'type'} = $type;
295 $$regression_tests[$si][$ri]{'level'} = $type;
297 check_for_forbidden_characters($value);
299 $$regression_tests[$si][$ri]{'data'} = $value;
301 # For function that only get passed single tests
302 $$regression_tests[$si][$ri]{'section-id'} = $si;
303 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
304 $$regression_tests[$si][$ri]{'number'} = $number - 1;
306 "Regression test " . $number . " (section:" . $si . "):");
309 sub load_action_files ($) {
313 our @regression_tests;
315 my $actionfiles_ref = shift;
316 my @actionfiles = @{$actionfiles_ref};
318 my $si = 0; # Section index
319 my $ri = -1; # Regression test index
324 l(LL_STATUS, "Gathering regression tests from " .
325 @actionfiles . " action file(s) delivered by Privoxy.");
327 for my $file_number (0 .. @actionfiles - 1) {
329 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
330 my $actionfile = undef;
331 my $sticky_actions = undef;
333 foreach (@{get_cgi_page_or_else($curl_url)}) {
338 if (/<h2>Contents of Actions File (.*?)</) {
342 next unless defined $actionfile;
346 my ($token, $value) = tokenize($_);
348 next unless defined $token;
350 # Load regression tests
352 if (token_starts_new_test($token)) {
354 # Beginning of new regression test.
357 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
360 if ($token =~ /level\s+(\d+)/i) {
363 register_dependency($level, $value);
366 if ($token eq 'sticky actions') {
368 # Will be used by each following Sticky URL.
369 $sticky_actions = $value;
370 if ($sticky_actions =~ /{[^}]*\s/) {
372 "'Sticky Actions' with whitespace inside the " .
373 "action parameters are currently unsupported.");
377 if ($si == -1 || $ri == -1) {
378 # No beginning of a test detected yet,
379 # so we don't care about any other test
384 if ($token eq 'expect header') {
386 l(LL_FILE_LOADING, "Detected expectation: " . $value);
387 $regression_tests[$si][$ri]{'expect-header'} = $value;
389 } elsif ($token eq 'tag') {
393 my $tag = parse_tag($value);
395 # We already checked in parse_tag() after filtering
398 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
400 # Save tag for all tests in this section
402 $regression_tests[$si][$ri]{'tag'} = $tag;
408 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
410 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
411 $regression_tests[$si][$ri]{'ignore'} = 1;
414 } elsif ($token eq 'expect status code') {
416 l(LL_FILE_LOADING, "Expecting status code: " . $value);
417 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
419 } elsif ($token eq 'level') { # XXX: stupid name
421 $value =~ s@(\d+).*@$1@;
422 l(LL_FILE_LOADING, "Level: " . $value);
423 $regression_tests[$si][$ri]{'level'} = $value;
425 } elsif ($token eq 'method') {
427 l(LL_FILE_LOADING, "Method: " . $value);
428 $regression_tests[$si][$ri]{'method'} = $value;
430 } elsif ($token eq 'url') {
432 if (defined $sticky_actions) {
433 die "WTF? Attempted to overwrite Sticky Actions"
434 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
436 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
437 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
439 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
444 # We don't use it, so we don't need
448 check_for_forbidden_characters($value) unless $no_checks;
449 check_for_forbidden_characters($token);
453 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
454 . " Of which " . $ignored. " will be ignored)\n");
457 ############################################################################
459 # Regression test executing functions
461 ############################################################################
463 sub execute_regression_tests () {
465 our @regression_tests;
466 my $loops = get_cli_option('loops');
468 my $all_failures = 0;
469 my $all_successes = 0;
471 unless (@regression_tests) {
473 l(LL_STATUS, "No regression tests found.");
477 l(LL_STATUS, "Executing regression tests ...");
479 while ($loops-- > 0) {
486 for my $s (0 .. @regression_tests - 1) {
490 while (defined $regression_tests[$s][$r]) {
492 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
493 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
495 my $number = $regression_tests[$s][$r]{'number'};
497 if ($regression_tests[$s][$r]{'ignore'}
498 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
499 or test_number_is_unacceptable($number)) {
505 my $result = execute_regression_test($regression_tests[$s][$r]);
507 log_result($regression_tests[$s][$r], $result, $tests);
509 $successes += $result;
515 $failures = $tests - $successes;
517 log_message("Executed " . $tests . " regression tests. " .
518 'Skipped ' . $skipped . '. ' .
519 $successes . " successes, " . $failures . " failures.");
521 $all_tests += $tests;
522 $all_failures += $failures;
523 $all_successes += $successes;
527 if (get_cli_option('loops') > 1) {
528 log_message("Total: Executed " . $all_tests . " regression tests. " .
529 $all_successes . " successes, " . $all_failures . " failures.");
533 sub level_is_unacceptable ($) {
535 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
536 or ($level < get_cli_option('min-level'))
537 or ($level > get_cli_option('max-level'))
538 or dependency_unsatisfied($level)
542 sub test_number_is_unacceptable ($) {
543 my $test_number = shift;
544 return (cli_option_is_set('test-number')
545 and get_cli_option('test-number') != $test_number)
548 sub dependency_unsatisfied ($) {
553 our %privoxy_features;
555 my $dependency_problem = 0;
557 if (defined ($dependencies{$level}{'config line'})) {
559 my $dependency = $dependencies{$level}{'config line'};
560 $dependency_problem = 1;
562 foreach (@privoxy_config) {
564 $dependency_problem = 0 if (/$dependency/);
568 } elsif (defined ($dependencies{$level}{'feature status'})) {
570 my $dependency = $dependencies{$level}{'feature status'};
571 $dependency_problem = 1;
572 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
574 if (defined($privoxy_features{$feature})
575 and ($privoxy_features{$feature} eq $status))
577 $dependency_problem = 0;
581 return $dependency_problem;
584 sub register_dependency ($$) {
587 my $dependency = shift;
590 if ($dependency =~ /config line\s+(.*)/) {
592 $dependencies{$level}{'config line'} = $1;
594 } elsif ($dependency =~ /feature status\s+(.*)/) {
596 $dependencies{$level}{'feature status'} = $1;
601 # XXX: somewhat misleading name
602 sub execute_regression_test ($) {
604 my $test_ref = shift;
605 my %test = %{$test_ref};
608 if ($test{'type'} == CLIENT_HEADER_TEST) {
610 $result = execute_client_header_regression_test($test_ref);
612 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
614 $result = execute_server_header_regression_test($test_ref);
616 } elsif ($test{'type'} == DUMB_FETCH_TEST
617 or $test{'type'} == TRUSTED_CGI_REQUEST) {
619 $result = execute_dumb_fetch_test($test_ref);
621 } elsif ($test{'type'} == METHOD_TEST) {
623 $result = execute_method_test($test_ref);
625 } elsif ($test{'type'} == BLOCK_TEST) {
627 $result = execute_block_test($test_ref);
629 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
631 $result = execute_sticky_actions_test($test_ref);
635 die "Unsupported test type detected: " . $test{'type'};
642 sub execute_method_test ($) {
644 my $test_ref = shift;
645 my %test = %{$test_ref};
648 my $method = $test{'data'};
650 my $curl_parameters = '';
651 my $expected_status_code = $test{'expected-status-code'};
653 $curl_parameters .= '--request ' . $method . ' ';
654 # Don't complain about the 'missing' body
655 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
657 $curl_parameters .= PRIVOXY_CGI_URL;
659 $buffer_ref = get_page_with_curl($curl_parameters);
660 $status_code = get_status_code($buffer_ref);
662 return check_status_code_result($status_code, $expected_status_code);
665 sub execute_dumb_fetch_test ($) {
667 my $test_ref = shift;
668 my %test = %{$test_ref};
672 my $curl_parameters = '';
673 my $expected_status_code = $test{'expected-status-code'};
675 if (defined $test{method}) {
676 $curl_parameters .= '--request ' . $test{method} . ' ';
678 if ($test{type} == TRUSTED_CGI_REQUEST) {
679 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
682 $curl_parameters .= $test{'data'};
684 $buffer_ref = get_page_with_curl($curl_parameters);
685 $status_code = get_status_code($buffer_ref);
687 return check_status_code_result($status_code, $expected_status_code);
690 sub execute_block_test ($) {
693 my $url = $test->{'data'};
694 my $final_results = get_final_results($url);
696 return defined $final_results->{'+block'};
699 sub execute_sticky_actions_test ($) {
702 my $url = $test->{'data'};
703 my $verified_actions = 0;
704 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
705 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
706 my $final_results = get_final_results($url);
708 foreach my $sticky_action (@sticky_actions) {
709 if (defined $final_results->{$sticky_action}) {
712 }elsif ($sticky_action =~ /-.*\{/ and
713 not defined $final_results->{$sticky_action}) {
714 # Disabled multi actions aren't explicitly listed as
715 # disabled and thus have to be checked by verifying
716 # that they aren't enabled.
719 l(LL_VERBOSE_FAILURE,
720 "Ooops. '$sticky_action' is not among the final results.");
724 return $verified_actions == @sticky_actions;
727 sub get_final_results ($) {
730 my $curl_parameters = '';
731 my %final_results = ();
732 my $final_results_reached = 0;
734 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
735 # XXX: should be URL-encoded properly
742 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
744 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
746 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
748 next unless ($final_results_reached);
751 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
755 if (defined $parameter) {
756 # In case the caller needs to check
757 # the action and its parameter
758 $final_results{$action . $parameter} = 1;
760 # In case the action doesn't have parameters
761 # or the caller doesn't care for the parameter.
762 $final_results{$action} = 1;
766 return \%final_results;
769 sub check_status_code_result ($$) {
771 my $status_code = shift;
772 my $expected_status_code = shift;
775 unless (defined $status_code) {
777 # XXX: should probably be caught earlier.
778 l(LL_VERBOSE_FAILURE,
779 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
781 } elsif ($expected_status_code == $status_code) {
784 l(LL_VERBOSE_SUCCESS,
785 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
787 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
789 l(LL_VERBOSE_FAILURE,
790 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
794 l(LL_VERBOSE_FAILURE,
795 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
802 sub execute_client_header_regression_test ($) {
804 my $test_ref = shift;
808 $buffer_ref = get_show_request_with_curl($test_ref);
810 $header = get_header($buffer_ref, $test_ref);
812 return check_header_result($test_ref, $header);
815 sub execute_server_header_regression_test ($) {
817 my $test_ref = shift;
821 $buffer_ref = get_head_with_curl($test_ref);
823 $header = get_server_header($buffer_ref, $test_ref);
825 return check_header_result($test_ref, $header);
828 sub interpret_result ($) {
830 return $success ? "Success" : "Failure";
833 sub check_header_result ($$) {
835 my $test_ref = shift;
838 my %test = %{$test_ref};
839 my $expect_header = $test{'expect-header'};
842 if ($expect_header eq 'NO CHANGE') {
844 if (defined($header) and $header eq $test{'data'}) {
850 $header = "REMOVAL" unless defined $header;
851 l(LL_VERBOSE_FAILURE,
852 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
855 } elsif ($expect_header eq 'REMOVAL') {
857 if (defined($header) and $header eq $test{'data'}) {
859 l(LL_VERBOSE_FAILURE,
860 "Ooops. Expected removal but: " . $header . " is still there.");
864 # XXX: Use more reliable check here and make sure
865 # the header has a different name.
870 } elsif ($expect_header eq 'SOME CHANGE') {
872 if (defined($header) and not $header eq $test{'data'}) {
878 $header = "REMOVAL" unless defined $header;
879 l(LL_VERBOSE_FAILURE,
880 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
886 if (defined($header) and $header eq $expect_header) {
892 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
893 l(LL_VERBOSE_FAILURE,
894 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
900 sub get_header_name ($) {
904 $header =~ s@(.*?: ).*@$1@;
909 sub get_header ($$) {
911 our $filtered_request = '';
913 my $buffer_ref = shift;
914 my $test_ref = shift;
916 my %test = %{$test_ref};
917 my @buffer = @{$buffer_ref};
919 my $expect_header = $test{'expect-header'};
921 die "get_header called with no expect header" unless defined $expect_header;
924 my $processed_request_reached = 0;
926 my $processed_request = '';
930 if ($expect_header eq 'REMOVAL'
931 or $expect_header eq 'NO CHANGE'
932 or $expect_header eq 'SOME CHANGE') {
934 $expect_header = $test{'data'};
938 $header_to_get = get_header_name($expect_header);
942 # Skip everything before the Processed request
943 if (/Processed Request/) {
944 $processed_request_reached = 1;
947 next unless $processed_request_reached;
949 # End loop after the Processed request
952 # Ditch tags and leading/trailing white space.
956 # Decode characters we care about.
959 $filtered_request .= "\n" . $_;
961 if (/^$header_to_get/) {
971 sub get_server_header ($$) {
973 my $buffer_ref = shift;
974 my $test_ref = shift;
976 my %test = %{$test_ref};
977 my @buffer = @{$buffer_ref};
979 my $expect_header = $test{'expect-header'};
983 # XXX: Should be caught before starting to test.
984 l(LL_ERROR, "No expect header for test " . $test{'number'})
985 unless defined $expect_header;
987 if ($expect_header eq 'REMOVAL'
988 or $expect_header eq 'NO CHANGE'
989 or $expect_header eq 'SOME CHANGE') {
991 $expect_header = $test{'data'};
995 $header_to_get = get_header_name($expect_header);
999 # XXX: should probably verify that the request
1000 # was actually answered by Fellatio.
1001 if (/^$header_to_get/) {
1003 $header =~ s@\s*$@@g;
1011 sub get_status_code ($) {
1013 my $buffer_ref = shift;
1014 my @buffer = @{$buffer_ref};
1018 if (/^HTTP\/\d\.\d (\d{3})/) {
1024 return '123' if cli_option_is_set('fuzzer-feeding');
1026 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1031 sub get_test_keys () {
1032 return ('tag', 'data', 'expect-header', 'ignore');
1036 sub test_content_as_string ($) {
1038 my $test_ref = shift;
1039 my %test = %{$test_ref};
1043 foreach my $key (get_test_keys()) {
1044 $test{$key} = 'Not set' unless (defined $test{$key});
1047 $s .= 'Tag: ' . $test{'tag'};
1049 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1051 $s .= 'Expected header: ' . $test{'expect-header'};
1053 $s .= 'Ignore: ' . $test{'ignore'};
1058 sub fuzz_header($) {
1060 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1062 $white_space = $white_space x (1 + int(rand(5)));
1064 # Only fuzz white space before the first quoted token.
1065 # (Privoxy doesn't touch white space inside quoted tokens
1066 # and modifying it would cause the tests to fail).
1067 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1072 ############################################################################
1074 # HTTP fetch functions
1076 ############################################################################
1078 sub check_for_curl () {
1080 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1083 sub get_cgi_page_or_else ($) {
1085 my $cgi_url = shift;
1086 my $content_ref = get_page_with_curl($cgi_url);
1087 my $status_code = get_status_code($content_ref);
1089 if (200 != $status_code) {
1091 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1092 "Received status code ". $status_code .
1093 " while only 200 is acceptable.";
1095 if (cli_option_is_set('fuzzer-feeding')) {
1097 $log_message .= " Ignored due to fuzzer feeding.";
1098 l(LL_SOFT_ERROR, $log_message)
1102 l(LL_ERROR, $log_message);
1107 return $content_ref;
1110 # XXX: misleading name
1111 sub get_show_request_with_curl ($) {
1113 our $privoxy_cgi_url;
1114 my $test_ref = shift;
1115 my %test = %{$test_ref};
1117 my $curl_parameters = ' ';
1118 my $header = $test{'data'};
1120 if (cli_option_is_set('header-fuzzing')) {
1121 $header = fuzz_header($header);
1124 # Enable the action to test
1125 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1126 # The header to filter
1127 $curl_parameters .= '-H \'' . $header . '\' ';
1129 $curl_parameters .= ' ';
1130 $curl_parameters .= $privoxy_cgi_url;
1131 $curl_parameters .= 'show-request';
1133 return get_cgi_page_or_else($curl_parameters);
1136 sub get_head_with_curl ($) {
1138 our $fellatio_url = FELLATIO_URL;
1139 my $test_ref = shift;
1140 my %test = %{$test_ref};
1142 my $curl_parameters = ' ';
1144 # Enable the action to test
1145 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1146 # The header to filter
1147 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1148 $curl_parameters .= '--head ';
1150 $curl_parameters .= ' ';
1151 $curl_parameters .= $fellatio_url;
1153 return get_page_with_curl($curl_parameters);
1156 sub get_page_with_curl ($) {
1160 my $parameters = shift;
1162 my $curl_line = CURL;
1163 my $retries_left = get_cli_option('retries') + 1;
1166 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1168 # We want to see the HTTP status code
1169 $curl_line .= " --include ";
1170 # Let Privoxy emit two log messages less.
1171 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1172 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1173 # We don't care about fetch statistic.
1174 $curl_line .= " -s ";
1175 # We do care about the failure reason if any.
1176 $curl_line .= " -S ";
1177 # We want to advertise ourselves
1178 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1179 # We aren't too patient
1180 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1182 $curl_line .= $parameters;
1183 # XXX: still necessary?
1184 $curl_line .= ' 2>&1';
1186 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1189 @buffer = `$curl_line`;
1192 $failure_reason = array_as_string(\@buffer);
1193 chomp $failure_reason;
1194 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1196 } while ($? && --$retries_left);
1198 unless ($retries_left) {
1200 "Running curl failed " . get_cli_option('retries') .
1201 " times in a row. Last error: '" . $failure_reason . "'.");
1208 ############################################################################
1212 ############################################################################
1214 sub array_as_string ($) {
1215 my $array_ref = shift;
1218 foreach (@{$array_ref}) {
1226 my $test_ref = shift;
1227 log_message('Test is:' . test_content_as_string($test_ref));
1233 my $this_level = shift;
1234 my $message = shift;
1236 return unless ($log_level & $this_level);
1238 if (LL_ERROR & $this_level) {
1239 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1242 log_message($message);
1244 if (LL_ERROR & $this_level) {
1249 sub log_message ($) {
1251 my $message = shift;
1255 our $leading_log_date;
1256 our $leading_log_time;
1258 my $time_stamp = '';
1259 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1261 if ($leading_log_date || $leading_log_time) {
1263 if ($leading_log_date) {
1266 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1269 if ($leading_log_time) {
1270 $time_stamp .= ' ' if $leading_log_date;
1271 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1274 $message = $time_stamp . ": " . $message;
1278 printf(STDERR "%s\n", $message);
1282 sub log_result ($$) {
1284 our $verbose_test_description;
1285 our $filtered_request;
1287 my $test_ref = shift;
1291 my %test = %{$test_ref};
1294 $message .= interpret_result($result);
1295 $message .= " for test ";
1296 $message .= $number;
1298 $message .= $test{'number'};
1300 $message .= $test{'section-id'};
1302 $message .= $test{'regression-test-id'};
1305 if ($verbose_test_description) {
1307 if ($test{'type'} == CLIENT_HEADER_TEST) {
1309 $message .= ' Header ';
1310 $message .= quote($test{'data'});
1311 $message .= ' and tag ';
1312 $message .= quote($test{'tag'});
1314 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1316 $message .= ' Request Header ';
1317 $message .= quote($test{'data'});
1318 $message .= ' and tag ';
1319 $message .= quote($test{'tag'});
1321 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1323 $message .= ' URL ';
1324 $message .= quote($test{'data'});
1325 $message .= ' and expected status code ';
1326 $message .= quote($test{'expected-status-code'});
1328 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1330 $message .= ' CGI URL ';
1331 $message .= quote($test{'data'});
1332 $message .= ' and expected status code ';
1333 $message .= quote($test{'expected-status-code'});
1335 } elsif ($test{'type'} == METHOD_TEST) {
1337 $message .= ' HTTP method ';
1338 $message .= quote($test{'data'});
1339 $message .= ' and expected status code ';
1340 $message .= quote($test{'expected-status-code'});
1342 } elsif ($test{'type'} == BLOCK_TEST) {
1344 $message .= ' Supposedly-blocked URL: ';
1345 $message .= quote($test{'data'});
1347 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1349 $message .= ' Sticky Actions: ';
1350 $message .= quote($test{'sticky-actions'});
1351 $message .= ' and URL: ';
1352 $message .= quote($test{'data'});
1356 die "Incomplete support for test type " . $test{'type'} . " detected.";
1361 log_message($message) if (!$result or cli_option_is_set('verbose'));
1366 return '\'' . $s . '\'';
1369 sub print_version () {
1370 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1381 Options and their default values if they have any:
1382 [--debug $cli_options{'debug'}]
1383 [--forks $cli_options{'forks'}]
1389 [--loops $cli_options{'loops'}]
1390 [--max-level $cli_options{'max-level'}]
1391 [--max-time $cli_options{'max-time'}]
1392 [--min-level $cli_options{'min-level'}]
1394 [--retries $cli_options{'retries'}]
1398 see "perldoc $0" for more information
1404 sub init_cli_options () {
1409 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1410 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1411 $cli_options{'debug'} = $log_level;
1412 $cli_options{'loops'} = CLI_LOOPS;
1413 $cli_options{'max-time'} = CLI_MAX_TIME;
1414 $cli_options{'retries'} = CLI_RETRIES;
1415 $cli_options{'forks'} = CLI_FORKS;
1418 sub parse_cli_options () {
1426 'debug=s' => \$cli_options{'debug'},
1427 'forks=s' => \$cli_options{'forks'},
1428 'help' => sub { help },
1429 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1430 'min-level=s' => \$cli_options{'min-level'},
1431 'max-level=s' => \$cli_options{'max-level'},
1432 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1433 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1434 'level=s' => \$cli_options{'level'},
1435 'loops=s' => \$cli_options{'loops'},
1436 'test-number=s' => \$cli_options{'test-number'},
1437 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1438 'retries=s' => \$cli_options{'retries'},
1439 'max-time=s' => \$cli_options{'max-time'},
1440 'verbose' => \$cli_options{'verbose'},
1441 'version' => sub { print_version && exit(0) }
1443 $log_level |= $cli_options{'debug'};
1446 sub cli_option_is_set ($) {
1449 my $cli_option = shift;
1451 return defined $cli_options{$cli_option};
1454 sub get_cli_option ($) {
1457 my $cli_option = shift;
1459 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1461 return $cli_options{$cli_option};
1464 sub init_proxy_settings($) {
1469 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1470 $proxy = get_cli_option('fuzzer-address');
1473 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1475 if (cli_option_is_set('privoxy-address')) {
1476 $proxy .= get_cli_option('privoxy-address');
1482 sub start_forks($) {
1485 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1487 foreach my $fork (1 .. $forks) {
1488 log_message("Starting fork $fork");
1490 if (defined $pid && !$pid) {
1498 init_our_variables();
1499 parse_cli_options();
1501 init_proxy_settings('vanilla-proxy');
1502 load_regressions_tests();
1503 init_proxy_settings('fuzz-proxy');
1504 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1505 execute_regression_tests();
1512 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1516 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1517 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1518 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1519 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1520 [B<--retries retries>] [B<--test-number test-number>] [B<--verbose>]
1525 Privoxy-Regression-Test is supposed to one day become
1526 a regression test suite for Privoxy. It's not quite there
1527 yet, however, and can currently only test header actions,
1528 check the returned status code for requests to arbitrary
1529 URLs and verify which actions are applied to them.
1531 Client header actions are tested by requesting
1532 B<http://p.p/show-request> and checking whether
1533 or not Privoxy modified the original request as expected.
1535 The original request contains both the header the action-to-be-tested
1536 acts upon and an additional tagger-triggering header that enables
1539 Applied actions are checked through B<http://p.p/show-url-info>.
1541 =head1 CONFIGURATION FILE SYNTAX
1543 Privoxy-Regression-Test's configuration is embedded in
1544 Privoxy action files and loaded through Privoxy's web interface.
1546 It makes testing a Privoxy version running on a remote system easier
1547 and should prevent you from updating your tests without updating Privoxy's
1548 configuration accordingly.
1550 A client-header-action test section looks like this:
1552 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1553 # Expect Header = Referer: http://www.example.org/
1554 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1555 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1557 The example above causes Privoxy-Regression-Test to set
1558 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1559 and to expect it to be modified to
1560 B<Referer: http://www.example.org/>.
1562 When testing this section, Privoxy-Regression-Test will set the header
1563 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1564 causing the B<privoxy-control> tagger to create the tag
1565 B<client-header-filter{hide-tor-exit-notation}> which will finally
1566 cause Privoxy to enable the action section.
1568 Note that the actions itself are only used by Privoxy,
1569 Privoxy-Regression-Test ignores them and will be happy
1570 as long as the expectations are satisfied.
1572 A fetch test looks like this:
1574 # Fetch Test = http://p.p/user-manual
1575 # Expect Status Code = 302
1577 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1578 and to expect a response with the HTTP status code B<302>. Obviously that's
1579 not a very thorough test and mainly useful to get some code coverage
1580 for Valgrind or to verify that the templates are installed correctly.
1582 If you want to test CGI pages that require a trusted
1583 referer, you can use:
1585 # Trusted CGI Request = http://p.p/edit-actions
1587 It works like ordinary fetch tests, but sets the referer
1588 header to a trusted value.
1590 If no explicit status code expectation is set, B<200> is used.
1592 To verify that a URL is blocked, use:
1594 # Blocked URL = http://www.example.com/blocked
1596 To verify that a specific set of actions is applied to an URL, use:
1598 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1599 # URL = http://www.example.org/my-first-url
1601 The sticky actions will be checked for all URLs below it
1602 until the next sticky actions directive.
1606 All tests have test levels to let the user
1607 control which ones to execute (see I<OPTIONS> below).
1608 Test levels are either set with the B<Level> directive,
1609 or implicitly through the test type.
1611 Block tests default to level 7, fetch tests to level 6,
1612 "Sticky Actions" tests default to level 5, tests for trusted CGI
1613 requests to level 3 and client-header-action tests to level 1.
1617 B<--debug bitmask> Add the bitmask provided as integer
1618 to the debug settings.
1620 B<--forks forks> Number of forks to start before executing
1621 the regression tests. This is mainly useful for stress-testing.
1623 B<--fuzzer-address> Listening address used when executing
1624 the regression tests. Useful to make sure that the requests
1625 to load the regression tests don't fail due to fuzzing.
1627 B<--fuzzer-feeding> Ignore some errors that would otherwise
1628 cause Privoxy-Regression-Test to abort the test because
1629 they shouldn't happen in normal operation. This option is
1630 intended to be used if Privoxy-Regression-Test is only
1631 used to feed a fuzzer in which case there's a high chance
1632 that Privoxy gets an invalid request and returns an error
1635 B<--help> Shows available command line options.
1637 B<--header-fuzzing> Modifies linear white space in
1638 headers in a way that should not affect the test result.
1640 B<--level level> Only execute tests with the specified B<level>.
1642 B<--loop count> Loop through the regression tests B<count> times.
1643 Useful to feed a fuzzer, or when doing stress tests with
1644 several Privoxy-Regression-Test instances running at the same
1647 B<--max-level max-level> Only execute tests with a B<level>
1648 below or equal to the numerical B<max-level>.
1650 B<--max-time max-time> Give Privoxy B<max-time> seconds
1651 to return data. Increasing the default may make sense when
1652 Privoxy is run through Valgrind, decreasing the default may
1653 make sense when Privoxy-Regression-Test is used to feed
1656 B<--min-level min-level> Only execute tests with a B<level>
1657 above or equal to the numerical B<min-level>.
1659 B<--privoxy-address proxy-address> Privoxy's listening address.
1660 If it's not set, the value of the environment variable http_proxy
1661 will be used. B<proxy-address> has to be specified in http_proxy
1664 B<--retries retries> Retry B<retries> times.
1666 B<--test-number test-number> Only run the test with the specified
1669 B<--verbose> Also log succesful test runs.
1671 B<--version> Print version and exit.
1673 The second dash is optional, options can be shortened,
1674 as long as there are no ambiguities.
1676 =head1 PRIVOXY CONFIGURATION
1678 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1679 which aims to test all official client-header modifying actions
1680 and can be used to verify that the templates and the user manual
1681 files are installed correctly.
1683 To use it, it has to be copied in Privoxy's configuration
1684 directory, and afterwards referenced in Privoxy's configuration
1687 actionsfile regression-tests.action
1689 In general, its tests are supposed to work without changing
1690 any other action files, unless you already added lots of
1691 taggers yourself. If you are using taggers that cause problems,
1692 you might have to temporary disable them for Privoxy's CGI pages.
1694 Some of the regression tests rely on Privoxy features that
1695 may be disabled in your configuration. Tests with a level below
1696 7 are supposed to work with all Privoxy configurations (provided
1697 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1699 Tests with level 9 require Privoxy to deliver the User Manual,
1700 tests with level 12 require the CGI editor to be enabled.
1704 Expect the configuration file syntax to change with future releases.
1708 As Privoxy's B<show-request> page only shows client headers,
1709 Privoxy-Regression-Test can't use it to test Privoxy actions
1710 that modify server headers.
1712 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1713 control the actions to test, it currently only works with
1714 Privoxy 3.0.7 or later.
1716 At the moment Privoxy-Regression-Test fetches Privoxy's
1717 configuration page through I<curl>(1), therefore you have to
1718 have I<curl> installed, otherwise you won't be able to run
1719 Privoxy-Regression-Test in a meaningful way.
1727 Fabian Keil <fk@fabiankeil.de>