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.212 2011/07/17 13:49:52 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-2011 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.4',
52 # XXX: why limit at all?
57 PRIVOXY_CGI_URL => 'http://p.p/',
58 FELLATIO_URL => 'http://127.0.0.1:8080/',
59 LEADING_LOG_DATE => 1,
60 LEADING_LOG_TIME => 1,
62 DEBUG_LEVEL_FILE_LOADING => 0,
63 DEBUG_LEVEL_PAGE_FETCHING => 0,
64 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
65 # XXX: Only partly implemented and mostly useless.
66 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
67 DEBUG_LEVEL_STATUS => 1,
69 VERBOSE_TEST_DESCRIPTION => 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,
80 CLIENT_HEADER_TEST => 1,
81 SERVER_HEADER_TEST => 2,
84 STICKY_ACTIONS_TEST => 5,
85 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;
94 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
95 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
96 our $log_level = get_default_log_level();
99 sub get_default_log_level () {
103 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
104 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
105 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
106 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
107 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
109 # This one is supposed to be always on.
110 $log_level |= LL_SOFT_ERROR;
115 ############################################################################
117 # File loading functions
119 ############################################################################
127 # Unescape brackets and dots
128 $tag =~ s@\\(?=[{}().+])@@g;
130 # log_message("Parsed tag: " . $tag);
132 check_for_forbidden_characters($tag);
137 sub check_for_forbidden_characters ($) {
140 my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]';
142 unless ($string =~ m/^$allowed*$/o) {
143 my $forbidden = $string;
144 $forbidden =~ s@^$allowed*(.).*@$1@;
146 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
150 sub load_regressions_tests () {
152 our $privoxy_cgi_url;
154 our %privoxy_features;
160 $curl_url .= $privoxy_cgi_url;
161 $curl_url .= 'show-status';
163 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
165 # Dear Privoxy, please reload the config file if necessary ...
166 get_cgi_page_or_else($curl_url);
168 # ... so we get the latest one here.
169 foreach (@{get_cgi_page_or_else($curl_url)}) {
172 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
174 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
175 $actionfiles[$file_number++] = $url;
177 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
179 my $directive = $1 . " " . $2;
180 push (@privoxy_config, $directive);
182 } elsif (m@<td><code>([^<]*)</code></td>@) {
186 } elsif (m@<td> (Yes|No) </td>@) {
188 $privoxy_features{$feature} = $1 if defined $feature;
193 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
195 load_action_files(\@actionfiles);
198 sub token_starts_new_test ($) {
201 my @new_test_directives = ('set header', 'fetch test',
202 'trusted cgi request', 'request header', 'method test',
203 'blocked url', 'url', 'redirected url');
205 foreach my $new_test_directive (@new_test_directives) {
206 return 1 if $new_test_directive eq $token;
214 my ($token, $value) = (undef, undef);
216 # Remove leading and trailing white space.
220 # Reverse HTML-encoding
221 # XXX: Seriously incomplete.
226 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
231 $token =~ s@\s\s+@ @g;
232 $token =~ tr/[A-Z]/[a-z]/;
234 } elsif (/^TAG\s*:(.*)$/) {
240 return ($token, $value);
243 sub enlist_new_test ($$$$$$) {
245 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
249 if ($token eq 'set header') {
251 l(LL_FILE_LOADING, "Header to set: " . $value);
252 $type = CLIENT_HEADER_TEST;
253 $executor = \&execute_client_header_regression_test;
255 } elsif ($token eq 'request header') {
257 l(LL_FILE_LOADING, "Header to request: " . $value);
258 $type = SERVER_HEADER_TEST;
259 $executor = \&execute_server_header_regression_test;
260 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
262 } elsif ($token eq 'trusted cgi request') {
264 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
265 $type = TRUSTED_CGI_REQUEST;
266 $executor = \&execute_dumb_fetch_test;
267 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
269 } elsif ($token eq 'fetch test') {
271 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
272 $type = DUMB_FETCH_TEST;
273 $executor = \&execute_dumb_fetch_test;
274 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
276 } elsif ($token eq 'method test') {
278 l(LL_FILE_LOADING, "Method to test: " . $value);
280 $executor = \&execute_method_test;
281 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
283 } elsif ($token eq 'blocked url') {
285 l(LL_FILE_LOADING, "URL to block-test: " . $value);
286 $executor = \&execute_block_test;
289 } elsif ($token eq 'url') {
291 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
292 $type = STICKY_ACTIONS_TEST;
293 $executor = \&execute_sticky_actions_test;
295 } elsif ($token eq 'redirected url') {
297 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
298 $type = REDIRECT_TEST;
299 $executor = \&execute_redirect_test;
303 die "Incomplete '" . $token . "' support detected.";
306 $$regression_tests[$si][$ri]{'type'} = $type;
307 $$regression_tests[$si][$ri]{'level'} = $type;
308 $$regression_tests[$si][$ri]{'executor'} = $executor;
310 check_for_forbidden_characters($value);
312 $$regression_tests[$si][$ri]{'data'} = $value;
314 # For function that only get passed single tests
315 $$regression_tests[$si][$ri]{'section-id'} = $si;
316 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
317 $$regression_tests[$si][$ri]{'number'} = $number - 1;
319 "Regression test " . $number . " (section:" . $si . "):");
322 sub load_action_files ($) {
326 our @regression_tests;
328 my $actionfiles_ref = shift;
329 my @actionfiles = @{$actionfiles_ref};
331 my $si = 0; # Section index
332 my $ri = -1; # Regression test index
337 l(LL_STATUS, "Gathering regression tests from " .
338 @actionfiles . " action file(s) delivered by Privoxy.");
340 for my $file_number (0 .. @actionfiles - 1) {
342 my $curl_url = quote($actionfiles[$file_number]);
343 my $actionfile = undef;
344 my $sticky_actions = undef;
346 foreach (@{get_cgi_page_or_else($curl_url)}) {
351 if (/<h2>Contents of Actions File (.*?)</) {
355 next unless defined $actionfile;
359 my ($token, $value) = tokenize($_);
361 next unless defined $token;
363 # Load regression tests
365 if (token_starts_new_test($token)) {
367 # Beginning of new regression test.
370 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
371 $no_checks = 1; # Already validated by enlist_new_test().
374 if ($token =~ /level\s+(\d+)/i) {
377 register_dependency($level, $value);
380 if ($token eq 'sticky actions') {
382 # Will be used by each following Sticky URL.
383 $sticky_actions = $value;
384 if ($sticky_actions =~ /{[^}]*\s/) {
385 log_and_die("'Sticky Actions' with whitespace inside the " .
386 "action parameters are currently unsupported.");
390 if ($si == -1 || $ri == -1) {
391 # No beginning of a test detected yet,
392 # so we don't care about any other test
397 if ($token eq 'expect header') {
399 l(LL_FILE_LOADING, "Detected expectation: " . $value);
400 $regression_tests[$si][$ri]{'expect-header'} = $value;
402 } elsif ($token eq 'tag') {
406 my $tag = parse_tag($value);
408 # We already checked in parse_tag() after filtering
411 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
413 # Save tag for all tests in this section
415 $regression_tests[$si][$ri]{'tag'} = $tag;
421 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
423 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
424 $regression_tests[$si][$ri]{'ignore'} = 1;
427 } elsif ($token eq 'expect status code') {
429 l(LL_FILE_LOADING, "Expecting status code: " . $value);
430 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
432 } elsif ($token eq 'level') { # XXX: stupid name
434 $value =~ s@(\d+).*@$1@;
435 l(LL_FILE_LOADING, "Level: " . $value);
436 $regression_tests[$si][$ri]{'level'} = $value;
438 } elsif ($token eq 'method') {
440 l(LL_FILE_LOADING, "Method: " . $value);
441 $regression_tests[$si][$ri]{'method'} = $value;
443 } elsif ($token eq 'redirect destination') {
445 l(LL_FILE_LOADING, "Redirect destination: " . $value);
446 $regression_tests[$si][$ri]{'redirect destination'} = $value;
448 } elsif ($token eq 'url') {
450 if (defined $sticky_actions) {
451 die "WTF? Attempted to overwrite Sticky Actions"
452 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
454 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
455 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
457 log_and_die("Sticky URL without Sticky Actions: $value");
462 # We don't use it, so we don't need
464 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
468 unless ($no_checks) {
469 check_for_forbidden_characters($value);
470 check_for_forbidden_characters($token);
475 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
476 . " Of which " . $ignored. " will be ignored)\n");
479 ############################################################################
481 # Regression test executing functions
483 ############################################################################
485 sub execute_regression_tests () {
487 our @regression_tests;
488 my $loops = get_cli_option('loops');
490 my $all_failures = 0;
491 my $all_successes = 0;
493 unless (@regression_tests) {
495 l(LL_STATUS, "No regression tests found.");
499 l(LL_STATUS, "Executing regression tests ...");
501 while ($loops-- > 0) {
508 for (my $s = 0; $s < @regression_tests; $s++) {
512 while (defined $regression_tests[$s][$r]) {
514 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
515 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
516 die "Internal error. Test executor missing."
517 unless defined $regression_tests[$s][$r]{executor};
519 my $number = $regression_tests[$s][$r]{'number'};
520 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
522 if (defined $skip_reason) {
524 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
525 log_message($message) if (cli_option_is_set('show-skipped-tests'));
530 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
532 log_result($regression_tests[$s][$r], $result, $tests);
534 $successes += $result;
536 sleep(get_cli_option('sleep-time')) if (cli_option_is_set('sleep-time'));
541 $failures = $tests - $successes;
543 log_message("Executed " . $tests . " regression tests. " .
544 'Skipped ' . $skipped . '. ' .
545 $successes . " successes, " . $failures . " failures.");
547 $all_tests += $tests;
548 $all_failures += $failures;
549 $all_successes += $successes;
552 if (get_cli_option('loops') > 1) {
553 log_message("Total: Executed " . $all_tests . " regression tests. " .
554 $all_successes . " successes, " . $all_failures . " failures.");
558 sub get_skip_reason ($) {
560 my $skip_reason = undef;
562 if ($test->{'ignore'}) {
564 $skip_reason = "Ignore flag is set";
566 } elsif (cli_option_is_set('test-number') and
567 get_cli_option('test-number') != $test->{'number'}) {
569 $skip_reason = "Only executing test " . get_cli_option('test-number');
573 $skip_reason = level_is_unacceptable($test->{'level'});
579 sub level_is_unacceptable ($) {
581 my $min_level = get_cli_option('min-level');
582 my $max_level = get_cli_option('max-level');
583 my $required_level = cli_option_is_set('level') ?
584 get_cli_option('level') : $level;
587 if ($required_level != $level) {
589 $reason = "Level doesn't match (" . $level .
590 " != " . $required_level . ")"
592 } elsif ($level < $min_level) {
594 $reason = "Level too low (" . $level . " < " . $min_level . ")";
596 } elsif ($level > $max_level) {
598 $reason = "Level too high (" . $level . " > " . $max_level . ")";
602 $reason = dependency_unsatisfied($level);
608 sub dependency_unsatisfied ($) {
613 our %privoxy_features;
615 my $dependency_problem = undef;
617 if (defined ($dependencies{$level}{'config line'})) {
619 my $dependency = $dependencies{$level}{'config line'};
620 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
622 foreach (@privoxy_config) {
625 $dependency_problem = undef;
632 if (defined ($dependencies{$level}{'feature status'})
633 and not defined $dependency_problem) {
635 my $dependency = $dependencies{$level}{'feature status'};
636 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
638 unless (defined($privoxy_features{$feature})
639 and ($privoxy_features{$feature} eq $status))
641 $dependency_problem = "depends on '" . $feature .
642 "' being set to '" . $status . "'";
646 return $dependency_problem;
649 sub register_dependency ($$) {
652 my $dependency = shift;
655 if ($dependency =~ /config line\s+(.*)/) {
657 $dependencies{$level}{'config line'} = $1;
659 } elsif ($dependency =~ /feature status\s+(.*)/) {
661 $dependencies{$level}{'feature status'} = $1;
665 log_and_die("Didn't recognize dependency: $dependency.");
669 sub execute_method_test ($) {
674 my $method = $test->{'data'};
676 my $curl_parameters = '';
677 my $expected_status_code = $test->{'expected-status-code'};
679 $curl_parameters .= '--request ' . $method . ' ';
680 # Don't complain about the 'missing' body
681 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
683 $curl_parameters .= PRIVOXY_CGI_URL;
685 $buffer_ref = get_page_with_curl($curl_parameters);
686 $status_code = get_status_code($buffer_ref);
688 return check_status_code_result($status_code, $expected_status_code);
691 sub execute_redirect_test ($) {
697 my $curl_parameters = '';
698 my $url = $test->{'data'};
699 my $redirect_destination;
700 my $expected_redirect_destination = $test->{'redirect destination'};
702 # XXX: Check if a redirect actually applies before doing the request.
703 # otherwise the test may hit a real server in failure cases.
705 $curl_parameters .= '--head ';
707 $curl_parameters .= quote($url);
709 $buffer_ref = get_page_with_curl($curl_parameters);
710 $status_code = get_status_code($buffer_ref);
712 if ($status_code ne "302") {
713 l(LL_VERBOSE_FAILURE,
714 "Ooops. Expected redirect to: '" . $expected_redirect_destination
715 . "' but got a response with status code: " . $status_code);
718 foreach (@{$buffer_ref}) {
719 if (/^Location: (.*)\r\n/) {
720 $redirect_destination = $1;
725 my $success = ($redirect_destination eq $expected_redirect_destination);
728 l(LL_VERBOSE_FAILURE,
729 "Ooops. Expected redirect to: '" . $expected_redirect_destination
730 . "' but the redirect leads to: '" . $redirect_destination. "'");
736 sub execute_dumb_fetch_test ($) {
742 my $curl_parameters = '';
743 my $expected_status_code = $test->{'expected-status-code'};
745 if (defined $test->{method}) {
746 $curl_parameters .= '--request ' . quote($test->{method}) . ' ';
748 if ($test->{type} == TRUSTED_CGI_REQUEST) {
749 $curl_parameters .= '--referer ' . quote(PRIVOXY_CGI_URL) . ' ';
752 $curl_parameters .= quote($test->{'data'});
754 $buffer_ref = get_page_with_curl($curl_parameters);
755 $status_code = get_status_code($buffer_ref);
757 return check_status_code_result($status_code, $expected_status_code);
760 sub execute_block_test ($) {
763 my $url = $test->{'data'};
764 my $final_results = get_final_results($url);
766 return defined $final_results->{'+block'};
769 sub execute_sticky_actions_test ($) {
772 my $url = $test->{'data'};
773 my $verified_actions = 0;
774 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
775 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
776 my $final_results = get_final_results($url);
778 foreach my $sticky_action (@sticky_actions) {
780 if (defined $final_results->{$sticky_action}) {
784 } elsif ($sticky_action =~ /-.*\{/) {
786 # Disabled multi actions aren't explicitly listed as
787 # disabled and thus have to be checked by verifying
788 # that they aren't enabled.
792 l(LL_VERBOSE_FAILURE,
793 "Ooops. '$sticky_action' is not among the final results.");
797 return $verified_actions == @sticky_actions;
800 sub get_final_results ($) {
803 my $curl_parameters = '';
804 my %final_results = ();
805 my $final_results_reached = 0;
807 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
808 # XXX: should be URL-encoded properly
815 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
817 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
819 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
821 next unless ($final_results_reached);
824 # Privoxy versions before 3.0.16 add a space
825 # between action name and parameters, therefore
827 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
831 if (defined $parameter) {
832 # In case the caller needs to check
833 # the action and its parameter
834 $final_results{$action . $parameter} = 1;
836 # In case the action doesn't have parameters
837 # or the caller doesn't care for the parameter.
838 $final_results{$action} = 1;
842 return \%final_results;
845 sub check_status_code_result ($$) {
847 my $status_code = shift;
848 my $expected_status_code = shift;
851 unless (defined $status_code) {
853 # XXX: should probably be caught earlier.
854 l(LL_VERBOSE_FAILURE,
855 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
857 } elsif ($expected_status_code == $status_code) {
860 l(LL_VERBOSE_SUCCESS,
861 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
863 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
865 l(LL_VERBOSE_FAILURE,
866 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
870 l(LL_VERBOSE_FAILURE,
871 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
877 sub execute_client_header_regression_test ($) {
883 $buffer_ref = get_show_request_with_curl($test);
885 $header = get_header($buffer_ref, $test);
887 return check_header_result($test, $header);
890 sub execute_server_header_regression_test ($) {
896 $buffer_ref = get_head_with_curl($test);
898 $header = get_server_header($buffer_ref, $test);
900 return check_header_result($test, $header);
903 sub interpret_result ($) {
905 return $success ? "Success" : "Failure";
908 sub check_header_result ($$) {
913 my $expect_header = $test->{'expect-header'};
916 if ($expect_header eq 'NO CHANGE') {
918 $success = (defined($header) and $header eq $test->{'data'});
921 $header = "REMOVAL" unless defined $header;
922 l(LL_VERBOSE_FAILURE,
923 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
926 } elsif ($expect_header eq 'REMOVAL') {
928 # XXX: Use more reliable check here and make sure
929 # the header has a different name.
930 $success = not (defined($header) and $header eq $test->{'data'});
933 l(LL_VERBOSE_FAILURE,
934 "Ooops. Expected removal but: '" . $header . "' is still there.");
937 } elsif ($expect_header eq 'SOME CHANGE') {
939 $success = (defined($header) and $header ne $test->{'data'});
942 $header = "REMOVAL" unless defined $header;
943 l(LL_VERBOSE_FAILURE,
944 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
949 $success = (defined($header) and $header eq $expect_header);
952 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
953 l(LL_VERBOSE_FAILURE,
954 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
960 sub get_header_name ($) {
964 $header =~ s@(.*?: ).*@$1@;
969 sub get_header ($$) {
971 our $filtered_request = '';
973 my $buffer_ref = shift;
976 my @buffer = @{$buffer_ref};
978 my $expect_header = $test->{'expect-header'};
980 die "get_header called with no expect header" unless defined $expect_header;
983 my $processed_request_reached = 0;
985 my $processed_request = '';
989 if ($expect_header eq 'REMOVAL'
990 or $expect_header eq 'NO CHANGE'
991 or $expect_header eq 'SOME CHANGE') {
993 $expect_header = $test->{'data'};
996 $header_to_get = get_header_name($expect_header);
1000 # Skip everything before the Processed request
1001 if (/Processed Request/) {
1002 $processed_request_reached = 1;
1005 next unless $processed_request_reached;
1007 # End loop after the Processed request
1008 last if (/<\/pre>/);
1010 # Ditch tags and leading/trailing white space.
1014 # Decode characters we care about.
1017 $filtered_request .= "\n" . $_;
1019 if (/^$header_to_get/) {
1029 sub get_server_header ($$) {
1031 my $buffer_ref = shift;
1034 my @buffer = @{$buffer_ref};
1036 my $expect_header = $test->{'expect-header'};
1040 # XXX: Should be caught before starting to test.
1041 log_and_die("No expect header for test " . $test->{'number'})
1042 unless defined $expect_header;
1044 if ($expect_header eq 'REMOVAL'
1045 or $expect_header eq 'NO CHANGE'
1046 or $expect_header eq 'SOME CHANGE') {
1048 $expect_header = $test->{'data'};
1051 $header_to_get = get_header_name($expect_header);
1055 # XXX: should probably verify that the request
1056 # was actually answered by Fellatio.
1057 if (/^$header_to_get/) {
1059 $header =~ s@\s*$@@g;
1067 sub get_status_code ($) {
1069 my $buffer_ref = shift;
1070 my @buffer = @{$buffer_ref};
1074 if (/^HTTP\/\d\.\d (\d{3})/) {
1080 return '123' if cli_option_is_set('fuzzer-feeding');
1082 log_and_die('Unexpected buffer line: "' . $_ . '"');
1087 sub get_test_keys () {
1088 return ('tag', 'data', 'expect-header', 'ignore');
1092 sub test_content_as_string ($) {
1098 foreach my $key (get_test_keys()) {
1099 $test->{$key} = 'Not set' unless (defined $test->{$key});
1102 $s .= 'Tag: ' . $test->{'tag'};
1104 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1106 $s .= 'Expected header: ' . $test->{'expect-header'};
1108 $s .= 'Ignore: ' . $test->{'ignore'};
1113 sub fuzz_header($) {
1115 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1117 $white_space = $white_space x (1 + int(rand(5)));
1119 # Only fuzz white space before the first quoted token.
1120 # (Privoxy doesn't touch white space inside quoted tokens
1121 # and modifying it would cause the tests to fail).
1122 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1127 ############################################################################
1129 # HTTP fetch functions
1131 ############################################################################
1133 sub get_cgi_page_or_else ($) {
1135 my $cgi_url = shift;
1136 my $content_ref = get_page_with_curl($cgi_url);
1137 my $status_code = get_status_code($content_ref);
1139 if (200 != $status_code) {
1141 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1142 "Received status code ". $status_code .
1143 " while only 200 is acceptable.";
1145 if (cli_option_is_set('fuzzer-feeding')) {
1147 $log_message .= " Ignored due to fuzzer feeding.";
1148 l(LL_SOFT_ERROR, $log_message)
1152 log_and_die($log_message);
1156 return $content_ref;
1159 # XXX: misleading name
1160 sub get_show_request_with_curl ($) {
1162 our $privoxy_cgi_url;
1165 my $curl_parameters = ' ';
1166 my $header = $test->{'data'};
1168 if (cli_option_is_set('header-fuzzing')) {
1169 $header = fuzz_header($header);
1172 # Enable the action to test
1173 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1174 # The header to filter
1175 $curl_parameters .= '-H \'' . $header . '\' ';
1177 $curl_parameters .= ' ';
1178 $curl_parameters .= $privoxy_cgi_url;
1179 $curl_parameters .= 'show-request';
1181 return get_cgi_page_or_else($curl_parameters);
1184 sub get_head_with_curl ($) {
1186 our $fellatio_url = FELLATIO_URL;
1189 my $curl_parameters = ' ';
1191 # Enable the action to test
1192 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1193 # The header to filter
1194 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1195 $curl_parameters .= '--head ';
1197 $curl_parameters .= ' ';
1198 $curl_parameters .= $fellatio_url;
1200 return get_page_with_curl($curl_parameters);
1203 sub get_page_with_curl ($) {
1207 my $parameters = shift;
1209 my $curl_line = CURL;
1210 my $retries_left = get_cli_option('retries') + 1;
1213 if (defined $proxy) {
1214 $curl_line .= ' --proxy ' . quote($proxy);
1216 # We want to see the HTTP status code
1217 $curl_line .= " --include ";
1218 # Let Privoxy emit two log messages less.
1219 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1220 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1221 # We don't care about fetch statistic.
1222 $curl_line .= " -s ";
1223 # We do care about the failure reason if any.
1224 $curl_line .= " -S ";
1225 # We want to advertise ourselves
1226 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1227 # We aren't too patient
1228 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1230 $curl_line .= $parameters;
1231 # XXX: still necessary?
1232 $curl_line .= ' 2>&1';
1234 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1237 @buffer = `$curl_line`;
1240 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1241 $failure_reason = array_as_string(\@buffer);
1242 chomp $failure_reason;
1243 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1245 } while ($? && --$retries_left);
1247 unless ($retries_left) {
1248 log_and_die("Running curl failed " . get_cli_option('retries') .
1249 " times in a row. Last error: '" . $failure_reason . "'.");
1256 ############################################################################
1260 ############################################################################
1262 sub array_as_string ($) {
1263 my $array_ref = shift;
1266 foreach (@{$array_ref}) {
1275 log_message('Test is:' . test_content_as_string($test));
1281 my $this_level = shift;
1282 my $message = shift;
1284 log_message($message) if ($log_level & $this_level);
1287 sub log_and_die ($) {
1288 my $message = shift;
1290 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1294 sub log_message ($) {
1296 my $message = shift;
1300 our $leading_log_date;
1301 our $leading_log_time;
1303 my $time_stamp = '';
1304 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1306 if ($leading_log_date || $leading_log_time) {
1308 if ($leading_log_date) {
1311 $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
1314 if ($leading_log_time) {
1315 $time_stamp .= ' ' if $leading_log_date;
1316 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1319 $message = $time_stamp . ": " . $message;
1322 printf(STDERR "%s\n", $message);
1325 sub log_result ($$) {
1327 our $verbose_test_description;
1328 our $filtered_request;
1336 $message .= interpret_result($result);
1337 $message .= " for test ";
1338 $message .= $number;
1340 $message .= $test->{'number'};
1342 $message .= $test->{'section-id'};
1344 $message .= $test->{'regression-test-id'};
1347 if ($verbose_test_description) {
1349 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1351 $message .= ' Header ';
1352 $message .= quote($test->{'data'});
1353 $message .= ' and tag ';
1354 $message .= quote($test->{'tag'});
1356 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1358 $message .= ' Request Header ';
1359 $message .= quote($test->{'data'});
1360 $message .= ' and tag ';
1361 $message .= quote($test->{'tag'});
1363 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1365 $message .= ' URL ';
1366 $message .= quote($test->{'data'});
1367 $message .= ' and expected status code ';
1368 $message .= quote($test->{'expected-status-code'});
1370 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1372 $message .= ' CGI URL ';
1373 $message .= quote($test->{'data'});
1374 $message .= ' and expected status code ';
1375 $message .= quote($test->{'expected-status-code'});
1377 } elsif ($test->{'type'} == METHOD_TEST) {
1379 $message .= ' HTTP method ';
1380 $message .= quote($test->{'data'});
1381 $message .= ' and expected status code ';
1382 $message .= quote($test->{'expected-status-code'});
1384 } elsif ($test->{'type'} == BLOCK_TEST) {
1386 $message .= ' Supposedly-blocked URL: ';
1387 $message .= quote($test->{'data'});
1389 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1391 $message .= ' Sticky Actions: ';
1392 $message .= quote($test->{'sticky-actions'});
1393 $message .= ' and URL: ';
1394 $message .= quote($test->{'data'});
1396 } elsif ($test->{'type'} == REDIRECT_TEST) {
1398 $message .= ' Redirected URL: ';
1399 $message .= quote($test->{'data'});
1400 $message .= ' and redirect destination: ';
1401 $message .= quote($test->{'redirect destination'});
1405 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1409 log_message($message) if (!$result or cli_option_is_set('verbose'));
1414 return '\'' . $s . '\'';
1417 sub print_version () {
1418 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil <fk@fabiankeil.de>' . "\n";
1421 sub list_test_types () {
1423 'Client header test' => CLIENT_HEADER_TEST,
1424 'Server header test' => 2,
1425 'Dumb fetch test' => 3,
1427 'Sticky action test' => 5,
1428 'Trusted CGI test' => 6,
1430 'Redirect test' => 108,
1433 print "\nThe supported test types and their default levels are:\n";
1434 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1435 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1447 Options and their default values if they have any:
1448 [--debug $cli_options{'debug'}]
1449 [--forks $cli_options{'forks'}]
1455 [--loops $cli_options{'loops'}]
1456 [--max-level $cli_options{'max-level'}]
1457 [--max-time $cli_options{'max-time'}]
1458 [--min-level $cli_options{'min-level'}]
1460 [--retries $cli_options{'retries'}]
1461 [--show-skipped-tests]
1462 [--sleep-time $cli_options{'sleep-time'}]
1473 Try "perldoc $0" for more information
1480 sub init_cli_options () {
1485 $cli_options{'debug'} = $log_level;
1486 $cli_options{'forks'} = CLI_FORKS;
1487 $cli_options{'loops'} = CLI_LOOPS;
1488 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1489 $cli_options{'max-time'} = CLI_MAX_TIME;
1490 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1491 $cli_options{'sleep-time'}= CLI_SLEEP_TIME;
1492 $cli_options{'retries'} = CLI_RETRIES;
1495 sub parse_cli_options () {
1503 'debug=i' => \$cli_options{'debug'},
1504 'forks=i' => \$cli_options{'forks'},
1505 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1506 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1507 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1509 'level=i' => \$cli_options{'level'},
1510 'loops=i' => \$cli_options{'loops'},
1511 'max-level=i' => \$cli_options{'max-level'},
1512 'max-time=i' => \$cli_options{'max-time'},
1513 'min-level=i' => \$cli_options{'min-level'},
1514 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1515 'retries=i' => \$cli_options{'retries'},
1516 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1517 'sleep-time=i' => \$cli_options{'sleep-time'},
1518 'test-number=i' => \$cli_options{'test-number'},
1519 'verbose' => \$cli_options{'verbose'},
1520 'version' => sub {print_version && exit(0)}
1522 $log_level |= $cli_options{'debug'};
1525 sub cli_option_is_set ($) {
1528 my $cli_option = shift;
1530 return defined $cli_options{$cli_option};
1533 sub get_cli_option ($) {
1536 my $cli_option = shift;
1538 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1540 return $cli_options{$cli_option};
1543 sub init_proxy_settings($) {
1548 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1549 $proxy = get_cli_option('fuzzer-address');
1552 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1554 if (cli_option_is_set('privoxy-address')) {
1555 $proxy .= get_cli_option('privoxy-address');
1560 sub start_forks($) {
1563 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1565 foreach my $fork (1 .. $forks) {
1566 log_message("Starting fork $fork");
1568 if (defined $pid && !$pid) {
1576 init_our_variables();
1577 parse_cli_options();
1578 init_proxy_settings('vanilla-proxy');
1579 load_regressions_tests();
1580 init_proxy_settings('fuzz-proxy');
1581 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1582 execute_regression_tests();
1589 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1593 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1594 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1595 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1596 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1597 [B<--retries retries>] [B<--test-number test-number>]
1598 [B<--show-skipped-tests>] [B<--sleep-time> seconds] [B<--verbose>]
1603 Privoxy-Regression-Test is supposed to one day become
1604 a regression test suite for Privoxy. It's not quite there
1605 yet, however, and can currently only test header actions,
1606 check the returned status code for requests to arbitrary
1607 URLs and verify which actions are applied to them.
1609 Client header actions are tested by requesting
1610 B<http://p.p/show-request> and checking whether
1611 or not Privoxy modified the original request as expected.
1613 The original request contains both the header the action-to-be-tested
1614 acts upon and an additional tagger-triggering header that enables
1617 Applied actions are checked through B<http://p.p/show-url-info>.
1619 =head1 CONFIGURATION FILE SYNTAX
1621 Privoxy-Regression-Test's configuration is embedded in
1622 Privoxy action files and loaded through Privoxy's web interface.
1624 It makes testing a Privoxy version running on a remote system easier
1625 and should prevent you from updating your tests without updating Privoxy's
1626 configuration accordingly.
1628 A client-header-action test section looks like this:
1630 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1631 # Expect Header = Referer: http://www.example.org/
1632 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1633 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1635 The example above causes Privoxy-Regression-Test to set
1636 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1637 and to expect it to be modified to
1638 B<Referer: http://www.example.org/>.
1640 When testing this section, Privoxy-Regression-Test will set the header
1641 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1642 causing the B<privoxy-control> tagger to create the tag
1643 B<client-header-filter{hide-tor-exit-notation}> which will finally
1644 cause Privoxy to enable the action section.
1646 Note that the actions itself are only used by Privoxy,
1647 Privoxy-Regression-Test ignores them and will be happy
1648 as long as the expectations are satisfied.
1650 A fetch test looks like this:
1652 # Fetch Test = http://p.p/user-manual
1653 # Expect Status Code = 302
1655 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1656 and to expect a response with the HTTP status code B<302>. Obviously that's
1657 not a very thorough test and mainly useful to get some code coverage
1658 for Valgrind or to verify that the templates are installed correctly.
1660 If you want to test CGI pages that require a trusted
1661 referer, you can use:
1663 # Trusted CGI Request = http://p.p/edit-actions
1665 It works like ordinary fetch tests, but sets the referer
1666 header to a trusted value.
1668 If no explicit status code expectation is set, B<200> is used.
1670 To verify that a URL is blocked, use:
1672 # Blocked URL = http://www.example.com/blocked
1674 To verify that a specific set of actions is applied to an URL, use:
1676 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1677 # URL = http://www.example.org/my-first-url
1679 The sticky actions will be checked for all URLs below it
1680 until the next sticky actions directive.
1682 To verify that requests for a URL get redirected, use:
1684 # Redirected URL = http://www.example.com/redirect-me
1685 # Redirect Destination = http://www.example.org/redirected
1689 All tests have test levels to let the user
1690 control which ones to execute (see I<OPTIONS> below).
1691 Test levels are either set with the B<Level> directive,
1692 or implicitly through the test type.
1694 Redirect tests default to level 108, block tests to level 7,
1695 fetch tests to level 6, "Sticky Actions" tests default to
1696 level 5, tests for trusted CGI requests to level 3 and
1697 client-header-action tests to level 1.
1699 The current redirect test level is above the default
1700 max-level value as failed tests will result in outgoing
1701 connections. Use the B<--max-level> option to run them
1706 B<--debug bitmask> Add the bitmask provided as integer
1707 to the debug settings.
1709 B<--forks forks> Number of forks to start before executing
1710 the regression tests. This is mainly useful for stress-testing.
1712 B<--fuzzer-address> Listening address used when executing
1713 the regression tests. Useful to make sure that the requests
1714 to load the regression tests don't fail due to fuzzing.
1716 B<--fuzzer-feeding> Ignore some errors that would otherwise
1717 cause Privoxy-Regression-Test to abort the test because
1718 they shouldn't happen in normal operation. This option is
1719 intended to be used if Privoxy-Regression-Test is only
1720 used to feed a fuzzer in which case there's a high chance
1721 that Privoxy gets an invalid request and returns an error
1724 B<--help> Shows available command line options.
1726 B<--header-fuzzing> Modifies linear white space in
1727 headers in a way that should not affect the test result.
1729 B<--level level> Only execute tests with the specified B<level>.
1731 B<--loop count> Loop through the regression tests B<count> times.
1732 Useful to feed a fuzzer, or when doing stress tests with
1733 several Privoxy-Regression-Test instances running at the same
1736 B<--max-level max-level> Only execute tests with a B<level>
1737 below or equal to the numerical B<max-level>.
1739 B<--max-time max-time> Give Privoxy B<max-time> seconds
1740 to return data. Increasing the default may make sense when
1741 Privoxy is run through Valgrind, decreasing the default may
1742 make sense when Privoxy-Regression-Test is used to feed
1745 B<--min-level min-level> Only execute tests with a B<level>
1746 above or equal to the numerical B<min-level>.
1748 B<--privoxy-address proxy-address> Privoxy's listening address.
1749 If it's not set, the value of the environment variable http_proxy
1750 will be used. B<proxy-address> has to be specified in http_proxy
1753 B<--retries retries> Retry B<retries> times.
1755 B<--test-number test-number> Only run the test with the specified
1758 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1760 B<--sleep-time seconds> Wait B<seconds> between tests. Useful when
1761 debugging issues with systems that don't log with millisecond precision.
1763 B<--verbose> Log successful tests as well. By default only
1764 the failures are logged.
1766 B<--version> Print version and exit.
1768 The second dash is optional, options can be shortened,
1769 as long as there are no ambiguities.
1771 =head1 PRIVOXY CONFIGURATION
1773 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1774 which aims to test all official client-header modifying actions
1775 and can be used to verify that the templates and the user manual
1776 files are installed correctly.
1778 To use it, it has to be copied in Privoxy's configuration
1779 directory, and afterwards referenced in Privoxy's configuration
1782 actionsfile regression-tests.action
1784 In general, its tests are supposed to work without changing
1785 any other action files, unless you already added lots of
1786 taggers yourself. If you are using taggers that cause problems,
1787 you might have to temporary disable them for Privoxy's CGI pages.
1789 Some of the regression tests rely on Privoxy features that
1790 may be disabled in your configuration. Tests with a level below
1791 7 are supposed to work with all Privoxy configurations (provided
1792 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1794 Tests with level 9 require Privoxy to deliver the User Manual,
1795 tests with level 12 require the CGI editor to be enabled.
1799 Expect the configuration file syntax to change with future releases.
1803 As Privoxy's B<show-request> page only shows client headers,
1804 Privoxy-Regression-Test can't use it to test Privoxy actions
1805 that modify server headers.
1807 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1808 control the actions to test, it currently only works with
1809 Privoxy 3.0.7 or later.
1811 At the moment Privoxy-Regression-Test fetches Privoxy's
1812 configuration page through I<curl>(1), therefore you have to
1813 have I<curl> installed, otherwise you won't be able to run
1814 Privoxy-Regression-Test in a meaningful way.
1822 Fabian Keil <fk@fabiankeil.de>