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.68 2011/05/08 13:28:13 fabiankeil 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?
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,
89 sub init_our_variables () {
91 our $leading_log_time = LEADING_LOG_TIME;
92 our $leading_log_date = LEADING_LOG_DATE;
93 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
94 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
95 our $log_level = get_default_log_level();
98 sub get_default_log_level () {
102 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
103 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
104 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
105 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
106 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
108 # This one is supposed to be always on.
109 $log_level |= LL_SOFT_ERROR;
114 ############################################################################
116 # File loading functions
118 ############################################################################
126 # Unescape brackets and dots
127 $tag =~ s@\\(?=[{}().+])@@g;
129 # log_message("Parsed tag: " . $tag);
131 check_for_forbidden_characters($tag);
136 sub check_for_forbidden_characters ($) {
139 my $allowed = '[-=\dA-Za-z~{}:./();\t ,+@"_%?&*^]';
141 unless ($string =~ m/^$allowed*$/o) {
142 my $forbidden = $string;
143 $forbidden =~ s@^$allowed*(.).*@$1@;
145 log_and_die("'" . $string . "' contains character '" . $forbidden. "' which is unacceptable.");
149 sub load_regressions_tests () {
151 our $privoxy_cgi_url;
153 our %privoxy_features;
159 $curl_url .= $privoxy_cgi_url;
160 $curl_url .= 'show-status';
162 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
164 # Dear Privoxy, please reload the config file if necessary ...
165 get_cgi_page_or_else($curl_url);
167 # ... so we get the latest one here.
168 foreach (@{get_cgi_page_or_else($curl_url)}) {
171 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
173 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
174 $actionfiles[$file_number++] = $url;
176 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
178 my $directive = $1 . " " . $2;
179 push (@privoxy_config, $directive);
181 } elsif (m@<td><code>([^<]*)</code></td>@) {
185 } elsif (m@<td> (Yes|No) </td>@) {
187 $privoxy_features{$feature} = $1 if defined $feature;
192 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
194 load_action_files(\@actionfiles);
197 sub token_starts_new_test ($) {
200 my @new_test_directives = ('set header', 'fetch test',
201 'trusted cgi request', 'request header', 'method test',
202 'blocked url', 'url', 'redirected url');
204 foreach my $new_test_directive (@new_test_directives) {
205 return 1 if $new_test_directive eq $token;
213 my ($token, $value) = (undef, undef);
215 # Remove leading and trailing white space.
219 # Reverse HTML-encoding
220 # XXX: Seriously incomplete.
225 if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
230 $token =~ s@\s\s+@ @g;
231 $token =~ tr/[A-Z]/[a-z]/;
233 } elsif (/^TAG\s*:(.*)$/) {
239 return ($token, $value);
242 sub enlist_new_test ($$$$$$) {
244 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
248 if ($token eq 'set header') {
250 l(LL_FILE_LOADING, "Header to set: " . $value);
251 $type = CLIENT_HEADER_TEST;
252 $executor = \&execute_client_header_regression_test;
254 } elsif ($token eq 'request header') {
256 l(LL_FILE_LOADING, "Header to request: " . $value);
257 $type = SERVER_HEADER_TEST;
258 $executor = \&execute_server_header_regression_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 $executor = \&execute_dumb_fetch_test;
266 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
268 } elsif ($token eq 'fetch test') {
270 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
271 $type = DUMB_FETCH_TEST;
272 $executor = \&execute_dumb_fetch_test;
273 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
275 } elsif ($token eq 'method test') {
277 l(LL_FILE_LOADING, "Method to test: " . $value);
279 $executor = \&execute_method_test;
280 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
282 } elsif ($token eq 'blocked url') {
284 l(LL_FILE_LOADING, "URL to block-test: " . $value);
285 $executor = \&execute_block_test;
288 } elsif ($token eq 'url') {
290 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
291 $type = STICKY_ACTIONS_TEST;
292 $executor = \&execute_sticky_actions_test;
294 } elsif ($token eq 'redirected url') {
296 l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
297 $type = REDIRECT_TEST;
298 $executor = \&execute_redirect_test;
302 die "Incomplete '" . $token . "' support detected.";
305 $$regression_tests[$si][$ri]{'type'} = $type;
306 $$regression_tests[$si][$ri]{'level'} = $type;
307 $$regression_tests[$si][$ri]{'executor'} = $executor;
309 check_for_forbidden_characters($value);
311 $$regression_tests[$si][$ri]{'data'} = $value;
313 # For function that only get passed single tests
314 $$regression_tests[$si][$ri]{'section-id'} = $si;
315 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
316 $$regression_tests[$si][$ri]{'number'} = $number - 1;
318 "Regression test " . $number . " (section:" . $si . "):");
321 sub load_action_files ($) {
325 our @regression_tests;
327 my $actionfiles_ref = shift;
328 my @actionfiles = @{$actionfiles_ref};
330 my $si = 0; # Section index
331 my $ri = -1; # Regression test index
336 l(LL_STATUS, "Gathering regression tests from " .
337 @actionfiles . " action file(s) delivered by Privoxy.");
339 for my $file_number (0 .. @actionfiles - 1) {
341 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
342 my $actionfile = undef;
343 my $sticky_actions = undef;
345 foreach (@{get_cgi_page_or_else($curl_url)}) {
350 if (/<h2>Contents of Actions File (.*?)</) {
354 next unless defined $actionfile;
358 my ($token, $value) = tokenize($_);
360 next unless defined $token;
362 # Load regression tests
364 if (token_starts_new_test($token)) {
366 # Beginning of new regression test.
369 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
370 $no_checks = 1; # Already validated by enlist_new_test().
373 if ($token =~ /level\s+(\d+)/i) {
376 register_dependency($level, $value);
379 if ($token eq 'sticky actions') {
381 # Will be used by each following Sticky URL.
382 $sticky_actions = $value;
383 if ($sticky_actions =~ /{[^}]*\s/) {
384 log_and_die("'Sticky Actions' with whitespace inside the " .
385 "action parameters are currently unsupported.");
389 if ($si == -1 || $ri == -1) {
390 # No beginning of a test detected yet,
391 # so we don't care about any other test
396 if ($token eq 'expect header') {
398 l(LL_FILE_LOADING, "Detected expectation: " . $value);
399 $regression_tests[$si][$ri]{'expect-header'} = $value;
401 } elsif ($token eq 'tag') {
405 my $tag = parse_tag($value);
407 # We already checked in parse_tag() after filtering
410 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
412 # Save tag for all tests in this section
414 $regression_tests[$si][$ri]{'tag'} = $tag;
420 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
422 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
423 $regression_tests[$si][$ri]{'ignore'} = 1;
426 } elsif ($token eq 'expect status code') {
428 l(LL_FILE_LOADING, "Expecting status code: " . $value);
429 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
431 } elsif ($token eq 'level') { # XXX: stupid name
433 $value =~ s@(\d+).*@$1@;
434 l(LL_FILE_LOADING, "Level: " . $value);
435 $regression_tests[$si][$ri]{'level'} = $value;
437 } elsif ($token eq 'method') {
439 l(LL_FILE_LOADING, "Method: " . $value);
440 $regression_tests[$si][$ri]{'method'} = $value;
442 } elsif ($token eq 'redirect destination') {
444 l(LL_FILE_LOADING, "Redirect destination: " . $value);
445 $regression_tests[$si][$ri]{'redirect destination'} = $value;
447 } elsif ($token eq 'url') {
449 if (defined $sticky_actions) {
450 die "WTF? Attempted to overwrite Sticky Actions"
451 if defined ($regression_tests[$si][$ri]{'sticky-actions'});
453 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
454 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
456 log_and_die("Sticky URL without Sticky Actions: $value");
461 # We don't use it, so we don't need
463 l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
467 unless ($no_checks) {
468 check_for_forbidden_characters($value);
469 check_for_forbidden_characters($token);
474 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
475 . " Of which " . $ignored. " will be ignored)\n");
478 ############################################################################
480 # Regression test executing functions
482 ############################################################################
484 sub execute_regression_tests () {
486 our @regression_tests;
487 my $loops = get_cli_option('loops');
489 my $all_failures = 0;
490 my $all_successes = 0;
492 unless (@regression_tests) {
494 l(LL_STATUS, "No regression tests found.");
498 l(LL_STATUS, "Executing regression tests ...");
500 while ($loops-- > 0) {
507 for (my $s = 0; $s < @regression_tests; $s++) {
511 while (defined $regression_tests[$s][$r]) {
513 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
514 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
515 die "Internal error. Test executor missing."
516 unless defined $regression_tests[$s][$r]{executor};
518 my $number = $regression_tests[$s][$r]{'number'};
519 my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
521 if (defined $skip_reason) {
523 my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
524 log_message($message) if (cli_option_is_set('show-skipped-tests'));
529 my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
531 log_result($regression_tests[$s][$r], $result, $tests);
533 $successes += $result;
539 $failures = $tests - $successes;
541 log_message("Executed " . $tests . " regression tests. " .
542 'Skipped ' . $skipped . '. ' .
543 $successes . " successes, " . $failures . " failures.");
545 $all_tests += $tests;
546 $all_failures += $failures;
547 $all_successes += $successes;
550 if (get_cli_option('loops') > 1) {
551 log_message("Total: Executed " . $all_tests . " regression tests. " .
552 $all_successes . " successes, " . $all_failures . " failures.");
556 sub get_skip_reason ($) {
558 my $skip_reason = undef;
560 if ($test->{'ignore'}) {
562 $skip_reason = "Ignore flag is set";
564 } elsif (cli_option_is_set('test-number') and
565 get_cli_option('test-number') != $test->{'number'}) {
567 $skip_reason = "Only executing test " . get_cli_option('test-number');
571 $skip_reason = level_is_unacceptable($test->{'level'});
577 sub level_is_unacceptable ($) {
579 my $min_level = get_cli_option('min-level');
580 my $max_level = get_cli_option('max-level');
581 my $required_level = cli_option_is_set('level') ?
582 get_cli_option('level') : $level;
585 if ($required_level != $level) {
587 $reason = "Level doesn't match (" . $level .
588 " != " . $required_level . ")"
590 } elsif ($level < $min_level) {
592 $reason = "Level too low (" . $level . " < " . $min_level . ")";
594 } elsif ($level > $max_level) {
596 $reason = "Level too high (" . $level . " > " . $max_level . ")";
600 $reason = dependency_unsatisfied($level);
606 sub dependency_unsatisfied ($) {
611 our %privoxy_features;
613 my $dependency_problem = undef;
615 if (defined ($dependencies{$level}{'config line'})) {
617 my $dependency = $dependencies{$level}{'config line'};
618 $dependency_problem = "depends on config line matching: '" . $dependency . "'";
620 foreach (@privoxy_config) {
623 $dependency_problem = undef;
630 if (defined ($dependencies{$level}{'feature status'})
631 and not defined $dependency_problem) {
633 my $dependency = $dependencies{$level}{'feature status'};
634 my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
636 unless (defined($privoxy_features{$feature})
637 and ($privoxy_features{$feature} eq $status))
639 $dependency_problem = "depends on '" . $feature .
640 "' being set to '" . $status . "'";
644 return $dependency_problem;
647 sub register_dependency ($$) {
650 my $dependency = shift;
653 if ($dependency =~ /config line\s+(.*)/) {
655 $dependencies{$level}{'config line'} = $1;
657 } elsif ($dependency =~ /feature status\s+(.*)/) {
659 $dependencies{$level}{'feature status'} = $1;
663 log_and_die("Didn't recognize dependency: $dependency.");
667 sub execute_method_test ($) {
672 my $method = $test->{'data'};
674 my $curl_parameters = '';
675 my $expected_status_code = $test->{'expected-status-code'};
677 $curl_parameters .= '--request ' . $method . ' ';
678 # Don't complain about the 'missing' body
679 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
681 $curl_parameters .= PRIVOXY_CGI_URL;
683 $buffer_ref = get_page_with_curl($curl_parameters);
684 $status_code = get_status_code($buffer_ref);
686 return check_status_code_result($status_code, $expected_status_code);
689 sub execute_redirect_test ($) {
695 my $curl_parameters = '';
696 my $url = $test->{'data'};
697 my $redirect_destination;
698 my $expected_redirect_destination = $test->{'redirect destination'};
700 # XXX: Check if a redirect actually applies before doing the request.
701 # otherwise the test may hit a real server in failure cases.
703 $curl_parameters .= '--head ';
705 $curl_parameters .= quote($url);
707 $buffer_ref = get_page_with_curl($curl_parameters);
708 $status_code = get_status_code($buffer_ref);
710 if ($status_code ne "302") {
711 l(LL_VERBOSE_FAILURE,
712 "Ooops. Expected redirect to: '" . $expected_redirect_destination
713 . "' but got a response with status code: " . $status_code);
716 foreach (@{$buffer_ref}) {
717 if (/^Location: (.*)\r\n/) {
718 $redirect_destination = $1;
723 my $success = ($redirect_destination eq $expected_redirect_destination);
726 l(LL_VERBOSE_FAILURE,
727 "Ooops. Expected redirect to: '" . $expected_redirect_destination
728 . "' but the redirect leads to: '" . $redirect_destination. "'");
734 sub execute_dumb_fetch_test ($) {
740 my $curl_parameters = '';
741 my $expected_status_code = $test->{'expected-status-code'};
743 if (defined $test->{method}) {
744 $curl_parameters .= '--request ' . $test->{method} . ' ';
746 if ($test->{type} == TRUSTED_CGI_REQUEST) {
747 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
750 $curl_parameters .= $test->{'data'};
752 $buffer_ref = get_page_with_curl($curl_parameters);
753 $status_code = get_status_code($buffer_ref);
755 return check_status_code_result($status_code, $expected_status_code);
758 sub execute_block_test ($) {
761 my $url = $test->{'data'};
762 my $final_results = get_final_results($url);
764 return defined $final_results->{'+block'};
767 sub execute_sticky_actions_test ($) {
770 my $url = $test->{'data'};
771 my $verified_actions = 0;
772 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
773 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
774 my $final_results = get_final_results($url);
776 foreach my $sticky_action (@sticky_actions) {
778 if (defined $final_results->{$sticky_action}) {
782 } elsif ($sticky_action =~ /-.*\{/) {
784 # Disabled multi actions aren't explicitly listed as
785 # disabled and thus have to be checked by verifying
786 # that they aren't enabled.
790 l(LL_VERBOSE_FAILURE,
791 "Ooops. '$sticky_action' is not among the final results.");
795 return $verified_actions == @sticky_actions;
798 sub get_final_results ($) {
801 my $curl_parameters = '';
802 my %final_results = ();
803 my $final_results_reached = 0;
805 die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
806 # XXX: should be URL-encoded properly
813 $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
815 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
817 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
819 next unless ($final_results_reached);
822 # Privoxy versions before 3.0.16 add a space
823 # between action name and parameters, therefore
825 if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
829 if (defined $parameter) {
830 # In case the caller needs to check
831 # the action and its parameter
832 $final_results{$action . $parameter} = 1;
834 # In case the action doesn't have parameters
835 # or the caller doesn't care for the parameter.
836 $final_results{$action} = 1;
840 return \%final_results;
843 sub check_status_code_result ($$) {
845 my $status_code = shift;
846 my $expected_status_code = shift;
849 unless (defined $status_code) {
851 # XXX: should probably be caught earlier.
852 l(LL_VERBOSE_FAILURE,
853 "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
855 } elsif ($expected_status_code == $status_code) {
858 l(LL_VERBOSE_SUCCESS,
859 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
861 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
863 l(LL_VERBOSE_FAILURE,
864 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
868 l(LL_VERBOSE_FAILURE,
869 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
875 sub execute_client_header_regression_test ($) {
881 $buffer_ref = get_show_request_with_curl($test);
883 $header = get_header($buffer_ref, $test);
885 return check_header_result($test, $header);
888 sub execute_server_header_regression_test ($) {
894 $buffer_ref = get_head_with_curl($test);
896 $header = get_server_header($buffer_ref, $test);
898 return check_header_result($test, $header);
901 sub interpret_result ($) {
903 return $success ? "Success" : "Failure";
906 sub check_header_result ($$) {
911 my $expect_header = $test->{'expect-header'};
914 if ($expect_header eq 'NO CHANGE') {
916 $success = (defined($header) and $header eq $test->{'data'});
919 $header = "REMOVAL" unless defined $header;
920 l(LL_VERBOSE_FAILURE,
921 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
924 } elsif ($expect_header eq 'REMOVAL') {
926 # XXX: Use more reliable check here and make sure
927 # the header has a different name.
928 $success = not (defined($header) and $header eq $test->{'data'});
931 l(LL_VERBOSE_FAILURE,
932 "Ooops. Expected removal but: '" . $header . "' is still there.");
935 } elsif ($expect_header eq 'SOME CHANGE') {
937 $success = (defined($header) and $header ne $test->{'data'});
940 $header = "REMOVAL" unless defined $header;
941 l(LL_VERBOSE_FAILURE,
942 "Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
947 $success = (defined($header) and $header eq $expect_header);
950 $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
951 l(LL_VERBOSE_FAILURE,
952 "Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
958 sub get_header_name ($) {
962 $header =~ s@(.*?: ).*@$1@;
967 sub get_header ($$) {
969 our $filtered_request = '';
971 my $buffer_ref = shift;
974 my @buffer = @{$buffer_ref};
976 my $expect_header = $test->{'expect-header'};
978 die "get_header called with no expect header" unless defined $expect_header;
981 my $processed_request_reached = 0;
983 my $processed_request = '';
987 if ($expect_header eq 'REMOVAL'
988 or $expect_header eq 'NO CHANGE'
989 or $expect_header eq 'SOME CHANGE') {
991 $expect_header = $test->{'data'};
994 $header_to_get = get_header_name($expect_header);
998 # Skip everything before the Processed request
999 if (/Processed Request/) {
1000 $processed_request_reached = 1;
1003 next unless $processed_request_reached;
1005 # End loop after the Processed request
1006 last if (/<\/pre>/);
1008 # Ditch tags and leading/trailing white space.
1012 # Decode characters we care about.
1015 $filtered_request .= "\n" . $_;
1017 if (/^$header_to_get/) {
1027 sub get_server_header ($$) {
1029 my $buffer_ref = shift;
1032 my @buffer = @{$buffer_ref};
1034 my $expect_header = $test->{'expect-header'};
1038 # XXX: Should be caught before starting to test.
1039 log_and_die("No expect header for test " . $test->{'number'})
1040 unless defined $expect_header;
1042 if ($expect_header eq 'REMOVAL'
1043 or $expect_header eq 'NO CHANGE'
1044 or $expect_header eq 'SOME CHANGE') {
1046 $expect_header = $test->{'data'};
1049 $header_to_get = get_header_name($expect_header);
1053 # XXX: should probably verify that the request
1054 # was actually answered by Fellatio.
1055 if (/^$header_to_get/) {
1057 $header =~ s@\s*$@@g;
1065 sub get_status_code ($) {
1067 my $buffer_ref = shift;
1068 my @buffer = @{$buffer_ref};
1072 if (/^HTTP\/\d\.\d (\d{3})/) {
1078 return '123' if cli_option_is_set('fuzzer-feeding');
1080 log_and_die('Unexpected buffer line: "' . $_ . '"');
1085 sub get_test_keys () {
1086 return ('tag', 'data', 'expect-header', 'ignore');
1090 sub test_content_as_string ($) {
1096 foreach my $key (get_test_keys()) {
1097 $test->{$key} = 'Not set' unless (defined $test->{$key});
1100 $s .= 'Tag: ' . $test->{'tag'};
1102 $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
1104 $s .= 'Expected header: ' . $test->{'expect-header'};
1106 $s .= 'Ignore: ' . $test->{'ignore'};
1111 sub fuzz_header($) {
1113 my $white_space = int(rand(2)) - 1 ? " " : "\t";
1115 $white_space = $white_space x (1 + int(rand(5)));
1117 # Only fuzz white space before the first quoted token.
1118 # (Privoxy doesn't touch white space inside quoted tokens
1119 # and modifying it would cause the tests to fail).
1120 $header =~ s@(^[^"]*?)\s@$1$white_space@g;
1125 ############################################################################
1127 # HTTP fetch functions
1129 ############################################################################
1131 sub get_cgi_page_or_else ($) {
1133 my $cgi_url = shift;
1134 my $content_ref = get_page_with_curl($cgi_url);
1135 my $status_code = get_status_code($content_ref);
1137 if (200 != $status_code) {
1139 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1140 "Received status code ". $status_code .
1141 " while only 200 is acceptable.";
1143 if (cli_option_is_set('fuzzer-feeding')) {
1145 $log_message .= " Ignored due to fuzzer feeding.";
1146 l(LL_SOFT_ERROR, $log_message)
1150 log_and_die($log_message);
1154 return $content_ref;
1157 # XXX: misleading name
1158 sub get_show_request_with_curl ($) {
1160 our $privoxy_cgi_url;
1163 my $curl_parameters = ' ';
1164 my $header = $test->{'data'};
1166 if (cli_option_is_set('header-fuzzing')) {
1167 $header = fuzz_header($header);
1170 # Enable the action to test
1171 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1172 # The header to filter
1173 $curl_parameters .= '-H \'' . $header . '\' ';
1175 $curl_parameters .= ' ';
1176 $curl_parameters .= $privoxy_cgi_url;
1177 $curl_parameters .= 'show-request';
1179 return get_cgi_page_or_else($curl_parameters);
1182 sub get_head_with_curl ($) {
1184 our $fellatio_url = FELLATIO_URL;
1187 my $curl_parameters = ' ';
1189 # Enable the action to test
1190 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
1191 # The header to filter
1192 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
1193 $curl_parameters .= '--head ';
1195 $curl_parameters .= ' ';
1196 $curl_parameters .= $fellatio_url;
1198 return get_page_with_curl($curl_parameters);
1201 sub get_page_with_curl ($) {
1205 my $parameters = shift;
1207 my $curl_line = CURL;
1208 my $retries_left = get_cli_option('retries') + 1;
1211 $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
1213 # We want to see the HTTP status code
1214 $curl_line .= " --include ";
1215 # Let Privoxy emit two log messages less.
1216 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1217 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1218 # We don't care about fetch statistic.
1219 $curl_line .= " -s ";
1220 # We do care about the failure reason if any.
1221 $curl_line .= " -S ";
1222 # We want to advertise ourselves
1223 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1224 # We aren't too patient
1225 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1227 $curl_line .= $parameters;
1228 # XXX: still necessary?
1229 $curl_line .= ' 2>&1';
1231 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1234 @buffer = `$curl_line`;
1237 log_and_die("Executing '$curl_line' failed.") unless @buffer;
1238 $failure_reason = array_as_string(\@buffer);
1239 chomp $failure_reason;
1240 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1242 } while ($? && --$retries_left);
1244 unless ($retries_left) {
1245 log_and_die("Running curl failed " . get_cli_option('retries') .
1246 " times in a row. Last error: '" . $failure_reason . "'.");
1253 ############################################################################
1257 ############################################################################
1259 sub array_as_string ($) {
1260 my $array_ref = shift;
1263 foreach (@{$array_ref}) {
1272 log_message('Test is:' . test_content_as_string($test));
1278 my $this_level = shift;
1279 my $message = shift;
1281 log_message($message) if ($log_level & $this_level);
1284 sub log_and_die ($) {
1285 my $message = shift;
1287 log_message('Oh noes. ' . $message . ' Fatal error. Exiting.');
1291 sub log_message ($) {
1293 my $message = shift;
1297 our $leading_log_date;
1298 our $leading_log_time;
1300 my $time_stamp = '';
1301 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1303 if ($leading_log_date || $leading_log_time) {
1305 if ($leading_log_date) {
1308 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1311 if ($leading_log_time) {
1312 $time_stamp .= ' ' if $leading_log_date;
1313 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1316 $message = $time_stamp . ": " . $message;
1319 printf(STDERR "%s\n", $message);
1322 sub log_result ($$) {
1324 our $verbose_test_description;
1325 our $filtered_request;
1333 $message .= interpret_result($result);
1334 $message .= " for test ";
1335 $message .= $number;
1337 $message .= $test->{'number'};
1339 $message .= $test->{'section-id'};
1341 $message .= $test->{'regression-test-id'};
1344 if ($verbose_test_description) {
1346 if ($test->{'type'} == CLIENT_HEADER_TEST) {
1348 $message .= ' Header ';
1349 $message .= quote($test->{'data'});
1350 $message .= ' and tag ';
1351 $message .= quote($test->{'tag'});
1353 } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
1355 $message .= ' Request Header ';
1356 $message .= quote($test->{'data'});
1357 $message .= ' and tag ';
1358 $message .= quote($test->{'tag'});
1360 } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
1362 $message .= ' URL ';
1363 $message .= quote($test->{'data'});
1364 $message .= ' and expected status code ';
1365 $message .= quote($test->{'expected-status-code'});
1367 } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
1369 $message .= ' CGI URL ';
1370 $message .= quote($test->{'data'});
1371 $message .= ' and expected status code ';
1372 $message .= quote($test->{'expected-status-code'});
1374 } elsif ($test->{'type'} == METHOD_TEST) {
1376 $message .= ' HTTP method ';
1377 $message .= quote($test->{'data'});
1378 $message .= ' and expected status code ';
1379 $message .= quote($test->{'expected-status-code'});
1381 } elsif ($test->{'type'} == BLOCK_TEST) {
1383 $message .= ' Supposedly-blocked URL: ';
1384 $message .= quote($test->{'data'});
1386 } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
1388 $message .= ' Sticky Actions: ';
1389 $message .= quote($test->{'sticky-actions'});
1390 $message .= ' and URL: ';
1391 $message .= quote($test->{'data'});
1393 } elsif ($test->{'type'} == REDIRECT_TEST) {
1395 $message .= ' Redirected URL: ';
1396 $message .= quote($test->{'data'});
1397 $message .= ' and redirect destination: ';
1398 $message .= quote($test->{'redirect destination'});
1402 die "Incomplete support for test type " . $test->{'type'} . " detected.";
1406 log_message($message) if (!$result or cli_option_is_set('verbose'));
1411 return '\'' . $s . '\'';
1414 sub print_version () {
1415 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil <fk@fabiankeil.de>' . "\n";
1418 sub list_test_types () {
1420 'Client header test' => CLIENT_HEADER_TEST,
1421 'Server header test' => 2,
1422 'Dumb fetch test' => 3,
1424 'Sticky action test' => 5,
1425 'Trusted CGI test' => 6,
1427 'Redirect test' => 108,
1430 print "\nThe supported test types and their default levels are:\n";
1431 foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
1432 printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
1444 Options and their default values if they have any:
1445 [--debug $cli_options{'debug'}]
1446 [--forks $cli_options{'forks'}]
1452 [--loops $cli_options{'loops'}]
1453 [--max-level $cli_options{'max-level'}]
1454 [--max-time $cli_options{'max-time'}]
1455 [--min-level $cli_options{'min-level'}]
1457 [--retries $cli_options{'retries'}]
1458 [--show-skipped-tests]
1469 Try "perldoc $0" for more information
1476 sub init_cli_options () {
1481 $cli_options{'debug'} = $log_level;
1482 $cli_options{'forks'} = CLI_FORKS;
1483 $cli_options{'loops'} = CLI_LOOPS;
1484 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1485 $cli_options{'max-time'} = CLI_MAX_TIME;
1486 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1487 $cli_options{'retries'} = CLI_RETRIES;
1490 sub parse_cli_options () {
1498 'debug=s' => \$cli_options{'debug'},
1499 'forks=s' => \$cli_options{'forks'},
1500 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
1501 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1502 'header-fuzzing' => \$cli_options{'header-fuzzing'},
1504 'level=s' => \$cli_options{'level'},
1505 'loops=s' => \$cli_options{'loops'},
1506 'max-level=s' => \$cli_options{'max-level'},
1507 'max-time=s' => \$cli_options{'max-time'},
1508 'min-level=s' => \$cli_options{'min-level'},
1509 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1510 'retries=s' => \$cli_options{'retries'},
1511 'show-skipped-tests' => \$cli_options{'show-skipped-tests'},
1512 'test-number=s' => \$cli_options{'test-number'},
1513 'verbose' => \$cli_options{'verbose'},
1514 'version' => sub {print_version && exit(0)}
1516 $log_level |= $cli_options{'debug'};
1519 sub cli_option_is_set ($) {
1522 my $cli_option = shift;
1524 return defined $cli_options{$cli_option};
1527 sub get_cli_option ($) {
1530 my $cli_option = shift;
1532 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1534 return $cli_options{$cli_option};
1537 sub init_proxy_settings($) {
1542 if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
1543 $proxy = get_cli_option('fuzzer-address');
1546 if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
1548 if (cli_option_is_set('privoxy-address')) {
1549 $proxy .= get_cli_option('privoxy-address');
1554 sub start_forks($) {
1557 log_and_die("Invalid --fork value: " . $forks . ".") if ($forks < 0);
1559 foreach my $fork (1 .. $forks) {
1560 log_message("Starting fork $fork");
1562 if (defined $pid && !$pid) {
1570 init_our_variables();
1571 parse_cli_options();
1572 init_proxy_settings('vanilla-proxy');
1573 load_regressions_tests();
1574 init_proxy_settings('fuzz-proxy');
1575 start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
1576 execute_regression_tests();
1583 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1587 B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
1588 [B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
1589 [B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
1590 [B<--min-level min-level>] B<--privoxy-address proxy-address>
1591 [B<--retries retries>] [B<--test-number test-number>]
1592 [B<--show-skipped-tests>] [B<--verbose>]
1597 Privoxy-Regression-Test is supposed to one day become
1598 a regression test suite for Privoxy. It's not quite there
1599 yet, however, and can currently only test header actions,
1600 check the returned status code for requests to arbitrary
1601 URLs and verify which actions are applied to them.
1603 Client header actions are tested by requesting
1604 B<http://p.p/show-request> and checking whether
1605 or not Privoxy modified the original request as expected.
1607 The original request contains both the header the action-to-be-tested
1608 acts upon and an additional tagger-triggering header that enables
1611 Applied actions are checked through B<http://p.p/show-url-info>.
1613 =head1 CONFIGURATION FILE SYNTAX
1615 Privoxy-Regression-Test's configuration is embedded in
1616 Privoxy action files and loaded through Privoxy's web interface.
1618 It makes testing a Privoxy version running on a remote system easier
1619 and should prevent you from updating your tests without updating Privoxy's
1620 configuration accordingly.
1622 A client-header-action test section looks like this:
1624 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1625 # Expect Header = Referer: http://www.example.org/
1626 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1627 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1629 The example above causes Privoxy-Regression-Test to set
1630 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1631 and to expect it to be modified to
1632 B<Referer: http://www.example.org/>.
1634 When testing this section, Privoxy-Regression-Test will set the header
1635 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1636 causing the B<privoxy-control> tagger to create the tag
1637 B<client-header-filter{hide-tor-exit-notation}> which will finally
1638 cause Privoxy to enable the action section.
1640 Note that the actions itself are only used by Privoxy,
1641 Privoxy-Regression-Test ignores them and will be happy
1642 as long as the expectations are satisfied.
1644 A fetch test looks like this:
1646 # Fetch Test = http://p.p/user-manual
1647 # Expect Status Code = 302
1649 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1650 and to expect a response with the HTTP status code B<302>. Obviously that's
1651 not a very thorough test and mainly useful to get some code coverage
1652 for Valgrind or to verify that the templates are installed correctly.
1654 If you want to test CGI pages that require a trusted
1655 referer, you can use:
1657 # Trusted CGI Request = http://p.p/edit-actions
1659 It works like ordinary fetch tests, but sets the referer
1660 header to a trusted value.
1662 If no explicit status code expectation is set, B<200> is used.
1664 To verify that a URL is blocked, use:
1666 # Blocked URL = http://www.example.com/blocked
1668 To verify that a specific set of actions is applied to an URL, use:
1670 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1671 # URL = http://www.example.org/my-first-url
1673 The sticky actions will be checked for all URLs below it
1674 until the next sticky actions directive.
1676 To verify that requests for a URL get redirected, use:
1678 # Redirected URL = http://www.example.com/redirect-me
1679 # Redirect Destination = http://www.example.org/redirected
1683 All tests have test levels to let the user
1684 control which ones to execute (see I<OPTIONS> below).
1685 Test levels are either set with the B<Level> directive,
1686 or implicitly through the test type.
1688 Redirect tests default to level 108, block tests to level 7,
1689 fetch tests to level 6, "Sticky Actions" tests default to
1690 level 5, tests for trusted CGI requests to level 3 and
1691 client-header-action tests to level 1.
1693 The current redirect test level is above the default
1694 max-level value as failed tests will result in outgoing
1695 connections. Use the B<--max-level> option to run them
1700 B<--debug bitmask> Add the bitmask provided as integer
1701 to the debug settings.
1703 B<--forks forks> Number of forks to start before executing
1704 the regression tests. This is mainly useful for stress-testing.
1706 B<--fuzzer-address> Listening address used when executing
1707 the regression tests. Useful to make sure that the requests
1708 to load the regression tests don't fail due to fuzzing.
1710 B<--fuzzer-feeding> Ignore some errors that would otherwise
1711 cause Privoxy-Regression-Test to abort the test because
1712 they shouldn't happen in normal operation. This option is
1713 intended to be used if Privoxy-Regression-Test is only
1714 used to feed a fuzzer in which case there's a high chance
1715 that Privoxy gets an invalid request and returns an error
1718 B<--help> Shows available command line options.
1720 B<--header-fuzzing> Modifies linear white space in
1721 headers in a way that should not affect the test result.
1723 B<--level level> Only execute tests with the specified B<level>.
1725 B<--loop count> Loop through the regression tests B<count> times.
1726 Useful to feed a fuzzer, or when doing stress tests with
1727 several Privoxy-Regression-Test instances running at the same
1730 B<--max-level max-level> Only execute tests with a B<level>
1731 below or equal to the numerical B<max-level>.
1733 B<--max-time max-time> Give Privoxy B<max-time> seconds
1734 to return data. Increasing the default may make sense when
1735 Privoxy is run through Valgrind, decreasing the default may
1736 make sense when Privoxy-Regression-Test is used to feed
1739 B<--min-level min-level> Only execute tests with a B<level>
1740 above or equal to the numerical B<min-level>.
1742 B<--privoxy-address proxy-address> Privoxy's listening address.
1743 If it's not set, the value of the environment variable http_proxy
1744 will be used. B<proxy-address> has to be specified in http_proxy
1747 B<--retries retries> Retry B<retries> times.
1749 B<--test-number test-number> Only run the test with the specified
1752 B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
1754 B<--verbose> Log successful tests as well. By default only
1755 the failures are logged.
1757 B<--version> Print version and exit.
1759 The second dash is optional, options can be shortened,
1760 as long as there are no ambiguities.
1762 =head1 PRIVOXY CONFIGURATION
1764 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1765 which aims to test all official client-header modifying actions
1766 and can be used to verify that the templates and the user manual
1767 files are installed correctly.
1769 To use it, it has to be copied in Privoxy's configuration
1770 directory, and afterwards referenced in Privoxy's configuration
1773 actionsfile regression-tests.action
1775 In general, its tests are supposed to work without changing
1776 any other action files, unless you already added lots of
1777 taggers yourself. If you are using taggers that cause problems,
1778 you might have to temporary disable them for Privoxy's CGI pages.
1780 Some of the regression tests rely on Privoxy features that
1781 may be disabled in your configuration. Tests with a level below
1782 7 are supposed to work with all Privoxy configurations (provided
1783 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1785 Tests with level 9 require Privoxy to deliver the User Manual,
1786 tests with level 12 require the CGI editor to be enabled.
1790 Expect the configuration file syntax to change with future releases.
1794 As Privoxy's B<show-request> page only shows client headers,
1795 Privoxy-Regression-Test can't use it to test Privoxy actions
1796 that modify server headers.
1798 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1799 control the actions to test, it currently only works with
1800 Privoxy 3.0.7 or later.
1802 At the moment Privoxy-Regression-Test fetches Privoxy's
1803 configuration page through I<curl>(1), therefore you have to
1804 have I<curl> installed, otherwise you won't be able to run
1805 Privoxy-Regression-Test in a meaningful way.
1813 Fabian Keil <fk@fabiankeil.de>