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.157 2008/07/03 11:32:14 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;
162 $curl_url .= $privoxy_cgi_url;
163 $curl_url .= 'show-status';
165 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
167 foreach (@{get_cgi_page_or_else($curl_url)}) {
170 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
172 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
173 $actionfiles[$file_number++] = $url;
175 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
177 my $directive = $1 . " " . $2;
178 push (@privoxy_config, $directive);
182 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
184 load_action_files(\@actionfiles);
187 sub token_starts_new_test ($) {
190 my @new_test_directives = ('set header', 'fetch test',
191 'trusted cgi request', 'request header', 'method test',
192 'blocked url', 'url');
194 foreach my $new_test_directive (@new_test_directives) {
195 return 1 if $new_test_directive eq $token;
203 my ($token, $value) = (undef, undef);
205 # Remove leading and trailing white space.
209 # Reverse HTML-encoding
210 # XXX: Seriously imcomplete.
215 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
220 $token =~ s@\s\s+@ @g;
221 $token =~ tr/[A-Z]/[a-z]/;
223 } elsif (/^TAG\s*:(.*)$/) {
230 return ($token, $value);
233 sub enlist_new_test ($$$$$$) {
235 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
238 if ($token eq 'set header') {
240 l(LL_FILE_LOADING, "Header to set: " . $value);
241 $type = CLIENT_HEADER_TEST;
243 } elsif ($token eq 'request header') {
245 l(LL_FILE_LOADING, "Header to request: " . $value);
246 $type = SERVER_HEADER_TEST;
247 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
249 } elsif ($token eq 'trusted cgi request') {
251 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
252 $type = TRUSTED_CGI_REQUEST;
253 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
255 } elsif ($token eq 'fetch test') {
257 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
258 $type = DUMB_FETCH_TEST;
259 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
261 } elsif ($token eq 'method test') {
263 l(LL_FILE_LOADING, "Method to test: " . $value);
265 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
267 } elsif ($token eq 'blocked url') {
269 l(LL_FILE_LOADING, "URL to block-test: " . $value);
272 } elsif ($token eq 'url') {
274 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
275 $type = STICKY_ACTIONS_TEST;
279 die "Incomplete '" . $token . "' support detected.";
283 $$regression_tests[$si][$ri]{'type'} = $type;
284 $$regression_tests[$si][$ri]{'level'} = $type;
286 check_for_forbidden_characters($value);
288 $$regression_tests[$si][$ri]{'data'} = $value;
290 # For function that only get passed single tests
291 $$regression_tests[$si][$ri]{'section-id'} = $si;
292 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
293 $$regression_tests[$si][$ri]{'number'} = $number - 1;
295 "Regression test " . $number . " (section:" . $si . "):");
298 sub load_action_files ($) {
302 our @regression_tests;
304 my $actionfiles_ref = shift;
305 my @actionfiles = @{$actionfiles_ref};
307 my $si = 0; # Section index
308 my $ri = -1; # Regression test index
313 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
315 for my $file_number (0 .. @actionfiles - 1) {
317 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
318 my $actionfile = undef;
319 my $sticky_actions = undef;
321 foreach (@{get_cgi_page_or_else($curl_url)}) {
326 if (/<h2>Contents of Actions File (.*?)</) {
330 next unless defined $actionfile;
334 my ($token, $value) = tokenize($_);
336 next unless defined $token;
338 # Load regression tests
340 if (token_starts_new_test($token)) {
342 # Beginning of new regression test.
345 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
348 if ($token =~ /level\s+(\d+)/i) {
351 register_dependency($level, $value);
354 if ($token eq 'sticky actions') {
356 # Will be used by each following Sticky URL.
357 $sticky_actions = $value;
358 if ($sticky_actions =~ /{[^}]*\s/) {
360 "'Sticky Actions' with whitespace inside the " .
361 "action parameters are currently unsupported.");
365 if ($si == -1 || $ri == -1) {
366 # No beginning of a test detected yet,
367 # so we don't care about any other test
372 if ($token eq 'expect header') {
374 l(LL_FILE_LOADING, "Detected expectation: " . $value);
375 $regression_tests[$si][$ri]{'expect-header'} = $value;
377 } elsif ($token eq 'tag') {
381 my $tag = parse_tag($value);
383 # We already checked in parse_tag() after filtering
386 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
388 # Save tag for all tests in this section
390 $regression_tests[$si][$ri]{'tag'} = $tag;
396 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
398 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
399 $regression_tests[$si][$ri]{'ignore'} = 1;
402 } elsif ($token eq 'expect status code') {
404 l(LL_FILE_LOADING, "Expecting status code: " . $value);
405 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
407 } elsif ($token eq 'level') { # XXX: stupid name
409 $value =~ s@(\d+).*@$1@;
410 l(LL_FILE_LOADING, "Level: " . $value);
411 $regression_tests[$si][$ri]{'level'} = $value;
413 } elsif ($token eq 'method') {
415 l(LL_FILE_LOADING, "Method: " . $value);
416 $regression_tests[$si][$ri]{'method'} = $value;
418 } elsif ($token eq 'url') {
420 if (defined $sticky_actions) {
421 die "WTF? Attempted to overwrite Sticky Actions"
422 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
424 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
425 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
427 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
432 # We don't use it, so we don't need
436 check_for_forbidden_characters($value) unless $no_checks;
437 check_for_forbidden_characters($token);
441 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
442 . " Of which " . $ignored. " will be ignored)\n");
445 ############################################################################
447 # Regression test executing functions
449 ############################################################################
451 sub execute_regression_tests () {
453 our @regression_tests;
454 my $loops = get_cli_option('loops');
456 my $all_failures = 0;
457 my $all_successes = 0;
459 unless (@regression_tests) {
461 l(LL_STATUS, "No regression tests found.");
465 l(LL_STATUS, "Executing regression tests ...");
467 while ($loops-- > 0) {
474 for my $s (0 .. @regression_tests - 1) {
478 while (defined $regression_tests[$s][$r]) {
480 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
481 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
483 my $number = $regression_tests[$s][$r]{'number'};
485 if ($regression_tests[$s][$r]{'ignore'}
486 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
487 or test_number_is_unacceptable($number)) {
493 my $result = execute_regression_test($regression_tests[$s][$r]);
495 log_result($regression_tests[$s][$r], $result, $tests);
497 $successes += $result;
503 $failures = $tests - $successes;
505 log_message("Executed " . $tests . " regression tests. " .
506 'Skipped ' . $skipped . '. ' .
507 $successes . " successes, " . $failures . " failures.");
509 $all_tests += $tests;
510 $all_failures += $failures;
511 $all_successes += $successes;
515 if (get_cli_option('loops') > 1) {
516 log_message("Total: Executed " . $all_tests . " regression tests. " .
517 $all_successes . " successes, " . $all_failures . " failures.");
521 sub level_is_unacceptable ($) {
523 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
524 or ($level < get_cli_option('min-level'))
525 or ($level > get_cli_option('max-level'))
526 or dependency_unsatisfied($level)
530 sub test_number_is_unacceptable ($) {
531 my $test_number = shift;
532 return (cli_option_is_set('test-number')
533 and get_cli_option('test-number') != $test_number)
536 sub dependency_unsatisfied ($) {
541 my $dependency_problem = 0;
543 if (defined ($dependencies{$level}{'config line'})) {
545 my $dependency = $dependencies{$level}{'config line'};
546 $dependency_problem = 1;
548 foreach (@privoxy_config) {
550 $dependency_problem = 0 if (/$dependency/);
554 return $dependency_problem;
557 sub register_dependency ($$) {
560 my $dependency = shift;
563 if ($dependency =~ /config line\s+(.*)/) {
565 $dependencies{$level}{'config line'} = $1;
569 # XXX: somewhat misleading name
570 sub execute_regression_test ($) {
572 my $test_ref = shift;
573 my %test = %{$test_ref};
576 if ($test{'type'} == CLIENT_HEADER_TEST) {
578 $result = execute_client_header_regression_test($test_ref);
580 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
582 $result = execute_server_header_regression_test($test_ref);
584 } elsif ($test{'type'} == DUMB_FETCH_TEST
585 or $test{'type'} == TRUSTED_CGI_REQUEST) {
587 $result = execute_dumb_fetch_test($test_ref);
589 } elsif ($test{'type'} == METHOD_TEST) {
591 $result = execute_method_test($test_ref);
593 } elsif ($test{'type'} == BLOCK_TEST) {
595 $result = execute_block_test($test_ref);
597 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
599 $result = execute_sticky_actions_test($test_ref);
603 die "Unsupported test type detected: " . $test{'type'};
610 sub execute_method_test ($) {
612 my $test_ref = shift;
613 my %test = %{$test_ref};
616 my $method = $test{'data'};
618 my $curl_parameters = '';
619 my $expected_status_code = $test{'expected-status-code'};
621 $curl_parameters .= '--request ' . $method . ' ';
622 # Don't complain about the 'missing' body
623 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
625 $curl_parameters .= PRIVOXY_CGI_URL;
627 $buffer_ref = get_page_with_curl($curl_parameters);
628 $status_code = get_status_code($buffer_ref);
630 return check_status_code_result($status_code, $expected_status_code);
633 sub execute_dumb_fetch_test ($) {
635 my $test_ref = shift;
636 my %test = %{$test_ref};
640 my $curl_parameters = '';
641 my $expected_status_code = $test{'expected-status-code'};
643 if (defined $test{method}) {
644 $curl_parameters .= '--request ' . $test{method} . ' ';
646 if ($test{type} == TRUSTED_CGI_REQUEST) {
647 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
650 $curl_parameters .= $test{'data'};
652 $buffer_ref = get_page_with_curl($curl_parameters);
653 $status_code = get_status_code($buffer_ref);
655 return check_status_code_result($status_code, $expected_status_code);
658 sub execute_block_test ($) {
661 my $url = $test->{'data'};
662 my $final_results = get_final_results($url);
664 return defined $final_results->{'+block'};
667 sub execute_sticky_actions_test ($) {
670 my $url = $test->{'data'};
671 my $verified_actions = 0;
672 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
673 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
674 my $final_results = get_final_results($url);
676 foreach my $sticky_action (@sticky_actions) {
677 if (defined $final_results->{$sticky_action}) {
680 }elsif ($sticky_action =~ /-.*\{/ and
681 not defined $final_results->{$sticky_action}) {
682 # Disabled multi actions aren't explicitly listed as
683 # disabled and thus have to be checked by verifying
684 # that they aren't enabled.
687 l(LL_VERBOSE_FAILURE,
688 "Ooops. '$sticky_action' is not among the final results.");
692 return $verified_actions == @sticky_actions;
695 sub get_final_results ($) {
698 my $curl_parameters = '';
699 my %final_results = ();
700 my $final_results_reached = 0;
702 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
703 # XXX: should be URL-encoded properly
710 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
712 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
714 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
716 next unless ($final_results_reached);
719 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
723 if (defined $parameter) {
724 # In case the caller needs to check
725 # the action and its parameter
726 $final_results{$action . $parameter} = 1;
728 # In case the action doesn't have parameters
729 # or the caller doesn't care for the parameter.
730 $final_results{$action} = 1;
734 return \%final_results;
737 sub check_status_code_result ($$) {
739 my $status_code = shift;
740 my $expected_status_code = shift;
743 unless (defined $status_code) {
745 # XXX: should probably be caught earlier.
746 l(LL_VERBOSE_FAILURE,
747 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
749 } elsif ($expected_status_code == $status_code) {
752 l(LL_VERBOSE_SUCCESS,
753 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
755 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
757 l(LL_VERBOSE_FAILURE,
758 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
762 l(LL_VERBOSE_FAILURE,
763 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
770 sub execute_client_header_regression_test ($) {
772 my $test_ref = shift;
776 $buffer_ref = get_show_request_with_curl($test_ref);
778 $header = get_header($buffer_ref, $test_ref);
780 return check_header_result($test_ref, $header);
783 sub execute_server_header_regression_test ($) {
785 my $test_ref = shift;
789 $buffer_ref = get_head_with_curl($test_ref);
791 $header = get_server_header($buffer_ref, $test_ref);
793 return check_header_result($test_ref, $header);
796 sub interpret_result ($) {
798 return $success ? "Success" : "Failure";
801 sub check_header_result ($$) {
803 my $test_ref = shift;
806 my %test = %{$test_ref};
807 my $expect_header = $test{'expect-header'};
810 if ($expect_header eq 'NO CHANGE') {
812 if (defined($header) and $header eq $test{'data'}) {
818 $header = "REMOVAL" unless defined $header;
819 l(LL_VERBOSE_FAILURE,
820 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
823 } elsif ($expect_header eq 'REMOVAL') {
825 if (defined($header) and $header eq $test{'data'}) {
827 l(LL_VERBOSE_FAILURE,
828 "Ooops. Expected removal but: " . $header . " is still there.");
832 # XXX: Use more reliable check here and make sure
833 # the header has a different name.
838 } elsif ($expect_header eq 'SOME CHANGE') {
840 if (defined($header) and not $header eq $test{'data'}) {
846 $header = "REMOVAL" unless defined $header;
847 l(LL_VERBOSE_FAILURE,
848 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
854 if (defined($header) and $header eq $expect_header) {
860 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
861 l(LL_VERBOSE_FAILURE,
862 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
868 sub get_header_name ($) {
872 $header =~ s@(.*?: ).*@$1@;
877 sub get_header ($$) {
879 our $filtered_request = '';
881 my $buffer_ref = shift;
882 my $test_ref = shift;
884 my %test = %{$test_ref};
885 my @buffer = @{$buffer_ref};
887 my $expect_header = $test{'expect-header'};
889 die "get_header called with no expect header" unless defined $expect_header;
892 my $processed_request_reached = 0;
894 my $processed_request = '';
898 if ($expect_header eq 'REMOVAL'
899 or $expect_header eq 'NO CHANGE'
900 or $expect_header eq 'SOME CHANGE') {
902 $expect_header = $test{'data'};
906 $header_to_get = get_header_name($expect_header);
910 # Skip everything before the Processed request
911 if (/Processed Request/) {
912 $processed_request_reached = 1;
915 next unless $processed_request_reached;
917 # End loop after the Processed request
920 # Ditch tags and leading/trailing white space.
924 # Decode characters we care about.
927 $filtered_request .= "\n" . $_;
929 if (/^$header_to_get/) {
939 sub get_server_header ($$) {
941 my $buffer_ref = shift;
942 my $test_ref = shift;
944 my %test = %{$test_ref};
945 my @buffer = @{$buffer_ref};
947 my $expect_header = $test{'expect-header'};
951 # XXX: Should be caught before starting to test.
952 l(LL_ERROR, "No expect header for test " . $test{'number'})
953 unless defined $expect_header;
955 if ($expect_header eq 'REMOVAL'
956 or $expect_header eq 'NO CHANGE'
957 or $expect_header eq 'SOME CHANGE') {
959 $expect_header = $test{'data'};
963 $header_to_get = get_header_name($expect_header);
967 # XXX: should probably verify that the request
968 # was actually answered by Fellatio.
969 if (/^$header_to_get/) {
971 $header =~ s@\s*$@@g;
979 sub get_status_code ($) {
981 my $buffer_ref = shift;
982 my @buffer = @{$buffer_ref};
986 if (/^HTTP\/\d\.\d (\d{3})/) {
992 return '123' if cli_option_is_set('fuzzer-feeding');
994 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
999 sub get_test_keys () {
1000 return ('tag', 'data', 'expect-header', 'ignore');
1004 sub test_content_as_string ($) {
1006 my $test_ref = shift;
1007 my %test = %{$test_ref};
1011 foreach my $key (get_test_keys()) {
1012 $test{$key} = 'Not set' unless (defined $test{$key});
1015 $s .= 'Tag: ' . $test{'tag'};
1017 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1019 $s .= 'Expected header: ' . $test{'expect-header'};
1021 $s .= 'Ignore: ' . $test{'ignore'};
1026 sub fuzz_header($) {
1028 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1030 $white_space = $white_space x (1 + int(rand(5)));
1032 # Only fuzz white space before the first quoted token.
1033 # (Privoxy doesn't touch white space inside quoted tokens
1034 # and modifying it would cause the tests to fail).
1035 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1040 ############################################################################
1042 # HTTP fetch functions
1044 ############################################################################
1046 sub check_for_curl () {
1048 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1051 sub get_cgi_page_or_else ($) {
1053 my $cgi_url = shift;
1054 my $content_ref = get_page_with_curl($cgi_url);
1055 my $status_code = get_status_code($content_ref);
1057 if (200 != $status_code) {
1059 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1060 "Received status code ". $status_code .
1061 " while only 200 is acceptable.";
1063 if (cli_option_is_set('fuzzer-feeding')) {
1065 $log_message .= " Ignored due to fuzzer feeding.";
1066 l(LL_SOFT_ERROR, $log_message)
1070 l(LL_ERROR, $log_message);
1075 return $content_ref;
1078 # XXX: misleading name
1079 sub get_show_request_with_curl ($) {
1081 our $privoxy_cgi_url;
1082 my $test_ref = shift;
1083 my %test = %{$test_ref};
1085 my $curl_parameters = ' ';
1086 my $header = $test{'data'};
1088 if (cli_option_is_set('header-fuzzing')) {
1089 $header = fuzz_header($header);
1092 # Enable the action to test
1093 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1094 # The header to filter
1095 $curl_parameters .= '-H \'' . $header . '\' ';
1097 $curl_parameters .= ' ';
1098 $curl_parameters .= $privoxy_cgi_url;
1099 $curl_parameters .= 'show-request';
1101 return get_cgi_page_or_else($curl_parameters);
1104 sub get_head_with_curl ($) {
1106 our $fellatio_url = FELLATIO_URL;
1107 my $test_ref = shift;
1108 my %test = %{$test_ref};
1110 my $curl_parameters = ' ';
1112 # Enable the action to test
1113 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1114 # The header to filter
1115 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1116 $curl_parameters .= '--head ';
1118 $curl_parameters .= ' ';
1119 $curl_parameters .= $fellatio_url;
1121 return get_page_with_curl($curl_parameters);
1124 sub get_page_with_curl ($) {
1128 my $parameters = shift;
1130 my $curl_line = CURL;
1131 my $retries_left = get_cli_option('retries') + 1;
1134 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1136 # We want to see the HTTP status code
1137 $curl_line .= " --include ";
1138 # Let Privoxy emit two log messages less.
1139 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1140 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1141 # We don't care about fetch statistic.
1142 $curl_line .= " -s ";
1143 # We do care about the failure reason if any.
1144 $curl_line .= " -S ";
1145 # We want to advertise ourselves
1146 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1147 # We aren't too patient
1148 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1150 $curl_line .= $parameters;
1151 # XXX: still necessary?
1152 $curl_line .= ' 2>&1';
1154 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1157 @buffer = `$curl_line`;
1160 $failure_reason = array_as_string(\@buffer);
1161 chomp $failure_reason;
1162 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1164 } while ($? && --$retries_left);
1166 unless ($retries_left) {
1168 "Running curl failed " . get_cli_option('retries') .
1169 " times in a row. Last error: '" . $failure_reason . "'.");
1176 ############################################################################
1180 ############################################################################
1182 sub array_as_string ($) {
1183 my $array_ref = shift;
1186 foreach (@{$array_ref}) {
1194 my $test_ref = shift;
1195 log_message('Test is:' . test_content_as_string($test_ref));
1201 my $this_level = shift;
1202 my $message = shift;
1204 return unless ($log_level & $this_level);
1206 if (LL_ERROR & $this_level) {
1207 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1210 log_message($message);
1212 if (LL_ERROR & $this_level) {
1217 sub log_message ($) {
1219 my $message = shift;
1223 our $leading_log_date;
1224 our $leading_log_time;
1226 my $time_stamp = '';
1227 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1229 if ($leading_log_date || $leading_log_time) {
1231 if ($leading_log_date) {
1234 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1237 if ($leading_log_time) {
1238 $time_stamp .= ' ' if $leading_log_date;
1239 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1242 $message = $time_stamp . ": " . $message;
1246 printf(STDERR "%s\n", $message);
1250 sub log_result ($$) {
1252 our $verbose_test_description;
1253 our $filtered_request;
1255 my $test_ref = shift;
1259 my %test = %{$test_ref};
1262 $message .= interpret_result($result);
1263 $message .= " for test ";
1264 $message .= $number;
1266 $message .= $test{'number'};
1268 $message .= $test{'section-id'};
1270 $message .= $test{'regression-test-id'};
1273 if ($verbose_test_description) {
1275 if ($test{'type'} == CLIENT_HEADER_TEST) {
1277 $message .= ' Header ';
1278 $message .= quote($test{'data'});
1279 $message .= ' and tag ';
1280 $message .= quote($test{'tag'});
1282 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1284 $message .= ' Request Header ';
1285 $message .= quote($test{'data'});
1286 $message .= ' and tag ';
1287 $message .= quote($test{'tag'});
1289 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1291 $message .= ' URL ';
1292 $message .= quote($test{'data'});
1293 $message .= ' and expected status code ';
1294 $message .= quote($test{'expected-status-code'});
1296 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1298 $message .= ' CGI URL ';
1299 $message .= quote($test{'data'});
1300 $message .= ' and expected status code ';
1301 $message .= quote($test{'expected-status-code'});
1303 } elsif ($test{'type'} == METHOD_TEST) {
1305 $message .= ' HTTP method ';
1306 $message .= quote($test{'data'});
1307 $message .= ' and expected status code ';
1308 $message .= quote($test{'expected-status-code'});
1310 } elsif ($test{'type'} == BLOCK_TEST) {
1312 $message .= ' Supposedly-blocked URL: ';
1313 $message .= quote($test{'data'});
1315 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1317 $message .= ' Sticky Actions: ';
1318 $message .= quote($test{'sticky-actions'});
1319 $message .= ' and URL: ';
1320 $message .= quote($test{'data'});
1324 die "Incomplete support for test type " . $test{'type'} . " detected.";
1329 log_message($message) if (!$result or cli_option_is_set('verbose'));
1334 return '\'' . $s . '\'';
1337 sub print_version () {
1338 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1349 Options and their default values if they have any:
1350 [--debug $cli_options{'debug'}]
1351 [--forks $cli_options{'forks'}]
1357 [--loops $cli_options{'loops'}]
1358 [--max-level $cli_options{'max-level'}]
1359 [--max-time $cli_options{'max-time'}]
1360 [--min-level $cli_options{'min-level'}]
1362 [--retries $cli_options{'retries'}]
1365 see "perldoc $0" for more information
1371 sub init_cli_options () {
1376 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1377 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1378 $cli_options{'debug'} = $log_level;
1379 $cli_options{'loops'} = CLI_LOOPS;
1380 $cli_options{'max-time'} = CLI_MAX_TIME;
1381 $cli_options{'retries'} = CLI_RETRIES;
1382 $cli_options{'forks'} = CLI_FORKS;
1385 sub parse_cli_options () {
1393 'debug=s' => \$cli_options{'debug'},
1394 'forks=s' => \$cli_options{'forks'},
1395 'help' => sub { help },
1396 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1397 'min-level=s' => \$cli_options{'min-level'},
1398 'max-level=s' => \$cli_options{'max-level'},
1399 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1400 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1401 'level=s' => \$cli_options{'level'},
1402 'loops=s' => \$cli_options{'loops'},
1403 'test-number=s' => \$cli_options{'test-number'},
1404 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1405 'retries=s' => \$cli_options{'retries'},
1406 'max-time=s' => \$cli_options{'max-time'},
1407 'verbose' => \$cli_options{'verbose'},
1408 'version' => sub { print_version && exit(0) }
1410 $log_level |= $cli_options{'debug'};
1413 sub cli_option_is_set ($) {
1416 my $cli_option = shift;
1418 return defined $cli_options{$cli_option};
1421 sub get_cli_option ($) {
1424 my $cli_option = shift;
1426 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1428 return $cli_options{$cli_option};
1431 sub init_proxy_settings($) {
1436 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1437 $proxy = get_cli_option('fuzzer-address');
1440 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1442 if (cli_option_is_set('privoxy-address')) {
1443 $proxy .= get_cli_option('privoxy-address');
1449 sub start_forks($) {
1452 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1454 foreach my $fork (1 .. $forks) {
1455 log_message("Starting fork $fork");
1457 if (defined $pid && !$pid) {
1465 init_our_variables();
1466 parse_cli_options();
1468 init_proxy_settings('vanilla-proxy');
1469 load_regressions_tests();
1470 init_proxy_settings('fuzz-proxy');
1471 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1472 execute_regression_tests();
1479 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1483 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1484 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1485 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1486 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1487 [B<--retries retries>] [B<--verbose>] [B<--version>]
1491 Privoxy-Regression-Test is supposed to one day become
1492 a regression test suite for Privoxy. It's not quite there
1493 yet, however, and can currently only test header actions,
1494 check the returned status code for requests to arbitrary
1495 URLs and verify which actions are applied to them.
1497 Client header actions are tested by requesting
1498 B<http://p.p/show-request> and checking whether
1499 or not Privoxy modified the original request as expected.
1501 The original request contains both the header the action-to-be-tested
1502 acts upon and an additional tagger-triggering header that enables
1505 Applied actions are checked through B<http://p.p/show-url-info>.
1507 =head1 CONFIGURATION FILE SYNTAX
1509 Privoxy-Regression-Test's configuration is embedded in
1510 Privoxy action files and loaded through Privoxy's web interface.
1512 It makes testing a Privoxy version running on a remote system easier
1513 and should prevent you from updating your tests without updating Privoxy's
1514 configuration accordingly.
1516 A client-header-action test section looks like this:
1518 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1519 # Expect Header = Referer: http://www.example.org/
1520 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1521 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1523 The example above causes Privoxy-Regression-Test to set
1524 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1525 and to expect it to be modified to
1526 B<Referer: http://www.example.org/>.
1528 When testing this section, Privoxy-Regression-Test will set the header
1529 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1530 causing the B<privoxy-control> tagger to create the tag
1531 B<client-header-filter{hide-tor-exit-notation}> which will finally
1532 cause Privoxy to enable the action section.
1534 Note that the actions itself are only used by Privoxy,
1535 Privoxy-Regression-Test ignores them and will be happy
1536 as long as the expectations are satisfied.
1538 A fetch test looks like this:
1540 # Fetch Test = http://p.p/user-manual
1541 # Expect Status Code = 302
1543 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1544 and to expect a response with the HTTP status code B<302>. Obviously that's
1545 not a very thorough test and mainly useful to get some code coverage
1546 for Valgrind or to verify that the templates are installed correctly.
1548 If you want to test CGI pages that require a trusted
1549 referer, you can use:
1551 # Trusted CGI Request = http://p.p/edit-actions
1553 It works like ordinary fetch tests, but sets the referer
1554 header to a trusted value.
1556 If no explicit status code expectation is set, B<200> is used.
1558 To verify that a URL is blocked, use:
1560 # Blocked URL = http://www.example.com/blocked
1562 To verify that a specific set of actions is applied to an URL, use:
1564 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1565 # URL = http://www.example.org/my-first-url
1567 The sticky actions will be checked for all URLs below it
1568 until the next sticky actions directive.
1572 All tests have test levels to let the user
1573 control which ones to execute (see I<OPTIONS> below).
1574 Test levels are either set with the B<Level> directive,
1575 or implicitly through the test type.
1577 Block tests default to level 7, fetch tests to level 6,
1578 "Sticky Actions" tests default to level 5, tests for trusted CGI
1579 requests to level 3 and client-header-action tests to level 1.
1583 B<--debug bitmask> Add the bitmask provided as integer
1584 to the debug settings.
1586 B<--forks forks> Number of forks to start before executing
1587 the regression tests. This is mainly useful for stress-testing.
1589 B<--fuzzer-address> Listening address used when executing
1590 the regression tests. Useful to make sure that the requests
1591 to load the regression tests don't fail due to fuzzing.
1593 B<--fuzzer-feeding> Ignore some errors that would otherwise
1594 cause Privoxy-Regression-Test to abort the test because
1595 they shouldn't happen in normal operation. This option is
1596 intended to be used if Privoxy-Regression-Test is only
1597 used to feed a fuzzer in which case there's a high chance
1598 that Privoxy gets an invalid request and returns an error
1601 B<--help> Shows available command line options.
1603 B<--header-fuzzing> Modifies linear white space in
1604 headers in a way that should not affect the test result.
1606 B<--level level> Only execute tests with the specified B<level>.
1608 B<--loop count> Loop through the regression tests B<count> times.
1609 Useful to feed a fuzzer, or when doing stress tests with
1610 several Privoxy-Regression-Test instances running at the same
1613 B<--max-level max-level> Only execute tests with a B<level>
1614 below or equal to the numerical B<max-level>.
1616 B<--max-time max-time> Give Privoxy B<max-time> seconds
1617 to return data. Increasing the default may make sense when
1618 Privoxy is run through Valgrind, decreasing the default may
1619 make sense when Privoxy-Regression-Test is used to feed
1622 B<--min-level min-level> Only execute tests with a B<level>
1623 above or equal to the numerical B<min-level>.
1625 B<--privoxy-address proxy-address> Privoxy's listening address.
1626 If it's not set, the value of the environment variable http_proxy
1627 will be used. B<proxy-address> has to be specified in http_proxy
1630 B<--retries retries> Retry B<retries> times.
1632 B<--verbose> Also log succesful test runs.
1634 B<--version> Print version and exit.
1636 The second dash is optional, options can be shortened,
1637 as long as there are no ambiguities.
1639 =head1 PRIVOXY CONFIGURATION
1641 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1642 which aims to test all official client-header modifying actions
1643 and can be used to verify that the templates and the user manual
1644 files are installed correctly.
1646 To use it, it has to be copied in Privoxy's configuration
1647 directory, and afterwards referenced in Privoxy's configuration
1650 actionsfile regression-tests.action
1652 In general, its tests are supposed to work without changing
1653 any other action files, unless you already added lots of
1654 taggers yourself. If you are using taggers that cause problems,
1655 you might have to temporary disable them for Privoxy's CGI pages.
1657 Some of the regression tests rely on Privoxy features that
1658 may be disabled in your configuration. Tests with a level below
1659 7 are supposed to work with all Privoxy configurations (provided
1660 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1662 Tests with level 9 require Privoxy to deliver the User Manual,
1663 tests with level 12 require the CGI editor to be enabled.
1667 Expect the configuration file syntax to change with future releases.
1671 As Privoxy's B<show-request> page only shows client headers,
1672 Privoxy-Regression-Test can't use it to test Privoxy actions
1673 that modify server headers.
1675 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1676 control the actions to test, it currently only works with
1677 Privoxy 3.0.7 or later.
1679 At the moment Privoxy-Regression-Test fetches Privoxy's
1680 configuration page through I<curl>(1), therefore you have to
1681 have I<curl> installed, otherwise you won't be able to run
1682 Privoxy-Regression-Test in a meaningful way.
1690 Fabian Keil <fk@fabiankeil.de>