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.14 2008/03/27 19:13:08 fabiankeil 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 STICKY_ACTIONS_TEST => 5,
89 TRUSTED_CGI_REQUEST => 6,
93 sub init_our_variables () {
95 our $leading_log_time = LEADING_LOG_TIME;
96 our $leading_log_date = LEADING_LOG_DATE;
98 our $privoxy_cgi_url = PRIVOXY_CGI_URL;
100 our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
102 our $log_level = get_default_log_level();
106 sub get_default_log_level () {
110 $log_level |= LL_FILE_LOADING if DEBUG_LEVEL_FILE_LOADING;
111 $log_level |= LL_PAGE_FETCHING if DEBUG_LEVEL_PAGE_FETCHING;
112 $log_level |= LL_VERBOSE_FAILURE if DEBUG_LEVEL_VERBOSE_FAILURE;
113 $log_level |= LL_VERBOSE_SUCCESS if DEBUG_LEVEL_VERBOSE_SUCCESS;
114 $log_level |= LL_STATUS if DEBUG_LEVEL_STATUS;
116 # These are intended to be always on.
117 $log_level |= LL_SOFT_ERROR;
118 $log_level |= LL_ERROR;
123 ############################################################################
125 # File loading functions
127 ############################################################################
135 # Unescape brackets and dots
136 $tag =~ s@\\(?=[{}().+])@@g;
138 # log_message("Parsed tag: " . $tag);
140 check_for_forbidden_characters($tag);
145 sub check_for_forbidden_characters ($) {
147 my $tag = shift; # XXX: also used to check values though.
148 my $allowed = '[-=\dA-Za-z~{}:.\/();\s,+@"_%\?&*^]';
150 unless ($tag =~ m/^$allowed*$/) {
151 my $forbidden = $tag;
152 $forbidden =~ s@^$allowed*(.).*@$1@;
154 l(LL_ERROR, "'" . $tag . "' contains character '" . $forbidden. "' which is unacceptable.");
158 sub load_regressions_tests () {
160 our $privoxy_cgi_url;
166 $curl_url .= $privoxy_cgi_url;
167 $curl_url .= 'show-status';
169 l(LL_STATUS, "Asking Privoxy for the number of action files available ...");
171 foreach (@{get_cgi_page_or_else($curl_url)}) {
174 if (/<td>(.*?)<\/td><td class=\"buttons\"><a href=\"\/show-status\?file=actions&index=(\d+)\">/) {
176 my $url = $privoxy_cgi_url . 'show-status?file=actions&index=' . $2;
177 $actionfiles[$file_number++] = $url;
179 } elsif (m@config\.html#.*\">([^<]*)</a>\s+(.*)<br>@) {
181 my $directive = $1 . " " . $2;
182 push (@privoxy_config, $directive);
186 l(LL_FILE_LOADING, "Recognized " . @actionfiles . " actions files");
188 load_action_files(\@actionfiles);
191 sub token_starts_new_test ($) {
194 my @new_test_directives = ('set header', 'fetch test',
195 'trusted cgi request', 'request header', 'method test',
196 'blocked url', 'url');
198 foreach my $new_test_directive (@new_test_directives) {
199 return 1 if $new_test_directive eq $token;
207 my ($token, $value) = (undef, undef);
209 # Remove leading and trailing white space.
213 # Reverse HTML-encoding
214 # XXX: Seriously imcomplete.
219 if (/^\#\s*([^=:]*?)\s*[=]\s*(.+?)\s*$/) {
224 $token =~ s@\s\s+@ @g;
225 $token =~ tr/[A-Z]/[a-z]/;
227 } elsif (/^TAG\s*:(.*)$/) {
234 return ($token, $value);
237 sub enlist_new_test ($$$$$$) {
239 my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
242 if ($token eq 'set header') {
244 l(LL_FILE_LOADING, "Header to set: " . $value);
245 $type = CLIENT_HEADER_TEST;
247 } elsif ($token eq 'request header') {
249 l(LL_FILE_LOADING, "Header to request: " . $value);
250 $type = SERVER_HEADER_TEST;
251 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
253 } elsif ($token eq 'trusted cgi request') {
255 l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
256 $type = TRUSTED_CGI_REQUEST;
257 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
259 } elsif ($token eq 'fetch test') {
261 l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
262 $type = DUMB_FETCH_TEST;
263 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
265 } elsif ($token eq 'method test') {
267 l(LL_FILE_LOADING, "Method to test: " . $value);
269 $$regression_tests[$si][$ri]{'expected-status-code'} = 200;
271 } elsif ($token eq 'blocked url') {
273 l(LL_FILE_LOADING, "URL to block-test: " . $value);
276 } elsif ($token eq 'url') {
278 l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
279 $type = STICKY_ACTIONS_TEST;
283 die "Incomplete '" . $token . "' support detected.";
287 $$regression_tests[$si][$ri]{'type'} = $type;
288 $$regression_tests[$si][$ri]{'level'} = $type;
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;
323 my $sticky_actions = undef;
325 foreach (@{get_cgi_page_or_else($curl_url)}) {
330 if (/<h2>Contents of Actions File (.*?)</) {
334 next unless defined $actionfile;
338 my ($token, $value) = tokenize($_);
340 next unless defined $token;
342 # Load regression tests
344 if (token_starts_new_test($token)) {
346 # Beginning of new regression test.
349 enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
352 if ($token =~ /level\s+(\d+)/i) {
355 register_dependency($level, $value);
358 if ($si == -1 || $ri == -1) {
359 # No beginning of a test detected yet,
360 # so we don't care about any other test
365 if ($token eq 'expect header') {
367 l(LL_FILE_LOADING, "Detected expectation: " . $value);
368 $regression_tests[$si][$ri]{'expect-header'} = $value;
370 } elsif ($token eq 'tag') {
374 my $tag = parse_tag($value);
376 # We already checked in parse_tag() after filtering
379 l(LL_FILE_LOADING, "Detected TAG: " . $tag);
381 # Save tag for all tests in this section
383 $regression_tests[$si][$ri]{'tag'} = $tag;
389 } elsif ($token eq 'ignore' && $value =~ /Yes/i) {
391 l(LL_FILE_LOADING, "Ignoring section: " . test_content_as_string($regression_tests[$si][$ri]));
392 $regression_tests[$si][$ri]{'ignore'} = 1;
395 } elsif ($token eq 'expect status code') {
397 l(LL_FILE_LOADING, "Expecting status code: " . $value);
398 $regression_tests[$si][$ri]{'expected-status-code'} = $value;
400 } elsif ($token eq 'level') { # XXX: stupid name
402 $value =~ s@(\d+).*@$1@;
403 l(LL_FILE_LOADING, "Level: " . $value);
404 $regression_tests[$si][$ri]{'level'} = $value;
406 } elsif ($token eq 'method') {
408 l(LL_FILE_LOADING, "Method: " . $value);
409 $regression_tests[$si][$ri]{'method'} = $value;
411 } elsif ($token eq 'sticky actions') {
413 # Will be used by each following Sticky URL.
414 $sticky_actions = $value;
415 if ($sticky_actions =~ /{[^}]*\s/) {
417 "'Sticky Actions' with whitespace inside the " .
418 "action parameters are currently unsupported.");
421 } elsif ($token eq 'url') {
423 if (defined $sticky_actions) {
424 die "What" if defined ($regression_tests[$si][$ri]{'sticky-actions'});
425 l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
426 $regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
428 l(LL_FILE_LOADING, "Sticky URL without Sticky Actions");
433 # We don't use it, so we don't need
437 check_for_forbidden_characters($value) unless $no_checks;
438 check_for_forbidden_characters($token);
442 l(LL_FILE_LOADING, "Done loading " . $count . " regression tests."
443 . " Of which " . $ignored. " will be ignored)\n");
446 ############################################################################
448 # Regression test executing functions
450 ############################################################################
452 sub execute_regression_tests () {
454 our @regression_tests;
455 my $loops = get_cli_option('loops');
457 my $all_failures = 0;
458 my $all_successes = 0;
460 unless (@regression_tests) {
462 l(LL_STATUS, "No regression tests found.");
466 l(LL_STATUS, "Executing regression tests ...");
468 while ($loops-- > 0) {
475 for my $s (0 .. @regression_tests - 1) {
479 while (defined $regression_tests[$s][$r]) {
481 die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
482 die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
484 my $number = $regression_tests[$s][$r]{'number'};
486 if ($regression_tests[$s][$r]{'ignore'}
487 or level_is_unacceptable($regression_tests[$s][$r]{'level'})
488 or test_number_is_unacceptable($number)) {
494 my $result = execute_regression_test($regression_tests[$s][$r]);
496 log_result($regression_tests[$s][$r], $result, $tests);
498 $successes += $result;
504 $failures = $tests - $successes;
506 log_message("Executed " . $tests . " regression tests. " .
507 'Skipped ' . $skipped . '. ' .
508 $successes . " successes, " . $failures . " failures.");
510 $all_tests += $tests;
511 $all_failures += $failures;
512 $all_successes += $successes;
516 if (get_cli_option('loops') > 1) {
517 log_message("Total: Executed " . $all_tests . " regression tests. " .
518 $all_successes . " successes, " . $all_failures . " failures.");
522 sub level_is_unacceptable ($) {
524 return ((cli_option_is_set('level') and get_cli_option('level') != $level)
525 or ($level < get_cli_option('min-level'))
526 or ($level > get_cli_option('max-level'))
527 or dependency_unsatisfied($level)
531 sub test_number_is_unacceptable ($) {
532 my $test_number = shift;
533 return (cli_option_is_set('test-number')
534 and get_cli_option('test-number') != $test_number)
537 sub dependency_unsatisfied ($) {
542 my $dependency_problem = 0;
544 if (defined ($dependencies{$level}{'config line'})) {
546 my $dependency = $dependencies{$level}{'config line'};
547 $dependency_problem = 1;
549 foreach (@privoxy_config) {
551 $dependency_problem = 0 if (/$dependency/);
555 return $dependency_problem;
558 sub register_dependency ($$) {
561 my $dependency = shift;
564 if ($dependency =~ /config line\s+(.*)/) {
566 $dependencies{$level}{'config line'} = $1;
570 # XXX: somewhat misleading name
571 sub execute_regression_test ($) {
573 my $test_ref = shift;
574 my %test = %{$test_ref};
577 if ($test{'type'} == CLIENT_HEADER_TEST) {
579 $result = execute_client_header_regression_test($test_ref);
581 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
583 $result = execute_server_header_regression_test($test_ref);
585 } elsif ($test{'type'} == DUMB_FETCH_TEST
586 or $test{'type'} == TRUSTED_CGI_REQUEST) {
588 $result = execute_dumb_fetch_test($test_ref);
590 } elsif ($test{'type'} == METHOD_TEST) {
592 $result = execute_method_test($test_ref);
594 } elsif ($test{'type'} == BLOCK_TEST) {
596 $result = execute_block_test($test_ref);
598 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
600 $result = execute_sticky_actions_test($test_ref);
604 die "Unsupported test type detected: " . $test{'type'};
611 sub execute_method_test ($) {
613 my $test_ref = shift;
614 my %test = %{$test_ref};
617 my $method = $test{'data'};
619 my $curl_parameters = '';
620 my $expected_status_code = $test{'expected-status-code'};
622 $curl_parameters .= '--request ' . $method . ' ';
623 # Don't complain about the 'missing' body
624 $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
626 $curl_parameters .= PRIVOXY_CGI_URL;
628 $buffer_ref = get_page_with_curl($curl_parameters);
629 $status_code = get_status_code($buffer_ref);
631 return check_status_code_result($status_code, $expected_status_code);
634 sub execute_dumb_fetch_test ($) {
636 my $test_ref = shift;
637 my %test = %{$test_ref};
641 my $curl_parameters = '';
642 my $expected_status_code = $test{'expected-status-code'};
644 if (defined $test{method}) {
645 $curl_parameters .= '--request ' . $test{method} . ' ';
647 if ($test{type} == TRUSTED_CGI_REQUEST) {
648 $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
651 $curl_parameters .= $test{'data'};
653 $buffer_ref = get_page_with_curl($curl_parameters);
654 $status_code = get_status_code($buffer_ref);
656 return check_status_code_result($status_code, $expected_status_code);
659 sub execute_block_test ($) {
662 my $url = $test->{'data'};
663 my $final_results = get_final_results($url);
665 return defined $final_results->{'+block'};
668 sub execute_sticky_actions_test ($) {
671 my $url = $test->{'data'};
672 my $verified_actions = 0;
673 # XXX: splitting currently doesn't work for actions whose parameters contain spaces.
674 my @sticky_actions = split(/\s+/, $test->{'sticky-actions'});
675 my $final_results = get_final_results($url);
677 foreach my $sticky_action (@sticky_actions) {
678 if (defined $final_results->{$sticky_action}) {
681 }elsif ($sticky_action =~ /-.*\{/ and
682 not defined $final_results->{$sticky_action}) {
683 # Disabled multi actions aren't explicitly listed as
684 # disabled and thus have to be checked by verifying
685 # that they aren't enabled.
688 l(LL_VERBOSE_FAILURE,
689 "Ooops. '$sticky_action' is not among the final results.");
693 return $verified_actions == @sticky_actions;
696 sub get_final_results ($) {
699 my $curl_parameters = '';
700 my %final_results = ();
701 my $final_results_reached = 0;
703 die "Unacceptable characterss in $url" if $url =~ m@[\\'"]@;
704 # XXX: should be URL-encoded properly
711 $curl_parameters .= "'" . PRIVOXY_CGI_URL . 'show-url-info?url=' . $url . "'";
713 foreach (@{get_cgi_page_or_else($curl_parameters)}) {
715 $final_results_reached = 1 if (m@<h2>Final results:</h2>@);
717 next unless ($final_results_reached);
720 if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
724 if (defined $parameter) {
725 # In case the caller needs to check
726 # the action and it's parameter
727 $final_results{$action . $parameter} = 1;
729 # In case the action doesn't have paramters
730 # or the caller doesn't care for the parameter.
731 $final_results{$action} = 1;
735 return \%final_results;
738 sub check_status_code_result ($$) {
740 my $status_code = shift;
741 my $expected_status_code = shift;
744 if ($expected_status_code == $status_code) {
747 l(LL_VERBOSE_SUCCESS,
748 "Yay. We expected status code " . $expected_status_code . ", and received: " . $status_code . '.');
750 } elsif (cli_option_is_set('fuzzer-feeding') and $status_code == 123) {
752 l(LL_VERBOSE_FAILURE,
753 "Oh well. Status code lost while fuzzing. Can't check if it was " . $expected_status_code . '.');
757 l(LL_VERBOSE_FAILURE,
758 "Ooops. We expected status code " . $expected_status_code . ", but received: " . $status_code . '.');
765 sub execute_client_header_regression_test ($) {
767 my $test_ref = shift;
771 $buffer_ref = get_show_request_with_curl($test_ref);
773 $header = get_header($buffer_ref, $test_ref);
775 return check_header_result($test_ref, $header);
778 sub execute_server_header_regression_test ($) {
780 my $test_ref = shift;
784 $buffer_ref = get_head_with_curl($test_ref);
786 $header = get_server_header($buffer_ref, $test_ref);
788 return check_header_result($test_ref, $header);
792 sub interpret_result ($) {
794 return $success ? "Success" : "Failure";
797 sub check_header_result ($$) {
799 my $test_ref = shift;
802 my %test = %{$test_ref};
803 my $expect_header = $test{'expect-header'};
806 $header =~ s@ @ @g if defined($header);
808 if ($expect_header eq 'NO CHANGE') {
810 if (defined($header) and $header eq $test{'data'}) {
816 $header = "REMOVAL" unless defined $header;
817 l(LL_VERBOSE_FAILURE,
818 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
821 } elsif ($expect_header eq 'REMOVAL') {
823 if (defined($header) and $header eq $test{'data'}) {
825 l(LL_VERBOSE_FAILURE,
826 "Ooops. Expected removal but: " . $header . " is still there.");
830 # XXX: Use more reliable check here and make sure
831 # the header has a different name.
836 } elsif ($expect_header eq 'SOME CHANGE') {
838 if (defined($header) and not $header eq $test{'data'}) {
844 $header = "REMOVAL" unless defined $header;
845 l(LL_VERBOSE_FAILURE,
846 "Ooops. Got: " . $header . " while expecting: SOME CHANGE");
852 if (defined($header) and $header eq $expect_header) {
858 $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
859 l(LL_VERBOSE_FAILURE,
860 "Ooops. Got: " . $header . " while expecting: " . $expect_header);
866 sub get_header_name ($) {
870 $header =~ s@(.*?: ).*@$1@;
875 sub get_header ($$) {
877 our $filtered_request = '';
879 my $buffer_ref = shift;
880 my $test_ref = shift;
882 my %test = %{$test_ref};
883 my @buffer = @{$buffer_ref};
885 my $expect_header = $test{'expect-header'};
888 my $processed_request_reached = 0;
890 my $processed_request = '';
894 if ($expect_header eq 'REMOVAL'
895 or $expect_header eq 'NO CHANGE'
896 or $expect_header eq 'SOME CHANGE') {
898 $expect_header = $test{'data'};
902 $header_to_get = get_header_name($expect_header);
906 # Skip everything before the Processed request
907 if (/Processed Request/) {
908 $processed_request_reached = 1;
911 next unless $processed_request_reached;
913 # End loop after the Processed request
916 # Ditch tags and leading/trailing white space.
920 $filtered_request .= "\n" . $_;
922 if (/^$header_to_get/) {
932 sub get_server_header ($$) {
934 my $buffer_ref = shift;
935 my $test_ref = shift;
937 my %test = %{$test_ref};
938 my @buffer = @{$buffer_ref};
940 my $expect_header = $test{'expect-header'};
944 if ($expect_header eq 'REMOVAL'
945 or $expect_header eq 'NO CHANGE'
946 or $expect_header eq 'SOME CHANGE') {
948 $expect_header = $test{'data'};
952 $header_to_get = get_header_name($expect_header);
956 # XXX: should probably verify that the request
957 # was actually answered by Fellatio.
958 if (/^$header_to_get/) {
960 $header =~ s@\s*$@@g;
968 sub get_status_code ($) {
970 my $buffer_ref = shift;
971 my @buffer = @{$buffer_ref};
975 if (/^HTTP\/\d\.\d (\d{3})/) {
981 return '123' if cli_option_is_set('fuzzer-feeding');
983 l(LL_ERROR, 'Unexpected buffer line: "' . $_ . '"');
988 sub get_test_keys () {
989 return ('tag', 'data', 'expect-header', 'ignore');
993 sub test_content_as_string ($) {
995 my $test_ref = shift;
996 my %test = %{$test_ref};
1000 foreach my $key (get_test_keys()) {
1001 $test{$key} = 'Not set' unless (defined $test{$key});
1004 $s .= 'Tag: ' . $test{'tag'};
1006 $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
1008 $s .= 'Expected header: ' . $test{'expect-header'};
1010 $s .= 'Ignore: ' . $test{'ignore'};
1015 ############################################################################
1017 # HTTP fetch functions
1019 ############################################################################
1021 sub check_for_curl () {
1023 l(LL_ERROR, "No curl found.") unless (`which $curl`);
1026 sub get_cgi_page_or_else ($) {
1028 my $cgi_url = shift;
1029 my $content_ref = get_page_with_curl($cgi_url);
1030 my $status_code = get_status_code($content_ref);
1032 if (200 != $status_code) {
1034 my $log_message = "Failed to fetch Privoxy CGI Page. " .
1035 "Received status code ". $status_code .
1036 " while only 200 is acceptable.";
1038 if (cli_option_is_set('fuzzer-feeding')) {
1040 $log_message .= " Ignored due to fuzzer feeding.";
1041 l(LL_SOFT_ERROR, $log_message)
1045 l(LL_ERROR, $log_message);
1050 return $content_ref;
1053 sub get_show_request_with_curl ($) {
1055 our $privoxy_cgi_url;
1056 my $test_ref = shift;
1057 my %test = %{$test_ref};
1059 my $curl_parameters = ' ';
1061 # Enable the action to test
1062 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1063 # The header to filter
1064 $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
1066 $curl_parameters .= ' ';
1067 $curl_parameters .= $privoxy_cgi_url;
1068 $curl_parameters .= 'show-request';
1070 return get_cgi_page_or_else($curl_parameters);
1074 sub get_head_with_curl ($) {
1076 our $fellatio_url = FELLATIO_URL;
1077 my $test_ref = shift;
1078 my %test = %{$test_ref};
1080 my $curl_parameters = ' ';
1082 # Enable the action to test
1083 $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
1084 # The header to filter
1085 $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
1086 $curl_parameters .= '--head ';
1088 $curl_parameters .= ' ';
1089 $curl_parameters .= $fellatio_url;
1091 return get_page_with_curl($curl_parameters);
1095 sub get_page_with_curl ($) {
1097 my $parameters = shift;
1099 my $curl_line = CURL;
1100 my $retries_left = get_cli_option('retries') + 1;
1103 if (cli_option_is_set('privoxy-address')) {
1104 $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
1107 # We want to see the HTTP status code
1108 $curl_line .= " --include ";
1109 # Let Privoxy emit two log messages less.
1110 $curl_line .= ' -H \'Proxy-Connection:\' ' unless $parameters =~ /Proxy-Connection:/;
1111 $curl_line .= ' -H \'Connection: close\' ' unless $parameters =~ /Connection:/;
1112 # We don't care about fetch statistic.
1113 $curl_line .= " -s ";
1114 # We do care about the failure reason if any.
1115 $curl_line .= " -S ";
1116 # We want to advertise ourselves
1117 $curl_line .= " --user-agent '" . PRT_VERSION . "' ";
1118 # We aren't too patient
1119 $curl_line .= " --max-time '" . get_cli_option('max-time') . "' ";
1121 $curl_line .= $parameters;
1122 # XXX: still necessary?
1123 $curl_line .= ' 2>&1';
1125 l(LL_PAGE_FETCHING, "Executing: " . $curl_line);
1128 @buffer = `$curl_line`;
1131 $failure_reason = array_as_string(\@buffer);
1132 chomp $failure_reason;
1133 l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
1135 } while ($? && --$retries_left);
1137 unless ($retries_left) {
1139 "Running curl failed " . get_cli_option('retries') .
1140 " times in a row. Last error: '" . $failure_reason . "'.");
1147 ############################################################################
1151 ############################################################################
1153 sub array_as_string ($) {
1154 my $array_ref = shift;
1157 foreach (@{$array_ref}) {
1166 my $test_ref = shift;
1167 log_message('Test is:' . test_content_as_string($test_ref));
1173 my $this_level = shift;
1174 my $message = shift;
1176 return unless ($log_level & $this_level);
1178 if (LL_ERROR & $this_level) {
1179 $message = 'Oh noes. ' . $message . ' Fatal error. Exiting.';
1182 log_message($message);
1184 if (LL_ERROR & $this_level) {
1189 sub log_message ($) {
1191 my $message = shift;
1195 our $leading_log_date;
1196 our $leading_log_time;
1198 my $time_stamp = '';
1199 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime time;
1201 if ($leading_log_date || $leading_log_time) {
1203 if ($leading_log_date) {
1206 $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
1209 if ($leading_log_time) {
1210 $time_stamp .= ' ' if $leading_log_date;
1211 $time_stamp.= sprintf("%.2i:%.2i:%.2i", $hour, $min, $sec);
1214 $message = $time_stamp . ": " . $message;
1218 printf(STDERR "%s\n", $message);
1222 sub log_result ($$) {
1224 our $verbose_test_description;
1225 our $filtered_request;
1227 my $test_ref = shift;
1231 my %test = %{$test_ref};
1234 $message .= interpret_result($result);
1235 $message .= " for test ";
1236 $message .= $number;
1238 $message .= $test{'number'};
1240 $message .= $test{'section-id'};
1242 $message .= $test{'regression-test-id'};
1245 if ($verbose_test_description) {
1247 if ($test{'type'} == CLIENT_HEADER_TEST) {
1249 $message .= ' Header ';
1250 $message .= quote($test{'data'});
1251 $message .= ' and tag ';
1252 $message .= quote($test{'tag'});
1254 } elsif ($test{'type'} == SERVER_HEADER_TEST) {
1256 $message .= ' Request Header ';
1257 $message .= quote($test{'data'});
1258 $message .= ' and tag ';
1259 $message .= quote($test{'tag'});
1261 } elsif ($test{'type'} == DUMB_FETCH_TEST) {
1263 $message .= ' URL ';
1264 $message .= quote($test{'data'});
1265 $message .= ' and expected status code ';
1266 $message .= quote($test{'expected-status-code'});
1268 } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
1270 $message .= ' CGI URL ';
1271 $message .= quote($test{'data'});
1272 $message .= ' and expected status code ';
1273 $message .= quote($test{'expected-status-code'});
1275 } elsif ($test{'type'} == METHOD_TEST) {
1277 $message .= ' HTTP method ';
1278 $message .= quote($test{'data'});
1279 $message .= ' and expected status code ';
1280 $message .= quote($test{'expected-status-code'});
1282 } elsif ($test{'type'} == BLOCK_TEST) {
1284 $message .= ' Supposedly-blocked URL: ';
1285 $message .= quote($test{'data'});
1287 } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
1289 $message .= ' Sticky Actions: ';
1290 $message .= quote($test{'sticky-actions'});
1291 $message .= ' and URL: ';
1292 $message .= quote($test{'data'});
1296 die "Incomplete support for test type " . $test{'type'} . " detected.";
1301 log_message($message) unless ($result && cli_option_is_set('silent'));
1306 return '\'' . $s . '\'';
1309 sub print_version () {
1310 printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
1321 Options and their default values if they have any:
1322 [--debug $cli_options{'debug'}]
1326 [--loops $cli_options{'loops'}]
1327 [--max-level $cli_options{'max-level'}]
1328 [--max-time $cli_options{'max-time'}]
1329 [--min-level $cli_options{'min-level'}]
1331 [--retries $cli_options{'retries'}]
1334 see "perldoc $0" for more information
1340 sub init_cli_options () {
1345 $cli_options{'min-level'} = CLI_MIN_LEVEL;
1346 $cli_options{'max-level'} = CLI_MAX_LEVEL;
1347 $cli_options{'debug'} = $log_level;
1348 $cli_options{'loops'} = CLI_LOOPS;
1349 $cli_options{'max-time'} = CLI_MAX_TIME;
1350 $cli_options{'retries'} = CLI_RETRIES;
1353 sub parse_cli_options () {
1361 'debug=s' => \$cli_options{'debug'},
1362 'help' => sub { help },
1363 'silent' => \$cli_options{'silent'},
1364 'min-level=s' => \$cli_options{'min-level'},
1365 'max-level=s' => \$cli_options{'max-level'},
1366 'privoxy-address=s' => \$cli_options{'privoxy-address'},
1367 'level=s' => \$cli_options{'level'},
1368 'loops=s' => \$cli_options{'loops'},
1369 'test-number=s' => \$cli_options{'test-number'},
1370 'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
1371 'retries=s' => \$cli_options{'retries'},
1372 'max-time=s' => \$cli_options{'max-time'},
1373 'version' => sub { print_version && exit(0) }
1375 $log_level |= $cli_options{'debug'};
1378 sub cli_option_is_set ($) {
1381 my $cli_option = shift;
1383 return defined $cli_options{$cli_option};
1386 sub get_cli_option ($) {
1389 my $cli_option = shift;
1391 die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
1393 return $cli_options{$cli_option};
1398 init_our_variables();
1399 parse_cli_options();
1401 load_regressions_tests();
1402 execute_regression_tests();
1409 B<privoxy-regression-test> - A regression test "framework" for Privoxy.
1413 B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
1414 [B<--level level>] [B<--loops count>] [B<--max-level max-level>]
1415 [B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
1416 [B<--retries retries>] [B<--silent>] [B<--version>]
1420 Privoxy-Regression-Test is supposed to one day become
1421 a regression test suite for Privoxy. It's not quite there
1422 yet, however, and can currently only test header actions,
1423 check the returned status code for requests to arbitrary
1424 URLs and verify which actions are applied to them.
1426 Client header actions are tested by requesting
1427 B<http://p.p/show-request> and checking whether
1428 or not Privoxy modified the original request as expected.
1430 The original request contains both the header the action-to-be-tested
1431 acts upon and an additional tagger-triggering header that enables
1434 Applied actions are checked through B<http://p.p/show-url-info>.
1436 =head1 CONFIGURATION FILE SYNTAX
1438 Privoxy-Regression-Test's configuration is embedded in
1439 Privoxy action files and loaded through Privoxy's web interface.
1441 It makes testing a Privoxy version running on a remote system easier
1442 and should prevent you from updating your tests without updating Privoxy's
1443 configuration accordingly.
1445 A client-header-action test section looks like this:
1447 # Set Header = Referer: http://www.example.org.zwiebelsuppe.exit/
1448 # Expect Header = Referer: http://www.example.org/
1449 {+client-header-filter{hide-tor-exit-notation} -hide-referer}
1450 TAG:^client-header-filter\{hide-tor-exit-notation\}$
1452 The example above causes Privoxy-Regression-Test to set
1453 the header B<Referer: http://www.example.org.zwiebelsuppe.exit/>
1454 and to expect it to be modified to
1455 B<Referer: http://www.example.org/>.
1457 When testing this section, Privoxy-Regression-Test will set the header
1458 B<X-Privoxy-Control: client-header-filter{hide-tor-exit-notation}>
1459 causing the B<privoxy-control> tagger to create the tag
1460 B<client-header-filter{hide-tor-exit-notation}> which will finally
1461 cause Privoxy to enable the action section.
1463 Note that the actions itself are only used by Privoxy,
1464 Privoxy-Regression-Test ignores them and will be happy
1465 as long as the expectations are satisfied.
1467 A fetch test looks like this:
1469 # Fetch Test = http://p.p/user-manual
1470 # Expect Status Code = 302
1472 It tells Privoxy-Regression-Test to request B<http://p.p/user-manual>
1473 and to expect a response with the HTTP status code B<302>. Obviously that's
1474 not a very thorough test and mainly useful to get some code coverage
1475 for Valgrind or to verify that the templates are installed correctly.
1477 If you want to test CGI pages that require a trusted
1478 referer, you can use:
1480 # Trusted CGI Request = http://p.p/edit-actions
1482 It works like ordinary fetch tests, but sets the referer
1483 header to a trusted value.
1485 If no explicit status code expectation is set, B<200> is used.
1487 To verify that a URL is blocked, use:
1489 # Blocked URL = http://www.example.com/blocked
1491 To verify that a specific set of actions is applied to an URL, use:
1493 # Sticky Actions = +block{foo} +handle-as-empty-document -handle-as-image
1494 # URL = http://www.example.org/my-first-url
1496 The sticky actions will be checked for all URLs below it
1497 until the next sticky actions directive.
1501 All tests have test levels to let the user
1502 control which ones to execute (see I<OPTIONS> below).
1503 Test levels are either set with the B<Level> directive,
1504 or implicitly through the test type.
1506 Block tests default to level 7, fetch tests to level 6,
1507 "Sticky Actions" tests default to level 5, tests for trusted CGI
1508 requests to level 3 and client-header-action tests to level 1.
1512 B<--debug bitmask> Add the bitmask provided as integer
1513 to the debug settings.
1515 B<--fuzzer-feeding> Ignore some errors that would otherwise
1516 cause Privoxy-Regression-Test to abort the test because
1517 they shouldn't happen in normal operation. This option is
1518 intended to be used if Privoxy-Regression-Test is only
1519 used to feed a fuzzer in which case there's a high chance
1520 that Privoxy gets an invalid request and returns an error
1523 B<--help> Shows available command line options.
1525 B<--level level> Only execute tests with the specified B<level>.
1527 B<--loop count> Loop through the regression tests B<count> times.
1528 Useful to feed a fuzzer, or when doing stress tests with
1529 several Privoxy-Regression-Test instances running at the same
1532 B<--max-level max-level> Only execute tests with a B<level>
1533 below or equal to the numerical B<max-level>.
1535 B<--max-time max-time> Give Privoxy B<max-time> seconds
1536 to return data. Increasing the default may make sense when
1537 Privoxy is run through Valgrind, decreasing the default may
1538 make sense when Privoxy-Regression-Test is used to feed
1541 B<--min-level min-level> Only execute tests with a B<level>
1542 above or equal to the numerical B<min-level>.
1544 B<--privoxy-address proxy-address> Privoxy's listening address.
1545 If it's not set, the value of the environment variable http_proxy
1546 will be used. B<proxy-address> has to be specified in http_proxy
1549 B<--retries retries> Retry B<retries> times.
1551 B<--silent> Don't log succesful test runs.
1553 B<--version> Print version and exit.
1555 The second dash is optional, options can be shortened,
1556 as long as there are no ambiguities.
1558 =head1 PRIVOXY CONFIGURATION
1560 Privoxy-Regression-Test is shipped with B<regression-tests.action>
1561 which aims to test all official client-header modifying actions
1562 and can be used to verify that the templates and the user manual
1563 files are installed correctly.
1565 To use it, it has to be copied in Privoxy's configuration
1566 directory, and afterwards referenced in Privoxy's configuration
1569 actionsfile regression-tests.action
1571 In general, its tests are supposed to work without changing
1572 any other action files, unless you already added lots of
1573 taggers yourself. If you are using taggers that cause problems,
1574 you might have to temporary disable them for Privoxy's CGI pages.
1576 Some of the regression tests rely on Privoxy features that
1577 may be disabled in your configuration. Tests with a level below
1578 7 are supposed to work with all Privoxy configurations (provided
1579 you didn't build with FEATURE_GRACEFUL_TERMINATION).
1581 Tests with level 9 require Privoxy to deliver the User Manual,
1582 tests with level 12 require the CGI editor to be enabled.
1586 Expect the configuration file syntax to change with future releases.
1590 As Privoxy's B<show-request> page only shows client headers,
1591 Privoxy-Regression-Test can't use it to test Privoxy actions
1592 that modify server headers.
1594 As Privoxy-Regression-Test relies on Privoxy's tag feature to
1595 control the actions to test, it currently only works with
1596 Privoxy 3.0.7 or later.
1598 At the moment Privoxy-Regression-Test fetches Privoxy's
1599 configuration page through I<curl>(1), therefore you have to
1600 have I<curl> installed, otherwise you won't be able to run
1601 Privoxy-Regression-Test in a meaningful way.
1609 Fabian Keil <fk@fabiankeil.de>