Blame t/lib/MemcachedTest.pm

Packit 4e8bc4
package MemcachedTest;
Packit 4e8bc4
use strict;
Packit 4e8bc4
use IO::Socket::INET;
Packit 4e8bc4
use IO::Socket::UNIX;
Packit 4e8bc4
use Exporter 'import';
Packit 4e8bc4
use Carp qw(croak);
Packit 4e8bc4
use vars qw(@EXPORT);
Packit 4e8bc4
Packit 4e8bc4
# Instead of doing the substitution with Autoconf, we assume that
Packit 4e8bc4
# cwd == builddir.
Packit 4e8bc4
use Cwd;
Packit 4e8bc4
my $builddir = getcwd;
Packit 4e8bc4
Packit 4e8bc4
my @unixsockets = ();
Packit 4e8bc4
Packit 4e8bc4
@EXPORT = qw(new_memcached sleep mem_get_is mem_gets mem_gets_is mem_stats
Packit 4e8bc4
             supports_sasl free_port supports_drop_priv supports_extstore
Packit 4e8bc4
             wait_ext_flush supports_tls enabled_tls_testing run_help);
Packit 4e8bc4
Packit 4e8bc4
use constant MAX_READ_WRITE_SIZE => 16384;
Packit 4e8bc4
use constant SRV_CRT => "server_crt.pem";
Packit 4e8bc4
use constant SRV_KEY => "server_key.pem";
Packit 4e8bc4
use constant CLIENT_CRT => "client_crt.pem";
Packit 4e8bc4
use constant CLIENT_KEY => "client_key.pem";
Packit 4e8bc4
use constant CA_CRT => "cacert.pem";
Packit 4e8bc4
Packit 4e8bc4
my $testdir = $builddir . "/t/";
Packit 4e8bc4
my $client_crt = $testdir. CLIENT_CRT;
Packit 4e8bc4
my $client_key = $testdir. CLIENT_KEY;
Packit 4e8bc4
my $server_crt = $testdir . SRV_CRT;
Packit 4e8bc4
my $server_key = $testdir . SRV_KEY;
Packit 4e8bc4
Packit 4e8bc4
my $tls_checked = 0;
Packit 4e8bc4
Packit 4e8bc4
sub sleep {
Packit 4e8bc4
    my $n = shift;
Packit 4e8bc4
    select undef, undef, undef, $n;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
# Wait until all items have flushed
Packit 4e8bc4
sub wait_ext_flush {
Packit 4e8bc4
    my $sock = shift;
Packit 4e8bc4
    my $target = shift || 0;
Packit 4e8bc4
    my $sum = $target + 1;
Packit 4e8bc4
    while ($sum > $target) {
Packit 4e8bc4
        my $s = mem_stats($sock, "items");
Packit 4e8bc4
        $sum = 0;
Packit 4e8bc4
        for my $key (keys %$s) {
Packit 4e8bc4
            if ($key =~ m/items:(\d+):number/) {
Packit 4e8bc4
                # Ignore classes which can contain extstore items
Packit 4e8bc4
                next if $1 < 3;
Packit 4e8bc4
                $sum += $s->{$key};
Packit 4e8bc4
            }
Packit 4e8bc4
        }
Packit 4e8bc4
        sleep 1 if $sum > $target;
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub mem_stats {
Packit 4e8bc4
    my ($sock, $type) = @_;
Packit 4e8bc4
    $type = $type ? " $type" : "";
Packit 4e8bc4
    print $sock "stats$type\r\n";
Packit 4e8bc4
    my $stats = {};
Packit 4e8bc4
    while (<$sock>) {
Packit 4e8bc4
        last if /^(\.|END)/;
Packit 4e8bc4
        /^(STAT|ITEM) (\S+)\s+([^\r\n]+)/;
Packit 4e8bc4
        #print " slabs: $_";
Packit 4e8bc4
        $stats->{$2} = $3;
Packit 4e8bc4
    }
Packit 4e8bc4
    return $stats;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub mem_get_is {
Packit 4e8bc4
    # works on single-line values only.  no newlines in value.
Packit 4e8bc4
    my ($sock_opts, $key, $val, $msg) = @_;
Packit 4e8bc4
    my $opts = ref $sock_opts eq "HASH" ? $sock_opts : {};
Packit 4e8bc4
    my $sock = ref $sock_opts eq "HASH" ? $opts->{sock} : $sock_opts;
Packit 4e8bc4
Packit 4e8bc4
    my $expect_flags = $opts->{flags} || 0;
Packit 4e8bc4
    my $dval = defined $val ? "'$val'" : "<undef>";
Packit 4e8bc4
    $msg ||= "$key == $dval";
Packit 4e8bc4
Packit 4e8bc4
    print $sock "get $key\r\n";
Packit 4e8bc4
    if (! defined $val) {
Packit 4e8bc4
        my $line = scalar <$sock>;
Packit 4e8bc4
        if ($line =~ /^VALUE/) {
Packit 4e8bc4
            $line .= scalar(<$sock>) . scalar(<$sock>);
Packit 4e8bc4
        }
Packit 4e8bc4
        Test::More::is($line, "END\r\n", $msg);
Packit 4e8bc4
    } else {
Packit 4e8bc4
        my $len = length($val);
Packit 4e8bc4
        my $body = scalar(<$sock>);
Packit 4e8bc4
        my $expected = "VALUE $key $expect_flags $len\r\n$val\r\nEND\r\n";
Packit 4e8bc4
        if (!$body || $body =~ /^END/) {
Packit 4e8bc4
            Test::More::is($body, $expected, $msg);
Packit 4e8bc4
            return;
Packit 4e8bc4
        }
Packit 4e8bc4
        $body .= scalar(<$sock>) . scalar(<$sock>);
Packit 4e8bc4
        Test::More::is($body, $expected, $msg);
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub mem_gets {
Packit 4e8bc4
    # works on single-line values only.  no newlines in value.
Packit 4e8bc4
    my ($sock_opts, $key) = @_;
Packit 4e8bc4
    my $opts = ref $sock_opts eq "HASH" ? $sock_opts : {};
Packit 4e8bc4
    my $sock = ref $sock_opts eq "HASH" ? $opts->{sock} : $sock_opts;
Packit 4e8bc4
    my $val;
Packit 4e8bc4
    my $expect_flags = $opts->{flags} || 0;
Packit 4e8bc4
Packit 4e8bc4
    print $sock "gets $key\r\n";
Packit 4e8bc4
    my $response = <$sock>;
Packit 4e8bc4
    if ($response =~ /^END/) {
Packit 4e8bc4
        return "NOT_FOUND";
Packit 4e8bc4
    }
Packit 4e8bc4
    else
Packit 4e8bc4
    {
Packit 4e8bc4
        $response =~ /VALUE (.*) (\d+) (\d+) (\d+)/;
Packit 4e8bc4
        my $flags = $2;
Packit 4e8bc4
        my $len = $3;
Packit 4e8bc4
        my $identifier = $4;
Packit 4e8bc4
        read $sock, $val , $len;
Packit 4e8bc4
        # get the END
Packit 4e8bc4
        $_ = <$sock>;
Packit 4e8bc4
        $_ = <$sock>;
Packit 4e8bc4
Packit 4e8bc4
        return ($identifier,$val);
Packit 4e8bc4
    }
Packit 4e8bc4
Packit 4e8bc4
}
Packit 4e8bc4
sub mem_gets_is {
Packit 4e8bc4
    # works on single-line values only.  no newlines in value.
Packit 4e8bc4
    my ($sock_opts, $identifier, $key, $val, $msg) = @_;
Packit 4e8bc4
    my $opts = ref $sock_opts eq "HASH" ? $sock_opts : {};
Packit 4e8bc4
    my $sock = ref $sock_opts eq "HASH" ? $opts->{sock} : $sock_opts;
Packit 4e8bc4
Packit 4e8bc4
    my $expect_flags = $opts->{flags} || 0;
Packit 4e8bc4
    my $dval = defined $val ? "'$val'" : "<undef>";
Packit 4e8bc4
    $msg ||= "$key == $dval";
Packit 4e8bc4
Packit 4e8bc4
    print $sock "gets $key\r\n";
Packit 4e8bc4
    if (! defined $val) {
Packit 4e8bc4
        my $line = scalar <$sock>;
Packit 4e8bc4
        if ($line =~ /^VALUE/) {
Packit 4e8bc4
            $line .= scalar(<$sock>) . scalar(<$sock>);
Packit 4e8bc4
        }
Packit 4e8bc4
        Test::More::is($line, "END\r\n", $msg);
Packit 4e8bc4
    } else {
Packit 4e8bc4
        my $len = length($val);
Packit 4e8bc4
        my $body = scalar(<$sock>);
Packit 4e8bc4
        my $expected = "VALUE $key $expect_flags $len $identifier\r\n$val\r\nEND\r\n";
Packit 4e8bc4
        if (!$body || $body =~ /^END/) {
Packit 4e8bc4
            Test::More::is($body, $expected, $msg);
Packit 4e8bc4
            return;
Packit 4e8bc4
        }
Packit 4e8bc4
        $body .= scalar(<$sock>) . scalar(<$sock>);
Packit 4e8bc4
        Test::More::is($body, $expected, $msg);
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub free_port {
Packit 4e8bc4
    my $type = shift || "tcp";
Packit 4e8bc4
    my $sock;
Packit 4e8bc4
    my $port;
Packit 4e8bc4
    while (!$sock) {
Packit 4e8bc4
        $port = int(rand(20000)) + 30000;
Packit 4e8bc4
        if (enabled_tls_testing()) {
Packit 4e8bc4
            $sock = eval qq{ IO::Socket::SSL->new(LocalAddr => '127.0.0.1',
Packit 4e8bc4
                                      LocalPort => $port,
Packit 4e8bc4
                                      Proto     => '$type',
Packit 4e8bc4
                                      ReuseAddr => 1,
Packit 4e8bc4
                                      SSL_verify_mode => SSL_VERIFY_NONE);
Packit 4e8bc4
                                      };
Packit 4e8bc4
             die $@ if $@; # sanity check.
Packit 4e8bc4
        } else {
Packit 4e8bc4
            $sock = IO::Socket::INET->new(LocalAddr => '127.0.0.1',
Packit 4e8bc4
                                      LocalPort => $port,
Packit 4e8bc4
                                      Proto     => $type,
Packit 4e8bc4
                                      ReuseAddr => 1);
Packit 4e8bc4
        }
Packit 4e8bc4
    }
Packit 4e8bc4
    return $port;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub supports_udp {
Packit 4e8bc4
    my $output = `$builddir/memcached-debug -h`;
Packit 4e8bc4
    return 0 if $output =~ /^memcached 1\.1\./;
Packit 4e8bc4
    return 1;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub supports_sasl {
Packit 4e8bc4
    my $output = `$builddir/memcached-debug -h`;
Packit 4e8bc4
    return 1 if $output =~ /sasl/i;
Packit 4e8bc4
    return 0;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub supports_extstore {
Packit 4e8bc4
    my $output = `$builddir/memcached-debug -h`;
Packit 4e8bc4
    return 1 if $output =~ /ext_path/i;
Packit 4e8bc4
    return 0;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub supports_tls {
Packit 4e8bc4
    my $output = `$builddir/memcached-debug -h`;
Packit 4e8bc4
    return 1 if $output =~ /enable-ssl/i;
Packit 4e8bc4
    return 0;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub enabled_tls_testing {
Packit 4e8bc4
    if ($tls_checked) {
Packit 4e8bc4
        return 1;
Packit 4e8bc4
    } elsif (supports_tls() && $ENV{SSL_TEST}) {
Packit 4e8bc4
        eval "use IO::Socket::SSL";
Packit 4e8bc4
        croak("IO::Socket::SSL not installed or failed to load, cannot run SSL tests as requested") if $@;
Packit 4e8bc4
        $tls_checked = 1;
Packit 4e8bc4
        return 1;
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub supports_drop_priv {
Packit 4e8bc4
    my $output = `$builddir/memcached-debug -h`;
Packit 4e8bc4
    return 1 if $output =~ /no_drop_privileges/i;
Packit 4e8bc4
    return 0;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub get_memcached_exe {
Packit 4e8bc4
    my $exe = "$builddir/memcached-debug";
Packit 4e8bc4
    croak("memcached binary doesn't exist.  Haven't run 'make' ?\n") unless -e $exe;
Packit 4e8bc4
    croak("memcached binary not executable\n") unless -x _;
Packit 4e8bc4
    return $exe;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub run_help {
Packit 4e8bc4
    my $exe = get_memcached_exe();
Packit 4e8bc4
    return system("$exe -h");
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub new_memcached {
Packit 4e8bc4
    my ($args, $passed_port) = @_;
Packit 4e8bc4
    my $port = $passed_port;
Packit 4e8bc4
    my $host = '127.0.0.1';
Packit 4e8bc4
    my $ssl_enabled  = enabled_tls_testing();
Packit 4e8bc4
Packit 4e8bc4
    if ($ENV{T_MEMD_USE_DAEMON}) {
Packit 4e8bc4
        my ($host, $port) = ($ENV{T_MEMD_USE_DAEMON} =~ m/^([^:]+):(\d+)$/);
Packit 4e8bc4
        my $conn;
Packit 4e8bc4
        if ($ssl_enabled) {
Packit 4e8bc4
            $conn = eval qq{IO::Socket::SSL->new(PeerAddr => "$host:$port",
Packit 4e8bc4
                                        SSL_verify_mode => SSL_VERIFY_NONE,
Packit 4e8bc4
                                        SSL_cert_file => '$client_crt',
Packit 4e8bc4
                                        SSL_key_file => '$client_key');
Packit 4e8bc4
                                        };
Packit 4e8bc4
             die $@ if $@; # sanity check.
Packit 4e8bc4
        } else {
Packit 4e8bc4
            $conn = IO::Socket::INET->new(PeerAddr => "$host:$port");
Packit 4e8bc4
        }
Packit 4e8bc4
        if ($conn) {
Packit 4e8bc4
            return Memcached::Handle->new(conn => $conn,
Packit 4e8bc4
                                          host => $host,
Packit 4e8bc4
                                          port => $port);
Packit 4e8bc4
        }
Packit 4e8bc4
        croak("Failed to connect to specified memcached server.") unless $conn;
Packit 4e8bc4
    }
Packit 4e8bc4
Packit 4e8bc4
    if ($< == 0) {
Packit 4e8bc4
        $args .= " -u root";
Packit 4e8bc4
    }
Packit 4e8bc4
    $args .= " -o relaxed_privileges";
Packit 4e8bc4
Packit 4e8bc4
    my $udpport;
Packit 4e8bc4
    if ($args =~ /-l (\S+)/ || ($ssl_enabled && ($args !~ /-s (\S+)/))) {
Packit 4e8bc4
        if (!$port) {
Packit 4e8bc4
            $port = free_port();
Packit 4e8bc4
        }
Packit 4e8bc4
        $udpport = free_port("udp");
Packit 4e8bc4
        $args .= " -p $port";
Packit 4e8bc4
        if (supports_udp() && $args !~ /-U (\S+)/) {
Packit 4e8bc4
            $args .= " -U $udpport";
Packit 4e8bc4
        }
Packit 4e8bc4
        if ($ssl_enabled) {
Packit 4e8bc4
            $args .= " -Z -o ssl_chain_cert=$server_crt -o ssl_key=$server_key";
Packit 4e8bc4
        }
Packit 4e8bc4
    } elsif ($args !~ /-s (\S+)/) {
Packit 4e8bc4
        my $num = @unixsockets;
Packit 4e8bc4
        my $file = "/tmp/memcachetest.$$.$num";
Packit 4e8bc4
        $args .= " -s $file";
Packit 4e8bc4
        push(@unixsockets, $file);
Packit 4e8bc4
    }
Packit 4e8bc4
Packit 4e8bc4
    my $childpid = fork();
Packit 4e8bc4
Packit 4e8bc4
    my $exe = get_memcached_exe();
Packit 4e8bc4
Packit 4e8bc4
    unless ($childpid) {
Packit 4e8bc4
        #print STDERR "RUN: $exe $args\n";
Packit 4e8bc4
        exec "$builddir/timedrun 600 $exe $args";
Packit 4e8bc4
        exit; # never gets here.
Packit 4e8bc4
    }
Packit 4e8bc4
Packit 4e8bc4
    # unix domain sockets
Packit 4e8bc4
    if ($args =~ /-s (\S+)/) {
Packit 4e8bc4
        sleep 1;
Packit 4e8bc4
        my $filename = $1;
Packit 4e8bc4
        my $conn = IO::Socket::UNIX->new(Peer => $filename) ||
Packit 4e8bc4
            croak("Failed to connect to unix domain socket: $! '$filename'");
Packit 4e8bc4
Packit 4e8bc4
        return Memcached::Handle->new(pid  => $childpid,
Packit 4e8bc4
                                      conn => $conn,
Packit 4e8bc4
                                      domainsocket => $filename,
Packit 4e8bc4
                                      host => $host,
Packit 4e8bc4
                                      port => $port);
Packit 4e8bc4
    }
Packit 4e8bc4
Packit 4e8bc4
    # try to connect / find open port, only if we're not using unix domain
Packit 4e8bc4
    # sockets
Packit 4e8bc4
Packit 4e8bc4
    for (1..20) {
Packit 4e8bc4
        my $conn;
Packit 4e8bc4
        if ($ssl_enabled) {
Packit 4e8bc4
            $conn = eval qq{ IO::Socket::SSL->new(PeerAddr => "127.0.0.1:$port",
Packit 4e8bc4
                                        SSL_verify_mode => SSL_VERIFY_NONE,
Packit 4e8bc4
                                        SSL_cert_file => '$client_crt',
Packit 4e8bc4
                                        SSL_key_file => '$client_key');
Packit 4e8bc4
                                        };
Packit 4e8bc4
            die $@ if $@; # sanity check.
Packit 4e8bc4
        } else {
Packit 4e8bc4
            $conn = IO::Socket::INET->new(PeerAddr => "127.0.0.1:$port");
Packit 4e8bc4
        }
Packit 4e8bc4
        if ($conn) {
Packit 4e8bc4
            return Memcached::Handle->new(pid  => $childpid,
Packit 4e8bc4
                                          conn => $conn,
Packit 4e8bc4
                                          udpport => $udpport,
Packit 4e8bc4
                                          host => $host,
Packit 4e8bc4
                                          port => $port);
Packit 4e8bc4
        }
Packit 4e8bc4
        select undef, undef, undef, 0.10;
Packit 4e8bc4
    }
Packit 4e8bc4
    croak("Failed to startup/connect to memcached server.");
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
END {
Packit 4e8bc4
    for (@unixsockets) {
Packit 4e8bc4
        unlink $_;
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
############################################################################
Packit 4e8bc4
package Memcached::Handle;
Packit 4e8bc4
sub new {
Packit 4e8bc4
    my ($class, %params) = @_;
Packit 4e8bc4
    return bless \%params, $class;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub DESTROY {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
    kill 2, $self->{pid};
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub stop {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
    kill 15, $self->{pid};
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub graceful_stop {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
    kill 'SIGUSR1', $self->{pid};
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub host { $_[0]{host} }
Packit 4e8bc4
sub port { $_[0]{port} }
Packit 4e8bc4
sub udpport { $_[0]{udpport} }
Packit 4e8bc4
Packit 4e8bc4
sub sock {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
Packit 4e8bc4
    if ($self->{conn} && ($self->{domainsocket} || getpeername($self->{conn}))) {
Packit 4e8bc4
        return $self->{conn};
Packit 4e8bc4
    }
Packit 4e8bc4
    return $self->new_sock;
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub new_sock {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
    if ($self->{domainsocket}) {
Packit 4e8bc4
        return IO::Socket::UNIX->new(Peer => $self->{domainsocket});
Packit 4e8bc4
    } elsif (MemcachedTest::enabled_tls_testing()) {
Packit 4e8bc4
        return eval qq{ IO::Socket::SSL->new(PeerAddr => "$self->{host}:$self->{port}",
Packit 4e8bc4
                                    SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
Packit 4e8bc4
                                    SSL_cert_file => '$client_crt',
Packit 4e8bc4
                                    SSL_key_file => '$client_key');
Packit 4e8bc4
                                    };
Packit 4e8bc4
    } else {
Packit 4e8bc4
        return IO::Socket::INET->new(PeerAddr => "$self->{host}:$self->{port}");
Packit 4e8bc4
    }
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
sub new_udp_sock {
Packit 4e8bc4
    my $self = shift;
Packit 4e8bc4
    return IO::Socket::INET->new(PeerAddr => '127.0.0.1',
Packit 4e8bc4
                                 PeerPort => $self->{udpport},
Packit 4e8bc4
                                 Proto    => 'udp',
Packit 4e8bc4
                                 LocalAddr => '127.0.0.1',
Packit 4e8bc4
                                 LocalPort => MemcachedTest::free_port('udp'),
Packit 4e8bc4
        );
Packit 4e8bc4
Packit 4e8bc4
}
Packit 4e8bc4
Packit 4e8bc4
1;