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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?php
namespace Codeception\Module;
use Codeception\Module as CodeceptionModule;
use Codeception\TestInterface;
use Codeception\Exception\ModuleConfigException;
/**
* Connects to [memcached](http://www.memcached.org/) using either _Memcache_ or _Memcached_ extension.
*
* Performs a cleanup by flushing all values after each test run.
*
* ## Status
*
* * Maintainer: **davert**
* * Stability: **beta**
* * Contact: davert@codeception.com
*
* ## Configuration
*
* * **`host`** (`string`, default `'localhost'`) - The memcached host
* * **`port`** (`int`, default `11211`) - The memcached port
*
* ### Example (`unit.suite.yml`)
*
* ```yaml
* modules:
* - Memcache:
* host: 'localhost'
* port: 11211
* ```
*
* Be sure you don't use the production server to connect.
*
* ## Public Properties
*
* * **memcache** - instance of _Memcache_ or _Memcached_ object
*
*/
class Memcache extends CodeceptionModule
{
/**
* @var \Memcache|\Memcached
*/
public $memcache = null;
/**
* {@inheritdoc}
*/
protected $config = [
'host' => 'localhost',
'port' => 11211
];
/**
* Code to run before each test.
*
* @param TestInterface $test
* @throws ModuleConfigException
*/
public function _before(TestInterface $test)
{
if (class_exists('\Memcache')) {
$this->memcache = new \Memcache;
$this->memcache->connect($this->config['host'], $this->config['port']);
} elseif (class_exists('\Memcached')) {
$this->memcache = new \Memcached;
$this->memcache->addServer($this->config['host'], $this->config['port']);
} else {
throw new ModuleConfigException(__CLASS__, 'Memcache classes not loaded');
}
}
/**
* Code to run after each test.
*
* @param TestInterface $test
*/
public function _after(TestInterface $test)
{
if (empty($this->memcache)) {
return;
}
$this->memcache->flush();
switch (get_class($this->memcache)) {
case 'Memcache':
$this->memcache->close();
break;
case 'Memcached':
$this->memcache->quit();
break;
}
}
/**
* Grabs value from memcached by key.
*
* Example:
*
* ``` php
* <?php
* $users_count = $I->grabValueFromMemcached('users_count');
* ?>
* ```
*
* @param $key
* @return array|string
*/
public function grabValueFromMemcached($key)
{
$value = $this->memcache->get($key);
$this->debugSection("Value", $value);
return $value;
}
/**
* Checks item in Memcached exists and the same as expected.
*
* Examples:
*
* ``` php
* <?php
* // With only one argument, only checks the key exists
* $I->seeInMemcached('users_count');
*
* // Checks a 'users_count' exists and has the value 200
* $I->seeInMemcached('users_count', 200);
* ?>
* ```
*
* @param $key
* @param $value
*/
public function seeInMemcached($key, $value = null)
{
$actual = $this->memcache->get($key);
$this->debugSection("Value", $actual);
if (null === $value) {
$this->assertNotFalse($actual, "Cannot find key '$key' in Memcached");
} else {
$this->assertEquals($value, $actual, "Cannot find key '$key' in Memcached with the provided value");
}
}
/**
* Checks item in Memcached doesn't exist or is the same as expected.
*
* Examples:
*
* ``` php
* <?php
* // With only one argument, only checks the key does not exist
* $I->dontSeeInMemcached('users_count');
*
* // Checks a 'users_count' exists does not exist or its value is not the one provided
* $I->dontSeeInMemcached('users_count', 200);
* ?>
* ```
*
* @param $key
* @param $value
*/
public function dontSeeInMemcached($key, $value = null)
{
$actual = $this->memcache->get($key);
$this->debugSection("Value", $actual);
if (null === $value) {
$this->assertFalse($actual, "The key '$key' exists in Memcached");
} else {
if (false !== $actual) {
$this->assertEquals($value, $actual, "The key '$key' exists in Memcached with the provided value");
}
}
}
/**
* Stores an item `$value` with `$key` on the Memcached server.
*
* @param string $key
* @param mixed $value
* @param int $expiration
*/
public function haveInMemcached($key, $value, $expiration = null)
{
switch (get_class($this->memcache)) {
case 'Memcache':
$this->assertTrue($this->memcache->set($key, $value, null, $expiration));
break;
case 'Memcached':
$this->assertTrue($this->memcache->set($key, $value, $expiration));
break;
}
}
/**
* Flushes all Memcached data.
*/
public function clearMemcache()
{
$this->memcache->flush();
}
}