# A regression test "framework" for Privoxy. For documentation see:
# perldoc privoxy-regression-test.pl
#
-# $Id: privoxy-regression-test.pl,v 1.136 2008/03/26 12:38:36 fk Exp $
+# $Id: privoxy-regression-test.pl,v 1.161 2008/10/25 15:44:26 fk Exp $
#
# Wish list:
#
# - Update documentation
# - Validate HTTP times.
-# - Understand default.action.master comment syntax
-# and verify that we actually block and unblock what
-# the comments claim we do.
# - Implement a HTTP_VERSION directive or allow to
# specify whole request lines.
# - Support filter regression tests.
-# - Add option to fork regression tests and run them in parallel,
-# possibly optional forever.
# - Document magic Expect Header values
# - Internal fuzz support?
#
use Getopt::Long;
use constant {
- PRT_VERSION => 'Privoxy-Regression-Test 0.2',
+ PRT_VERSION => 'Privoxy-Regression-Test 0.3',
- CURL => 'curl',
+ CURL => 'curl',
# CLI option defaults
- CLI_RETRIES => 1,
- CLI_LOOPS => 1,
- CLI_MAX_TIME => 5,
- CLI_MIN_LEVEL => 0,
- CLI_MAX_LEVEL => 25,
+ CLI_RETRIES => 1,
+ CLI_LOOPS => 1,
+ CLI_MAX_TIME => 5,
+ CLI_MIN_LEVEL => 0,
+ CLI_MAX_LEVEL => 25,
+ CLI_FORKS => 0,
PRIVOXY_CGI_URL => 'http://p.p/',
- FELLATIO_URL => 'http://10.0.0.1:8080/',
+ FELLATIO_URL => 'http://127.0.0.1:8080/',
LEADING_LOG_DATE => 1,
LEADING_LOG_TIME => 1,
our $privoxy_cgi_url;
our @privoxy_config;
+ our %privoxy_features;
my @actionfiles;
my $curl_url = '';
my $file_number = 0;
+ my $feature;
$curl_url .= $privoxy_cgi_url;
$curl_url .= 'show-status';
my $directive = $1 . " " . $2;
push (@privoxy_config, $directive);
+
+ } elsif (m@<td><code>([^<]*)</code></td>@) {
+
+ $feature = $1;
+
+ } elsif (m@<td> (Yes|No) </td>@) {
+
+ $privoxy_features{$feature} = $1 if defined $feature;
+ $feature = undef;
}
}
sub enlist_new_test ($$$$$$) {
my ($regression_tests, $token, $value, $si, $ri, $number) = @_;
+ my $type;
if ($token eq 'set header') {
l(LL_FILE_LOADING, "Header to set: " . $value);
- $$regression_tests[$si][$ri]{'type'} = CLIENT_HEADER_TEST;
- # Implicit default
- $$regression_tests[$si][$ri]{'level'} = CLIENT_HEADER_TEST;
+ $type = CLIENT_HEADER_TEST;
} elsif ($token eq 'request header') {
l(LL_FILE_LOADING, "Header to request: " . $value);
- $$regression_tests[$si][$ri]{'type'} = SERVER_HEADER_TEST;
- # Implicit default
+ $type = SERVER_HEADER_TEST;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
- $$regression_tests[$si][$ri]{'level'} = SERVER_HEADER_TEST;
} elsif ($token eq 'trusted cgi request') {
l(LL_FILE_LOADING, "CGI URL to test in a dumb way: " . $value);
- $$regression_tests[$si][$ri]{'type'} = TRUSTED_CGI_REQUEST;
- # Implicit default
+ $type = TRUSTED_CGI_REQUEST;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
- $$regression_tests[$si][$ri]{'level'} = TRUSTED_CGI_REQUEST;
} elsif ($token eq 'fetch test') {
l(LL_FILE_LOADING, "URL to test in a dumb way: " . $value);
- $$regression_tests[$si][$ri]{'type'} = DUMB_FETCH_TEST;
- # Implicit default
+ $type = DUMB_FETCH_TEST;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
- $$regression_tests[$si][$ri]{'level'} = DUMB_FETCH_TEST;
} elsif ($token eq 'method test') {
l(LL_FILE_LOADING, "Method to test: " . $value);
- $$regression_tests[$si][$ri]{'type'} = METHOD_TEST;
- # Implicit default
+ $type = METHOD_TEST;
$$regression_tests[$si][$ri]{'expected-status-code'} = 200;
- $$regression_tests[$si][$ri]{'level'} = METHOD_TEST;
} elsif ($token eq 'blocked url') {
l(LL_FILE_LOADING, "URL to block-test: " . $value);
- $$regression_tests[$si][$ri]{'type'} = BLOCK_TEST;
- # Implicit default
- $$regression_tests[$si][$ri]{'expected-status-code'} = 403;
- $$regression_tests[$si][$ri]{'level'} = BLOCK_TEST;
+ $type = BLOCK_TEST;
} elsif ($token eq 'url') {
l(LL_FILE_LOADING, "Sticky URL to test: " . $value);
- $$regression_tests[$si][$ri]{'type'} = STICKY_ACTIONS_TEST;
- # Implicit default
- $$regression_tests[$si][$ri]{'level'} = STICKY_ACTIONS_TEST;
- $$regression_tests[$si][$ri]{'url'} = '';
+ $type = STICKY_ACTIONS_TEST;
} else {
}
+ $$regression_tests[$si][$ri]{'type'} = $type;
+ $$regression_tests[$si][$ri]{'level'} = $type;
+
check_for_forbidden_characters($value);
$$regression_tests[$si][$ri]{'data'} = $value;
my $ignored = 0;
- l(LL_STATUS, "Loading regression tests from action file(s) delivered by Privoxy.");
+ l(LL_STATUS, "Gathering regression tests from " .
+ @actionfiles . " action file(s) delivered by Privoxy.");
for my $file_number (0 .. @actionfiles - 1) {
my $no_checks = 0;
chomp;
-
+
if (/<h2>Contents of Actions File (.*?)</) {
$actionfile = $1;
next;
my $level = $1;
register_dependency($level, $value);
}
+
+ if ($token eq 'sticky actions') {
+
+ # Will be used by each following Sticky URL.
+ $sticky_actions = $value;
+ if ($sticky_actions =~ /{[^}]*\s/) {
+ l(LL_ERROR,
+ "'Sticky Actions' with whitespace inside the " .
+ "action parameters are currently unsupported.");
+ }
+ }
if ($si == -1 || $ri == -1) {
# No beginning of a test detected yet,
l(LL_FILE_LOADING, "Method: " . $value);
$regression_tests[$si][$ri]{'method'} = $value;
- } elsif ($token eq 'sticky actions') {
-
- # Will be used by each following Sticky URL.
- $sticky_actions = $value;
- if ($sticky_actions =~ /{[^}]*\s/) {
- l(LL_ERROR,
- "'Sticky Actions' with whitespace inside the " .
- "action parameters are currently unsupported.");
- }
-
} elsif ($token eq 'url') {
if (defined $sticky_actions) {
- die "What" if defined ($regression_tests[$si][$ri]{'sticky-actions'});
+ die "WTF? Attempted to overwrite Sticky Actions"
+ if defined ($regression_tests[$si][$ri]{'sticky-actions'});
+
l(LL_FILE_LOADING, "Sticky actions: " . $sticky_actions);
$regression_tests[$si][$ri]{'sticky-actions'} = $sticky_actions;
} else {
- l(LL_FILE_LOADING, "Sticky URL without Sticky Actions");
+ l(LL_ERROR, "Sticky URL without Sticky Actions: $value");
}
} else {
my $level = shift;
our %dependencies;
our @privoxy_config;
+ our %privoxy_features;
+
my $dependency_problem = 0;
if (defined ($dependencies{$level}{'config line'})) {
foreach (@privoxy_config) {
$dependency_problem = 0 if (/$dependency/);
+ last;
+ }
+
+ } elsif (defined ($dependencies{$level}{'feature status'})) {
+
+ my $dependency = $dependencies{$level}{'feature status'};
+ my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
+
+ $dependency_problem = 1;
+
+ if (defined($privoxy_features{$feature})
+ and ($privoxy_features{$feature} eq $status))
+ {
+ $dependency_problem = 0;
}
}
if ($dependency =~ /config line\s+(.*)/) {
- $dependencies{$level}{'config line'} = $1;
+ $dependencies{$level}{'config line'} = $1;
+
+ } elsif ($dependency =~ /feature status\s+(.*)/) {
+
+ $dependencies{$level}{'feature status'} = $1;
+
}
}
my $expected_status_code = $test{'expected-status-code'};
$curl_parameters .= '--request ' . $method . ' ';
- # Don't complain in about the 'missing' body
+ # Don't complain about the 'missing' body
$curl_parameters .= '--head ' if ($method =~ /^HEAD$/i);
$curl_parameters .= PRIVOXY_CGI_URL;
my %final_results = ();
my $final_results_reached = 0;
- die "Unacceptable characterss in $url" if $url =~ m@[\\'"]@;
+ die "Unacceptable characters in $url" if $url =~ m@[\\'"]@;
# XXX: should be URL-encoded properly
$url =~ s@%@%25@g;
$url =~ s@\s@%20@g;
$url =~ s@:@%3A@g;
$url =~ s@/@%2F@g;
- $curl_parameters .= "'" . PRIVOXY_CGI_URL . 'show-url-info?url=' . $url . "'";
+ $curl_parameters .= quote(PRIVOXY_CGI_URL . 'show-url-info?url=' . $url);
foreach (@{get_cgi_page_or_else($curl_parameters)}) {
if (defined $parameter) {
# In case the caller needs to check
- # the action and it's parameter
+ # the action and its parameter
$final_results{$action . $parameter} = 1;
}
- # In case the action doesn't have paramters
+ # In case the action doesn't have parameters
# or the caller doesn't care for the parameter.
$final_results{$action} = 1;
}
my $expected_status_code = shift;
my $result = 0;
- if ($expected_status_code == $status_code) {
+ unless (defined $status_code) {
+
+ # XXX: should probably be caught earlier.
+ l(LL_VERBOSE_FAILURE,
+ "Ooops. We expected status code " . $expected_status_code . ", but didn't get any status code at all.");
+
+ } elsif ($expected_status_code == $status_code) {
$result = 1;
l(LL_VERBOSE_SUCCESS,
return check_header_result($test_ref, $header);
}
-
sub interpret_result ($) {
my $success = shift;
return $success ? "Success" : "Failure";
my $expect_header = $test{'expect-header'};
my $success = 0;
- $header =~ s@ @ @g if defined($header);
-
if ($expect_header eq 'NO CHANGE') {
if (defined($header) and $header eq $test{'data'}) {
} else {
- $header //= "REMOVAL";
+ $header = "REMOVAL" unless defined $header;
l(LL_VERBOSE_FAILURE,
"Ooops. Got: " . $header . " while expecting: " . $expect_header);
}
} else {
- $header //= "REMOVAL";
+ $header = "REMOVAL" unless defined $header;
l(LL_VERBOSE_FAILURE,
"Ooops. Got: " . $header . " while expecting: SOME CHANGE");
}
} else {
- $header //= "'No matching 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);
}
my $expect_header = $test{'expect-header'};
+ die "get_header called with no expect header" unless defined $expect_header;
+
my $line;
my $processed_request_reached = 0;
my $read_header = 0;
s@^\s*<.*?>@@g;
s@\s*$@@g;
+ # Decode characters we care about.
+ s@"@"@g;
+
$filtered_request .= "\n" . $_;
if (/^$header_to_get/) {
my $header;
my $header_to_get;
+ # XXX: Should be caught before starting to test.
+ l(LL_ERROR, "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') {
return $s;
}
+sub fuzz_header($) {
+ my $header = shift;
+ my $white_space = int(rand(2)) - 1 ? " " : "\t";
+
+ $white_space = $white_space x (1 + int(rand(5)));
+
+ # Only fuzz white space before the first quoted token.
+ # (Privoxy doesn't touch white space inside quoted tokens
+ # and modifying it would cause the tests to fail).
+ $header =~ s@(^[^"]*?)\s@$1$white_space@g;
+
+ return $header;
+}
+
############################################################################
#
# HTTP fetch functions
return $content_ref;
}
+# XXX: misleading name
sub get_show_request_with_curl ($) {
our $privoxy_cgi_url;
my %test = %{$test_ref};
my $curl_parameters = ' ';
+ 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'} . '\' ';
# The header to filter
- $curl_parameters .= '-H \'' . $test{'data'} . '\' ';
+ $curl_parameters .= '-H \'' . $header . '\' ';
$curl_parameters .= ' ';
$curl_parameters .= $privoxy_cgi_url;
return get_cgi_page_or_else($curl_parameters);
}
-
sub get_head_with_curl ($) {
our $fellatio_url = FELLATIO_URL;
return get_page_with_curl($curl_parameters);
}
-
sub get_page_with_curl ($) {
+ our $proxy;
+
my $parameters = shift;
my @buffer;
my $curl_line = CURL;
my $retries_left = get_cli_option('retries') + 1;
my $failure_reason;
- if (cli_option_is_set('privoxy-address')) {
- $curl_line .= ' --proxy ' . get_cli_option('privoxy-address');
- }
+ $curl_line .= ' --proxy ' . $proxy if (defined $proxy);
# We want to see the HTTP status code
$curl_line .= " --include ";
return $string;
}
-
sub show_test ($) {
my $test_ref = shift;
log_message('Test is:' . test_content_as_string($test_ref));
}
}
- log_message($message) unless ($result && cli_option_is_set('silent'));
+ log_message($message) if (!$result or cli_option_is_set('verbose'));
}
sub quote ($) {
Options and their default values if they have any:
[--debug $cli_options{'debug'}]
+ [--forks $cli_options{'forks'}]
+ [--fuzzer-address]
[--fuzzer-feeding]
[--help]
+ [--header-fuzzing]
[--level]
[--loops $cli_options{'loops'}]
[--max-level $cli_options{'max-level'}]
[--min-level $cli_options{'min-level'}]
[--privoxy-address]
[--retries $cli_options{'retries'}]
- [--silent]
+ [--test-number]
+ [--verbose]
[--version]
see "perldoc $0" for more information
EOF
$cli_options{'loops'} = CLI_LOOPS;
$cli_options{'max-time'} = CLI_MAX_TIME;
$cli_options{'retries'} = CLI_RETRIES;
+ $cli_options{'forks'} = CLI_FORKS;
}
sub parse_cli_options () {
GetOptions (
'debug=s' => \$cli_options{'debug'},
+ 'forks=s' => \$cli_options{'forks'},
'help' => sub { help },
- 'silent' => \$cli_options{'silent'},
+ 'header-fuzzing' => \$cli_options{'header-fuzzing'},
'min-level=s' => \$cli_options{'min-level'},
'max-level=s' => \$cli_options{'max-level'},
'privoxy-address=s' => \$cli_options{'privoxy-address'},
+ 'fuzzer-address=s' => \$cli_options{'fuzzer-address'},
'level=s' => \$cli_options{'level'},
'loops=s' => \$cli_options{'loops'},
'test-number=s' => \$cli_options{'test-number'},
'fuzzer-feeding' => \$cli_options{'fuzzer-feeding'},
'retries=s' => \$cli_options{'retries'},
'max-time=s' => \$cli_options{'max-time'},
+ 'verbose' => \$cli_options{'verbose'},
'version' => sub { print_version && exit(0) }
);
$log_level |= $cli_options{'debug'};
return $cli_options{$cli_option};
}
+sub init_proxy_settings($) {
+
+ my $choice = shift;
+ our $proxy = undef;
+
+ if (($choice eq 'fuzz-proxy') and cli_option_is_set('fuzzer-address')) {
+ $proxy = get_cli_option('fuzzer-address');
+ }
+
+ if ((not defined $proxy) or ($choice eq 'vanilla-proxy')) {
+
+ if (cli_option_is_set('privoxy-address')) {
+ $proxy .= get_cli_option('privoxy-address');
+ }
+
+ }
+}
+
+sub start_forks($) {
+ my $forks = shift;
+
+ l(LL_ERROR, "Invalid --fork value: " . $forks . ".") if ($forks < 0);
+
+ foreach my $fork (1 .. $forks) {
+ log_message("Starting fork $fork");
+ my $pid = fork();
+ if (defined $pid && !$pid) {
+ return;
+ }
+ }
+}
+
sub main () {
init_our_variables();
parse_cli_options();
check_for_curl();
+ init_proxy_settings('vanilla-proxy');
load_regressions_tests();
+ init_proxy_settings('fuzz-proxy');
+ start_forks(get_cli_option('forks')) if cli_option_is_set('forks');
execute_regression_tests();
}
=head1 SYNOPSIS
-B<privoxy-regression-test> [B<--debug bitmask>] [B<--fuzzer-feeding>] [B<--help>]
-[B<--level level>] [B<--loops count>] [B<--max-level max-level>]
-[B<--max-time max-time>] [B<--min-level min-level>] B<--privoxy-address proxy-address>
-[B<--retries retries>] [B<--silent>] [B<--version>]
+B<privoxy-regression-test> [B<--debug bitmask>] [B<--forks> forks]
+[B<--fuzzer-feeding>] [B<--fuzzer-feeding>] [B<--help>] [B<--level level>]
+[B<--loops count>] [B<--max-level max-level>] [B<--max-time max-time>]
+[B<--min-level min-level>] B<--privoxy-address proxy-address>
+[B<--retries retries>] [B<--test-number test-number>] [B<--verbose>]
+[B<--version>]
=head1 DESCRIPTION
B<--debug bitmask> Add the bitmask provided as integer
to the debug settings.
+B<--forks forks> Number of forks to start before executing
+the regression tests. This is mainly useful for stress-testing.
+
+B<--fuzzer-address> Listening address used when executing
+the regression tests. Useful to make sure that the requests
+to load the regression tests don't fail due to fuzzing.
+
B<--fuzzer-feeding> Ignore some errors that would otherwise
cause Privoxy-Regression-Test to abort the test because
they shouldn't happen in normal operation. This option is
B<--help> Shows available command line options.
+B<--header-fuzzing> Modifies linear white space in
+headers in a way that should not affect the test result.
+
B<--level level> Only execute tests with the specified B<level>.
B<--loop count> Loop through the regression tests B<count> times.
B<--retries retries> Retry B<retries> times.
-B<--silent> Don't log succesful test runs.
+B<--test-number test-number> Only run the test with the specified
+number.
+
+B<--verbose> Also log succesful test runs.
B<--version> Print version and exit.
projects / privoxy.git / blobdiff