# A regression test "framework" for Privoxy. For documentation see:
# perldoc privoxy-regression-test.pl
#
-# $Id: privoxy-regression-test.pl,v 1.154 2008/06/21 16:44:09 fk Exp $
+# $Id: privoxy-regression-test.pl,v 1.164 2009/02/23 09:40:24 fk Exp $
#
# Wish list:
#
# - 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?
#
-# Copyright (c) 2007-2008 Fabian Keil <fk@fabiankeil.de>
+# Copyright (c) 2007-2009 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.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,
+ # XXX: why limit at all.
+ CLI_MAX_LEVEL => 100,
+ CLI_FORKS => 0,
PRIVOXY_CGI_URL => 'http://p.p/',
FELLATIO_URL => 'http://127.0.0.1:8080/',
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;
}
}
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) {
die "Regression test id mismatch" if ($r != $regression_tests[$s][$r]{'regression-test-id'});
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'});
+ }
- if ($regression_tests[$s][$r]{'ignore'}
- or level_is_unacceptable($regression_tests[$s][$r]{'level'})
- or test_number_is_unacceptable($number)) {
+ if (defined $skip_reason) {
+ my $message = "Skipping test " . $number . ": " . $skip_reason . ".";
+ log_message($message) if cli_option_is_set('verbose');
$skipped++;
} else {
'Skipped ' . $skipped . '. ' .
$successes . " successes, " . $failures . " failures.");
- $all_tests += $tests;
- $all_failures += $failures;
+ $all_tests += $tests;
+ $all_failures += $failures;
$all_successes += $successes;
}
sub level_is_unacceptable ($) {
my $level = shift;
- return ((cli_option_is_set('level') and get_cli_option('level') != $level)
- or ($level < get_cli_option('min-level'))
- or ($level > get_cli_option('max-level'))
- or dependency_unsatisfied($level)
- );
-}
+ my $min_level = get_cli_option('min-level');
+ my $max_level = get_cli_option('max-level');
+ my $required_level = cli_option_is_set('level') ?
+ get_cli_option('level') : $level;
+ my $reason = undef;
+
+ if ($required_level != $level) {
+
+ $reason = "Level doesn't match (" . $level .
+ " != " . $required_level . ")"
+
+ } elsif ($level < $min_level) {
+
+ $reason = "Level to low (" . $level . " < " . $min_level . ")";
+
+ } elsif ($level > $max_level) {
+
+ $reason = "Level to high (" . $level . " > " . $max_level . ")";
+
+ } else {
+
+ $reason = dependency_unsatisfied($level);
+ }
-sub test_number_is_unacceptable ($) {
- my $test_number = shift;
- return (cli_option_is_set('test-number')
- and get_cli_option('test-number') != $test_number)
+ return $reason;
}
sub dependency_unsatisfied ($) {
my $level = shift;
our %dependencies;
our @privoxy_config;
- my $dependency_problem = 0;
+ our %privoxy_features;
+
+ my $dependency_problem = undef;
if (defined ($dependencies{$level}{'config line'})) {
my $dependency = $dependencies{$level}{'config line'};
- $dependency_problem = 1;
+ $dependency_problem = "depends on config line matching: '" . $dependency . "'";
foreach (@privoxy_config) {
- $dependency_problem = 0 if (/$dependency/);
+ $dependency_problem = undef if (/$dependency/);
+ last; # XXX: this looks ... interesting.
+ }
+
+ } elsif (defined ($dependencies{$level}{'feature status'})) {
+
+ my $dependency = $dependencies{$level}{'feature status'};
+ my ($feature, $status) = $dependency =~ /([^\s]*)\s+(Yes|No)/;
+
+ unless (defined($privoxy_features{$feature})
+ and ($privoxy_features{$feature} eq $status))
+ {
+ $dependency_problem = "depends on '" . $feature .
+ "' being set to '" . $status . "'";
}
}
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;
+
}
}
return check_header_result($test_ref, $header);
}
-
sub interpret_result ($) {
my $success = shift;
return $success ? "Success" : "Failure";
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;
return $string;
}
-
sub show_test ($) {
my $test_ref = shift;
log_message('Test is:' . test_content_as_string($test_ref));
$message = $time_stamp . ": " . $message;
}
-
printf(STDERR "%s\n", $message);
-
}
sub log_result ($$) {
}
sub print_version () {
- printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2008 Fabian Keil <fk@fabiankeil.de>' . "\n";
+ printf PRT_VERSION . "\n" . 'Copyright (C) 2007-2009 Fabian Keil <fk@fabiankeil.de>' . "\n";
}
sub help () {
Options and their default values if they have any:
[--debug $cli_options{'debug'}]
+ [--forks $cli_options{'forks'}]
[--fuzzer-address]
[--fuzzer-feeding]
[--help]
[--min-level $cli_options{'min-level'}]
[--privoxy-address]
[--retries $cli_options{'retries'}]
+ [--test-number]
[--verbose]
[--version]
see "perldoc $0" for more information
$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 },
'header-fuzzing' => \$cli_options{'header-fuzzing'},
'min-level=s' => \$cli_options{'min-level'},
}
}
+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();
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<--fuzzer-feeding>] [B<--help>] [B<--level level>] [B<--loops count>]
-[B<--max-level max-level>] [B<--max-time max-time>]
+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<--verbose>] [B<--version>]
+[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<--retries retries> Retry B<retries> times.
+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