Highlight Shoutcast response lines.
[privoxy.git] / tools / privoxy-regression-test.pl
index 644f2e4..e83ce0e 100755 (executable)
@@ -7,7 +7,7 @@
 # A regression test "framework" for Privoxy. For documentation see:
 # perldoc privoxy-regression-test.pl
 #
-# $Id: privoxy-regression-test.pl,v 1.149 2008/05/17 14:11:29 fk Exp $
+# $Id: privoxy-regression-test.pl,v 1.158 2008/07/23 18:47:11 fk Exp $
 #
 # Wish list:
 #
@@ -16,8 +16,6 @@
 # - 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?
 #
@@ -42,19 +40,20 @@ use strict;
 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,
 
@@ -311,7 +310,8 @@ sub load_action_files ($) {
 
     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) {
 
@@ -741,7 +741,13 @@ sub check_status_code_result ($$) {
     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,
@@ -788,7 +794,6 @@ sub execute_server_header_regression_test ($) {
     return check_header_result($test_ref, $header);
 }
 
-
 sub interpret_result ($) {
     my $success = shift;
     return $success ? "Success" : "Failure";
@@ -1019,6 +1024,20 @@ sub test_content_as_string ($) {
     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
@@ -1057,6 +1076,7 @@ sub get_cgi_page_or_else ($) {
     return $content_ref;
 }
 
+# XXX: misleading name
 sub get_show_request_with_curl ($) {
 
     our $privoxy_cgi_url;
@@ -1064,11 +1084,16 @@ sub get_show_request_with_curl ($) {
     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;
@@ -1077,7 +1102,6 @@ sub get_show_request_with_curl ($) {
     return get_cgi_page_or_else($curl_parameters);
 }
 
-
 sub get_head_with_curl ($) {
 
     our $fellatio_url = FELLATIO_URL;
@@ -1098,7 +1122,6 @@ sub get_head_with_curl ($) {
     return get_page_with_curl($curl_parameters);
 }
 
-
 sub get_page_with_curl ($) {
 
     our $proxy;
@@ -1168,7 +1191,6 @@ sub array_as_string ($) {
     return $string;
 }
 
-
 sub show_test ($) {
     my $test_ref = shift;
     log_message('Test is:' . test_content_as_string($test_ref));
@@ -1327,9 +1349,11 @@ sub help () {
 
 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'}]
@@ -1356,6 +1380,7 @@ sub init_cli_options () {
     $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 () {
@@ -1367,7 +1392,9 @@ 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'},
                 'max-level=s' => \$cli_options{'max-level'},
                 'privoxy-address=s' => \$cli_options{'privoxy-address'},
@@ -1420,6 +1447,20 @@ sub init_proxy_settings($) {
     }
 }
 
+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();
@@ -1428,6 +1469,7 @@ sub main () {
     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();
 }
 
@@ -1439,9 +1481,9 @@ B<privoxy-regression-test> - A regression test "framework" for Privoxy.
 
 =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>]
 
@@ -1542,6 +1584,9 @@ requests to level 3 and client-header-action tests to level 1.
 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.
@@ -1556,6 +1601,9 @@ message.
 
 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.