# A regression test "framework" for Privoxy. For documentation see:
# perldoc privoxy-regression-test.pl
#
-# $Id: privoxy-regression-test.pl,v 1.54 2009/10/01 15:05:26 fabiankeil Exp $
+# $Id: privoxy-regression-test.pl,v 1.72 2011/06/29 18:34:23 fabiankeil Exp $
#
# Wish list:
#
# - Document magic Expect Header values
# - Internal fuzz support?
#
-# Copyright (c) 2007-2009 Fabian Keil <fk@fabiankeil.de>
+# Copyright (c) 2007-2011 Fabian Keil <fk@fabiankeil.de>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
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 => 8,
+ REDIRECT_TEST =>108,
};
sub init_our_variables () {
our $leading_log_time = LEADING_LOG_TIME;
our $leading_log_date = LEADING_LOG_DATE;
-
our $privoxy_cgi_url = PRIVOXY_CGI_URL;
-
our $verbose_test_description = VERBOSE_TEST_DESCRIPTION;
-
our $log_level = get_default_log_level();
-
}
sub get_default_log_level () {
s@\s*$@@;
# Reverse HTML-encoding
- # XXX: Seriously imcomplete.
+ # XXX: Seriously incomplete.
s@"@"@g;
s@&@&@g;
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);
for my $file_number (0 .. @actionfiles - 1) {
- my $curl_url = ' "' . $actionfiles[$file_number] . '"';
+ my $curl_url = quote($actionfiles[$file_number]);
my $actionfile = undef;
my $sticky_actions = undef;
$ri++;
$count++;
enlist_new_test(\@regression_tests, $token, $value, $si, $ri, $count);
+ $no_checks = 1; # Already validated by enlist_new_test().
}
if ($token =~ /level\s+(\d+)/i) {
# We don't use it, so we don't need
$no_checks = 1;
+ l(LL_STATUS, "Enabling no_checks for $token") unless $no_checks;
+ }
+
+ # XXX: Necessary?
+ unless ($no_checks) {
+ check_for_forbidden_characters($value);
+ check_for_forbidden_characters($token);
}
- # XXX: Neccessary?
- check_for_forbidden_characters($value) unless $no_checks;
- check_for_forbidden_characters($token);
}
}
my $failures;
my $skipped = 0;
- for my $s (0 .. @regression_tests - 1) {
+ for (my $s = 0; $s < @regression_tests; $s++) {
my $r = 0;
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 = get_skip_reason($regression_tests[$s][$r]);
} 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);
} elsif ($level < $min_level) {
- $reason = "Level to low (" . $level . " < " . $min_level . ")";
+ $reason = "Level too low (" . $level . " < " . $min_level . ")";
} elsif ($level > $max_level) {
- $reason = "Level to high (" . $level . " > " . $max_level . ")";
+ $reason = "Level too high (" . $level . " > " . $max_level . ")";
} else {
}
}
-# XXX: somewhat misleading name
-sub execute_regression_test ($) {
-
- my $test = shift;
- my $type = $test->{'type'};
- my %test_subs = (
- (CLIENT_HEADER_TEST) => \&execute_client_header_regression_test,
- (SERVER_HEADER_TEST) => \&execute_server_header_regression_test,
- (DUMB_FETCH_TEST) => \&execute_dumb_fetch_test,
- (TRUSTED_CGI_REQUEST) => \&execute_dumb_fetch_test,
- (METHOD_TEST) => \&execute_method_test,
- (BLOCK_TEST) => \&execute_block_test,
- (STICKY_ACTIONS_TEST) => \&execute_sticky_actions_test,
- (REDIRECT_TEST) => \&execute_redirect_test);
-
- die "Unsupported test type detected: " . $type
- unless defined ($test_subs{$type});
-
- return $test_subs{$type}($test);
-}
-
sub execute_method_test ($) {
my $test = shift;
my $redirect_destination;
my $expected_redirect_destination = $test->{'redirect destination'};
- # XXX: Check if a redirect actualy applies before doing the request.
+ # XXX: Check if a redirect actually applies before doing the request.
# otherwise the test may hit a real server in failure cases.
$curl_parameters .= '--head ';
my $expected_status_code = $test->{'expected-status-code'};
if (defined $test->{method}) {
- $curl_parameters .= '--request ' . $test->{method} . ' ';
+ $curl_parameters .= quote('--request') . quote($test->{method}) . ' ';
}
if ($test->{type} == TRUSTED_CGI_REQUEST) {
- $curl_parameters .= '--referer ' . PRIVOXY_CGI_URL . ' ';
+ $curl_parameters .= quote('--referer ') . quote(PRIVOXY_CGI_URL) . ' ';
}
- $curl_parameters .= $test->{'data'};
+ $curl_parameters .= quote($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;
if ($expect_header eq 'NO CHANGE') {
- if (defined($header) and $header eq $test->{'data'}) {
-
- $success = 1;
-
- } else {
+ $success = (defined($header) and $header eq $test->{'data'});
+ unless ($success) {
$header = "REMOVAL" unless defined $header;
l(LL_VERBOSE_FAILURE,
"Ooops. Got: '" . $header . "' while expecting: '" . $expect_header . "'");
} elsif ($expect_header eq 'REMOVAL') {
- if (defined($header) and $header eq $test->{'data'}) {
+ # XXX: Use more reliable check here and make sure
+ # the header has a different name.
+ $success = not (defined($header) and $header eq $test->{'data'});
+ unless ($success) {
l(LL_VERBOSE_FAILURE,
"Ooops. Expected removal but: '" . $header . "' is still there.");
-
- } else {
-
- # XXX: Use more reliable check here and make sure
- # the header has a different name.
- $success = 1;
}
} elsif ($expect_header eq 'SOME CHANGE') {
- if (defined($header) and not $header eq $test->{'data'}) {
-
- $success = 1;
-
- } else {
+ $success = (defined($header) and $header ne $test->{'data'});
+ unless ($success) {
$header = "REMOVAL" unless defined $header;
l(LL_VERBOSE_FAILURE,
"Ooops. Got: '" . $header . "' while expecting: SOME CHANGE");
} else {
- if (defined($header) and $header eq $expect_header) {
-
- $success = 1;
-
- } else {
+ $success = (defined($header) and $header eq $expect_header);
+ unless ($success) {
$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 . "'");
if ($expect_header eq 'REMOVAL'
or $expect_header eq 'NO CHANGE'
- or $expect_header eq 'SOME CHANGE') {
+ or $expect_header eq 'SOME CHANGE') {
$expect_header = $test->{'data'};
}
if ($leading_log_date) {
$year += 1900;
$mon += 1;
- $time_stamp = sprintf("%i/%.2i/%.2i", $year, $mon, $mday);
+ $time_stamp = sprintf("%i-%.2i-%.2i", $year, $mon, $mday);
}
if ($leading_log_time) {
}
sub print_version () {
- printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
+ printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2011 Fabian Keil <fk@fabiankeil.de>' . "\n";
+}
+
+sub list_test_types () {
+ my %test_types = (
+ 'Client header test' => CLIENT_HEADER_TEST,
+ 'Server header test' => 2,
+ 'Dumb fetch test' => 3,
+ 'Method test' => 4,
+ 'Sticky action test' => 5,
+ 'Trusted CGI test' => 6,
+ 'Block test' => 7,
+ 'Redirect test' => 108,
+ );
+
+ print "\nThe supported test types and their default levels are:\n";
+ foreach my $test_type (sort { $test_types{$a} <=> $test_types{$b} } keys %test_types) {
+ printf " %-20s -> %3.d\n", $test_type, $test_types{$test_type};
+ }
}
sub help () {
[--test-number]
[--verbose]
[--version]
-see "perldoc $0" for more information
EOF
;
+
+ list_test_types();
+
+ print << " EOF"
+
+Try "perldoc $0" for more information
+ EOF
+ ;
+
exit(0);
}
'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'};
}
Test levels are either set with the B<Level> directive,
or implicitly through the test type.
-Redirect tests default to level 8, block tests to level 7,
+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
B<--debug bitmask> Add the bitmask provided as integer
B<--show-skipped-tests> Log skipped tests even if verbose mode is off.
-B<--verbose> Log succesful tests as well. By default only
+B<--verbose> Log successful tests as well. By default only
the failures are logged.
B<--version> Print version and exit.
projects / privoxy.git / blobdiff