File: README.md

package info (click to toggle)
libtest-redisserver-perl 0.21-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 168 kB
  • ctags: 14
  • sloc: perl: 171; makefile: 11; sh: 4
file content (144 lines) | stat: -rw-r--r-- 3,583 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# NAME

Test::RedisServer - redis-server runner for tests.

# SYNOPSIS

    use Redis;
    use Test::RedisServer;
    use Test::More;
    
    my $redis_server;
    eval {
        $redis_server = Test::RedisServer->new;
    } or plan skip_all => 'redis-server is required for this test';
    
    my $redis = Redis->new( $redis_server->connect_info );
    
    is $redis->ping, 'PONG', 'ping pong ok';
    
    done_testing;

# DESCRIPTION

# METHODS

## new(%options)

    my $redis_server = Test::RedisServer->new(%options);

Create a new redis-server instance, and start it by default (use auto\_start option to avoid this)

Available options are:

- auto\_start => 0 | 1 (Default: 1)

    Automatically start redis-server instance (by default).
    You can disable this feature by `auto_start => 0`, and start instance manually by `start` or `exec` method below.

- conf => 'HashRef'

    This is a redis.conf key value pair. You can use any key-value pair(s) that redis-server supports.

    If you want to use this redis.conf:

        port 9999
        databases 16
        save 900 1

    Your conf parameter will be:

        Test::RedisServer->new( conf => {
            port      => 9999,
            databases => 16,
            save      => '900 1',
        });

- timeout => 'Int'

    Timeout seconds for detecting if redis-server is awake or not. (Default: 3)

- tmpdir => 'String'

    Temporal directory, where redis config will be stored. By default it is created for you, but if you start Test::RedisServer via exec (e.g. with Test::TCP), you should provide it to be automatically deleted:

## start

Start redis-server instance manually.

## exec

Just exec to redis-server instance. This method is useful to use this module with [Test::TCP](https://metacpan.org/pod/Test::TCP), [Proclet](https://metacpan.org/pod/Proclet) or etc.

    use File::Temp;
    use Test::TCP;
    my $tmp_dir = File::Temp->newdir( CLEANUP => 1 );

    test_tcp(
        client => sub {
            my ($port, $server_pid) = @_;
            ...
        },
        server => sub {
            my ($port) = @_;
            my $redis = Test::RedisServer->new(
                auto_start => 0,
                conf       => { port => $port },
                tmpdir     => $tmp_dir,
            );
            $redis->exec;
        },
    );

## stop

Stop redis-server instance.

This method is automatically called from object destructor, DESTROY.

## connect\_info

Return connection info for client library to connect this redis-server instance.

This parameter is designed to pass directly to [Redis](https://metacpan.org/pod/Redis) module.

    my $redis_server = Test::RedisServer->new;
    my $redis = Redis->new( $redis_server->connect_info );

## pid

Return redis-server instance's process id, or undef when redis-server is not running.

## wait\_exit

Block until redis instance exited. 

# SEE ALSO

[Test::mysqld](https://metacpan.org/pod/Test::mysqld) for mysqld.

[Test::Memcached](https://metacpan.org/pod/Test::Memcached) for Memcached.

This module steals lots of stuff from above modules.

[Test::Mock::Redis](https://metacpan.org/pod/Test::Mock::Redis), another approach for testing redis application.

# INTERNAL METHODS

## BUILD

## DEMOLISH

# AUTHOR

Daisuke Murase <typester@cpan.org>

# COPYRIGHT AND LICENSE

Copyright (c) 2012 KAYAC Inc. All rights reserved.

This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the
LICENSE file included with this module.