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.118 2008/03/19 16:15:45 fk Exp $
14 # - Update documentation
15 # - Validate HTTP times.
16 # - Understand default.action.master comment syntax
17 # and verify that we actually block and unblock what
18 # the comments claim we do.
19 # - Implement a HTTP_VERSION directive or allow to
20 # specify whole request lines.
21 # - Support filter regression tests.
22 # - Add option to fork regression tests and run them in parallel,
23 # possibly optional forever.
24 # - Document magic Expect Header values
25 # - Internal fuzz support?
27 # Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
29 # Permission to use, copy, modify, and distribute this software for any
30 # purpose with or without fee is hereby granted, provided that the above
31 # copyright notice and this permission notice appear in all copies.
33 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
34 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
35 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
36 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
37 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
38 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
39 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 ############################################################################
48 PRT_VERSION => 'Privoxy-Regression-Test 0.2',
59 PRIVOXY_CGI_URL => 'http://p.p/',
60 FELLATIO_URL => 'http://10.0.0.1:8080/',
61 LEADING_LOG_DATE => 1,
62 LEADING_LOG_TIME => 1,
64 DEBUG_LEVEL_FILE_LOADING => 0,
65 DEBUG_LEVEL_PAGE_FETCHING => 0,
67 VERBOSE_TEST_DESCRIPTION => 1,
69 DEBUG_LEVEL_VERBOSE_FAILURE => 1,
70 # XXX: Only partly implemented and mostly useless.
71 DEBUG_LEVEL_VERBOSE_SUCCESS => 0,
72 DEBUG_LEVEL_STATUS => 1,
74 # Internal use, don't modify
75 # Available debug bits:
77 LL_VERBOSE_FAILURE => 2,
78 LL_PAGE_FETCHING => 4,
80 LL_VERBOSE_SUCCESS => 16,
84 CLIENT_HEADER_TEST => 1,
85 SERVER_HEADER_TEST => 2,
88 TRUSTED_CGI_REQUEST => 6,
92 sub init_our_variables () {
94 our $leading_log_time = LEADING_LOG_TIME;
95 our $leading_log_date = LEADING_LOG_DATE;
97 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
99 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
101 our $log_level = get_default_log_level();
105 sub get_default_log_level () {
109 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
110 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
111 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
112 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
113 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
115 # These are intended to be always on.
116 $log_level |= LL_SOFT_ERROR;
117 $log_level |= LL_ERROR;
122 ############################################################################
124 # File loading functions
126 ############################################################################
134 # Unescape brackets and dots
135 $tag =~ s@\\(?=[{}().+])@@g;
137 # log_message("Parsed tag: " . $tag);
139 check_for_forbidden_characters($tag);
144 sub check_for_forbidden_characters ($) {
146 my $tag = shift; # XXX: also used to check values though.
147 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&]';
149 unless ($tag =~ m/^$allowed*$/) {
150 my $forbidden = $tag;
151 $forbidden =~ s@^$allowed*(.).*@$1@;
153 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
157 sub load_regressions_tests () {
159 our $privoxy_cgi_url;
165 $curl_url .= $privoxy_cgi_url;
166 $curl_url .= 'show-status';
168 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
170 foreach (@{get_cgi_page_or_else($curl_url)}) {
173 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
175 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
176 $actionfiles[$file_number++] = $url;
178 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
180 my $directive = $1 . " " . $2;
181 push (@privoxy_config, $directive);
185 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
187 load_action_files(\@actionfiles);
190 sub token_starts_new_test ($) {
193 my @new_test_directives =
194 ('set header', 'fetch test', 'trusted cgi request', 'request header', 'method test', 'blocked url');
196 foreach my $new_test_directive (@new_test_directives) {
197 return 1 if $new_test_directive eq $token;
205 my ($token, $value) = (undef, undef);
207 # Remove leading and trailing white space.
211 # Reverse HTML-encoding
212 # XXX: Seriously imcomplete.
217 if (/^\#\s*([^=:]*?)\s*[=]\s*(.*?)\s*$/) {
220 $token =~ tr/[A-Z]/[a-z]/;
223 } elsif (/^TAG\s*:(.*)$/) {
230 return ($token, $value);
233 sub enlist_new_test ($$$$$$) {
235 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
237 if ($token eq 'set header') {
239 l(LL_FILE_LOADING, "Header to set: " . $value);
240 ${$regression_tests}[$si][$ri]{'type'} = CLIENT_HEADER_TEST;
242 $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST;
244 } elsif ($token eq 'request header') {
246 l(LL_FILE_LOADING, "Header to request: " . $value);
247 $$regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST;
249 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
250 $$regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST;
252 } elsif ($token eq 'trusted cgi request') {
254 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
255 $$regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST;
257 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
258 $$regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST;
260 } elsif ($token eq 'fetch test') {
262 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
263 $$regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST;
265 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
266 $$regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST;
268 } elsif ($token eq 'method test') {
270 l(LL_FILE_LOADING, "Method to test: " . $value);
271 $$regression_tests[$si][$ri]{'type'} = METHOD_TEST;
273 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
274 $$regression_tests[$si][$ri]{'level'} = METHOD_TEST;
276 } elsif ($token eq 'blocked url') {
278 l(LL_FILE_LOADING, "URL to block-test: " . $value);
279 $$regression_tests[$si][$ri]{'type'} = BLOCK_TEST;
281 $$regression_tests[$si][$ri]{'expected-status-code'} = 403;
282 $$regression_tests[$si][$ri]{'level'} = BLOCK_TEST;
286 die "Incomplete '" . $token . "' support detected.";
290 check_for_forbidden_characters($value);
292 $$regression_tests[$si][$ri]{'data'} = $value;
294 # For function that only get passed single tests
295 $$regression_tests[$si][$ri]{'section-id'} = $si;
296 $$regression_tests[$si][$ri]{'regression-test-id'} = $ri;
297 $$regression_tests[$si][$ri]{'number'} = $number - 1;
299 "Regression test " . $number . " (section:" . $si . "):");
302 sub load_action_files ($) {
306 our @regression_tests;
308 my $actionfiles_ref = shift;
309 my @actionfiles = @{$actionfiles_ref};
311 my $si = 0; # Section index
312 my $ri = -1; # Regression test index
317 l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
319 for my $file_number (0 .. @actionfiles - 1) {
321 my $curl_url = ' "' . $actionfiles[$file_number] . '"';
322 my $actionfile = undef;
324 foreach (@{get_cgi_page_or_else($curl_url)}) {
329 if (/<h2>Contents of Actions File (.*?)</) {
333 next unless defined $actionfile;
337 my ($token, $value) = tokenize($_);
339 next unless defined $token;
341 # Load regression tests
343 if (token_starts_new_test($token)) {
345 # Beginning of new regression test.
348 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
351 if ($token =~ /level\s+(\d+)/i) {
354 register_dependency($level, $value);
357 if ($si == -1 || $ri == -1) {
358 # No beginning of a test detected yet,
359 # so we don't care about any other test
364 if ($token eq 'expect header') {
366 l(LL_FILE_LOADING, "Detected expectation: " . $value);
367 $regression_tests[$si][$ri]{'expect-header'} = $value;
369 } elsif ($token eq 'tag') {
373 my $tag = parse_tag($value);
375 # We already checked in parse_tag() after filtering
378 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
380 # Save tag for all tests in this section
382 $regression_tests[$si][$ri]{'tag'} = $tag;
388 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
390 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
391 $regression_tests[$si][$ri]{'ignore'} = 1;
394 } elsif ($token eq 'expect status code') {
396 l(LL_FILE_LOADING, "Expecting status code: " . $value);
397 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
399 } elsif ($token eq 'level') { # XXX: stupid name
401 $value =~ s@(\d+).*@$1@;
402 l(LL_FILE_LOADING, "Level: " . $value);
403 $regression_tests[$si][$ri]{'level'} = $value;
405 } elsif ($token eq 'method') {
407 l(LL_FILE_LOADING, "Method: " . $value);
408 $regression_tests[$si][$ri]{'method'} = $value;
412 # We don't use it, so we don't need
416 check_for_forbidden_characters($value) unless $no_checks;
417 check_for_forbidden_characters($token);
421 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
422 . " Of which " . $ignored. " will be ignored)\n");
425 ############################################################################
427 # Regression test executing functions
429 ############################################################################
431 sub execute_regression_tests () {
433 our @regression_tests;
434 my $loops = get_cli_option('loops');
436 my $all_failures = 0;
437 my $all_successes = 0;
439 unless (@regression_tests) {
441 l(LL_STATUS, "No regression tests found.");
445 l(LL_STATUS, "Executing regression tests ...");
447 while ($loops-- > 0) {
454 for my $s (0 .. @regression_tests - 1) {
458 while (defined $regression_tests[$s][$r]) {
460 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
461 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
463 my $number = $regression_tests[$s][$r]{'number'};
465 if ($regression_tests[$s][$r]{'ignore'}
466 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
467 or test_number_is_unacceptable($number)) {
473 my $result = execute_regression_test($regression_tests[$s][$r]);
475 log_result($regression_tests[$s][$r], $result, $tests);
477 $successes += $result;
483 $failures = $tests - $successes;
485 log_message("Executed " . $tests . " regression tests. " .
486 'Skipped ' . $skipped . '. ' .
487 $successes . " successes, " . $failures . " failures.");
489 $all_tests += $tests;
490 $all_failures += $failures;
491 $all_successes += $successes;
495 if (get_cli_option('loops') > 1) {
496 log_message("Total: Executed " . $all_tests . " regression tests. " .
497 $all_successes . " successes, " . $all_failures . " failures.");
501 sub level_is_unacceptable ($) {
503 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
504 or ($level < get_cli_option('min-level'))
505 or ($level > get_cli_option('max-level'))
506 or dependency_unsatisfied($level)
510 sub test_number_is_unacceptable ($) {
511 my $test_number = shift;
512 return (cli_option_is_set('test-number')
513 and get_cli_option('test-number') != $test_number)
516 sub dependency_unsatisfied ($) {
521 my $dependency_problem = 0;
523 if (defined ($dependencies{$level}{'config line'})) {
525 my $dependency = $dependencies{$level}{'config line'};
526 $dependency_problem = 1;
528 foreach (@privoxy_config) {
530 $dependency_problem = 0 if (/$dependency/);
534 return $dependency_problem;
537 sub register_dependency ($$) {
540 my $dependency = shift;
543 if ($dependency =~ /config line\s+(.*)/) {
545 $dependencies{$level}{'config line'} = $1;
549 # XXX: somewhat misleading name
550 sub execute_regression_test ($) {
552 my $test_ref = shift;
553 my %test = %{$test_ref};
556 if ($test{'type'} == CLIENT_HEADER_TEST) {
558 $result = execute_client_header_regression_test($test_ref);
560 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
562 $result = execute_server_header_regression_test($test_ref);
564 } elsif ($test{'type'} == DUMB_FETCH_TEST
565 or $test{'type'} == TRUSTED_CGI_REQUEST) {
567 $result = execute_dumb_fetch_test($test_ref);
569 } elsif ($test{'type'} == METHOD_TEST) {
571 $result = execute_method_test($test_ref);
573 } elsif ($test{'type'} == BLOCK_TEST) {
575 $result = execute_block_test($test_ref);
579 die "Unsupported test type detected: " . $test{'type'};
586 sub execute_method_test ($) {
588 my $test_ref = shift;
589 my %test = %{$test_ref};
593 my $method = $test{'data'};
595 my $curl_parameters = '';
596 my $expected_status_code = $test{'expected-status-code'};
598 $curl_parameters .= '--request ' . $method . ' ';
599 # Don't complain in case about the 'missing' body
600 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
602 $curl_parameters .= PRIVOXY_CGI_URL;
604 $buffer_ref = get_page_with_curl($curl_parameters);
605 $status_code = get_status_code($buffer_ref);
607 $result = check_status_code_result($status_code, $expected_status_code);
612 sub execute_dumb_fetch_test ($) {
614 my $test_ref = shift;
615 my %test = %{$test_ref};
620 my $curl_parameters = '';
621 my $expected_status_code = $test{'expected-status-code'};
623 if (defined $test{method}) {
624 $curl_parameters .= '--request ' . $test{method} . ' ';
626 if ($test{type} == TRUSTED_CGI_REQUEST) {
627 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
630 $curl_parameters .= $test{'data'};
632 $buffer_ref = get_page_with_curl($curl_parameters);
633 $status_code = get_status_code($buffer_ref);
635 $result = check_status_code_result($status_code, $expected_status_code);
640 sub execute_block_test ($) {
643 my $url = $test->{'data'};
644 my $final_results = get_final_results($url);
646 return defined $final_results->{'+block'};
649 sub get_final_results ($) {
652 my $curl_parameters = '';
653 my %final_results = ();
654 my $final_results_reached = 0;
656 die "Unacceptable characterss in $url" if $url =~ m@[\\'"]@;
659 $curl_parameters .= "'" . PRIVOXY_CGI_URL . 'show-url-info?url=' . $url . "'";
661 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
663 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
665 next unless ($final_results_reached);
668 if (m@<br>([-+])<a.*>([^>]*)</a>( \{.*\})@) {
671 $final_results{$action} = $value;
675 return \%final_results;
678 sub check_status_code_result ($$) {
680 my $status_code = shift;
681 my $expected_status_code = shift;
684 if ($expected_status_code == $status_code) {
687 l(LL_VERBOSE_SUCCESS,
688 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
690 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
692 l(LL_VERBOSE_FAILURE,
693 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
697 l(LL_VERBOSE_FAILURE,
698 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
705 sub execute_client_header_regression_test ($) {
707 my $test_ref = shift;
712 $buffer_ref = get_show_request_with_curl($test_ref);
714 $header = get_header($buffer_ref, $test_ref);
715 $result = check_header_result($test_ref, $header);
720 sub execute_server_header_regression_test ($) {
722 my $test_ref = shift;
727 $buffer_ref = get_head_with_curl($test_ref);
729 $header = get_server_header($buffer_ref, $test_ref);
730 $result = check_header_result($test_ref, $header);
736 sub interpret_result ($) {
738 return $success ? "Success" : "Failure";
741 sub check_header_result ($$) {
743 my $test_ref = shift;
746 my %test = %{$test_ref};
747 my $expect_header = $test{'expect-header'};
750 $header =~ s@ @ @g if defined($header);
752 if ($expect_header eq 'NO CHANGE') {
754 if (defined($header) and $header eq $test{'data'}) {
760 $header //= "REMOVAL";
761 l(LL_VERBOSE_FAILURE,
762 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
765 } elsif ($expect_header eq 'REMOVAL') {
767 if (defined($header) and $header eq $test{'data'}) {
769 l(LL_VERBOSE_FAILURE,
770 "Ooops. Expected removal but: " . $header . " is still there.");
774 # XXX: Use more reliable check here and make sure
775 # the header has a different name.
780 } elsif ($expect_header eq 'SOME CHANGE') {
782 if (defined($header) and not $header eq $test{'data'}) {
788 $header //= "REMOVAL";
789 l(LL_VERBOSE_FAILURE,
790 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
796 if (defined($header) and $header eq $expect_header) {
802 $header //= "'No matching header'"; # XXX: No header detected to be precise
803 l(LL_VERBOSE_FAILURE,
804 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
810 sub get_header_name ($) {
814 $header =~ s@(.*?: ).*@$1@;
819 sub get_header ($$) {
821 our $filtered_request = '';
823 my $buffer_ref = shift;
824 my $test_ref = shift;
826 my %test = %{$test_ref};
827 my @buffer = @{$buffer_ref};
829 my $expect_header = $test{'expect-header'};
832 my $processed_request_reached = 0;
834 my $processed_request = '';
838 if ($expect_header eq 'REMOVAL'
839 or $expect_header eq 'NO CHANGE'
840 or $expect_header eq 'SOME CHANGE') {
842 $expect_header = $test{'data'};
846 $header_to_get = get_header_name($expect_header);
850 # Skip everything before the Processed request
851 if (/Processed Request/) {
852 $processed_request_reached = 1;
855 next unless $processed_request_reached;
857 # End loop after the Processed request
860 # Ditch tags and leading/trailing white space.
864 $filtered_request .= "\n" . $_;
866 if (/^$header_to_get/) {
876 sub get_server_header ($$) {
878 my $buffer_ref = shift;
879 my $test_ref = shift;
881 my %test = %{$test_ref};
882 my @buffer = @{$buffer_ref};
884 my $expect_header = $test{'expect-header'};
888 if ($expect_header eq 'REMOVAL'
889 or $expect_header eq 'NO CHANGE'
890 or $expect_header eq 'SOME CHANGE') {
892 $expect_header = $test{'data'};
896 $header_to_get = get_header_name($expect_header);
900 # XXX: should probably verify that the request
901 # was actually answered by Fellatio.
902 if (/^$header_to_get/) {
904 $header =~ s@\s*$@@g;
912 sub get_status_code ($) {
914 my $buffer_ref = shift;
915 my @buffer = @{$buffer_ref};
919 if (/^HTTP\/\d\.\d (\d{3})/) {
925 return '123' if cli_option_is_set('fuzzer-feeding');
927 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
932 sub get_test_keys () {
933 return ('tag', 'data', 'expect-header', 'ignore');
937 sub test_content_as_string ($) {
939 my $test_ref = shift;
940 my %test = %{$test_ref};
944 foreach my $key (get_test_keys()) {
945 $test{$key} = 'Not set' unless (defined $test{$key});
948 $s .= 'Tag: ' . $test{'tag'};
950 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
952 $s .= 'Expected header: ' . $test{'expect-header'};
954 $s .= 'Ignore: ' . $test{'ignore'};
959 ############################################################################
961 # HTTP fetch functions
963 ############################################################################
965 sub check_for_curl () {
967 l(LL_ERROR, "No curl found.") unless (`which $curl`);
970 sub get_cgi_page_or_else ($) {
973 my $content_ref = get_page_with_curl($cgi_url);
974 my $status_code = get_status_code($content_ref);
976 if (200 != $status_code) {
978 my $log_message = "Failed to fetch Privoxy CGI Page. " .
979 "Received status code ". $status_code .
980 " while only 200 is acceptable.";
982 if (cli_option_is_set('fuzzer-feeding')) {
984 $log_message .= " Ignored due to fuzzer feeding.";
985 l(LL_SOFT_ERROR, $log_message)
989 l(LL_ERROR, $log_message);
997 sub get_show_request_with_curl ($) {
999 our $privoxy_cgi_url;
1000 my $test_ref = shift;
1001 my %test = %{$test_ref};
1003 my $curl_parameters = ' ';
1005 # Enable the action to test
1006 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1007 # The header to filter
1008 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1010 $curl_parameters .= ' ';
1011 $curl_parameters .= $privoxy_cgi_url;
1012 $curl_parameters .= 'show-request';
1014 return get_cgi_page_or_else($curl_parameters);
1018 sub get_head_with_curl ($) {
1020 our $fellatio_url = FELLATIO_URL;
1021 my $test_ref = shift;
1022 my %test = %{$test_ref};
1024 my $curl_parameters = ' ';
1026 # Enable the action to test
1027 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1028 # The header to filter
1029 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1030 $curl_parameters .= '--head ';
1032 $curl_parameters .= ' ';
1033 $curl_parameters .= $fellatio_url;
1035 return get_page_with_curl($curl_parameters);
1039 sub get_page_with_curl ($) {
1041 my $parameters = shift;
1043 my $curl_line = CURL;
1044 my $retries_left = get_cli_option('retries') + 1;
1047 if (cli_option_is_set('privoxy-address')) {
1048 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
1051 # We want to see the HTTP status code
1052 $curl_line .= " --include ";
1053 # Let Privoxy emit two log messages less.
1054 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1055 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1056 # We don't care about fetch statistic.
1057 $curl_line .= " -s ";
1058 # We do care about the failure reason if any.
1059 $curl_line .= " -S ";
1060 # We want to advertise ourselves
1061 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1062 # We aren't too patient
1063 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1065 $curl_line .= $parameters;
1066 # XXX: still necessary?
1067 $curl_line .= ' 2>&1';
1069 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1072 @buffer = `$curl_line`;
1075 $failure_reason = array_as_string(\@buffer);
1076 chomp $failure_reason;
1077 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1079 } while ($? && --$retries_left);
1081 unless ($retries_left) {
1083 "Running curl failed " . get_cli_option('retries') .
1084 " times in a row. Last error: '" . $failure_reason . "'.");
1091 ############################################################################
1095 ############################################################################
1097 sub array_as_string ($) {
1098 my $array_ref = shift;
1101 foreach (@{$array_ref}) {
1110 my $test_ref = shift;
1111 log_message('Test is:' . test_content_as_string($test_ref));
1117 my $this_level = shift;
1118 my $message = shift;
1120 return unless ($log_level & $this_level);
1122 if (LL_ERROR & $this_level) {
1123 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1126 log_message($message);
1128 if (LL_ERROR & $this_level) {
1133 sub log_message ($) {
1135 my $message = shift;
1139 our $leading_log_date;
1140 our $leading_log_time;
1142 my $time_stamp = '';
1143 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1145 if ($leading_log_date || $leading_log_time) {
1147 if ($leading_log_date) {
1150 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1153 if ($leading_log_time) {
1154 $time_stamp .= ' ' if $leading_log_date;
1155 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1158 $message = $time_stamp . ": " . $message;
1162 printf(STDERR "%s\n", $message);
1166 sub log_result ($$) {
1168 our $verbose_test_description;
1169 our $filtered_request;
1171 my $test_ref = shift;
1175 my %test = %{$test_ref};
1178 $message .= interpret_result($result);
1179 $message .= " for test ";
1180 $message .= $number;
1182 $message .= $test{'number'};
1184 $message .= $test{'section-id'};
1186 $message .= $test{'regression-test-id'};
1189 if ($verbose_test_description) {
1191 if ($test{'type'} == CLIENT_HEADER_TEST) {
1193 $message .= ' Header ';
1194 $message .= quote($test{'data'});
1195 $message .= ' and tag ';
1196 $message .= quote($test{'tag'});
1198 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1200 $message .= ' Request Header ';
1201 $message .= quote($test{'data'});
1202 $message .= ' and tag ';
1203 $message .= quote($test{'tag'});
1205 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1207 $message .= ' URL ';
1208 $message .= quote($test{'data'});
1209 $message .= ' and expected status code ';
1210 $message .= quote($test{'expected-status-code'});
1212 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1214 $message .= ' CGI URL ';
1215 $message .= quote($test{'data'});
1216 $message .= ' and expected status code ';
1217 $message .= quote($test{'expected-status-code'});
1219 } elsif ($test{'type'} == METHOD_TEST) {
1221 $message .= ' HTTP method ';
1222 $message .= quote($test{'data'});
1223 $message .= ' and expected status code ';
1224 $message .= quote($test{'expected-status-code'});
1226 } elsif ($test{'type'} == BLOCK_TEST) {
1228 $message .= ' Supposedly-blocked URL: ';
1229 $message .= quote($test{'data'});
1233 die "Incomplete support for test type " . $test{'type'} . " detected.";
1238 log_message($message) unless ($result && cli_option_is_set('silent'));
1243 return '\'' . $s . '\'';
1246 sub print_version () {
1247 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1258 Options and their default values if they have any:
1259 [--debug $cli_options{'debug'}]
1263 [--loops $cli_options{'loops'}]
1264 [--max-level $cli_options{'max-level'}]
1265 [--max-time $cli_options{'max-time'}]
1266 [--min-level $cli_options{'min-level'}]
1268 [--retries $cli_options{'retries'}]
1271 see "perldoc $0" for more information
1277 sub init_cli_options () {
1282 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1283 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1284 $cli_options{'debug'} = $log_level;
1285 $cli_options{'loops'} = CLI_LOOPS;
1286 $cli_options{'max-time'} = CLI_MAX_TIME;
1287 $cli_options{'retries'} = CLI_RETRIES;
1290 sub parse_cli_options () {
1298 'debug=s' => \$cli_options{'debug'},
1299 'help' => sub { help },
1300 'silent' => \$cli_options{'silent'},
1301 'min-level=s' => \$cli_options{'min-level'},
1302 'max-level=s' => \$cli_options{'max-level'},
1303 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1304 'level=s' => \$cli_options{'level'},
1305 'loops=s' => \$cli_options{'loops'},
1306 'test-number=s' => \$cli_options{'test-number'},
1307 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1308 'retries=s' => \$cli_options{'retries'},
1309 'max-time=s' => \$cli_options{'max-time'},
1310 'version' => sub { print_version && exit(0) }
1312 $log_level |= $cli_options{'debug'};
1315 sub cli_option_is_set ($) {
1318 my $cli_option = shift;
1320 return defined $cli_options{$cli_option};
1323 sub get_cli_option ($) {
1326 my $cli_option = shift;
1328 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1330 return $cli_options{$cli_option};
1335 init_our_variables();
1336 parse_cli_options();
1338 load_regressions_tests();
1339 execute_regression_tests();
1346 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1350 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1351 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1352 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1353 [B<--retries retries>] [B<--silent>] [B<--version>]
1357 Privoxy-Regression-Test is supposed to one day become
1358 a regression test suite for Privoxy. It's not quite there
1359 yet, however, and can currently only test client header
1360 actions and check the returned status code for requests
1363 Client header actions are tested by requesting
1364 B<http://config.privoxy.org/show-request> and checking whether
1365 or not Privoxy modified the original request as expected.
1367 The original request contains both the header the action-to-be-tested
1368 acts upon and an additional tagger-triggering header that enables
1371 =head1 CONFIGURATION FILE SYNTAX
1373 Privoxy-Regression-Test's configuration is embedded in
1374 Privoxy action files and loaded through Privoxy's web interface.
1376 It makes testing a Privoxy version running on a remote system easier
1377 and should prevent you from updating your tests without updating Privoxy's
1378 configuration accordingly.
1380 A client-header-action test section looks like this:
1382 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1383 # Expect Header = Referer: http://www.example.org/
1384 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1385 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1387 The example above causes Privoxy-Regression-Test to set
1388 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1389 and to expect it to be modified to
1390 B<Referer: http://www.example.org/>.
1392 When testing this section, Privoxy-Regression-Test will set the header
1393 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1394 causing the B<privoxy-control> tagger to create the tag
1395 B<client-header-filter{hide-tor-exit-notation}> which will finally
1396 cause Privoxy to enable the action section.
1398 Note that the actions itself are only used by Privoxy,
1399 Privoxy-Regression-Test ignores them and will be happy
1400 as long as the expectations are satisfied.
1402 A fetch test looks like this:
1404 # Fetch Test = http://p.p/user-manual
1405 # Expect Status Code = 302
1407 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1408 and to expect a response with the HTTP status code B<302>. Obviously that's
1409 not a very thorough test and mainly useful to get some code coverage
1410 for Valgrind or to verify that the templates are installed correctly.
1412 If you want to test CGI pages that require a trusted
1413 referer, you can use:
1415 # Trusted CGI Request = http://p.p/edit-actions
1417 It works like ordinary fetch tests, but sets the referer
1418 header to a trusted value.
1420 If no explicit status code expectation is set, B<200> is used.
1422 Additionally all tests have test levels to let the user
1423 control which ones to execute (see I<OPTIONS> below).
1424 Test levels are either set with the B<Level> directive,
1425 or implicitly through the test type.
1427 Fetch tests default to level 6, tests for trusted
1428 CGI requests to level 3 and client-header-action tests
1433 B<--debug bitmask> Add the bitmask provided as integer
1434 to the debug settings.
1436 B<--fuzzer-feeding> Ignore some errors that would otherwise
1437 cause Privoxy-Regression-Test to abort the test because
1438 they shouldn't happen in normal operation. This option is
1439 intended to be used if Privoxy-Regression-Test is only
1440 used to feed a fuzzer in which case there's a high chance
1441 that Privoxy gets an invalid request and returns an error
1444 B<--help> Shows available command line options.
1446 B<--level level> Only execute tests with the specified B<level>.
1448 B<--loop count> Loop through the regression tests B<count> times.
1449 Useful to feed a fuzzer, or when doing stress tests with
1450 several Privoxy-Regression-Test instances running at the same
1453 B<--max-level max-level> Only execute tests with a B<level>
1454 below or equal to the numerical B<max-level>.
1456 B<--max-time max-time> Give Privoxy B<max-time> seconds
1457 to return data. Increasing the default may make sense when
1458 Privoxy is run through Valgrind, decreasing the default may
1459 make sense when Privoxy-Regression-Test is used to feed
1462 B<--min-level min-level> Only execute tests with a B<level>
1463 above or equal to the numerical B<min-level>.
1465 B<--privoxy-address proxy-address> Privoxy's listening address.
1466 If it's not set, the value of the environment variable http_proxy
1467 will be used. B<proxy-address> has to be specified in http_proxy
1470 B<--retries retries> Retry B<retries> times.
1472 B<--silent> Don't log succesful test runs.
1474 B<--version> Print version and exit.
1476 The second dash is optional, options can be shortened,
1477 as long as there are no ambiguities.
1479 =head1 PRIVOXY CONFIGURATION
1481 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1482 which aims to test all official client-header modifying actions
1483 and can be used to verify that the templates and the user manual
1484 files are installed correctly.
1486 To use it, it has to be copied in Privoxy's configuration
1487 directory, and afterwards referenced in Privoxy's configuration
1490 actionsfile regression-tests.action
1492 In general, its tests are supposed to work without changing
1493 any other action files, unless you already added lots of
1494 taggers yourself. If you are using taggers that cause problems,
1495 you might have to temporary disable them for Privoxy's CGI pages.
1497 Some of the regression tests rely on Privoxy features that
1498 may be disabled in your configuration. Tests with a level below
1499 7 are supposed to work with all Privoxy configurations (provided
1500 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1502 Tests with level 9 require Privoxy to deliver the User Manual,
1503 tests with level 12 require the CGI editor to be enabled.
1507 Expect the configuration file syntax to change with future releases.
1511 As Privoxy's B<show-request> page only shows client headers,
1512 Privoxy-Regression-Test can't use it to test Privoxy actions
1513 that modify server headers.
1515 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1516 control the actions to test, it currently only works with
1517 Privoxy 3.0.7 or later.
1519 At the moment Privoxy-Regression-Test fetches Privoxy's
1520 configuration page through I<curl>(1), therefore you have to
1521 have I<curl> installed, otherwise you won't be able to run
1522 Privoxy-Regression-Test in a meaningful way.
1530 Fabian Keil <fk@fabiankeil.de>