# A regression test "framework" for Privoxy. For documentation see:
# perldoc privoxy-regression-test.pl
#
-# $Id: privoxy-regression-test.pl,v 1.44 2009/06/01 10:49:07 fabiankeil Exp $
+# $Id: privoxy-regression-test.pl,v 1.200 2010/01/03 13:46:38 fk Exp $
#
# Wish list:
#
use Getopt::Long;
use constant {
- PRT_VERSION => 'Privoxy-Regression-Test 0.3',
+ PRT_VERSION => 'Privoxy-Regression-Test 0.4',
CURL => 'curl',
STICKY_ACTIONS_TEST => 5,
TRUSTED_CGI_REQUEST => 6,
BLOCK_TEST => 7,
+ REDIRECT_TEST =>108,
};
sub init_our_variables () {
my $token = shift;
my @new_test_directives = ('set header', 'fetch test',
'trusted cgi request', 'request header', 'method test',
- 'blocked url', 'url');
+ 'blocked url', 'url', 'redirected url');
foreach my $new_test_directive (@new_test_directives) {
return 1 if $new_test_directive eq $token;
s@&@&@g;
# Tokenize
- if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)$/) {
+ if (/^\#\s*([^=:#]*?)\s*[=]\s*([^#]+)(?:#.*)?$/) {
$token = $1;
$value = $2;
my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
my $type;
+ my $executor;
if ($token eq 'set header') {
l(LL_FILE_LOADING, "Header to set: " . $value);
$type = CLIENT_HEADER_TEST;
+ $executor = \&execute_client_header_regression_test;
} elsif ($token eq 'request header') {
l(LL_FILE_LOADING, "Header to request: " . $value);
$type = SERVER_HEADER_TEST;
+ $executor = \&execute_server_header_regression_test;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
} elsif ($token eq 'trusted cgi request') {
l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
$type = TRUSTED_CGI_REQUEST;
+ $executor = \&execute_dumb_fetch_test;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
} elsif ($token eq 'fetch test') {
l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
$type = DUMB_FETCH_TEST;
+ $executor = \&execute_dumb_fetch_test;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
} elsif ($token eq 'method test') {
l(LL_FILE_LOADING, "Method to test: " . $value);
$type = METHOD_TEST;
+ $executor = \&execute_method_test;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
} elsif ($token eq 'blocked url') {
l(LL_FILE_LOADING, "URL to block-test: " . $value);
+ $executor = \&execute_block_test;
$type = BLOCK_TEST;
} elsif ($token eq 'url') {
l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
$type = STICKY_ACTIONS_TEST;
+ $executor = \&execute_sticky_actions_test;
+
+ } elsif ($token eq 'redirected url') {
+
+ l(LL_FILE_LOADING, "Redirected URL to test: " . $value);
+ $type = REDIRECT_TEST;
+ $executor = \&execute_redirect_test;
} else {
$$regression_tests[$si][$ri]{'type'} = $type;
$$regression_tests[$si][$ri]{'level'} = $type;
+ $$regression_tests[$si][$ri]{'executor'} = $executor;
check_for_forbidden_characters($value);
l(LL_FILE_LOADING, "Method: " . $value);
$regression_tests[$si][$ri]{'method'} = $value;
+ } elsif ($token eq 'redirect destination') {
+
+ l(LL_FILE_LOADING, "Redirect destination: " . $value);
+ $regression_tests[$si][$ri]{'redirect destination'} = $value;
+
} elsif ($token eq 'url') {
if (defined $sticky_actions) {
die "Section id mismatch" if ($s != $regression_tests[$s][$r]{'section-id'});
die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
+ die "Internal error. Test executor missing."
+ unless defined $regression_tests[$s][$r]{executor};
my $number = $regression_tests[$s][$r]{'number'};
- my $skip_reason = undef;
-
- if ($regression_tests[$s][$r]{'ignore'}) {
-
- $skip_reason = "Ignore flag is set";
-
- } elsif (cli_option_is_set('test-number')
- and get_cli_option('test-number') != $number) {
-
- $skip_reason = "Only executing test " . get_cli_option('test-number');
-
- } else {
-
- $skip_reason = level_is_unacceptable($regression_tests[$s][$r]{'level'});
- }
+ my $skip_reason = get_skip_reason($regression_tests[$s][$r]);
if (defined $skip_reason) {
} else {
- my $result = execute_regression_test($regression_tests[$s][$r]);
+ my $result = $regression_tests[$s][$r]{executor}($regression_tests[$s][$r]);
log_result($regression_tests[$s][$r], $result, $tests);
}
}
+sub get_skip_reason ($) {
+ my $test = shift;
+ my $skip_reason = undef;
+
+ if ($test->{'ignore'}) {
+
+ $skip_reason = "Ignore flag is set";
+
+ } elsif (cli_option_is_set('test-number') and
+ get_cli_option('test-number') != $test->{'number'}) {
+
+ $skip_reason = "Only executing test " . get_cli_option('test-number');
+
+ } else {
+
+ $skip_reason = level_is_unacceptable($test->{'level'});
+ }
+
+ return $skip_reason;
+}
+
sub level_is_unacceptable ($) {
my $level = shift;
my $min_level = get_cli_option('min-level');
}
}
- } elsif (defined ($dependencies{$level}{'feature status'})) {
+ }
+
+ if (defined ($dependencies{$level}{'feature status'})
+ and not defined $dependency_problem) {
my $dependency = $dependencies{$level}{'feature status'};
my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
}
}
-# XXX: somewhat misleading name
-sub execute_regression_test ($) {
-
- my $test_ref = shift;
- my %test = %{$test_ref};
- my $result = 0;
-
- if ($test{'type'} == CLIENT_HEADER_TEST) {
-
- $result = execute_client_header_regression_test($test_ref);
-
- } elsif ($test{'type'} == SERVER_HEADER_TEST) {
-
- $result = execute_server_header_regression_test($test_ref);
-
- } elsif ($test{'type'} == DUMB_FETCH_TEST
- or $test{'type'} == TRUSTED_CGI_REQUEST) {
-
- $result = execute_dumb_fetch_test($test_ref);
-
- } elsif ($test{'type'} == METHOD_TEST) {
-
- $result = execute_method_test($test_ref);
-
- } elsif ($test{'type'} == BLOCK_TEST) {
+sub execute_method_test ($) {
- $result = execute_block_test($test_ref);
+ my $test = shift;
+ my $buffer_ref;
+ my $status_code;
+ my $method = $test->{'data'};
- } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
+ my $curl_parameters = '';
+ my $expected_status_code = $test->{'expected-status-code'};
- $result = execute_sticky_actions_test($test_ref);
+ $curl_parameters .= '--request ' . $method . ' ';
+ # Don't complain about the 'missing' body
+ $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
- } else {
+ $curl_parameters .= PRIVOXY_CGI_URL;
- die "Unsupported test type detected: " . $test{'type'};
- }
+ $buffer_ref = get_page_with_curl($curl_parameters);
+ $status_code = get_status_code($buffer_ref);
- return $result;
+ return check_status_code_result($status_code, $expected_status_code);
}
-sub execute_method_test ($) {
+sub execute_redirect_test ($) {
- my $test_ref = shift;
- my %test = %{$test_ref};
+ my $test = shift;
my $buffer_ref;
my $status_code;
- my $method = $test{'data'};
my $curl_parameters = '';
- my $expected_status_code = $test{'expected-status-code'};
+ my $url = $test->{'data'};
+ my $redirect_destination;
+ my $expected_redirect_destination = $test->{'redirect destination'};
- $curl_parameters .= '--request ' . $method . ' ';
- # Don't complain about the 'missing' body
- $curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
+ # XXX: Check if a redirect actualy applies before doing the request.
+ # otherwise the test may hit a real server in failure cases.
- $curl_parameters .= PRIVOXY_CGI_URL;
+ $curl_parameters .= '--head ';
+
+ $curl_parameters .= quote($url);
$buffer_ref = get_page_with_curl($curl_parameters);
$status_code = get_status_code($buffer_ref);
- return check_status_code_result($status_code, $expected_status_code);
+ if ($status_code ne "302") {
+ l(LL_VERBOSE_FAILURE,
+ "Ooops. Expected redirect to: '" . $expected_redirect_destination
+ . "' but got a response with status code: " . $status_code);
+ return 0;
+ }
+ foreach (@{$buffer_ref}) {
+ if (/^Location: (.*)\r\n/) {
+ $redirect_destination = $1;
+ last;
+ }
+ }
+
+ my $success = ($redirect_destination eq $expected_redirect_destination);
+
+ unless ($success) {
+ l(LL_VERBOSE_FAILURE,
+ "Ooops. Expected redirect to: '" . $expected_redirect_destination
+ . "' but the redirect leads to: '" . $redirect_destination. "'");
+ }
+
+ return $success;
}
sub execute_dumb_fetch_test ($) {
- my $test_ref = shift;
- my %test = %{$test_ref};
+ my $test = shift;
my $buffer_ref;
my $status_code;
my $curl_parameters = '';
- my $expected_status_code = $test{'expected-status-code'};
+ my $expected_status_code = $test->{'expected-status-code'};
- if (defined $test{method}) {
- $curl_parameters .= '--request ' . $test{method} . ' ';
+ if (defined $test->{method}) {
+ $curl_parameters .= '--request ' . $test->{method} . ' ';
}
- if ($test{type} == TRUSTED_CGI_REQUEST) {
+ if ($test->{type} == TRUSTED_CGI_REQUEST) {
$curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
}
- $curl_parameters .= $test{'data'};
+ $curl_parameters .= $test->{'data'};
$buffer_ref = get_page_with_curl($curl_parameters);
$status_code = get_status_code($buffer_ref);
next unless ($final_results_reached);
last if (m@</td>@);
- if (m@<br>([-+])<a.*>([^>]*)</a>(?: (\{.*\}))?@) {
+ # Privoxy versions before 3.0.16 add a space
+ # between action name and parameters, therefore
+ # the " ?".
+ if (m@<br>([-+])<a.*>([^>]*)</a>(?: ?(\{.*\}))?@) {
my $action = $1.$2;
my $parameter = $3;
sub execute_client_header_regression_test ($) {
- my $test_ref = shift;
+ my $test = shift;
my $buffer_ref;
my $header;
- $buffer_ref = get_show_request_with_curl($test_ref);
+ $buffer_ref = get_show_request_with_curl($test);
- $header = get_header($buffer_ref, $test_ref);
+ $header = get_header($buffer_ref, $test);
- return check_header_result($test_ref, $header);
+ return check_header_result($test, $header);
}
sub execute_server_header_regression_test ($) {
- my $test_ref = shift;
+ my $test = shift;
my $buffer_ref;
my $header;
- $buffer_ref = get_head_with_curl($test_ref);
+ $buffer_ref = get_head_with_curl($test);
- $header = get_server_header($buffer_ref, $test_ref);
+ $header = get_server_header($buffer_ref, $test);
- return check_header_result($test_ref, $header);
+ return check_header_result($test, $header);
}
sub interpret_result ($) {
sub check_header_result ($$) {
- my $test_ref = shift;
+ my $test = shift;
my $header = shift;
- my %test = %{$test_ref};
- my $expect_header = $test{'expect-header'};
+ my $expect_header = $test->{'expect-header'};
my $success = 0;
if ($expect_header eq 'NO CHANGE') {
- if (defined($header) and $header eq $test{'data'}) {
+ if (defined($header) and $header eq $test->{'data'}) {
$success = 1;
} elsif ($expect_header eq 'REMOVAL') {
- if (defined($header) and $header eq $test{'data'}) {
+ if (defined($header) and $header eq $test->{'data'}) {
l(LL_VERBOSE_FAILURE,
"Ooops. Expected removal but: '" . $header . "' is still there.");
} elsif ($expect_header eq 'SOME CHANGE') {
- if (defined($header) and not $header eq $test{'data'}) {
+ if (defined($header) and not $header eq $test->{'data'}) {
$success = 1;
} else {
- $header = "'No matching header'" unless defined $header; # XXX: No header detected to be precise
+ $header = "No matching header" unless defined $header; # XXX: No header detected to be precise
l(LL_VERBOSE_FAILURE,
"Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
}
our $filtered_request = '';
my $buffer_ref = shift;
- my $test_ref = shift;
+ my $test = shift;
- my %test = %{$test_ref};
my @buffer = @{$buffer_ref};
- my $expect_header = $test{'expect-header'};
+ my $expect_header = $test->{'expect-header'};
die "get_header called with no expect header" unless defined $expect_header;
or $expect_header eq 'NO CHANGE'
or $expect_header eq 'SOME CHANGE') {
- $expect_header = $test{'data'};
+ $expect_header = $test->{'data'};
}
$header_to_get = get_header_name($expect_header);
sub get_server_header ($$) {
my $buffer_ref = shift;
- my $test_ref = shift;
+ my $test = shift;
- my %test = %{$test_ref};
my @buffer = @{$buffer_ref};
- my $expect_header = $test{'expect-header'};
+ my $expect_header = $test->{'expect-header'};
my $header;
my $header_to_get;
# XXX: Should be caught before starting to test.
- log_and_die("No expect header for test " . $test{'number'})
+ log_and_die("No expect header for test " . $test->{'number'})
unless defined $expect_header;
if ($expect_header eq 'REMOVAL'
or $expect_header eq 'NO CHANGE'
or $expect_header eq 'SOME CHANGE') {
- $expect_header = $test{'data'};
+ $expect_header = $test->{'data'};
}
$header_to_get = get_header_name($expect_header);
# XXX: incomplete
sub test_content_as_string ($) {
- my $test_ref = shift;
- my %test = %{$test_ref};
+ my $test = shift;
my $s = "\n\t";
foreach my $key (get_test_keys()) {
- $test{$key} = 'Not set' unless (defined $test{$key});
+ $test->{$key} = 'Not set' unless (defined $test->{$key});
}
- $s .= 'Tag: ' . $test{'tag'};
+ $s .= 'Tag: ' . $test->{'tag'};
$s .= "\n\t";
- $s .= 'Set header: ' . $test{'data'}; # XXX: adjust for other test types
+ $s .= 'Set header: ' . $test->{'data'}; # XXX: adjust for other test types
$s .= "\n\t";
- $s .= 'Expected header: ' . $test{'expect-header'};
+ $s .= 'Expected header: ' . $test->{'expect-header'};
$s .= "\n\t";
- $s .= 'Ignore: ' . $test{'ignore'};
+ $s .= 'Ignore: ' . $test->{'ignore'};
return $s;
}
#
############################################################################
-sub check_for_curl () {
- my $curl = CURL;
- log_and_die("No curl found.") unless (`which $curl`);
-}
-
sub get_cgi_page_or_else ($) {
my $cgi_url = shift;
sub get_show_request_with_curl ($) {
our $privoxy_cgi_url;
- my $test_ref = shift;
- my %test = %{$test_ref};
+ my $test = shift;
my $curl_parameters = ' ';
- my $header = $test{'data'};
+ my $header = $test->{'data'};
if (cli_option_is_set('header-fuzzing')) {
$header = fuzz_header($header);
}
# Enable the action to test
- $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
+ $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
# The header to filter
$curl_parameters .= '-H \'' . $header . '\' ';
sub get_head_with_curl ($) {
our $fellatio_url = FELLATIO_URL;
- my $test_ref = shift;
- my %test = %{$test_ref};
+ my $test = shift;
my $curl_parameters = ' ';
# Enable the action to test
- $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test{'tag'} . '\' ';
+ $curl_parameters .= '-H \'X-Privoxy-Control: ' . $test->{'tag'} . '\' ';
# The header to filter
- $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test{'data'} . '\' ';
+ $curl_parameters .= '-H \'X-Gimme-Head-With: ' . $test->{'data'} . '\' ';
$curl_parameters .= '--head ';
$curl_parameters .= ' ';
@buffer = `$curl_line`;
if ($?) {
+ log_and_die("Executing '$curl_line' failed.") unless @buffer;
$failure_reason = array_as_string(\@buffer);
chomp $failure_reason;
l(LL_SOFT_ERROR, "Fetch failure: '" . $failure_reason . $! ."'");
}
sub show_test ($) {
- my $test_ref = shift;
- log_message('Test is:' . test_content_as_string($test_ref));
+ my $test = shift;
+ log_message('Test is:' . test_content_as_string($test));
}
# Conditional log
our $verbose_test_description;
our $filtered_request;
- my $test_ref = shift;
+ my $test = shift;
my $result = shift;
my $number = shift;
- my %test = %{$test_ref};
my $message = '';
$message .= interpret_result($result);
$message .= " for test ";
$message .= $number;
$message .= '/';
- $message .= $test{'number'};
+ $message .= $test->{'number'};
$message .= '/';
- $message .= $test{'section-id'};
+ $message .= $test->{'section-id'};
$message .= '/';
- $message .= $test{'regression-test-id'};
+ $message .= $test->{'regression-test-id'};
$message .= '.';
if ($verbose_test_description) {
- if ($test{'type'} == CLIENT_HEADER_TEST) {
+ if ($test->{'type'} == CLIENT_HEADER_TEST) {
$message .= ' Header ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
$message .= ' and tag ';
- $message .= quote($test{'tag'});
+ $message .= quote($test->{'tag'});
- } elsif ($test{'type'} == SERVER_HEADER_TEST) {
+ } elsif ($test->{'type'} == SERVER_HEADER_TEST) {
$message .= ' Request Header ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
$message .= ' and tag ';
- $message .= quote($test{'tag'});
+ $message .= quote($test->{'tag'});
- } elsif ($test{'type'} == DUMB_FETCH_TEST) {
+ } elsif ($test->{'type'} == DUMB_FETCH_TEST) {
$message .= ' URL ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
$message .= ' and expected status code ';
- $message .= quote($test{'expected-status-code'});
+ $message .= quote($test->{'expected-status-code'});
- } elsif ($test{'type'} == TRUSTED_CGI_REQUEST) {
+ } elsif ($test->{'type'} == TRUSTED_CGI_REQUEST) {
$message .= ' CGI URL ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
$message .= ' and expected status code ';
- $message .= quote($test{'expected-status-code'});
+ $message .= quote($test->{'expected-status-code'});
- } elsif ($test{'type'} == METHOD_TEST) {
+ } elsif ($test->{'type'} == METHOD_TEST) {
$message .= ' HTTP method ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
$message .= ' and expected status code ';
- $message .= quote($test{'expected-status-code'});
+ $message .= quote($test->{'expected-status-code'});
- } elsif ($test{'type'} == BLOCK_TEST) {
+ } elsif ($test->{'type'} == BLOCK_TEST) {
$message .= ' Supposedly-blocked URL: ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
- } elsif ($test{'type'} == STICKY_ACTIONS_TEST) {
+ } elsif ($test->{'type'} == STICKY_ACTIONS_TEST) {
$message .= ' Sticky Actions: ';
- $message .= quote($test{'sticky-actions'});
+ $message .= quote($test->{'sticky-actions'});
$message .= ' and URL: ';
- $message .= quote($test{'data'});
+ $message .= quote($test->{'data'});
+
+ } elsif ($test->{'type'} == REDIRECT_TEST) {
+
+ $message .= ' Redirected URL: ';
+ $message .= quote($test->{'data'});
+ $message .= ' and redirect destination: ';
+ $message .= quote($test->{'redirect destination'});
} else {
- die "Incomplete support for test type " . $test{'type'} . " detected.";
+ die "Incomplete support for test type " . $test->{'type'} . " detected.";
}
}
'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
'header-fuzzing' => \$cli_options{'header-fuzzing'},
- 'help' => sub {help},
+ 'help' => \&help,
'level=s' => \$cli_options{'level'},
'loops=s' => \$cli_options{'loops'},
'max-level=s' => \$cli_options{'max-level'},
'test-number=s' => \$cli_options{'test-number'},
'verbose' => \$cli_options{'verbose'},
'version' => sub {print_version && exit(0)}
- );
+ ) or exit(1);
$log_level |= $cli_options{'debug'};
}
init_our_variables();
parse_cli_options();
- check_for_curl();
init_proxy_settings('vanilla-proxy');
load_regressions_tests();
init_proxy_settings('fuzz-proxy');
The sticky actions will be checked for all URLs below it
until the next sticky actions directive.
+To verify that requests for a URL get redirected, use:
+
+ # Redirected URL = http://www.example.com/redirect-me
+ # Redirect Destination = http://www.example.org/redirected
+
=head1 TEST LEVELS
All tests have test levels to let the user
Test levels are either set with the B<Level> directive,
or implicitly through the test type.
-Block tests default to level 7, fetch tests to level 6,
-"Sticky Actions" tests default to level 5, tests for trusted CGI
-requests to level 3 and client-header-action tests to level 1.
+Redirect tests default to level 108, block tests to level 7,
+fetch tests to level 6, "Sticky Actions" tests default to
+level 5, tests for trusted CGI requests to level 3 and
+client-header-action tests to level 1.
+
+The current redirect test level is above the default
+max-level value as failed tests will result in outgoing
+connections. Use the B<--max-level> option to run them
+as well.
=head1 OPTIONS
projects / privoxy.git / blobdiff