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.161 2008/10/25 15:44:26 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 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
573 $dependency_problem = 1;
575 if (defined($privoxy_features{$feature})
576 and ($privoxy_features{$feature} eq $status))
578 $dependency_problem = 0;
582 return $dependency_problem;
585 sub register_dependency ($$) {
588 my $dependency = shift;
591 if ($dependency =~ /config line\s+(.*)/) {
593 $dependencies{$level}{'config line'} = $1;
595 } elsif ($dependency =~ /feature status\s+(.*)/) {
597 $dependencies{$level}{'feature status'} = $1;
602 # XXX: somewhat misleading name
603 sub execute_regression_test ($) {
605 my $test_ref = shift;
606 my %test = %{$test_ref};
609 if ($test{'type'} == CLIENT_HEADER_TEST) {
611 $result = execute_client_header_regression_test($test_ref);
613 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
615 $result = execute_server_header_regression_test($test_ref);
617 } elsif ($test{'type'} == DUMB_FETCH_TEST
618 or $test{'type'} == TRUSTED_CGI_REQUEST) {
620 $result = execute_dumb_fetch_test($test_ref);
622 } elsif ($test{'type'} == METHOD_TEST) {
624 $result = execute_method_test($test_ref);
626 } elsif ($test{'type'} == BLOCK_TEST) {
628 $result = execute_block_test($test_ref);
630 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
632 $result = execute_sticky_actions_test($test_ref);
636 die "Unsupported test type detected: " . $test{'type'};
643 sub execute_method_test ($) {
645 my $test_ref = shift;
646 my %test = %{$test_ref};
649 my $method = $test{'data'};
651 my $curl_parameters = '';
652 my $expected_status_code = $test{'expected-status-code'};
654 $curl_parameters .= '--request ' . $method . ' ';
655 # Don't complain about the 'missing' body
656 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
658 $curl_parameters .= PRIVOXY_CGI_URL;
660 $buffer_ref = get_page_with_curl($curl_parameters);
661 $status_code = get_status_code($buffer_ref);
663 return check_status_code_result($status_code, $expected_status_code);
666 sub execute_dumb_fetch_test ($) {
668 my $test_ref = shift;
669 my %test = %{$test_ref};
673 my $curl_parameters = '';
674 my $expected_status_code = $test{'expected-status-code'};
676 if (defined $test{method}) {
677 $curl_parameters .= '--request ' . $test{method} . ' ';
679 if ($test{type} == TRUSTED_CGI_REQUEST) {
680 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
683 $curl_parameters .= $test{'data'};
685 $buffer_ref = get_page_with_curl($curl_parameters);
686 $status_code = get_status_code($buffer_ref);
688 return check_status_code_result($status_code, $expected_status_code);
691 sub execute_block_test ($) {
694 my $url = $test->{'data'};
695 my $final_results = get_final_results($url);
697 return defined $final_results->{'+block'};
700 sub execute_sticky_actions_test ($) {
703 my $url = $test->{'data'};
704 my $verified_actions = 0;
705 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
706 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
707 my $final_results = get_final_results($url);
709 foreach my $sticky_action (@sticky_actions) {
710 if (defined $final_results->{$sticky_action}) {
713 }elsif ($sticky_action =~ /-.*\{/ and
714 not defined $final_results->{$sticky_action}) {
715 # Disabled multi actions aren't explicitly listed as
716 # disabled and thus have to be checked by verifying
717 # that they aren't enabled.
720 l(LL_VERBOSE_FAILURE,
721 "Ooops. '$sticky_action' is not among the final results.");
725 return $verified_actions == @sticky_actions;
728 sub get_final_results ($) {
731 my $curl_parameters = '';
732 my %final_results = ();
733 my $final_results_reached = 0;
735 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
736 # XXX: should be URL-encoded properly
743 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
745 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
747 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
749 next unless ($final_results_reached);
752 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
756 if (defined $parameter) {
757 # In case the caller needs to check
758 # the action and its parameter
759 $final_results{$action . $parameter} = 1;
761 # In case the action doesn't have parameters
762 # or the caller doesn't care for the parameter.
763 $final_results{$action} = 1;
767 return \%final_results;
770 sub check_status_code_result ($$) {
772 my $status_code = shift;
773 my $expected_status_code = shift;
776 unless (defined $status_code) {
778 # XXX: should probably be caught earlier.
779 l(LL_VERBOSE_FAILURE,
780 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
782 } elsif ($expected_status_code == $status_code) {
785 l(LL_VERBOSE_SUCCESS,
786 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
788 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
790 l(LL_VERBOSE_FAILURE,
791 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
795 l(LL_VERBOSE_FAILURE,
796 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
803 sub execute_client_header_regression_test ($) {
805 my $test_ref = shift;
809 $buffer_ref = get_show_request_with_curl($test_ref);
811 $header = get_header($buffer_ref, $test_ref);
813 return check_header_result($test_ref, $header);
816 sub execute_server_header_regression_test ($) {
818 my $test_ref = shift;
822 $buffer_ref = get_head_with_curl($test_ref);
824 $header = get_server_header($buffer_ref, $test_ref);
826 return check_header_result($test_ref, $header);
829 sub interpret_result ($) {
831 return $success ? "Success" : "Failure";
834 sub check_header_result ($$) {
836 my $test_ref = shift;
839 my %test = %{$test_ref};
840 my $expect_header = $test{'expect-header'};
843 if ($expect_header eq 'NO CHANGE') {
845 if (defined($header) and $header eq $test{'data'}) {
851 $header = "REMOVAL" unless defined $header;
852 l(LL_VERBOSE_FAILURE,
853 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
856 } elsif ($expect_header eq 'REMOVAL') {
858 if (defined($header) and $header eq $test{'data'}) {
860 l(LL_VERBOSE_FAILURE,
861 "Ooops. Expected removal but: " . $header . " is still there.");
865 # XXX: Use more reliable check here and make sure
866 # the header has a different name.
871 } elsif ($expect_header eq 'SOME CHANGE') {
873 if (defined($header) and not $header eq $test{'data'}) {
879 $header = "REMOVAL" unless defined $header;
880 l(LL_VERBOSE_FAILURE,
881 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
887 if (defined($header) and $header eq $expect_header) {
893 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
894 l(LL_VERBOSE_FAILURE,
895 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
901 sub get_header_name ($) {
905 $header =~ s@(.*?: ).*@$1@;
910 sub get_header ($$) {
912 our $filtered_request = '';
914 my $buffer_ref = shift;
915 my $test_ref = shift;
917 my %test = %{$test_ref};
918 my @buffer = @{$buffer_ref};
920 my $expect_header = $test{'expect-header'};
922 die "get_header called with no expect header" unless defined $expect_header;
925 my $processed_request_reached = 0;
927 my $processed_request = '';
931 if ($expect_header eq 'REMOVAL'
932 or $expect_header eq 'NO CHANGE'
933 or $expect_header eq 'SOME CHANGE') {
935 $expect_header = $test{'data'};
939 $header_to_get = get_header_name($expect_header);
943 # Skip everything before the Processed request
944 if (/Processed Request/) {
945 $processed_request_reached = 1;
948 next unless $processed_request_reached;
950 # End loop after the Processed request
953 # Ditch tags and leading/trailing white space.
957 # Decode characters we care about.
960 $filtered_request .= "\n" . $_;
962 if (/^$header_to_get/) {
972 sub get_server_header ($$) {
974 my $buffer_ref = shift;
975 my $test_ref = shift;
977 my %test = %{$test_ref};
978 my @buffer = @{$buffer_ref};
980 my $expect_header = $test{'expect-header'};
984 # XXX: Should be caught before starting to test.
985 l(LL_ERROR, "No expect header for test " . $test{'number'})
986 unless defined $expect_header;
988 if ($expect_header eq 'REMOVAL'
989 or $expect_header eq 'NO CHANGE'
990 or $expect_header eq 'SOME CHANGE') {
992 $expect_header = $test{'data'};
996 $header_to_get = get_header_name($expect_header);
1000 # XXX: should probably verify that the request
1001 # was actually answered by Fellatio.
1002 if (/^$header_to_get/) {
1004 $header =~ s@\s*$@@g;
1012 sub get_status_code ($) {
1014 my $buffer_ref = shift;
1015 my @buffer = @{$buffer_ref};
1019 if (/^HTTP\/\d\.\d (\d{3})/) {
1025 return '123' if cli_option_is_set('fuzzer-feeding');
1027 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1032 sub get_test_keys () {
1033 return ('tag', 'data', 'expect-header', 'ignore');
1037 sub test_content_as_string ($) {
1039 my $test_ref = shift;
1040 my %test = %{$test_ref};
1044 foreach my $key (get_test_keys()) {
1045 $test{$key} = 'Not set' unless (defined $test{$key});
1048 $s .= 'Tag: ' . $test{'tag'};
1050 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1052 $s .= 'Expected header: ' . $test{'expect-header'};
1054 $s .= 'Ignore: ' . $test{'ignore'};
1059 sub fuzz_header($) {
1061 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1063 $white_space = $white_space x (1 + int(rand(5)));
1065 # Only fuzz white space before the first quoted token.
1066 # (Privoxy doesn't touch white space inside quoted tokens
1067 # and modifying it would cause the tests to fail).
1068 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1073 ############################################################################
1075 # HTTP fetch functions
1077 ############################################################################
1079 sub check_for_curl () {
1081 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1084 sub get_cgi_page_or_else ($) {
1086 my $cgi_url = shift;
1087 my $content_ref = get_page_with_curl($cgi_url);
1088 my $status_code = get_status_code($content_ref);
1090 if (200 != $status_code) {
1092 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1093 "Received status code ". $status_code .
1094 " while only 200 is acceptable.";
1096 if (cli_option_is_set('fuzzer-feeding')) {
1098 $log_message .= " Ignored due to fuzzer feeding.";
1099 l(LL_SOFT_ERROR, $log_message)
1103 l(LL_ERROR, $log_message);
1108 return $content_ref;
1111 # XXX: misleading name
1112 sub get_show_request_with_curl ($) {
1114 our $privoxy_cgi_url;
1115 my $test_ref = shift;
1116 my %test = %{$test_ref};
1118 my $curl_parameters = ' ';
1119 my $header = $test{'data'};
1121 if (cli_option_is_set('header-fuzzing')) {
1122 $header = fuzz_header($header);
1125 # Enable the action to test
1126 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1127 # The header to filter
1128 $curl_parameters .= '-H \'' . $header . '\' ';
1130 $curl_parameters .= ' ';
1131 $curl_parameters .= $privoxy_cgi_url;
1132 $curl_parameters .= 'show-request';
1134 return get_cgi_page_or_else($curl_parameters);
1137 sub get_head_with_curl ($) {
1139 our $fellatio_url = FELLATIO_URL;
1140 my $test_ref = shift;
1141 my %test = %{$test_ref};
1143 my $curl_parameters = ' ';
1145 # Enable the action to test
1146 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1147 # The header to filter
1148 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1149 $curl_parameters .= '--head ';
1151 $curl_parameters .= ' ';
1152 $curl_parameters .= $fellatio_url;
1154 return get_page_with_curl($curl_parameters);
1157 sub get_page_with_curl ($) {
1161 my $parameters = shift;
1163 my $curl_line = CURL;
1164 my $retries_left = get_cli_option('retries') + 1;
1167 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1169 # We want to see the HTTP status code
1170 $curl_line .= " --include ";
1171 # Let Privoxy emit two log messages less.
1172 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1173 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1174 # We don't care about fetch statistic.
1175 $curl_line .= " -s ";
1176 # We do care about the failure reason if any.
1177 $curl_line .= " -S ";
1178 # We want to advertise ourselves
1179 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1180 # We aren't too patient
1181 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1183 $curl_line .= $parameters;
1184 # XXX: still necessary?
1185 $curl_line .= ' 2>&1';
1187 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1190 @buffer = `$curl_line`;
1193 $failure_reason = array_as_string(\@buffer);
1194 chomp $failure_reason;
1195 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1197 } while ($? && --$retries_left);
1199 unless ($retries_left) {
1201 "Running curl failed " . get_cli_option('retries') .
1202 " times in a row. Last error: '" . $failure_reason . "'.");
1209 ############################################################################
1213 ############################################################################
1215 sub array_as_string ($) {
1216 my $array_ref = shift;
1219 foreach (@{$array_ref}) {
1227 my $test_ref = shift;
1228 log_message('Test is:' . test_content_as_string($test_ref));
1234 my $this_level = shift;
1235 my $message = shift;
1237 return unless ($log_level & $this_level);
1239 if (LL_ERROR & $this_level) {
1240 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1243 log_message($message);
1245 if (LL_ERROR & $this_level) {
1250 sub log_message ($) {
1252 my $message = shift;
1256 our $leading_log_date;
1257 our $leading_log_time;
1259 my $time_stamp = '';
1260 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1262 if ($leading_log_date || $leading_log_time) {
1264 if ($leading_log_date) {
1267 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1270 if ($leading_log_time) {
1271 $time_stamp .= ' ' if $leading_log_date;
1272 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1275 $message = $time_stamp . ": " . $message;
1279 printf(STDERR "%s\n", $message);
1283 sub log_result ($$) {
1285 our $verbose_test_description;
1286 our $filtered_request;
1288 my $test_ref = shift;
1292 my %test = %{$test_ref};
1295 $message .= interpret_result($result);
1296 $message .= " for test ";
1297 $message .= $number;
1299 $message .= $test{'number'};
1301 $message .= $test{'section-id'};
1303 $message .= $test{'regression-test-id'};
1306 if ($verbose_test_description) {
1308 if ($test{'type'} == CLIENT_HEADER_TEST) {
1310 $message .= ' Header ';
1311 $message .= quote($test{'data'});
1312 $message .= ' and tag ';
1313 $message .= quote($test{'tag'});
1315 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1317 $message .= ' Request Header ';
1318 $message .= quote($test{'data'});
1319 $message .= ' and tag ';
1320 $message .= quote($test{'tag'});
1322 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1324 $message .= ' URL ';
1325 $message .= quote($test{'data'});
1326 $message .= ' and expected status code ';
1327 $message .= quote($test{'expected-status-code'});
1329 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1331 $message .= ' CGI URL ';
1332 $message .= quote($test{'data'});
1333 $message .= ' and expected status code ';
1334 $message .= quote($test{'expected-status-code'});
1336 } elsif ($test{'type'} == METHOD_TEST) {
1338 $message .= ' HTTP method ';
1339 $message .= quote($test{'data'});
1340 $message .= ' and expected status code ';
1341 $message .= quote($test{'expected-status-code'});
1343 } elsif ($test{'type'} == BLOCK_TEST) {
1345 $message .= ' Supposedly-blocked URL: ';
1346 $message .= quote($test{'data'});
1348 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1350 $message .= ' Sticky Actions: ';
1351 $message .= quote($test{'sticky-actions'});
1352 $message .= ' and URL: ';
1353 $message .= quote($test{'data'});
1357 die "Incomplete support for test type " . $test{'type'} . " detected.";
1362 log_message($message) if (!$result or cli_option_is_set('verbose'));
1367 return '\'' . $s . '\'';
1370 sub print_version () {
1371 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1382 Options and their default values if they have any:
1383 [--debug $cli_options{'debug'}]
1384 [--forks $cli_options{'forks'}]
1390 [--loops $cli_options{'loops'}]
1391 [--max-level $cli_options{'max-level'}]
1392 [--max-time $cli_options{'max-time'}]
1393 [--min-level $cli_options{'min-level'}]
1395 [--retries $cli_options{'retries'}]
1399 see "perldoc $0" for more information
1405 sub init_cli_options () {
1410 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1411 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1412 $cli_options{'debug'} = $log_level;
1413 $cli_options{'loops'} = CLI_LOOPS;
1414 $cli_options{'max-time'} = CLI_MAX_TIME;
1415 $cli_options{'retries'} = CLI_RETRIES;
1416 $cli_options{'forks'} = CLI_FORKS;
1419 sub parse_cli_options () {
1427 'debug=s' => \$cli_options{'debug'},
1428 'forks=s' => \$cli_options{'forks'},
1429 'help' => sub { help },
1430 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1431 'min-level=s' => \$cli_options{'min-level'},
1432 'max-level=s' => \$cli_options{'max-level'},
1433 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1434 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1435 'level=s' => \$cli_options{'level'},
1436 'loops=s' => \$cli_options{'loops'},
1437 'test-number=s' => \$cli_options{'test-number'},
1438 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1439 'retries=s' => \$cli_options{'retries'},
1440 'max-time=s' => \$cli_options{'max-time'},
1441 'verbose' => \$cli_options{'verbose'},
1442 'version' => sub { print_version && exit(0) }
1444 $log_level |= $cli_options{'debug'};
1447 sub cli_option_is_set ($) {
1450 my $cli_option = shift;
1452 return defined $cli_options{$cli_option};
1455 sub get_cli_option ($) {
1458 my $cli_option = shift;
1460 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1462 return $cli_options{$cli_option};
1465 sub init_proxy_settings($) {
1470 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1471 $proxy = get_cli_option('fuzzer-address');
1474 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1476 if (cli_option_is_set('privoxy-address')) {
1477 $proxy .= get_cli_option('privoxy-address');
1483 sub start_forks($) {
1486 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1488 foreach my $fork (1 .. $forks) {
1489 log_message("Starting fork $fork");
1491 if (defined $pid && !$pid) {
1499 init_our_variables();
1500 parse_cli_options();
1502 init_proxy_settings('vanilla-proxy');
1503 load_regressions_tests();
1504 init_proxy_settings('fuzz-proxy');
1505 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1506 execute_regression_tests();
1513 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1517 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1518 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1519 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1520 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1521 [B<--retries retries>] [B<--test-number test-number>] [B<--verbose>]
1526 Privoxy-Regression-Test is supposed to one day become
1527 a regression test suite for Privoxy. It's not quite there
1528 yet, however, and can currently only test header actions,
1529 check the returned status code for requests to arbitrary
1530 URLs and verify which actions are applied to them.
1532 Client header actions are tested by requesting
1533 B<http://p.p/show-request> and checking whether
1534 or not Privoxy modified the original request as expected.
1536 The original request contains both the header the action-to-be-tested
1537 acts upon and an additional tagger-triggering header that enables
1540 Applied actions are checked through B<http://p.p/show-url-info>.
1542 =head1 CONFIGURATION FILE SYNTAX
1544 Privoxy-Regression-Test's configuration is embedded in
1545 Privoxy action files and loaded through Privoxy's web interface.
1547 It makes testing a Privoxy version running on a remote system easier
1548 and should prevent you from updating your tests without updating Privoxy's
1549 configuration accordingly.
1551 A client-header-action test section looks like this:
1553 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1554 # Expect Header = Referer: http://www.example.org/
1555 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1556 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1558 The example above causes Privoxy-Regression-Test to set
1559 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1560 and to expect it to be modified to
1561 B<Referer: http://www.example.org/>.
1563 When testing this section, Privoxy-Regression-Test will set the header
1564 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1565 causing the B<privoxy-control> tagger to create the tag
1566 B<client-header-filter{hide-tor-exit-notation}> which will finally
1567 cause Privoxy to enable the action section.
1569 Note that the actions itself are only used by Privoxy,
1570 Privoxy-Regression-Test ignores them and will be happy
1571 as long as the expectations are satisfied.
1573 A fetch test looks like this:
1575 # Fetch Test = http://p.p/user-manual
1576 # Expect Status Code = 302
1578 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1579 and to expect a response with the HTTP status code B<302>. Obviously that's
1580 not a very thorough test and mainly useful to get some code coverage
1581 for Valgrind or to verify that the templates are installed correctly.
1583 If you want to test CGI pages that require a trusted
1584 referer, you can use:
1586 # Trusted CGI Request = http://p.p/edit-actions
1588 It works like ordinary fetch tests, but sets the referer
1589 header to a trusted value.
1591 If no explicit status code expectation is set, B<200> is used.
1593 To verify that a URL is blocked, use:
1595 # Blocked URL = http://www.example.com/blocked
1597 To verify that a specific set of actions is applied to an URL, use:
1599 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1600 # URL = http://www.example.org/my-first-url
1602 The sticky actions will be checked for all URLs below it
1603 until the next sticky actions directive.
1607 All tests have test levels to let the user
1608 control which ones to execute (see I<OPTIONS> below).
1609 Test levels are either set with the B<Level> directive,
1610 or implicitly through the test type.
1612 Block tests default to level 7, fetch tests to level 6,
1613 "Sticky Actions" tests default to level 5, tests for trusted CGI
1614 requests to level 3 and client-header-action tests to level 1.
1618 B<--debug bitmask> Add the bitmask provided as integer
1619 to the debug settings.
1621 B<--forks forks> Number of forks to start before executing
1622 the regression tests. This is mainly useful for stress-testing.
1624 B<--fuzzer-address> Listening address used when executing
1625 the regression tests. Useful to make sure that the requests
1626 to load the regression tests don't fail due to fuzzing.
1628 B<--fuzzer-feeding> Ignore some errors that would otherwise
1629 cause Privoxy-Regression-Test to abort the test because
1630 they shouldn't happen in normal operation. This option is
1631 intended to be used if Privoxy-Regression-Test is only
1632 used to feed a fuzzer in which case there's a high chance
1633 that Privoxy gets an invalid request and returns an error
1636 B<--help> Shows available command line options.
1638 B<--header-fuzzing> Modifies linear white space in
1639 headers in a way that should not affect the test result.
1641 B<--level level> Only execute tests with the specified B<level>.
1643 B<--loop count> Loop through the regression tests B<count> times.
1644 Useful to feed a fuzzer, or when doing stress tests with
1645 several Privoxy-Regression-Test instances running at the same
1648 B<--max-level max-level> Only execute tests with a B<level>
1649 below or equal to the numerical B<max-level>.
1651 B<--max-time max-time> Give Privoxy B<max-time> seconds
1652 to return data. Increasing the default may make sense when
1653 Privoxy is run through Valgrind, decreasing the default may
1654 make sense when Privoxy-Regression-Test is used to feed
1657 B<--min-level min-level> Only execute tests with a B<level>
1658 above or equal to the numerical B<min-level>.
1660 B<--privoxy-address proxy-address> Privoxy's listening address.
1661 If it's not set, the value of the environment variable http_proxy
1662 will be used. B<proxy-address> has to be specified in http_proxy
1665 B<--retries retries> Retry B<retries> times.
1667 B<--test-number test-number> Only run the test with the specified
1670 B<--verbose> Also log succesful test runs.
1672 B<--version> Print version and exit.
1674 The second dash is optional, options can be shortened,
1675 as long as there are no ambiguities.
1677 =head1 PRIVOXY CONFIGURATION
1679 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1680 which aims to test all official client-header modifying actions
1681 and can be used to verify that the templates and the user manual
1682 files are installed correctly.
1684 To use it, it has to be copied in Privoxy's configuration
1685 directory, and afterwards referenced in Privoxy's configuration
1688 actionsfile regression-tests.action
1690 In general, its tests are supposed to work without changing
1691 any other action files, unless you already added lots of
1692 taggers yourself. If you are using taggers that cause problems,
1693 you might have to temporary disable them for Privoxy's CGI pages.
1695 Some of the regression tests rely on Privoxy features that
1696 may be disabled in your configuration. Tests with a level below
1697 7 are supposed to work with all Privoxy configurations (provided
1698 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1700 Tests with level 9 require Privoxy to deliver the User Manual,
1701 tests with level 12 require the CGI editor to be enabled.
1705 Expect the configuration file syntax to change with future releases.
1709 As Privoxy's B<show-request> page only shows client headers,
1710 Privoxy-Regression-Test can't use it to test Privoxy actions
1711 that modify server headers.
1713 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1714 control the actions to test, it currently only works with
1715 Privoxy 3.0.7 or later.
1717 At the moment Privoxy-Regression-Test fetches Privoxy's
1718 configuration page through I<curl>(1), therefore you have to
1719 have I<curl> installed, otherwise you won't be able to run
1720 Privoxy-Regression-Test in a meaningful way.
1728 Fabian Keil <fk@fabiankeil.de>