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.179 2009/05/28 17:24:53 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,
79 CLIENT_HEADER_TEST => 1,
80 SERVER_HEADER_TEST => 2,
83 STICKY_ACTIONS_TEST => 5,
84 TRUSTED_CGI_REQUEST => 6,
88 sub init_our_variables () {
90 our $leading_log_time = LEADING_LOG_TIME;
91 our $leading_log_date = LEADING_LOG_DATE;
93 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
95 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
97 our $log_level = get_default_log_level();
101 sub get_default_log_level () {
105 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
106 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
107 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
108 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
109 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
111 # This one is supposed to be always on.
112 $log_level |= LL_SOFT_ERROR;
117 ############################################################################
119 # File loading functions
121 ############################################################################
129 # Unescape brackets and dots
130 $tag =~ s@\\(?=[{}().+])@@g;
132 # log_message("Parsed tag: " . $tag);
134 check_for_forbidden_characters($tag);
139 sub check_for_forbidden_characters ($) {
142 my $allowed = '[-=\dA-Za-z~{}:./();\s,+@"_%?&*^]';
144 unless ($string =~ m/^$allowed*$/o) {
145 my $forbidden = $string;
146 $forbidden =~ s@^$allowed*(.).*@$1@;
148 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
152 sub load_regressions_tests () {
154 our $privoxy_cgi_url;
156 our %privoxy_features;
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);
180 } elsif (m@<td><code>([^<]*)</code></td>@) {
184 } elsif (m@<td> (Yes|No) </td>@) {
186 $privoxy_features{$feature} = $1 if defined $feature;
191 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
193 load_action_files(\@actionfiles);
196 sub token_starts_new_test ($) {
199 my @new_test_directives = ('set header', 'fetch test',
200 'trusted cgi request', 'request header', 'method test',
201 'blocked url', 'url');
203 foreach my $new_test_directive (@new_test_directives) {
204 return 1 if $new_test_directive eq $token;
212 my ($token, $value) = (undef, undef);
214 # Remove leading and trailing white space.
218 # Reverse HTML-encoding
219 # XXX: Seriously imcomplete.
224 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)$/) {
229 $token =~ s@\s\s+@ @g;
230 $token =~ tr/[A-Z]/[a-z]/;
232 } elsif (/^TAG\s*:(.*)$/) {
238 return ($token, $value);
241 sub enlist_new_test ($$$$$$) {
243 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
246 if ($token eq 'set header') {
248 l(LL_FILE_LOADING, "Header to set: " . $value);
249 $type = CLIENT_HEADER_TEST;
251 } elsif ($token eq 'request header') {
253 l(LL_FILE_LOADING, "Header to request: " . $value);
254 $type = SERVER_HEADER_TEST;
255 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
257 } elsif ($token eq 'trusted cgi request') {
259 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
260 $type = TRUSTED_CGI_REQUEST;
261 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
263 } elsif ($token eq 'fetch test') {
265 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
266 $type = DUMB_FETCH_TEST;
267 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
269 } elsif ($token eq 'method test') {
271 l(LL_FILE_LOADING, "Method to test: " . $value);
273 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
275 } elsif ($token eq 'blocked url') {
277 l(LL_FILE_LOADING, "URL to block-test: " . $value);
280 } elsif ($token eq 'url') {
282 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
283 $type = STICKY_ACTIONS_TEST;
287 die "Incomplete '" . $token . "' support detected.";
290 $$regression_tests[$si][$ri]{'type'} = $type;
291 $$regression_tests[$si][$ri]{'level'} = $type;
293 check_for_forbidden_characters($value);
295 $$regression_tests[$si][$ri]{'data'} = $value;
297 # For function that only get passed single tests
298 $$regression_tests[$si][$ri]{'section-id'} = $si;
299 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
300 $$regression_tests[$si][$ri]{'number'} = $number - 1;
302 "Regression test " . $number . " (section:" . $si . "):");
305 sub load_action_files ($) {
309 our @regression_tests;
311 my $actionfiles_ref = shift;
312 my @actionfiles = @{$actionfiles_ref};
314 my $si = 0; # Section index
315 my $ri = -1; # Regression test index
320 l(LL_STATUS, "Gathering regression tests from " .
321 @actionfiles . " action file(s) delivered by Privoxy.");
323 for my $file_number (0 .. @actionfiles - 1) {
325 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
326 my $actionfile = undef;
327 my $sticky_actions = undef;
329 foreach (@{get_cgi_page_or_else($curl_url)}) {
334 if (/<h2>Contents of Actions File (.*?)</) {
338 next unless defined $actionfile;
342 my ($token, $value) = tokenize($_);
344 next unless defined $token;
346 # Load regression tests
348 if (token_starts_new_test($token)) {
350 # Beginning of new regression test.
353 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
356 if ($token =~ /level\s+(\d+)/i) {
359 register_dependency($level, $value);
362 if ($token eq 'sticky actions') {
364 # Will be used by each following Sticky URL.
365 $sticky_actions = $value;
366 if ($sticky_actions =~ /{[^}]*\s/) {
367 log_and_die("'Sticky Actions' with whitespace inside the " .
368 "action parameters are currently unsupported.");
372 if ($si == -1 || $ri == -1) {
373 # No beginning of a test detected yet,
374 # so we don't care about any other test
379 if ($token eq 'expect header') {
381 l(LL_FILE_LOADING, "Detected expectation: " . $value);
382 $regression_tests[$si][$ri]{'expect-header'} = $value;
384 } elsif ($token eq 'tag') {
388 my $tag = parse_tag($value);
390 # We already checked in parse_tag() after filtering
393 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
395 # Save tag for all tests in this section
397 $regression_tests[$si][$ri]{'tag'} = $tag;
403 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
405 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
406 $regression_tests[$si][$ri]{'ignore'} = 1;
409 } elsif ($token eq 'expect status code') {
411 l(LL_FILE_LOADING, "Expecting status code: " . $value);
412 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
414 } elsif ($token eq 'level') { # XXX: stupid name
416 $value =~ s@(\d+).*@$1@;
417 l(LL_FILE_LOADING, "Level: " . $value);
418 $regression_tests[$si][$ri]{'level'} = $value;
420 } elsif ($token eq 'method') {
422 l(LL_FILE_LOADING, "Method: " . $value);
423 $regression_tests[$si][$ri]{'method'} = $value;
425 } elsif ($token eq 'url') {
427 if (defined $sticky_actions) {
428 die "WTF? Attempted to overwrite Sticky Actions"
429 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
431 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
432 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
434 log_and_die("Sticky URL without Sticky Actions: $value");
439 # We don't use it, so we don't need
443 check_for_forbidden_characters($value) unless $no_checks;
444 check_for_forbidden_characters($token);
448 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
449 . " Of which " . $ignored. " will be ignored)\n");
452 ############################################################################
454 # Regression test executing functions
456 ############################################################################
458 sub execute_regression_tests () {
460 our @regression_tests;
461 my $loops = get_cli_option('loops');
463 my $all_failures = 0;
464 my $all_successes = 0;
466 unless (@regression_tests) {
468 l(LL_STATUS, "No regression tests found.");
472 l(LL_STATUS, "Executing regression tests ...");
474 while ($loops-- > 0) {
481 for my $s (0 .. @regression_tests - 1) {
485 while (defined $regression_tests[$s][$r]) {
487 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
488 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
490 my $number = $regression_tests[$s][$r]{'number'};
491 my $skip_reason = undef;
493 if ($regression_tests[$s][$r]{'ignore'}) {
495 $skip_reason = "Ignore flag is set";
497 } elsif (cli_option_is_set('test-number')
498 and get_cli_option('test-number') != $number) {
500 $skip_reason = "Only executing test " . get_cli_option('test-number');
504 $skip_reason = level_is_unacceptable($regression_tests[$s][$r]{'level'});
507 if (defined $skip_reason) {
509 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
510 log_message($message) if (cli_option_is_set('show-skipped-tests'));
515 my $result = execute_regression_test($regression_tests[$s][$r]);
517 log_result($regression_tests[$s][$r], $result, $tests);
519 $successes += $result;
525 $failures = $tests - $successes;
527 log_message("Executed " . $tests . " regression tests. " .
528 'Skipped ' . $skipped . '. ' .
529 $successes . " successes, " . $failures . " failures.");
531 $all_tests += $tests;
532 $all_failures += $failures;
533 $all_successes += $successes;
536 if (get_cli_option('loops') > 1) {
537 log_message("Total: Executed " . $all_tests . " regression tests. " .
538 $all_successes . " successes, " . $all_failures . " failures.");
542 sub level_is_unacceptable ($) {
544 my $min_level = get_cli_option('min-level');
545 my $max_level = get_cli_option('max-level');
546 my $required_level = cli_option_is_set('level') ?
547 get_cli_option('level') : $level;
550 if ($required_level != $level) {
552 $reason = "Level doesn't match (" . $level .
553 " != " . $required_level . ")"
555 } elsif ($level < $min_level) {
557 $reason = "Level to low (" . $level . " < " . $min_level . ")";
559 } elsif ($level > $max_level) {
561 $reason = "Level to high (" . $level . " > " . $max_level . ")";
565 $reason = dependency_unsatisfied($level);
571 sub dependency_unsatisfied ($) {
576 our %privoxy_features;
578 my $dependency_problem = undef;
580 if (defined ($dependencies{$level}{'config line'})) {
582 my $dependency = $dependencies{$level}{'config line'};
583 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
585 foreach (@privoxy_config) {
588 $dependency_problem = undef;
593 } elsif (defined ($dependencies{$level}{'feature status'})) {
595 my $dependency = $dependencies{$level}{'feature status'};
596 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
598 unless (defined($privoxy_features{$feature})
599 and ($privoxy_features{$feature} eq $status))
601 $dependency_problem = "depends on '" . $feature .
602 "' being set to '" . $status . "'";
606 return $dependency_problem;
609 sub register_dependency ($$) {
612 my $dependency = shift;
615 if ($dependency =~ /config line\s+(.*)/) {
617 $dependencies{$level}{'config line'} = $1;
619 } elsif ($dependency =~ /feature status\s+(.*)/) {
621 $dependencies{$level}{'feature status'} = $1;
625 log_and_die("Didn't recognize dependency: $dependency.");
629 # XXX: somewhat misleading name
630 sub execute_regression_test ($) {
632 my $test_ref = shift;
633 my %test = %{$test_ref};
636 if ($test{'type'} == CLIENT_HEADER_TEST) {
638 $result = execute_client_header_regression_test($test_ref);
640 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
642 $result = execute_server_header_regression_test($test_ref);
644 } elsif ($test{'type'} == DUMB_FETCH_TEST
645 or $test{'type'} == TRUSTED_CGI_REQUEST) {
647 $result = execute_dumb_fetch_test($test_ref);
649 } elsif ($test{'type'} == METHOD_TEST) {
651 $result = execute_method_test($test_ref);
653 } elsif ($test{'type'} == BLOCK_TEST) {
655 $result = execute_block_test($test_ref);
657 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
659 $result = execute_sticky_actions_test($test_ref);
663 die "Unsupported test type detected: " . $test{'type'};
669 sub execute_method_test ($) {
671 my $test_ref = shift;
672 my %test = %{$test_ref};
675 my $method = $test{'data'};
677 my $curl_parameters = '';
678 my $expected_status_code = $test{'expected-status-code'};
680 $curl_parameters .= '--request ' . $method . ' ';
681 # Don't complain about the 'missing' body
682 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
684 $curl_parameters .= PRIVOXY_CGI_URL;
686 $buffer_ref = get_page_with_curl($curl_parameters);
687 $status_code = get_status_code($buffer_ref);
689 return check_status_code_result($status_code, $expected_status_code);
692 sub execute_dumb_fetch_test ($) {
694 my $test_ref = shift;
695 my %test = %{$test_ref};
699 my $curl_parameters = '';
700 my $expected_status_code = $test{'expected-status-code'};
702 if (defined $test{method}) {
703 $curl_parameters .= '--request ' . $test{method} . ' ';
705 if ($test{type} == TRUSTED_CGI_REQUEST) {
706 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
709 $curl_parameters .= $test{'data'};
711 $buffer_ref = get_page_with_curl($curl_parameters);
712 $status_code = get_status_code($buffer_ref);
714 return check_status_code_result($status_code, $expected_status_code);
717 sub execute_block_test ($) {
720 my $url = $test->{'data'};
721 my $final_results = get_final_results($url);
723 return defined $final_results->{'+block'};
726 sub execute_sticky_actions_test ($) {
729 my $url = $test->{'data'};
730 my $verified_actions = 0;
731 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
732 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
733 my $final_results = get_final_results($url);
735 foreach my $sticky_action (@sticky_actions) {
737 if (defined $final_results->{$sticky_action}) {
741 } elsif ($sticky_action =~ /-.*\{/) {
743 # Disabled multi actions aren't explicitly listed as
744 # disabled and thus have to be checked by verifying
745 # 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 . '.');
831 sub execute_client_header_regression_test ($) {
833 my $test_ref = shift;
837 $buffer_ref = get_show_request_with_curl($test_ref);
839 $header = get_header($buffer_ref, $test_ref);
841 return check_header_result($test_ref, $header);
844 sub execute_server_header_regression_test ($) {
846 my $test_ref = shift;
850 $buffer_ref = get_head_with_curl($test_ref);
852 $header = get_server_header($buffer_ref, $test_ref);
854 return check_header_result($test_ref, $header);
857 sub interpret_result ($) {
859 return $success ? "Success" : "Failure";
862 sub check_header_result ($$) {
864 my $test_ref = shift;
867 my %test = %{$test_ref};
868 my $expect_header = $test{'expect-header'};
871 if ($expect_header eq 'NO CHANGE') {
873 if (defined($header) and $header eq $test{'data'}) {
879 $header = "REMOVAL" unless defined $header;
880 l(LL_VERBOSE_FAILURE,
881 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
884 } elsif ($expect_header eq 'REMOVAL') {
886 if (defined($header) and $header eq $test{'data'}) {
888 l(LL_VERBOSE_FAILURE,
889 "Ooops. Expected removal but: '" . $header . "' is still there.");
893 # XXX: Use more reliable check here and make sure
894 # the header has a different name.
898 } elsif ($expect_header eq 'SOME CHANGE') {
900 if (defined($header) and not $header eq $test{'data'}) {
906 $header = "REMOVAL" unless defined $header;
907 l(LL_VERBOSE_FAILURE,
908 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
913 if (defined($header) and $header eq $expect_header) {
919 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
920 l(LL_VERBOSE_FAILURE,
921 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
927 sub get_header_name ($) {
931 $header =~ s@(.*?: ).*@$1@;
936 sub get_header ($$) {
938 our $filtered_request = '';
940 my $buffer_ref = shift;
941 my $test_ref = shift;
943 my %test = %{$test_ref};
944 my @buffer = @{$buffer_ref};
946 my $expect_header = $test{'expect-header'};
948 die "get_header called with no expect header" unless defined $expect_header;
951 my $processed_request_reached = 0;
953 my $processed_request = '';
957 if ($expect_header eq 'REMOVAL'
958 or $expect_header eq 'NO CHANGE'
959 or $expect_header eq 'SOME CHANGE') {
961 $expect_header = $test{'data'};
964 $header_to_get = get_header_name($expect_header);
968 # Skip everything before the Processed request
969 if (/Processed Request/) {
970 $processed_request_reached = 1;
973 next unless $processed_request_reached;
975 # End loop after the Processed request
978 # Ditch tags and leading/trailing white space.
982 # Decode characters we care about.
985 $filtered_request .= "\n" . $_;
987 if (/^$header_to_get/) {
997 sub get_server_header ($$) {
999 my $buffer_ref = shift;
1000 my $test_ref = shift;
1002 my %test = %{$test_ref};
1003 my @buffer = @{$buffer_ref};
1005 my $expect_header = $test{'expect-header'};
1009 # XXX: Should be caught before starting to test.
1010 log_and_die("No expect header for test " . $test{'number'})
1011 unless defined $expect_header;
1013 if ($expect_header eq 'REMOVAL'
1014 or $expect_header eq 'NO CHANGE'
1015 or $expect_header eq 'SOME CHANGE') {
1017 $expect_header = $test{'data'};
1020 $header_to_get = get_header_name($expect_header);
1024 # XXX: should probably verify that the request
1025 # was actually answered by Fellatio.
1026 if (/^$header_to_get/) {
1028 $header =~ s@\s*$@@g;
1036 sub get_status_code ($) {
1038 my $buffer_ref = shift;
1039 my @buffer = @{$buffer_ref};
1043 if (/^HTTP\/\d\.\d (\d{3})/) {
1049 return '123' if cli_option_is_set('fuzzer-feeding');
1051 log_and_die('Unexpected buffer line: "' . $_ . '"');
1056 sub get_test_keys () {
1057 return ('tag', 'data', 'expect-header', 'ignore');
1061 sub test_content_as_string ($) {
1063 my $test_ref = shift;
1064 my %test = %{$test_ref};
1068 foreach my $key (get_test_keys()) {
1069 $test{$key} = 'Not set' unless (defined $test{$key});
1072 $s .= 'Tag: ' . $test{'tag'};
1074 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1076 $s .= 'Expected header: ' . $test{'expect-header'};
1078 $s .= 'Ignore: ' . $test{'ignore'};
1083 sub fuzz_header($) {
1085 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1087 $white_space = $white_space x (1 + int(rand(5)));
1089 # Only fuzz white space before the first quoted token.
1090 # (Privoxy doesn't touch white space inside quoted tokens
1091 # and modifying it would cause the tests to fail).
1092 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1097 ############################################################################
1099 # HTTP fetch functions
1101 ############################################################################
1103 sub check_for_curl () {
1105 log_and_die("No curl found.") unless (`which $curl`);
1108 sub get_cgi_page_or_else ($) {
1110 my $cgi_url = shift;
1111 my $content_ref = get_page_with_curl($cgi_url);
1112 my $status_code = get_status_code($content_ref);
1114 if (200 != $status_code) {
1116 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1117 "Received status code ". $status_code .
1118 " while only 200 is acceptable.";
1120 if (cli_option_is_set('fuzzer-feeding')) {
1122 $log_message .= " Ignored due to fuzzer feeding.";
1123 l(LL_SOFT_ERROR, $log_message)
1127 log_and_die($log_message);
1131 return $content_ref;
1134 # XXX: misleading name
1135 sub get_show_request_with_curl ($) {
1137 our $privoxy_cgi_url;
1138 my $test_ref = shift;
1139 my %test = %{$test_ref};
1141 my $curl_parameters = ' ';
1142 my $header = $test{'data'};
1144 if (cli_option_is_set('header-fuzzing')) {
1145 $header = fuzz_header($header);
1148 # Enable the action to test
1149 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1150 # The header to filter
1151 $curl_parameters .= '-H \'' . $header . '\' ';
1153 $curl_parameters .= ' ';
1154 $curl_parameters .= $privoxy_cgi_url;
1155 $curl_parameters .= 'show-request';
1157 return get_cgi_page_or_else($curl_parameters);
1160 sub get_head_with_curl ($) {
1162 our $fellatio_url = FELLATIO_URL;
1163 my $test_ref = shift;
1164 my %test = %{$test_ref};
1166 my $curl_parameters = ' ';
1168 # Enable the action to test
1169 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1170 # The header to filter
1171 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1172 $curl_parameters .= '--head ';
1174 $curl_parameters .= ' ';
1175 $curl_parameters .= $fellatio_url;
1177 return get_page_with_curl($curl_parameters);
1180 sub get_page_with_curl ($) {
1184 my $parameters = shift;
1186 my $curl_line = CURL;
1187 my $retries_left = get_cli_option('retries') + 1;
1190 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1192 # We want to see the HTTP status code
1193 $curl_line .= " --include ";
1194 # Let Privoxy emit two log messages less.
1195 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1196 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1197 # We don't care about fetch statistic.
1198 $curl_line .= " -s ";
1199 # We do care about the failure reason if any.
1200 $curl_line .= " -S ";
1201 # We want to advertise ourselves
1202 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1203 # We aren't too patient
1204 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1206 $curl_line .= $parameters;
1207 # XXX: still necessary?
1208 $curl_line .= ' 2>&1';
1210 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1213 @buffer = `$curl_line`;
1216 $failure_reason = array_as_string(\@buffer);
1217 chomp $failure_reason;
1218 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1220 } while ($? && --$retries_left);
1222 unless ($retries_left) {
1223 log_and_die("Running curl failed " . get_cli_option('retries') .
1224 " times in a row. Last error: '" . $failure_reason . "'.");
1231 ############################################################################
1235 ############################################################################
1237 sub array_as_string ($) {
1238 my $array_ref = shift;
1241 foreach (@{$array_ref}) {
1249 my $test_ref = shift;
1250 log_message('Test is:' . test_content_as_string($test_ref));
1256 my $this_level = shift;
1257 my $message = shift;
1259 log_message($message) if ($log_level & $this_level);
1262 sub log_and_die ($) {
1263 my $message = shift;
1265 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1269 sub log_message ($) {
1271 my $message = shift;
1275 our $leading_log_date;
1276 our $leading_log_time;
1278 my $time_stamp = '';
1279 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1281 if ($leading_log_date || $leading_log_time) {
1283 if ($leading_log_date) {
1286 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1289 if ($leading_log_time) {
1290 $time_stamp .= ' ' if $leading_log_date;
1291 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1294 $message = $time_stamp . ": " . $message;
1297 printf(STDERR "%s\n", $message);
1300 sub log_result ($$) {
1302 our $verbose_test_description;
1303 our $filtered_request;
1305 my $test_ref = shift;
1309 my %test = %{$test_ref};
1312 $message .= interpret_result($result);
1313 $message .= " for test ";
1314 $message .= $number;
1316 $message .= $test{'number'};
1318 $message .= $test{'section-id'};
1320 $message .= $test{'regression-test-id'};
1323 if ($verbose_test_description) {
1325 if ($test{'type'} == CLIENT_HEADER_TEST) {
1327 $message .= ' Header ';
1328 $message .= quote($test{'data'});
1329 $message .= ' and tag ';
1330 $message .= quote($test{'tag'});
1332 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1334 $message .= ' Request Header ';
1335 $message .= quote($test{'data'});
1336 $message .= ' and tag ';
1337 $message .= quote($test{'tag'});
1339 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1341 $message .= ' URL ';
1342 $message .= quote($test{'data'});
1343 $message .= ' and expected status code ';
1344 $message .= quote($test{'expected-status-code'});
1346 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1348 $message .= ' CGI URL ';
1349 $message .= quote($test{'data'});
1350 $message .= ' and expected status code ';
1351 $message .= quote($test{'expected-status-code'});
1353 } elsif ($test{'type'} == METHOD_TEST) {
1355 $message .= ' HTTP method ';
1356 $message .= quote($test{'data'});
1357 $message .= ' and expected status code ';
1358 $message .= quote($test{'expected-status-code'});
1360 } elsif ($test{'type'} == BLOCK_TEST) {
1362 $message .= ' Supposedly-blocked URL: ';
1363 $message .= quote($test{'data'});
1365 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1367 $message .= ' Sticky Actions: ';
1368 $message .= quote($test{'sticky-actions'});
1369 $message .= ' and URL: ';
1370 $message .= quote($test{'data'});
1374 die "Incomplete support for test type " . $test{'type'} . " detected.";
1378 log_message($message) if (!$result or cli_option_is_set('verbose'));
1383 return '\'' . $s . '\'';
1386 sub print_version () {
1387 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
1398 Options and their default values if they have any:
1399 [--debug $cli_options{'debug'}]
1400 [--forks $cli_options{'forks'}]
1406 [--loops $cli_options{'loops'}]
1407 [--max-level $cli_options{'max-level'}]
1408 [--max-time $cli_options{'max-time'}]
1409 [--min-level $cli_options{'min-level'}]
1411 [--retries $cli_options{'retries'}]
1412 [--show-skipped-tests]
1416 see "perldoc $0" for more information
1422 sub init_cli_options () {
1427 $cli_options{'debug'} = $log_level;
1428 $cli_options{'forks'} = CLI_FORKS;
1429 $cli_options{'loops'} = CLI_LOOPS;
1430 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1431 $cli_options{'max-time'} = CLI_MAX_TIME;
1432 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1433 $cli_options{'retries'} = CLI_RETRIES;
1436 sub parse_cli_options () {
1444 'debug=s' => \$cli_options{'debug'},
1445 'forks=s' => \$cli_options{'forks'},
1446 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1447 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1448 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1449 'help' => sub {help},
1450 'level=s' => \$cli_options{'level'},
1451 'loops=s' => \$cli_options{'loops'},
1452 'max-level=s' => \$cli_options{'max-level'},
1453 'max-time=s' => \$cli_options{'max-time'},
1454 'min-level=s' => \$cli_options{'min-level'},
1455 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1456 'retries=s' => \$cli_options{'retries'},
1457 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1458 'test-number=s' => \$cli_options{'test-number'},
1459 'verbose' => \$cli_options{'verbose'},
1460 'version' => sub {print_version && exit(0)}
1462 $log_level |= $cli_options{'debug'};
1465 sub cli_option_is_set ($) {
1468 my $cli_option = shift;
1470 return defined $cli_options{$cli_option};
1473 sub get_cli_option ($) {
1476 my $cli_option = shift;
1478 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1480 return $cli_options{$cli_option};
1483 sub init_proxy_settings($) {
1488 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1489 $proxy = get_cli_option('fuzzer-address');
1492 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1494 if (cli_option_is_set('privoxy-address')) {
1495 $proxy .= get_cli_option('privoxy-address');
1500 sub start_forks($) {
1503 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1505 foreach my $fork (1 .. $forks) {
1506 log_message("Starting fork $fork");
1508 if (defined $pid && !$pid) {
1516 init_our_variables();
1517 parse_cli_options();
1519 init_proxy_settings('vanilla-proxy');
1520 load_regressions_tests();
1521 init_proxy_settings('fuzz-proxy');
1522 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1523 execute_regression_tests();
1530 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1534 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1535 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1536 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1537 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1538 [B<--retries retries>] [B<--test-number test-number>]
1539 [B<--show-skipped-tests>] [B<--verbose>]
1544 Privoxy-Regression-Test is supposed to one day become
1545 a regression test suite for Privoxy. It's not quite there
1546 yet, however, and can currently only test header actions,
1547 check the returned status code for requests to arbitrary
1548 URLs and verify which actions are applied to them.
1550 Client header actions are tested by requesting
1551 B<http://p.p/show-request> and checking whether
1552 or not Privoxy modified the original request as expected.
1554 The original request contains both the header the action-to-be-tested
1555 acts upon and an additional tagger-triggering header that enables
1558 Applied actions are checked through B<http://p.p/show-url-info>.
1560 =head1 CONFIGURATION FILE SYNTAX
1562 Privoxy-Regression-Test's configuration is embedded in
1563 Privoxy action files and loaded through Privoxy's web interface.
1565 It makes testing a Privoxy version running on a remote system easier
1566 and should prevent you from updating your tests without updating Privoxy's
1567 configuration accordingly.
1569 A client-header-action test section looks like this:
1571 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1572 # Expect Header = Referer: http://www.example.org/
1573 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1574 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1576 The example above causes Privoxy-Regression-Test to set
1577 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1578 and to expect it to be modified to
1579 B<Referer: http://www.example.org/>.
1581 When testing this section, Privoxy-Regression-Test will set the header
1582 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1583 causing the B<privoxy-control> tagger to create the tag
1584 B<client-header-filter{hide-tor-exit-notation}> which will finally
1585 cause Privoxy to enable the action section.
1587 Note that the actions itself are only used by Privoxy,
1588 Privoxy-Regression-Test ignores them and will be happy
1589 as long as the expectations are satisfied.
1591 A fetch test looks like this:
1593 # Fetch Test = http://p.p/user-manual
1594 # Expect Status Code = 302
1596 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1597 and to expect a response with the HTTP status code B<302>. Obviously that's
1598 not a very thorough test and mainly useful to get some code coverage
1599 for Valgrind or to verify that the templates are installed correctly.
1601 If you want to test CGI pages that require a trusted
1602 referer, you can use:
1604 # Trusted CGI Request = http://p.p/edit-actions
1606 It works like ordinary fetch tests, but sets the referer
1607 header to a trusted value.
1609 If no explicit status code expectation is set, B<200> is used.
1611 To verify that a URL is blocked, use:
1613 # Blocked URL = http://www.example.com/blocked
1615 To verify that a specific set of actions is applied to an URL, use:
1617 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1618 # URL = http://www.example.org/my-first-url
1620 The sticky actions will be checked for all URLs below it
1621 until the next sticky actions directive.
1625 All tests have test levels to let the user
1626 control which ones to execute (see I<OPTIONS> below).
1627 Test levels are either set with the B<Level> directive,
1628 or implicitly through the test type.
1630 Block tests default to level 7, fetch tests to level 6,
1631 "Sticky Actions" tests default to level 5, tests for trusted CGI
1632 requests to level 3 and client-header-action tests to level 1.
1636 B<--debug bitmask> Add the bitmask provided as integer
1637 to the debug settings.
1639 B<--forks forks> Number of forks to start before executing
1640 the regression tests. This is mainly useful for stress-testing.
1642 B<--fuzzer-address> Listening address used when executing
1643 the regression tests. Useful to make sure that the requests
1644 to load the regression tests don't fail due to fuzzing.
1646 B<--fuzzer-feeding> Ignore some errors that would otherwise
1647 cause Privoxy-Regression-Test to abort the test because
1648 they shouldn't happen in normal operation. This option is
1649 intended to be used if Privoxy-Regression-Test is only
1650 used to feed a fuzzer in which case there's a high chance
1651 that Privoxy gets an invalid request and returns an error
1654 B<--help> Shows available command line options.
1656 B<--header-fuzzing> Modifies linear white space in
1657 headers in a way that should not affect the test result.
1659 B<--level level> Only execute tests with the specified B<level>.
1661 B<--loop count> Loop through the regression tests B<count> times.
1662 Useful to feed a fuzzer, or when doing stress tests with
1663 several Privoxy-Regression-Test instances running at the same
1666 B<--max-level max-level> Only execute tests with a B<level>
1667 below or equal to the numerical B<max-level>.
1669 B<--max-time max-time> Give Privoxy B<max-time> seconds
1670 to return data. Increasing the default may make sense when
1671 Privoxy is run through Valgrind, decreasing the default may
1672 make sense when Privoxy-Regression-Test is used to feed
1675 B<--min-level min-level> Only execute tests with a B<level>
1676 above or equal to the numerical B<min-level>.
1678 B<--privoxy-address proxy-address> Privoxy's listening address.
1679 If it's not set, the value of the environment variable http_proxy
1680 will be used. B<proxy-address> has to be specified in http_proxy
1683 B<--retries retries> Retry B<retries> times.
1685 B<--test-number test-number> Only run the test with the specified
1688 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1690 B<--verbose> Log succesful tests as well. By default only
1691 the failures are logged.
1693 B<--version> Print version and exit.
1695 The second dash is optional, options can be shortened,
1696 as long as there are no ambiguities.
1698 =head1 PRIVOXY CONFIGURATION
1700 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1701 which aims to test all official client-header modifying actions
1702 and can be used to verify that the templates and the user manual
1703 files are installed correctly.
1705 To use it, it has to be copied in Privoxy's configuration
1706 directory, and afterwards referenced in Privoxy's configuration
1709 actionsfile regression-tests.action
1711 In general, its tests are supposed to work without changing
1712 any other action files, unless you already added lots of
1713 taggers yourself. If you are using taggers that cause problems,
1714 you might have to temporary disable them for Privoxy's CGI pages.
1716 Some of the regression tests rely on Privoxy features that
1717 may be disabled in your configuration. Tests with a level below
1718 7 are supposed to work with all Privoxy configurations (provided
1719 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1721 Tests with level 9 require Privoxy to deliver the User Manual,
1722 tests with level 12 require the CGI editor to be enabled.
1726 Expect the configuration file syntax to change with future releases.
1730 As Privoxy's B<show-request> page only shows client headers,
1731 Privoxy-Regression-Test can't use it to test Privoxy actions
1732 that modify server headers.
1734 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1735 control the actions to test, it currently only works with
1736 Privoxy 3.0.7 or later.
1738 At the moment Privoxy-Regression-Test fetches Privoxy's
1739 configuration page through I<curl>(1), therefore you have to
1740 have I<curl> installed, otherwise you won't be able to run
1741 Privoxy-Regression-Test in a meaningful way.
1749 Fabian Keil <fk@fabiankeil.de>