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.171 2009/05/19 14:34:49 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-2009 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',
52 # XXX: why limit at all?
56 PRIVOXY_CGI_URL => 'http://p.p/',
57 FELLATIO_URL => 'http://127.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,
63 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
64 # XXX: Only partly implemented and mostly useless.
65 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
66 DEBUG_LEVEL_STATUS => 1,
68 VERBOSE_TEST_DESCRIPTION => 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 ($) {
144 my $allowed = '[-=\dA-Za-z~{}:./();\s,+@"_%?&*^]';
146 unless ($string =~ m/^$allowed*$/o) {
147 my $forbidden = $string;
148 $forbidden =~ s@^$allowed*(.).*@$1@;
150 l(LL_ERROR, "'" . $string . "' 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*([^#]+)$/) {
231 $token =~ s@\s\s+@ @g;
232 $token =~ tr/[A-Z]/[a-z]/;
234 } elsif (/^TAG\s*:(.*)$/) {
240 return ($token, $value);
243 sub enlist_new_test ($$$$$$) {
245 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
248 if ($token eq 'set header') {
250 l(LL_FILE_LOADING, "Header to set: " . $value);
251 $type = CLIENT_HEADER_TEST;
253 } elsif ($token eq 'request header') {
255 l(LL_FILE_LOADING, "Header to request: " . $value);
256 $type = SERVER_HEADER_TEST;
257 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
259 } elsif ($token eq 'trusted cgi request') {
261 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
262 $type = TRUSTED_CGI_REQUEST;
263 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
265 } elsif ($token eq 'fetch test') {
267 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
268 $type = DUMB_FETCH_TEST;
269 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
271 } elsif ($token eq 'method test') {
273 l(LL_FILE_LOADING, "Method to test: " . $value);
275 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
277 } elsif ($token eq 'blocked url') {
279 l(LL_FILE_LOADING, "URL to block-test: " . $value);
282 } elsif ($token eq 'url') {
284 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
285 $type = STICKY_ACTIONS_TEST;
289 die "Incomplete '" . $token . "' support detected.";
292 $$regression_tests[$si][$ri]{'type'} = $type;
293 $$regression_tests[$si][$ri]{'level'} = $type;
295 check_for_forbidden_characters($value);
297 $$regression_tests[$si][$ri]{'data'} = $value;
299 # For function that only get passed single tests
300 $$regression_tests[$si][$ri]{'section-id'} = $si;
301 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
302 $$regression_tests[$si][$ri]{'number'} = $number - 1;
304 "Regression test " . $number . " (section:" . $si . "):");
307 sub load_action_files ($) {
311 our @regression_tests;
313 my $actionfiles_ref = shift;
314 my @actionfiles = @{$actionfiles_ref};
316 my $si = 0; # Section index
317 my $ri = -1; # Regression test index
322 l(LL_STATUS, "Gathering regression tests from " .
323 @actionfiles . " action file(s) delivered by Privoxy.");
325 for my $file_number (0 .. @actionfiles - 1) {
327 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
328 my $actionfile = undef;
329 my $sticky_actions = undef;
331 foreach (@{get_cgi_page_or_else($curl_url)}) {
336 if (/<h2>Contents of Actions File (.*?)</) {
340 next unless defined $actionfile;
344 my ($token, $value) = tokenize($_);
346 next unless defined $token;
348 # Load regression tests
350 if (token_starts_new_test($token)) {
352 # Beginning of new regression test.
355 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
358 if ($token =~ /level\s+(\d+)/i) {
361 register_dependency($level, $value);
364 if ($token eq 'sticky actions') {
366 # Will be used by each following Sticky URL.
367 $sticky_actions = $value;
368 if ($sticky_actions =~ /{[^}]*\s/) {
370 "'Sticky Actions' with whitespace inside the " .
371 "action parameters are currently unsupported.");
375 if ($si == -1 || $ri == -1) {
376 # No beginning of a test detected yet,
377 # so we don't care about any other test
382 if ($token eq 'expect header') {
384 l(LL_FILE_LOADING, "Detected expectation: " . $value);
385 $regression_tests[$si][$ri]{'expect-header'} = $value;
387 } elsif ($token eq 'tag') {
391 my $tag = parse_tag($value);
393 # We already checked in parse_tag() after filtering
396 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
398 # Save tag for all tests in this section
400 $regression_tests[$si][$ri]{'tag'} = $tag;
406 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
408 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
409 $regression_tests[$si][$ri]{'ignore'} = 1;
412 } elsif ($token eq 'expect status code') {
414 l(LL_FILE_LOADING, "Expecting status code: " . $value);
415 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
417 } elsif ($token eq 'level') { # XXX: stupid name
419 $value =~ s@(\d+).*@$1@;
420 l(LL_FILE_LOADING, "Level: " . $value);
421 $regression_tests[$si][$ri]{'level'} = $value;
423 } elsif ($token eq 'method') {
425 l(LL_FILE_LOADING, "Method: " . $value);
426 $regression_tests[$si][$ri]{'method'} = $value;
428 } elsif ($token eq 'url') {
430 if (defined $sticky_actions) {
431 die "WTF? Attempted to overwrite Sticky Actions"
432 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
434 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
435 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
437 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
442 # We don't use it, so we don't need
446 check_for_forbidden_characters($value) unless $no_checks;
447 check_for_forbidden_characters($token);
451 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
452 . " Of which " . $ignored. " will be ignored)\n");
455 ############################################################################
457 # Regression test executing functions
459 ############################################################################
461 sub execute_regression_tests () {
463 our @regression_tests;
464 my $loops = get_cli_option('loops');
466 my $all_failures = 0;
467 my $all_successes = 0;
469 unless (@regression_tests) {
471 l(LL_STATUS, "No regression tests found.");
475 l(LL_STATUS, "Executing regression tests ...");
477 while ($loops-- > 0) {
484 for my $s (0 .. @regression_tests - 1) {
488 while (defined $regression_tests[$s][$r]) {
490 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
491 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
493 my $number = $regression_tests[$s][$r]{'number'};
494 my $skip_reason = undef;
496 if ($regression_tests[$s][$r]{'ignore'}) {
498 $skip_reason = "Ignore flag is set";
500 } elsif (cli_option_is_set('test-number')
501 and get_cli_option('test-number') != $number) {
503 $skip_reason = "Only executing test " . get_cli_option('test-number');
507 $skip_reason = level_is_unacceptable($regression_tests[$s][$r]{'level'});
510 if (defined $skip_reason) {
512 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
513 log_message($message) if (cli_option_is_set('show-skipped-tests'));
518 my $result = execute_regression_test($regression_tests[$s][$r]);
520 log_result($regression_tests[$s][$r], $result, $tests);
522 $successes += $result;
528 $failures = $tests - $successes;
530 log_message("Executed " . $tests . " regression tests. " .
531 'Skipped ' . $skipped . '. ' .
532 $successes . " successes, " . $failures . " failures.");
534 $all_tests += $tests;
535 $all_failures += $failures;
536 $all_successes += $successes;
539 if (get_cli_option('loops') > 1) {
540 log_message("Total: Executed " . $all_tests . " regression tests. " .
541 $all_successes . " successes, " . $all_failures . " failures.");
545 sub level_is_unacceptable ($) {
547 my $min_level = get_cli_option('min-level');
548 my $max_level = get_cli_option('max-level');
549 my $required_level = cli_option_is_set('level') ?
550 get_cli_option('level') : $level;
553 if ($required_level != $level) {
555 $reason = "Level doesn't match (" . $level .
556 " != " . $required_level . ")"
558 } elsif ($level < $min_level) {
560 $reason = "Level to low (" . $level . " < " . $min_level . ")";
562 } elsif ($level > $max_level) {
564 $reason = "Level to high (" . $level . " > " . $max_level . ")";
568 $reason = dependency_unsatisfied($level);
574 sub dependency_unsatisfied ($) {
579 our %privoxy_features;
581 my $dependency_problem = undef;
583 if (defined ($dependencies{$level}{'config line'})) {
585 my $dependency = $dependencies{$level}{'config line'};
586 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
588 foreach (@privoxy_config) {
590 $dependency_problem = undef if (/$dependency/);
591 last; # XXX: this looks ... interesting.
594 } elsif (defined ($dependencies{$level}{'feature status'})) {
596 my $dependency = $dependencies{$level}{'feature status'};
597 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
599 unless (defined($privoxy_features{$feature})
600 and ($privoxy_features{$feature} eq $status))
602 $dependency_problem = "depends on '" . $feature .
603 "' being set to '" . $status . "'";
607 return $dependency_problem;
610 sub register_dependency ($$) {
613 my $dependency = shift;
616 if ($dependency =~ /config line\s+(.*)/) {
618 $dependencies{$level}{'config line'} = $1;
620 } elsif ($dependency =~ /feature status\s+(.*)/) {
622 $dependencies{$level}{'feature status'} = $1;
626 # XXX: somewhat misleading name
627 sub execute_regression_test ($) {
629 my $test_ref = shift;
630 my %test = %{$test_ref};
633 if ($test{'type'} == CLIENT_HEADER_TEST) {
635 $result = execute_client_header_regression_test($test_ref);
637 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
639 $result = execute_server_header_regression_test($test_ref);
641 } elsif ($test{'type'} == DUMB_FETCH_TEST
642 or $test{'type'} == TRUSTED_CGI_REQUEST) {
644 $result = execute_dumb_fetch_test($test_ref);
646 } elsif ($test{'type'} == METHOD_TEST) {
648 $result = execute_method_test($test_ref);
650 } elsif ($test{'type'} == BLOCK_TEST) {
652 $result = execute_block_test($test_ref);
654 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
656 $result = execute_sticky_actions_test($test_ref);
660 die "Unsupported test type detected: " . $test{'type'};
666 sub execute_method_test ($) {
668 my $test_ref = shift;
669 my %test = %{$test_ref};
672 my $method = $test{'data'};
674 my $curl_parameters = '';
675 my $expected_status_code = $test{'expected-status-code'};
677 $curl_parameters .= '--request ' . $method . ' ';
678 # Don't complain about the 'missing' body
679 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
681 $curl_parameters .= PRIVOXY_CGI_URL;
683 $buffer_ref = get_page_with_curl($curl_parameters);
684 $status_code = get_status_code($buffer_ref);
686 return check_status_code_result($status_code, $expected_status_code);
689 sub execute_dumb_fetch_test ($) {
691 my $test_ref = shift;
692 my %test = %{$test_ref};
696 my $curl_parameters = '';
697 my $expected_status_code = $test{'expected-status-code'};
699 if (defined $test{method}) {
700 $curl_parameters .= '--request ' . $test{method} . ' ';
702 if ($test{type} == TRUSTED_CGI_REQUEST) {
703 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
706 $curl_parameters .= $test{'data'};
708 $buffer_ref = get_page_with_curl($curl_parameters);
709 $status_code = get_status_code($buffer_ref);
711 return check_status_code_result($status_code, $expected_status_code);
714 sub execute_block_test ($) {
717 my $url = $test->{'data'};
718 my $final_results = get_final_results($url);
720 return defined $final_results->{'+block'};
723 sub execute_sticky_actions_test ($) {
726 my $url = $test->{'data'};
727 my $verified_actions = 0;
728 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
729 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
730 my $final_results = get_final_results($url);
732 foreach my $sticky_action (@sticky_actions) {
733 if (defined $final_results->{$sticky_action}) {
736 }elsif ($sticky_action =~ /-.*\{/ and
737 not defined $final_results->{$sticky_action}) {
738 # Disabled multi actions aren't explicitly listed as
739 # disabled and thus have to be checked by verifying
740 # that they aren't enabled.
743 l(LL_VERBOSE_FAILURE,
744 "Ooops. '$sticky_action' is not among the final results.");
748 return $verified_actions == @sticky_actions;
751 sub get_final_results ($) {
754 my $curl_parameters = '';
755 my %final_results = ();
756 my $final_results_reached = 0;
758 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
759 # XXX: should be URL-encoded properly
766 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
768 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
770 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
772 next unless ($final_results_reached);
775 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
779 if (defined $parameter) {
780 # In case the caller needs to check
781 # the action and its parameter
782 $final_results{$action . $parameter} = 1;
784 # In case the action doesn't have parameters
785 # or the caller doesn't care for the parameter.
786 $final_results{$action} = 1;
790 return \%final_results;
793 sub check_status_code_result ($$) {
795 my $status_code = shift;
796 my $expected_status_code = shift;
799 unless (defined $status_code) {
801 # XXX: should probably be caught earlier.
802 l(LL_VERBOSE_FAILURE,
803 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
805 } elsif ($expected_status_code == $status_code) {
808 l(LL_VERBOSE_SUCCESS,
809 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
811 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
813 l(LL_VERBOSE_FAILURE,
814 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
818 l(LL_VERBOSE_FAILURE,
819 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
825 sub execute_client_header_regression_test ($) {
827 my $test_ref = shift;
831 $buffer_ref = get_show_request_with_curl($test_ref);
833 $header = get_header($buffer_ref, $test_ref);
835 return check_header_result($test_ref, $header);
838 sub execute_server_header_regression_test ($) {
840 my $test_ref = shift;
844 $buffer_ref = get_head_with_curl($test_ref);
846 $header = get_server_header($buffer_ref, $test_ref);
848 return check_header_result($test_ref, $header);
851 sub interpret_result ($) {
853 return $success ? "Success" : "Failure";
856 sub check_header_result ($$) {
858 my $test_ref = shift;
861 my %test = %{$test_ref};
862 my $expect_header = $test{'expect-header'};
865 if ($expect_header eq 'NO CHANGE') {
867 if (defined($header) and $header eq $test{'data'}) {
873 $header = "REMOVAL" unless defined $header;
874 l(LL_VERBOSE_FAILURE,
875 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
878 } elsif ($expect_header eq 'REMOVAL') {
880 if (defined($header) and $header eq $test{'data'}) {
882 l(LL_VERBOSE_FAILURE,
883 "Ooops. Expected removal but: '" . $header . "' is still there.");
887 # XXX: Use more reliable check here and make sure
888 # the header has a different name.
892 } elsif ($expect_header eq 'SOME CHANGE') {
894 if (defined($header) and not $header eq $test{'data'}) {
900 $header = "REMOVAL" unless defined $header;
901 l(LL_VERBOSE_FAILURE,
902 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
907 if (defined($header) and $header eq $expect_header) {
913 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
914 l(LL_VERBOSE_FAILURE,
915 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
921 sub get_header_name ($) {
925 $header =~ s@(.*?: ).*@$1@;
930 sub get_header ($$) {
932 our $filtered_request = '';
934 my $buffer_ref = shift;
935 my $test_ref = shift;
937 my %test = %{$test_ref};
938 my @buffer = @{$buffer_ref};
940 my $expect_header = $test{'expect-header'};
942 die "get_header called with no expect header" unless defined $expect_header;
945 my $processed_request_reached = 0;
947 my $processed_request = '';
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'};
958 $header_to_get = get_header_name($expect_header);
962 # Skip everything before the Processed request
963 if (/Processed Request/) {
964 $processed_request_reached = 1;
967 next unless $processed_request_reached;
969 # End loop after the Processed request
972 # Ditch tags and leading/trailing white space.
976 # Decode characters we care about.
979 $filtered_request .= "\n" . $_;
981 if (/^$header_to_get/) {
991 sub get_server_header ($$) {
993 my $buffer_ref = shift;
994 my $test_ref = shift;
996 my %test = %{$test_ref};
997 my @buffer = @{$buffer_ref};
999 my $expect_header = $test{'expect-header'};
1003 # XXX: Should be caught before starting to test.
1004 l(LL_ERROR, "No expect header for test " . $test{'number'})
1005 unless defined $expect_header;
1007 if ($expect_header eq 'REMOVAL'
1008 or $expect_header eq 'NO CHANGE'
1009 or $expect_header eq 'SOME CHANGE') {
1011 $expect_header = $test{'data'};
1014 $header_to_get = get_header_name($expect_header);
1018 # XXX: should probably verify that the request
1019 # was actually answered by Fellatio.
1020 if (/^$header_to_get/) {
1022 $header =~ s@\s*$@@g;
1030 sub get_status_code ($) {
1032 my $buffer_ref = shift;
1033 my @buffer = @{$buffer_ref};
1037 if (/^HTTP\/\d\.\d (\d{3})/) {
1043 return '123' if cli_option_is_set('fuzzer-feeding');
1045 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1050 sub get_test_keys () {
1051 return ('tag', 'data', 'expect-header', 'ignore');
1055 sub test_content_as_string ($) {
1057 my $test_ref = shift;
1058 my %test = %{$test_ref};
1062 foreach my $key (get_test_keys()) {
1063 $test{$key} = 'Not set' unless (defined $test{$key});
1066 $s .= 'Tag: ' . $test{'tag'};
1068 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1070 $s .= 'Expected header: ' . $test{'expect-header'};
1072 $s .= 'Ignore: ' . $test{'ignore'};
1077 sub fuzz_header($) {
1079 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1081 $white_space = $white_space x (1 + int(rand(5)));
1083 # Only fuzz white space before the first quoted token.
1084 # (Privoxy doesn't touch white space inside quoted tokens
1085 # and modifying it would cause the tests to fail).
1086 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1091 ############################################################################
1093 # HTTP fetch functions
1095 ############################################################################
1097 sub check_for_curl () {
1099 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1102 sub get_cgi_page_or_else ($) {
1104 my $cgi_url = shift;
1105 my $content_ref = get_page_with_curl($cgi_url);
1106 my $status_code = get_status_code($content_ref);
1108 if (200 != $status_code) {
1110 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1111 "Received status code ". $status_code .
1112 " while only 200 is acceptable.";
1114 if (cli_option_is_set('fuzzer-feeding')) {
1116 $log_message .= " Ignored due to fuzzer feeding.";
1117 l(LL_SOFT_ERROR, $log_message)
1121 l(LL_ERROR, $log_message);
1125 return $content_ref;
1128 # XXX: misleading name
1129 sub get_show_request_with_curl ($) {
1131 our $privoxy_cgi_url;
1132 my $test_ref = shift;
1133 my %test = %{$test_ref};
1135 my $curl_parameters = ' ';
1136 my $header = $test{'data'};
1138 if (cli_option_is_set('header-fuzzing')) {
1139 $header = fuzz_header($header);
1142 # Enable the action to test
1143 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1144 # The header to filter
1145 $curl_parameters .= '-H \'' . $header . '\' ';
1147 $curl_parameters .= ' ';
1148 $curl_parameters .= $privoxy_cgi_url;
1149 $curl_parameters .= 'show-request';
1151 return get_cgi_page_or_else($curl_parameters);
1154 sub get_head_with_curl ($) {
1156 our $fellatio_url = FELLATIO_URL;
1157 my $test_ref = shift;
1158 my %test = %{$test_ref};
1160 my $curl_parameters = ' ';
1162 # Enable the action to test
1163 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1164 # The header to filter
1165 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1166 $curl_parameters .= '--head ';
1168 $curl_parameters .= ' ';
1169 $curl_parameters .= $fellatio_url;
1171 return get_page_with_curl($curl_parameters);
1174 sub get_page_with_curl ($) {
1178 my $parameters = shift;
1180 my $curl_line = CURL;
1181 my $retries_left = get_cli_option('retries') + 1;
1184 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1186 # We want to see the HTTP status code
1187 $curl_line .= " --include ";
1188 # Let Privoxy emit two log messages less.
1189 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1190 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1191 # We don't care about fetch statistic.
1192 $curl_line .= " -s ";
1193 # We do care about the failure reason if any.
1194 $curl_line .= " -S ";
1195 # We want to advertise ourselves
1196 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1197 # We aren't too patient
1198 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1200 $curl_line .= $parameters;
1201 # XXX: still necessary?
1202 $curl_line .= ' 2>&1';
1204 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1207 @buffer = `$curl_line`;
1210 $failure_reason = array_as_string(\@buffer);
1211 chomp $failure_reason;
1212 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1214 } while ($? && --$retries_left);
1216 unless ($retries_left) {
1218 "Running curl failed " . get_cli_option('retries') .
1219 " times in a row. Last error: '" . $failure_reason . "'.");
1226 ############################################################################
1230 ############################################################################
1232 sub array_as_string ($) {
1233 my $array_ref = shift;
1236 foreach (@{$array_ref}) {
1244 my $test_ref = shift;
1245 log_message('Test is:' . test_content_as_string($test_ref));
1251 my $this_level = shift;
1252 my $message = shift;
1254 return unless ($log_level & $this_level);
1256 if (LL_ERROR & $this_level) {
1257 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1260 log_message($message);
1262 if (LL_ERROR & $this_level) {
1267 sub log_message ($) {
1269 my $message = shift;
1273 our $leading_log_date;
1274 our $leading_log_time;
1276 my $time_stamp = '';
1277 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1279 if ($leading_log_date || $leading_log_time) {
1281 if ($leading_log_date) {
1284 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1287 if ($leading_log_time) {
1288 $time_stamp .= ' ' if $leading_log_date;
1289 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1292 $message = $time_stamp . ": " . $message;
1295 printf(STDERR "%s\n", $message);
1298 sub log_result ($$) {
1300 our $verbose_test_description;
1301 our $filtered_request;
1303 my $test_ref = shift;
1307 my %test = %{$test_ref};
1310 $message .= interpret_result($result);
1311 $message .= " for test ";
1312 $message .= $number;
1314 $message .= $test{'number'};
1316 $message .= $test{'section-id'};
1318 $message .= $test{'regression-test-id'};
1321 if ($verbose_test_description) {
1323 if ($test{'type'} == CLIENT_HEADER_TEST) {
1325 $message .= ' Header ';
1326 $message .= quote($test{'data'});
1327 $message .= ' and tag ';
1328 $message .= quote($test{'tag'});
1330 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1332 $message .= ' Request Header ';
1333 $message .= quote($test{'data'});
1334 $message .= ' and tag ';
1335 $message .= quote($test{'tag'});
1337 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1339 $message .= ' URL ';
1340 $message .= quote($test{'data'});
1341 $message .= ' and expected status code ';
1342 $message .= quote($test{'expected-status-code'});
1344 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1346 $message .= ' CGI URL ';
1347 $message .= quote($test{'data'});
1348 $message .= ' and expected status code ';
1349 $message .= quote($test{'expected-status-code'});
1351 } elsif ($test{'type'} == METHOD_TEST) {
1353 $message .= ' HTTP method ';
1354 $message .= quote($test{'data'});
1355 $message .= ' and expected status code ';
1356 $message .= quote($test{'expected-status-code'});
1358 } elsif ($test{'type'} == BLOCK_TEST) {
1360 $message .= ' Supposedly-blocked URL: ';
1361 $message .= quote($test{'data'});
1363 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1365 $message .= ' Sticky Actions: ';
1366 $message .= quote($test{'sticky-actions'});
1367 $message .= ' and URL: ';
1368 $message .= quote($test{'data'});
1372 die "Incomplete support for test type " . $test{'type'} . " detected.";
1376 log_message($message) if (!$result or cli_option_is_set('verbose'));
1381 return '\'' . $s . '\'';
1384 sub print_version () {
1385 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1396 Options and their default values if they have any:
1397 [--debug $cli_options{'debug'}]
1398 [--forks $cli_options{'forks'}]
1404 [--loops $cli_options{'loops'}]
1405 [--max-level $cli_options{'max-level'}]
1406 [--max-time $cli_options{'max-time'}]
1407 [--min-level $cli_options{'min-level'}]
1409 [--retries $cli_options{'retries'}]
1410 [--show-skipped-tests]
1414 see "perldoc $0" for more information
1420 sub init_cli_options () {
1425 $cli_options{'debug'} = $log_level;
1426 $cli_options{'forks'} = CLI_FORKS;
1427 $cli_options{'loops'} = CLI_LOOPS;
1428 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1429 $cli_options{'max-time'} = CLI_MAX_TIME;
1430 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1431 $cli_options{'retries'} = CLI_RETRIES;
1434 sub parse_cli_options () {
1442 'debug=s' => \$cli_options{'debug'},
1443 'forks=s' => \$cli_options{'forks'},
1444 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1445 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1446 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1447 'help' => sub {help},
1448 'level=s' => \$cli_options{'level'},
1449 'loops=s' => \$cli_options{'loops'},
1450 'max-level=s' => \$cli_options{'max-level'},
1451 'max-time=s' => \$cli_options{'max-time'},
1452 'min-level=s' => \$cli_options{'min-level'},
1453 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1454 'retries=s' => \$cli_options{'retries'},
1455 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1456 'test-number=s' => \$cli_options{'test-number'},
1457 'verbose' => \$cli_options{'verbose'},
1458 'version' => sub {print_version && exit(0)}
1460 $log_level |= $cli_options{'debug'};
1463 sub cli_option_is_set ($) {
1466 my $cli_option = shift;
1468 return defined $cli_options{$cli_option};
1471 sub get_cli_option ($) {
1474 my $cli_option = shift;
1476 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1478 return $cli_options{$cli_option};
1481 sub init_proxy_settings($) {
1486 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1487 $proxy = get_cli_option('fuzzer-address');
1490 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1492 if (cli_option_is_set('privoxy-address')) {
1493 $proxy .= get_cli_option('privoxy-address');
1498 sub start_forks($) {
1501 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1503 foreach my $fork (1 .. $forks) {
1504 log_message("Starting fork $fork");
1506 if (defined $pid && !$pid) {
1514 init_our_variables();
1515 parse_cli_options();
1517 init_proxy_settings('vanilla-proxy');
1518 load_regressions_tests();
1519 init_proxy_settings('fuzz-proxy');
1520 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1521 execute_regression_tests();
1528 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1532 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1533 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1534 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1535 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1536 [B<--retries retries>] [B<--test-number test-number>]
1537 [B<--show-skipped-tests>] [B<--verbose>]
1542 Privoxy-Regression-Test is supposed to one day become
1543 a regression test suite for Privoxy. It's not quite there
1544 yet, however, and can currently only test header actions,
1545 check the returned status code for requests to arbitrary
1546 URLs and verify which actions are applied to them.
1548 Client header actions are tested by requesting
1549 B<http://p.p/show-request> and checking whether
1550 or not Privoxy modified the original request as expected.
1552 The original request contains both the header the action-to-be-tested
1553 acts upon and an additional tagger-triggering header that enables
1556 Applied actions are checked through B<http://p.p/show-url-info>.
1558 =head1 CONFIGURATION FILE SYNTAX
1560 Privoxy-Regression-Test's configuration is embedded in
1561 Privoxy action files and loaded through Privoxy's web interface.
1563 It makes testing a Privoxy version running on a remote system easier
1564 and should prevent you from updating your tests without updating Privoxy's
1565 configuration accordingly.
1567 A client-header-action test section looks like this:
1569 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1570 # Expect Header = Referer: http://www.example.org/
1571 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1572 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1574 The example above causes Privoxy-Regression-Test to set
1575 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1576 and to expect it to be modified to
1577 B<Referer: http://www.example.org/>.
1579 When testing this section, Privoxy-Regression-Test will set the header
1580 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1581 causing the B<privoxy-control> tagger to create the tag
1582 B<client-header-filter{hide-tor-exit-notation}> which will finally
1583 cause Privoxy to enable the action section.
1585 Note that the actions itself are only used by Privoxy,
1586 Privoxy-Regression-Test ignores them and will be happy
1587 as long as the expectations are satisfied.
1589 A fetch test looks like this:
1591 # Fetch Test = http://p.p/user-manual
1592 # Expect Status Code = 302
1594 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1595 and to expect a response with the HTTP status code B<302>. Obviously that's
1596 not a very thorough test and mainly useful to get some code coverage
1597 for Valgrind or to verify that the templates are installed correctly.
1599 If you want to test CGI pages that require a trusted
1600 referer, you can use:
1602 # Trusted CGI Request = http://p.p/edit-actions
1604 It works like ordinary fetch tests, but sets the referer
1605 header to a trusted value.
1607 If no explicit status code expectation is set, B<200> is used.
1609 To verify that a URL is blocked, use:
1611 # Blocked URL = http://www.example.com/blocked
1613 To verify that a specific set of actions is applied to an URL, use:
1615 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1616 # URL = http://www.example.org/my-first-url
1618 The sticky actions will be checked for all URLs below it
1619 until the next sticky actions directive.
1623 All tests have test levels to let the user
1624 control which ones to execute (see I<OPTIONS> below).
1625 Test levels are either set with the B<Level> directive,
1626 or implicitly through the test type.
1628 Block tests default to level 7, fetch tests to level 6,
1629 "Sticky Actions" tests default to level 5, tests for trusted CGI
1630 requests to level 3 and client-header-action tests to level 1.
1634 B<--debug bitmask> Add the bitmask provided as integer
1635 to the debug settings.
1637 B<--forks forks> Number of forks to start before executing
1638 the regression tests. This is mainly useful for stress-testing.
1640 B<--fuzzer-address> Listening address used when executing
1641 the regression tests. Useful to make sure that the requests
1642 to load the regression tests don't fail due to fuzzing.
1644 B<--fuzzer-feeding> Ignore some errors that would otherwise
1645 cause Privoxy-Regression-Test to abort the test because
1646 they shouldn't happen in normal operation. This option is
1647 intended to be used if Privoxy-Regression-Test is only
1648 used to feed a fuzzer in which case there's a high chance
1649 that Privoxy gets an invalid request and returns an error
1652 B<--help> Shows available command line options.
1654 B<--header-fuzzing> Modifies linear white space in
1655 headers in a way that should not affect the test result.
1657 B<--level level> Only execute tests with the specified B<level>.
1659 B<--loop count> Loop through the regression tests B<count> times.
1660 Useful to feed a fuzzer, or when doing stress tests with
1661 several Privoxy-Regression-Test instances running at the same
1664 B<--max-level max-level> Only execute tests with a B<level>
1665 below or equal to the numerical B<max-level>.
1667 B<--max-time max-time> Give Privoxy B<max-time> seconds
1668 to return data. Increasing the default may make sense when
1669 Privoxy is run through Valgrind, decreasing the default may
1670 make sense when Privoxy-Regression-Test is used to feed
1673 B<--min-level min-level> Only execute tests with a B<level>
1674 above or equal to the numerical B<min-level>.
1676 B<--privoxy-address proxy-address> Privoxy's listening address.
1677 If it's not set, the value of the environment variable http_proxy
1678 will be used. B<proxy-address> has to be specified in http_proxy
1681 B<--retries retries> Retry B<retries> times.
1683 B<--test-number test-number> Only run the test with the specified
1686 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1688 B<--verbose> Log succesful tests as well. By default only
1689 the failures are logged.
1691 B<--version> Print version and exit.
1693 The second dash is optional, options can be shortened,
1694 as long as there are no ambiguities.
1696 =head1 PRIVOXY CONFIGURATION
1698 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1699 which aims to test all official client-header modifying actions
1700 and can be used to verify that the templates and the user manual
1701 files are installed correctly.
1703 To use it, it has to be copied in Privoxy's configuration
1704 directory, and afterwards referenced in Privoxy's configuration
1707 actionsfile regression-tests.action
1709 In general, its tests are supposed to work without changing
1710 any other action files, unless you already added lots of
1711 taggers yourself. If you are using taggers that cause problems,
1712 you might have to temporary disable them for Privoxy's CGI pages.
1714 Some of the regression tests rely on Privoxy features that
1715 may be disabled in your configuration. Tests with a level below
1716 7 are supposed to work with all Privoxy configurations (provided
1717 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1719 Tests with level 9 require Privoxy to deliver the User Manual,
1720 tests with level 12 require the CGI editor to be enabled.
1724 Expect the configuration file syntax to change with future releases.
1728 As Privoxy's B<show-request> page only shows client headers,
1729 Privoxy-Regression-Test can't use it to test Privoxy actions
1730 that modify server headers.
1732 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1733 control the actions to test, it currently only works with
1734 Privoxy 3.0.7 or later.
1736 At the moment Privoxy-Regression-Test fetches Privoxy's
1737 configuration page through I<curl>(1), therefore you have to
1738 have I<curl> installed, otherwise you won't be able to run
1739 Privoxy-Regression-Test in a meaningful way.
1747 Fabian Keil <fk@fabiankeil.de>