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.164 2009/02/23 09:40:24 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,
64 VERBOSE_TEST_DESCRIPTION => 1,
66 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
67 # XXX: Only partly implemented and mostly useless.
68 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
69 DEBUG_LEVEL_STATUS => 1,
71 # Internal use, don't modify
72 # Available debug bits:
74 LL_VERBOSE_FAILURE => 2,
75 LL_PAGE_FETCHING => 4,
77 LL_VERBOSE_SUCCESS => 16,
81 CLIENT_HEADER_TEST => 1,
82 SERVER_HEADER_TEST => 2,
85 STICKY_ACTIONS_TEST => 5,
86 TRUSTED_CGI_REQUEST => 6,
90 sub init_our_variables () {
92 our $leading_log_time = LEADING_LOG_TIME;
93 our $leading_log_date = LEADING_LOG_DATE;
95 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
97 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
99 our $log_level = get_default_log_level();
103 sub get_default_log_level () {
107 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
108 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
109 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
110 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
111 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
113 # These are intended to be always on.
114 $log_level |= LL_SOFT_ERROR;
115 $log_level |= LL_ERROR;
120 ############################################################################
122 # File loading functions
124 ############################################################################
132 # Unescape brackets and dots
133 $tag =~ s@\\(?=[{}().+])@@g;
135 # log_message("Parsed tag: " . $tag);
137 check_for_forbidden_characters($tag);
142 sub check_for_forbidden_characters ($) {
144 my $tag = shift; # XXX: also used to check values though.
145 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
147 unless ($tag =~ m/^$allowed*$/) {
148 my $forbidden = $tag;
149 $forbidden =~ s@^$allowed*(.).*@$1@;
151 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
155 sub load_regressions_tests () {
157 our $privoxy_cgi_url;
159 our %privoxy_features;
165 $curl_url .= $privoxy_cgi_url;
166 $curl_url .= 'show-status';
168 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
170 foreach (@{get_cgi_page_or_else($curl_url)}) {
173 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
175 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
176 $actionfiles[$file_number++] = $url;
178 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
180 my $directive = $1 . " " . $2;
181 push (@privoxy_config, $directive);
183 } elsif (m@<td><code>([^<]*)</code></td>@) {
187 } elsif (m@<td> (Yes|No) </td>@) {
189 $privoxy_features{$feature} = $1 if defined $feature;
194 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
196 load_action_files(\@actionfiles);
199 sub token_starts_new_test ($) {
202 my @new_test_directives = ('set header', 'fetch test',
203 'trusted cgi request', 'request header', 'method test',
204 'blocked url', 'url');
206 foreach my $new_test_directive (@new_test_directives) {
207 return 1 if $new_test_directive eq $token;
215 my ($token, $value) = (undef, undef);
217 # Remove leading and trailing white space.
221 # Reverse HTML-encoding
222 # XXX: Seriously imcomplete.
227 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
232 $token =~ s@\s\s+@ @g;
233 $token =~ tr/[A-Z]/[a-z]/;
235 } elsif (/^TAG\s*:(.*)$/) {
242 return ($token, $value);
245 sub enlist_new_test ($$$$$$) {
247 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
250 if ($token eq 'set header') {
252 l(LL_FILE_LOADING, "Header to set: " . $value);
253 $type = CLIENT_HEADER_TEST;
255 } elsif ($token eq 'request header') {
257 l(LL_FILE_LOADING, "Header to request: " . $value);
258 $type = SERVER_HEADER_TEST;
259 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
261 } elsif ($token eq 'trusted cgi request') {
263 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
264 $type = TRUSTED_CGI_REQUEST;
265 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
267 } elsif ($token eq 'fetch test') {
269 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
270 $type = DUMB_FETCH_TEST;
271 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
273 } elsif ($token eq 'method test') {
275 l(LL_FILE_LOADING, "Method to test: " . $value);
277 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
279 } elsif ($token eq 'blocked url') {
281 l(LL_FILE_LOADING, "URL to block-test: " . $value);
284 } elsif ($token eq 'url') {
286 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
287 $type = STICKY_ACTIONS_TEST;
291 die "Incomplete '" . $token . "' support detected.";
295 $$regression_tests[$si][$ri]{'type'} = $type;
296 $$regression_tests[$si][$ri]{'level'} = $type;
298 check_for_forbidden_characters($value);
300 $$regression_tests[$si][$ri]{'data'} = $value;
302 # For function that only get passed single tests
303 $$regression_tests[$si][$ri]{'section-id'} = $si;
304 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
305 $$regression_tests[$si][$ri]{'number'} = $number - 1;
307 "Regression test " . $number . " (section:" . $si . "):");
310 sub load_action_files ($) {
314 our @regression_tests;
316 my $actionfiles_ref = shift;
317 my @actionfiles = @{$actionfiles_ref};
319 my $si = 0; # Section index
320 my $ri = -1; # Regression test index
325 l(LL_STATUS, "Gathering regression tests from " .
326 @actionfiles . " action file(s) delivered by Privoxy.");
328 for my $file_number (0 .. @actionfiles - 1) {
330 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
331 my $actionfile = undef;
332 my $sticky_actions = undef;
334 foreach (@{get_cgi_page_or_else($curl_url)}) {
339 if (/<h2>Contents of Actions File (.*?)</) {
343 next unless defined $actionfile;
347 my ($token, $value) = tokenize($_);
349 next unless defined $token;
351 # Load regression tests
353 if (token_starts_new_test($token)) {
355 # Beginning of new regression test.
358 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
361 if ($token =~ /level\s+(\d+)/i) {
364 register_dependency($level, $value);
367 if ($token eq 'sticky actions') {
369 # Will be used by each following Sticky URL.
370 $sticky_actions = $value;
371 if ($sticky_actions =~ /{[^}]*\s/) {
373 "'Sticky Actions' with whitespace inside the " .
374 "action parameters are currently unsupported.");
378 if ($si == -1 || $ri == -1) {
379 # No beginning of a test detected yet,
380 # so we don't care about any other test
385 if ($token eq 'expect header') {
387 l(LL_FILE_LOADING, "Detected expectation: " . $value);
388 $regression_tests[$si][$ri]{'expect-header'} = $value;
390 } elsif ($token eq 'tag') {
394 my $tag = parse_tag($value);
396 # We already checked in parse_tag() after filtering
399 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
401 # Save tag for all tests in this section
403 $regression_tests[$si][$ri]{'tag'} = $tag;
409 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
411 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
412 $regression_tests[$si][$ri]{'ignore'} = 1;
415 } elsif ($token eq 'expect status code') {
417 l(LL_FILE_LOADING, "Expecting status code: " . $value);
418 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
420 } elsif ($token eq 'level') { # XXX: stupid name
422 $value =~ s@(\d+).*@$1@;
423 l(LL_FILE_LOADING, "Level: " . $value);
424 $regression_tests[$si][$ri]{'level'} = $value;
426 } elsif ($token eq 'method') {
428 l(LL_FILE_LOADING, "Method: " . $value);
429 $regression_tests[$si][$ri]{'method'} = $value;
431 } elsif ($token eq 'url') {
433 if (defined $sticky_actions) {
434 die "WTF? Attempted to overwrite Sticky Actions"
435 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
437 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
438 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
440 l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
445 # We don't use it, so we don't need
449 check_for_forbidden_characters($value) unless $no_checks;
450 check_for_forbidden_characters($token);
454 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
455 . " Of which " . $ignored. " will be ignored)\n");
458 ############################################################################
460 # Regression test executing functions
462 ############################################################################
464 sub execute_regression_tests () {
466 our @regression_tests;
467 my $loops = get_cli_option('loops');
469 my $all_failures = 0;
470 my $all_successes = 0;
472 unless (@regression_tests) {
474 l(LL_STATUS, "No regression tests found.");
478 l(LL_STATUS, "Executing regression tests ...");
480 while ($loops-- > 0) {
487 for my $s (0 .. @regression_tests - 1) {
491 while (defined $regression_tests[$s][$r]) {
493 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
494 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
496 my $number = $regression_tests[$s][$r]{'number'};
497 my $skip_reason = undef;
499 if ($regression_tests[$s][$r]{'ignore'}) {
501 $skip_reason = "Ignore flag is set";
503 } elsif (cli_option_is_set('test-number')
504 and get_cli_option('test-number') != $number) {
506 $skip_reason = "Only executing test " . get_cli_option('test-number');
510 $skip_reason = level_is_unacceptable($regression_tests[$s][$r]{'level'});
513 if (defined $skip_reason) {
515 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
516 log_message($message) if cli_option_is_set('verbose');
521 my $result = execute_regression_test($regression_tests[$s][$r]);
523 log_result($regression_tests[$s][$r], $result, $tests);
525 $successes += $result;
531 $failures = $tests - $successes;
533 log_message("Executed " . $tests . " regression tests. " .
534 'Skipped ' . $skipped . '. ' .
535 $successes . " successes, " . $failures . " failures.");
537 $all_tests += $tests;
538 $all_failures += $failures;
539 $all_successes += $successes;
543 if (get_cli_option('loops') > 1) {
544 log_message("Total: Executed " . $all_tests . " regression tests. " .
545 $all_successes . " successes, " . $all_failures . " failures.");
549 sub level_is_unacceptable ($) {
551 my $min_level = get_cli_option('min-level');
552 my $max_level = get_cli_option('max-level');
553 my $required_level = cli_option_is_set('level') ?
554 get_cli_option('level') : $level;
557 if ($required_level != $level) {
559 $reason = "Level doesn't match (" . $level .
560 " != " . $required_level . ")"
562 } elsif ($level < $min_level) {
564 $reason = "Level to low (" . $level . " < " . $min_level . ")";
566 } elsif ($level > $max_level) {
568 $reason = "Level to high (" . $level . " > " . $max_level . ")";
572 $reason = dependency_unsatisfied($level);
578 sub dependency_unsatisfied ($) {
583 our %privoxy_features;
585 my $dependency_problem = undef;
587 if (defined ($dependencies{$level}{'config line'})) {
589 my $dependency = $dependencies{$level}{'config line'};
590 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
592 foreach (@privoxy_config) {
594 $dependency_problem = undef if (/$dependency/);
595 last; # XXX: this looks ... interesting.
598 } elsif (defined ($dependencies{$level}{'feature status'})) {
600 my $dependency = $dependencies{$level}{'feature status'};
601 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
603 unless (defined($privoxy_features{$feature})
604 and ($privoxy_features{$feature} eq $status))
606 $dependency_problem = "depends on '" . $feature .
607 "' being set to '" . $status . "'";
611 return $dependency_problem;
614 sub register_dependency ($$) {
617 my $dependency = shift;
620 if ($dependency =~ /config line\s+(.*)/) {
622 $dependencies{$level}{'config line'} = $1;
624 } elsif ($dependency =~ /feature status\s+(.*)/) {
626 $dependencies{$level}{'feature status'} = $1;
631 # XXX: somewhat misleading name
632 sub execute_regression_test ($) {
634 my $test_ref = shift;
635 my %test = %{$test_ref};
638 if ($test{'type'} == CLIENT_HEADER_TEST) {
640 $result = execute_client_header_regression_test($test_ref);
642 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
644 $result = execute_server_header_regression_test($test_ref);
646 } elsif ($test{'type'} == DUMB_FETCH_TEST
647 or $test{'type'} == TRUSTED_CGI_REQUEST) {
649 $result = execute_dumb_fetch_test($test_ref);
651 } elsif ($test{'type'} == METHOD_TEST) {
653 $result = execute_method_test($test_ref);
655 } elsif ($test{'type'} == BLOCK_TEST) {
657 $result = execute_block_test($test_ref);
659 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
661 $result = execute_sticky_actions_test($test_ref);
665 die "Unsupported test type detected: " . $test{'type'};
672 sub execute_method_test ($) {
674 my $test_ref = shift;
675 my %test = %{$test_ref};
678 my $method = $test{'data'};
680 my $curl_parameters = '';
681 my $expected_status_code = $test{'expected-status-code'};
683 $curl_parameters .= '--request ' . $method . ' ';
684 # Don't complain about the 'missing' body
685 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
687 $curl_parameters .= PRIVOXY_CGI_URL;
689 $buffer_ref = get_page_with_curl($curl_parameters);
690 $status_code = get_status_code($buffer_ref);
692 return check_status_code_result($status_code, $expected_status_code);
695 sub execute_dumb_fetch_test ($) {
697 my $test_ref = shift;
698 my %test = %{$test_ref};
702 my $curl_parameters = '';
703 my $expected_status_code = $test{'expected-status-code'};
705 if (defined $test{method}) {
706 $curl_parameters .= '--request ' . $test{method} . ' ';
708 if ($test{type} == TRUSTED_CGI_REQUEST) {
709 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
712 $curl_parameters .= $test{'data'};
714 $buffer_ref = get_page_with_curl($curl_parameters);
715 $status_code = get_status_code($buffer_ref);
717 return check_status_code_result($status_code, $expected_status_code);
720 sub execute_block_test ($) {
723 my $url = $test->{'data'};
724 my $final_results = get_final_results($url);
726 return defined $final_results->{'+block'};
729 sub execute_sticky_actions_test ($) {
732 my $url = $test->{'data'};
733 my $verified_actions = 0;
734 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
735 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
736 my $final_results = get_final_results($url);
738 foreach my $sticky_action (@sticky_actions) {
739 if (defined $final_results->{$sticky_action}) {
742 }elsif ($sticky_action =~ /-.*\{/ and
743 not defined $final_results->{$sticky_action}) {
744 # Disabled multi actions aren't explicitly listed as
745 # disabled and thus have to be checked by verifying
746 # that they aren't enabled.
749 l(LL_VERBOSE_FAILURE,
750 "Ooops. '$sticky_action' is not among the final results.");
754 return $verified_actions == @sticky_actions;
757 sub get_final_results ($) {
760 my $curl_parameters = '';
761 my %final_results = ();
762 my $final_results_reached = 0;
764 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
765 # XXX: should be URL-encoded properly
772 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
774 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
776 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
778 next unless ($final_results_reached);
781 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
785 if (defined $parameter) {
786 # In case the caller needs to check
787 # the action and its parameter
788 $final_results{$action . $parameter} = 1;
790 # In case the action doesn't have parameters
791 # or the caller doesn't care for the parameter.
792 $final_results{$action} = 1;
796 return \%final_results;
799 sub check_status_code_result ($$) {
801 my $status_code = shift;
802 my $expected_status_code = shift;
805 unless (defined $status_code) {
807 # XXX: should probably be caught earlier.
808 l(LL_VERBOSE_FAILURE,
809 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
811 } elsif ($expected_status_code == $status_code) {
814 l(LL_VERBOSE_SUCCESS,
815 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
817 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
819 l(LL_VERBOSE_FAILURE,
820 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
824 l(LL_VERBOSE_FAILURE,
825 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
832 sub execute_client_header_regression_test ($) {
834 my $test_ref = shift;
838 $buffer_ref = get_show_request_with_curl($test_ref);
840 $header = get_header($buffer_ref, $test_ref);
842 return check_header_result($test_ref, $header);
845 sub execute_server_header_regression_test ($) {
847 my $test_ref = shift;
851 $buffer_ref = get_head_with_curl($test_ref);
853 $header = get_server_header($buffer_ref, $test_ref);
855 return check_header_result($test_ref, $header);
858 sub interpret_result ($) {
860 return $success ? "Success" : "Failure";
863 sub check_header_result ($$) {
865 my $test_ref = shift;
868 my %test = %{$test_ref};
869 my $expect_header = $test{'expect-header'};
872 if ($expect_header eq 'NO CHANGE') {
874 if (defined($header) and $header eq $test{'data'}) {
880 $header = "REMOVAL" unless defined $header;
881 l(LL_VERBOSE_FAILURE,
882 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
885 } elsif ($expect_header eq 'REMOVAL') {
887 if (defined($header) and $header eq $test{'data'}) {
889 l(LL_VERBOSE_FAILURE,
890 "Ooops. Expected removal but: " . $header . " is still there.");
894 # XXX: Use more reliable check here and make sure
895 # the header has a different name.
900 } elsif ($expect_header eq 'SOME CHANGE') {
902 if (defined($header) and not $header eq $test{'data'}) {
908 $header = "REMOVAL" unless defined $header;
909 l(LL_VERBOSE_FAILURE,
910 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
916 if (defined($header) and $header eq $expect_header) {
922 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
923 l(LL_VERBOSE_FAILURE,
924 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
930 sub get_header_name ($) {
934 $header =~ s@(.*?: ).*@$1@;
939 sub get_header ($$) {
941 our $filtered_request = '';
943 my $buffer_ref = shift;
944 my $test_ref = shift;
946 my %test = %{$test_ref};
947 my @buffer = @{$buffer_ref};
949 my $expect_header = $test{'expect-header'};
951 die "get_header called with no expect header" unless defined $expect_header;
954 my $processed_request_reached = 0;
956 my $processed_request = '';
960 if ($expect_header eq 'REMOVAL'
961 or $expect_header eq 'NO CHANGE'
962 or $expect_header eq 'SOME CHANGE') {
964 $expect_header = $test{'data'};
968 $header_to_get = get_header_name($expect_header);
972 # Skip everything before the Processed request
973 if (/Processed Request/) {
974 $processed_request_reached = 1;
977 next unless $processed_request_reached;
979 # End loop after the Processed request
982 # Ditch tags and leading/trailing white space.
986 # Decode characters we care about.
989 $filtered_request .= "\n" . $_;
991 if (/^$header_to_get/) {
1001 sub get_server_header ($$) {
1003 my $buffer_ref = shift;
1004 my $test_ref = shift;
1006 my %test = %{$test_ref};
1007 my @buffer = @{$buffer_ref};
1009 my $expect_header = $test{'expect-header'};
1013 # XXX: Should be caught before starting to test.
1014 l(LL_ERROR, "No expect header for test " . $test{'number'})
1015 unless defined $expect_header;
1017 if ($expect_header eq 'REMOVAL'
1018 or $expect_header eq 'NO CHANGE'
1019 or $expect_header eq 'SOME CHANGE') {
1021 $expect_header = $test{'data'};
1025 $header_to_get = get_header_name($expect_header);
1029 # XXX: should probably verify that the request
1030 # was actually answered by Fellatio.
1031 if (/^$header_to_get/) {
1033 $header =~ s@\s*$@@g;
1041 sub get_status_code ($) {
1043 my $buffer_ref = shift;
1044 my @buffer = @{$buffer_ref};
1048 if (/^HTTP\/\d\.\d (\d{3})/) {
1054 return '123' if cli_option_is_set('fuzzer-feeding');
1056 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
1061 sub get_test_keys () {
1062 return ('tag', 'data', 'expect-header', 'ignore');
1066 sub test_content_as_string ($) {
1068 my $test_ref = shift;
1069 my %test = %{$test_ref};
1073 foreach my $key (get_test_keys()) {
1074 $test{$key} = 'Not set' unless (defined $test{$key});
1077 $s .= 'Tag: ' . $test{'tag'};
1079 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1081 $s .= 'Expected header: ' . $test{'expect-header'};
1083 $s .= 'Ignore: ' . $test{'ignore'};
1088 sub fuzz_header($) {
1090 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1092 $white_space = $white_space x (1 + int(rand(5)));
1094 # Only fuzz white space before the first quoted token.
1095 # (Privoxy doesn't touch white space inside quoted tokens
1096 # and modifying it would cause the tests to fail).
1097 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1102 ############################################################################
1104 # HTTP fetch functions
1106 ############################################################################
1108 sub check_for_curl () {
1110 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1113 sub get_cgi_page_or_else ($) {
1115 my $cgi_url = shift;
1116 my $content_ref = get_page_with_curl($cgi_url);
1117 my $status_code = get_status_code($content_ref);
1119 if (200 != $status_code) {
1121 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1122 "Received status code ". $status_code .
1123 " while only 200 is acceptable.";
1125 if (cli_option_is_set('fuzzer-feeding')) {
1127 $log_message .= " Ignored due to fuzzer feeding.";
1128 l(LL_SOFT_ERROR, $log_message)
1132 l(LL_ERROR, $log_message);
1137 return $content_ref;
1140 # XXX: misleading name
1141 sub get_show_request_with_curl ($) {
1143 our $privoxy_cgi_url;
1144 my $test_ref = shift;
1145 my %test = %{$test_ref};
1147 my $curl_parameters = ' ';
1148 my $header = $test{'data'};
1150 if (cli_option_is_set('header-fuzzing')) {
1151 $header = fuzz_header($header);
1154 # Enable the action to test
1155 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1156 # The header to filter
1157 $curl_parameters .= '-H \'' . $header . '\' ';
1159 $curl_parameters .= ' ';
1160 $curl_parameters .= $privoxy_cgi_url;
1161 $curl_parameters .= 'show-request';
1163 return get_cgi_page_or_else($curl_parameters);
1166 sub get_head_with_curl ($) {
1168 our $fellatio_url = FELLATIO_URL;
1169 my $test_ref = shift;
1170 my %test = %{$test_ref};
1172 my $curl_parameters = ' ';
1174 # Enable the action to test
1175 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1176 # The header to filter
1177 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1178 $curl_parameters .= '--head ';
1180 $curl_parameters .= ' ';
1181 $curl_parameters .= $fellatio_url;
1183 return get_page_with_curl($curl_parameters);
1186 sub get_page_with_curl ($) {
1190 my $parameters = shift;
1192 my $curl_line = CURL;
1193 my $retries_left = get_cli_option('retries') + 1;
1196 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1198 # We want to see the HTTP status code
1199 $curl_line .= " --include ";
1200 # Let Privoxy emit two log messages less.
1201 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1202 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1203 # We don't care about fetch statistic.
1204 $curl_line .= " -s ";
1205 # We do care about the failure reason if any.
1206 $curl_line .= " -S ";
1207 # We want to advertise ourselves
1208 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1209 # We aren't too patient
1210 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1212 $curl_line .= $parameters;
1213 # XXX: still necessary?
1214 $curl_line .= ' 2>&1';
1216 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1219 @buffer = `$curl_line`;
1222 $failure_reason = array_as_string(\@buffer);
1223 chomp $failure_reason;
1224 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1226 } while ($? && --$retries_left);
1228 unless ($retries_left) {
1230 "Running curl failed " . get_cli_option('retries') .
1231 " times in a row. Last error: '" . $failure_reason . "'.");
1238 ############################################################################
1242 ############################################################################
1244 sub array_as_string ($) {
1245 my $array_ref = shift;
1248 foreach (@{$array_ref}) {
1256 my $test_ref = shift;
1257 log_message('Test is:' . test_content_as_string($test_ref));
1263 my $this_level = shift;
1264 my $message = shift;
1266 return unless ($log_level & $this_level);
1268 if (LL_ERROR & $this_level) {
1269 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1272 log_message($message);
1274 if (LL_ERROR & $this_level) {
1279 sub log_message ($) {
1281 my $message = shift;
1285 our $leading_log_date;
1286 our $leading_log_time;
1288 my $time_stamp = '';
1289 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1291 if ($leading_log_date || $leading_log_time) {
1293 if ($leading_log_date) {
1296 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1299 if ($leading_log_time) {
1300 $time_stamp .= ' ' if $leading_log_date;
1301 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1304 $message = $time_stamp . ": " . $message;
1307 printf(STDERR "%s\n", $message);
1310 sub log_result ($$) {
1312 our $verbose_test_description;
1313 our $filtered_request;
1315 my $test_ref = shift;
1319 my %test = %{$test_ref};
1322 $message .= interpret_result($result);
1323 $message .= " for test ";
1324 $message .= $number;
1326 $message .= $test{'number'};
1328 $message .= $test{'section-id'};
1330 $message .= $test{'regression-test-id'};
1333 if ($verbose_test_description) {
1335 if ($test{'type'} == CLIENT_HEADER_TEST) {
1337 $message .= ' Header ';
1338 $message .= quote($test{'data'});
1339 $message .= ' and tag ';
1340 $message .= quote($test{'tag'});
1342 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1344 $message .= ' Request Header ';
1345 $message .= quote($test{'data'});
1346 $message .= ' and tag ';
1347 $message .= quote($test{'tag'});
1349 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1351 $message .= ' URL ';
1352 $message .= quote($test{'data'});
1353 $message .= ' and expected status code ';
1354 $message .= quote($test{'expected-status-code'});
1356 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1358 $message .= ' CGI URL ';
1359 $message .= quote($test{'data'});
1360 $message .= ' and expected status code ';
1361 $message .= quote($test{'expected-status-code'});
1363 } elsif ($test{'type'} == METHOD_TEST) {
1365 $message .= ' HTTP method ';
1366 $message .= quote($test{'data'});
1367 $message .= ' and expected status code ';
1368 $message .= quote($test{'expected-status-code'});
1370 } elsif ($test{'type'} == BLOCK_TEST) {
1372 $message .= ' Supposedly-blocked URL: ';
1373 $message .= quote($test{'data'});
1375 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1377 $message .= ' Sticky Actions: ';
1378 $message .= quote($test{'sticky-actions'});
1379 $message .= ' and URL: ';
1380 $message .= quote($test{'data'});
1384 die "Incomplete support for test type " . $test{'type'} . " detected.";
1389 log_message($message) if (!$result or cli_option_is_set('verbose'));
1394 return '\'' . $s . '\'';
1397 sub print_version () {
1398 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1409 Options and their default values if they have any:
1410 [--debug $cli_options{'debug'}]
1411 [--forks $cli_options{'forks'}]
1417 [--loops $cli_options{'loops'}]
1418 [--max-level $cli_options{'max-level'}]
1419 [--max-time $cli_options{'max-time'}]
1420 [--min-level $cli_options{'min-level'}]
1422 [--retries $cli_options{'retries'}]
1426 see "perldoc $0" for more information
1432 sub init_cli_options () {
1437 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1438 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1439 $cli_options{'debug'} = $log_level;
1440 $cli_options{'loops'} = CLI_LOOPS;
1441 $cli_options{'max-time'} = CLI_MAX_TIME;
1442 $cli_options{'retries'} = CLI_RETRIES;
1443 $cli_options{'forks'} = CLI_FORKS;
1446 sub parse_cli_options () {
1454 'debug=s' => \$cli_options{'debug'},
1455 'forks=s' => \$cli_options{'forks'},
1456 'help' => sub { help },
1457 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1458 'min-level=s' => \$cli_options{'min-level'},
1459 'max-level=s' => \$cli_options{'max-level'},
1460 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1461 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1462 'level=s' => \$cli_options{'level'},
1463 'loops=s' => \$cli_options{'loops'},
1464 'test-number=s' => \$cli_options{'test-number'},
1465 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1466 'retries=s' => \$cli_options{'retries'},
1467 'max-time=s' => \$cli_options{'max-time'},
1468 'verbose' => \$cli_options{'verbose'},
1469 'version' => sub { print_version && exit(0) }
1471 $log_level |= $cli_options{'debug'};
1474 sub cli_option_is_set ($) {
1477 my $cli_option = shift;
1479 return defined $cli_options{$cli_option};
1482 sub get_cli_option ($) {
1485 my $cli_option = shift;
1487 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1489 return $cli_options{$cli_option};
1492 sub init_proxy_settings($) {
1497 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1498 $proxy = get_cli_option('fuzzer-address');
1501 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1503 if (cli_option_is_set('privoxy-address')) {
1504 $proxy .= get_cli_option('privoxy-address');
1510 sub start_forks($) {
1513 l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
1515 foreach my $fork (1 .. $forks) {
1516 log_message("Starting fork $fork");
1518 if (defined $pid && !$pid) {
1526 init_our_variables();
1527 parse_cli_options();
1529 init_proxy_settings('vanilla-proxy');
1530 load_regressions_tests();
1531 init_proxy_settings('fuzz-proxy');
1532 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1533 execute_regression_tests();
1540 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1544 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1545 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1546 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1547 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1548 [B<--retries retries>] [B<--test-number test-number>] [B<--verbose>]
1553 Privoxy-Regression-Test is supposed to one day become
1554 a regression test suite for Privoxy. It's not quite there
1555 yet, however, and can currently only test header actions,
1556 check the returned status code for requests to arbitrary
1557 URLs and verify which actions are applied to them.
1559 Client header actions are tested by requesting
1560 B<http://p.p/show-request> and checking whether
1561 or not Privoxy modified the original request as expected.
1563 The original request contains both the header the action-to-be-tested
1564 acts upon and an additional tagger-triggering header that enables
1567 Applied actions are checked through B<http://p.p/show-url-info>.
1569 =head1 CONFIGURATION FILE SYNTAX
1571 Privoxy-Regression-Test's configuration is embedded in
1572 Privoxy action files and loaded through Privoxy's web interface.
1574 It makes testing a Privoxy version running on a remote system easier
1575 and should prevent you from updating your tests without updating Privoxy's
1576 configuration accordingly.
1578 A client-header-action test section looks like this:
1580 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1581 # Expect Header = Referer: http://www.example.org/
1582 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1583 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1585 The example above causes Privoxy-Regression-Test to set
1586 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1587 and to expect it to be modified to
1588 B<Referer: http://www.example.org/>.
1590 When testing this section, Privoxy-Regression-Test will set the header
1591 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1592 causing the B<privoxy-control> tagger to create the tag
1593 B<client-header-filter{hide-tor-exit-notation}> which will finally
1594 cause Privoxy to enable the action section.
1596 Note that the actions itself are only used by Privoxy,
1597 Privoxy-Regression-Test ignores them and will be happy
1598 as long as the expectations are satisfied.
1600 A fetch test looks like this:
1602 # Fetch Test = http://p.p/user-manual
1603 # Expect Status Code = 302
1605 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1606 and to expect a response with the HTTP status code B<302>. Obviously that's
1607 not a very thorough test and mainly useful to get some code coverage
1608 for Valgrind or to verify that the templates are installed correctly.
1610 If you want to test CGI pages that require a trusted
1611 referer, you can use:
1613 # Trusted CGI Request = http://p.p/edit-actions
1615 It works like ordinary fetch tests, but sets the referer
1616 header to a trusted value.
1618 If no explicit status code expectation is set, B<200> is used.
1620 To verify that a URL is blocked, use:
1622 # Blocked URL = http://www.example.com/blocked
1624 To verify that a specific set of actions is applied to an URL, use:
1626 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1627 # URL = http://www.example.org/my-first-url
1629 The sticky actions will be checked for all URLs below it
1630 until the next sticky actions directive.
1634 All tests have test levels to let the user
1635 control which ones to execute (see I<OPTIONS> below).
1636 Test levels are either set with the B<Level> directive,
1637 or implicitly through the test type.
1639 Block tests default to level 7, fetch tests to level 6,
1640 "Sticky Actions" tests default to level 5, tests for trusted CGI
1641 requests to level 3 and client-header-action tests to level 1.
1645 B<--debug bitmask> Add the bitmask provided as integer
1646 to the debug settings.
1648 B<--forks forks> Number of forks to start before executing
1649 the regression tests. This is mainly useful for stress-testing.
1651 B<--fuzzer-address> Listening address used when executing
1652 the regression tests. Useful to make sure that the requests
1653 to load the regression tests don't fail due to fuzzing.
1655 B<--fuzzer-feeding> Ignore some errors that would otherwise
1656 cause Privoxy-Regression-Test to abort the test because
1657 they shouldn't happen in normal operation. This option is
1658 intended to be used if Privoxy-Regression-Test is only
1659 used to feed a fuzzer in which case there's a high chance
1660 that Privoxy gets an invalid request and returns an error
1663 B<--help> Shows available command line options.
1665 B<--header-fuzzing> Modifies linear white space in
1666 headers in a way that should not affect the test result.
1668 B<--level level> Only execute tests with the specified B<level>.
1670 B<--loop count> Loop through the regression tests B<count> times.
1671 Useful to feed a fuzzer, or when doing stress tests with
1672 several Privoxy-Regression-Test instances running at the same
1675 B<--max-level max-level> Only execute tests with a B<level>
1676 below or equal to the numerical B<max-level>.
1678 B<--max-time max-time> Give Privoxy B<max-time> seconds
1679 to return data. Increasing the default may make sense when
1680 Privoxy is run through Valgrind, decreasing the default may
1681 make sense when Privoxy-Regression-Test is used to feed
1684 B<--min-level min-level> Only execute tests with a B<level>
1685 above or equal to the numerical B<min-level>.
1687 B<--privoxy-address proxy-address> Privoxy's listening address.
1688 If it's not set, the value of the environment variable http_proxy
1689 will be used. B<proxy-address> has to be specified in http_proxy
1692 B<--retries retries> Retry B<retries> times.
1694 B<--test-number test-number> Only run the test with the specified
1697 B<--verbose> Also log succesful test runs.
1699 B<--version> Print version and exit.
1701 The second dash is optional, options can be shortened,
1702 as long as there are no ambiguities.
1704 =head1 PRIVOXY CONFIGURATION
1706 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1707 which aims to test all official client-header modifying actions
1708 and can be used to verify that the templates and the user manual
1709 files are installed correctly.
1711 To use it, it has to be copied in Privoxy's configuration
1712 directory, and afterwards referenced in Privoxy's configuration
1715 actionsfile regression-tests.action
1717 In general, its tests are supposed to work without changing
1718 any other action files, unless you already added lots of
1719 taggers yourself. If you are using taggers that cause problems,
1720 you might have to temporary disable them for Privoxy's CGI pages.
1722 Some of the regression tests rely on Privoxy features that
1723 may be disabled in your configuration. Tests with a level below
1724 7 are supposed to work with all Privoxy configurations (provided
1725 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1727 Tests with level 9 require Privoxy to deliver the User Manual,
1728 tests with level 12 require the CGI editor to be enabled.
1732 Expect the configuration file syntax to change with future releases.
1736 As Privoxy's B<show-request> page only shows client headers,
1737 Privoxy-Regression-Test can't use it to test Privoxy actions
1738 that modify server headers.
1740 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1741 control the actions to test, it currently only works with
1742 Privoxy 3.0.7 or later.
1744 At the moment Privoxy-Regression-Test fetches Privoxy's
1745 configuration page through I<curl>(1), therefore you have to
1746 have I<curl> installed, otherwise you won't be able to run
1747 Privoxy-Regression-Test in a meaningful way.
1755 Fabian Keil <fk@fabiankeil.de>