-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathMongoDb.php
More file actions
454 lines (404 loc) · 14.4 KB
/
MongoDb.php
File metadata and controls
454 lines (404 loc) · 14.4 KB
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
<?php
declare(strict_types=1);
namespace Codeception\Module;
use Codeception\Module;
use Codeception\Configuration;
use Codeception\Exception\ModuleConfigException;
use Codeception\Exception\ModuleException;
use Codeception\Lib\Driver\MongoDb as MongoDbDriver;
use Codeception\TestInterface;
use Exception;
use MongoConnectionException;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\ExpectationFailedException;
/**
* Works with MongoDb database.
*
* The most important function of this module is cleaning database before each test.
* To have your database properly cleaned you should configure it to access the database.
*
* In order to have your database populated with data you need a valid js file with data (of the same style which can be fed up to mongo binary)
* File can be generated by RockMongo export command
* You can also use directory, generated by ```mongodump``` tool or it's ```.tar.gz``` archive (not available for Windows systems), generated by ```tar -czf <archive_file_name>.tar.gz <path_to dump directory>```.
* Just put it in ``` tests/_data ``` dir (by default) and specify path to it in config.
* Next time after database is cleared all your data will be restored from dump.
* The DB preparation should as following:
* - clean database
* - system collection system.users should contain the user which will be authenticated while script performs DB operations
*
* Connection is done by MongoDb driver, which is stored in Codeception\Lib\Driver namespace.
* Check out the driver if you get problems loading dumps and cleaning databases.
*
* HINT: This module can be used with [Mongofill](https://github.com/mongofill/mongofill) library which is Mongo client written in PHP without extension.
*
* ## Status
*
* * Maintainer: **judgedim**, **davert**
* * Stability: **beta**
* * Contact: davert@codeception.com
*
* *Please review the code of non-stable modules and provide patches if you have issues.*
*
* ## Config
*
* * dsn *required* - MongoDb DSN with the db name specified at the end of the host after slash
* * user *required* - user to access database
* * password *required* - password
* * dump_type *required* - type of dump.
* One of 'js' (MongoDb::DUMP_TYPE_JS), 'mongodump' (MongoDb::DUMP_TYPE_MONGODUMP) or 'mongodump-tar-gz' (MongoDb::DUMP_TYPE_MONGODUMP_TAR_GZ).
* default: MongoDb::DUMP_TYPE_JS).
* * dump - path to database dump
* * populate: true - should the dump be loaded before test suite is started.
* * cleanup: true - should the dump be reloaded after each test.
* Boolean or 'dirty'. If cleanup is set to 'dirty', the dump is only reloaded if any data has been written to the db during a test. This is
* checked using the [dbHash](https://docs.mongodb.com/manual/reference/command/dbHash/) command.
*
*/
class MongoDb extends Module
{
/**
* @var string
*/
public const DUMP_TYPE_JS = 'js';
/**
* @var string
*/
public const DUMP_TYPE_MONGODUMP = 'mongodump';
/**
* @var string
*/
public const DUMP_TYPE_MONGODUMP_TAR_GZ = 'mongodump-tar-gz';
protected string $dumpFile;
protected bool $isDumpFileEmpty = true;
protected ?string $dbHash;
/**
* @var array<string, mixed>
*/
protected array $config = [
'populate' => true,
'cleanup' => true,
'dsn' => '',
'dump' => null,
'dump_type' => self::DUMP_TYPE_JS,
'user' => '',
'password' => '',
'quiet' => false,
];
protected bool $populated = false;
public ?MongoDbDriver $driver = null;
/**
* @var string[]
*/
protected array $requiredFields = ['dsn'];
public function _initialize(): void
{
try {
$this->driver = MongoDbDriver::create(
$this->config['dsn'],
$this->config['user'],
$this->config['password']
);
} catch (MongoConnectionException $exception) {
throw new ModuleException(__CLASS__,
$exception->getMessage() . ' while creating Mongo connection'
);
}
if ($this->config['populate']) {
$this->cleanup();
$this->loadDump();
$this->populated = true;
}
}
private function validateDump(): void
{
if ($this->config['dump'] && ($this->config['cleanup'] || $this->config['populate'])) {
if (!file_exists(Configuration::projectDir() . $this->config['dump'])) {
throw new ModuleConfigException(
__CLASS__,
"File with dump doesn't exist.\n
Please, check path for dump file: " . $this->config['dump']
);
}
$this->dumpFile = Configuration::projectDir() . $this->config['dump'];
$this->isDumpFileEmpty = false;
if ($this->config['dump_type'] === self::DUMP_TYPE_JS) {
$content = file_get_contents($this->dumpFile);
$content = trim(preg_replace('#/\*(?:(?!\*/).)*\*/#s', "", $content));
if (count(explode("\n", $content)) === 0) {
$this->isDumpFileEmpty = true;
}
return;
}
if ($this->config['dump_type'] === self::DUMP_TYPE_MONGODUMP) {
if (!is_dir($this->dumpFile)) {
throw new ModuleConfigException(
__CLASS__,
"Dump must be a directory.\n
Please, check dump: " . $this->config['dump']
);
}
$this->isDumpFileEmpty = true;
$dumpDir = dir($this->dumpFile);
while (false !== ($entry = $dumpDir->read())) {
if ($entry !== '..' && $entry !== '.') {
$this->isDumpFileEmpty = false;
break;
}
}
$dumpDir->close();
return;
}
if ($this->config['dump_type'] === self::DUMP_TYPE_MONGODUMP_TAR_GZ) {
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
throw new ModuleConfigException(
__CLASS__,
"Tar gunzip archives are not supported for Windows systems"
);
}
if (!preg_match('#(\.tar\.gz|\.tgz)$#', $this->dumpFile)) {
throw new ModuleConfigException(
__CLASS__,
"Dump file must be a valid tar gunzip archive.\n
Please, check dump file: " . $this->config['dump']
);
}
return;
}
throw new ModuleConfigException(
__CLASS__,
'\"dump_type\" must be one of ["'
. self::DUMP_TYPE_JS . '", "'
. self::DUMP_TYPE_MONGODUMP . '", "'
. self::DUMP_TYPE_MONGODUMP_TAR_GZ . '"].'
);
}
}
public function _before(TestInterface $test): void
{
6880
if ($this->shouldCleanup()) {
$this->cleanup();
$this->loadDump();
}
}
public function _after(TestInterface $test): void
{
$this->populated = false;
}
protected function shouldCleanup(): bool
{
if ($this->populated) {
return false;
}
return $this->config['cleanup'] === 'dirty'
? ($this->dbHash === null || $this->driver->getDbHash() !== $this->dbHash)
: (bool)$this->config['cleanup'];
}
protected function cleanup(): void
{
$dbh = $this->driver->getDbh();
if ($dbh === null) {
throw new ModuleConfigException(
__CLASS__,
"No connection to database. Remove this module from config if you don't need database repopulation"
);
}
try {
$this->driver->cleanup();
} catch (Exception $exception) {
throw new ModuleException(__CLASS__, $exception->getMessage());
}
}
protected function loadDump(): void
{
$this->validateDump();
if ($this->isDumpFileEmpty) {
return;
}
try {
if ($this->config['dump_type'] === self::DUMP_TYPE_JS) {
$this->driver->load($this->dumpFile);
}
if ($this->config['dump_type'] === self::DUMP_TYPE_MONGODUMP) {
$this->driver->setQuiet($this->config['quiet']);
$this->driver->loadFromMongoDump($this->dumpFile);
}
if ($this->config['dump_type'] === self::DUMP_TYPE_MONGODUMP_TAR_GZ) {
$this->driver->setQuiet($this->config['quiet']);
$this->driver->loadFromTarGzMongoDump($this->dumpFile);
}
} catch (Exception $e) {
throw new ModuleException(__CLASS__, $e->getMessage());
}
if ($this->config['cleanup'] === 'dirty') {
$this->dbHash = $this->driver->getDbHash();
}
}
/**
* Specify the database to use
*
* ```php
* <?php
* $I->useDatabase('db_1');
* ```
*/
public function useDatabase(string $dbName): void
{
$this->driver->setDatabase($dbName);
}
/**
* Inserts data into collection
*
* ```php
* <?php
* $I->haveInCollection('users', ['name' => 'John', 'email' => 'john@coltrane.com']);
* $user_id = $I->haveInCollection('users', ['email' => 'john@coltrane.com']);
* ```
*
* @param array<string, mixed> $data
*/
public function haveInCollection(string $collection, array $data): string
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$response = $collection->insertOne($data);
return (string) $response->getInsertedId();
}
/**
* Checks if collection contains an item.
*
* ```php
* <?php
* $I->seeInCollection('users', ['name' => 'miles']);
* ```
*
* @param array<string, mixed> $criteria
*/
public function seeInCollection(string $collection, array $criteria = []): void
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$res = $collection->count($criteria);
Assert::assertGreaterThan(0, $res);
}
/**
* Checks if collection doesn't contain an item.
*
* ```php
* <?php
* $I->dontSeeInCollection('users', ['name' => 'miles']);
* ```
*
* @param array<string, mixed> $criteria
*/
public function dontSeeInCollection(string $collection, array $criteria = []): void
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$res = $collection->count($criteria);
Assert::assertLessThan(1, $res);
}
/**
* Grabs a data from collection
*
* ```php
* <?php
* $user = $I->grabFromCollection('users', ['name' => 'miles']);
* ```
*
* @param array<string, mixed> $criteria
*/
public function grabFromCollection(string $collection, array $criteria = []): array|object|null
{
$collection = $this->driver->getDbh()->selectCollection($collection);
return $collection->findOne($criteria);
}
/**
* Grabs the documents count from a collection
*
* ```php
* <?php
* $count = $I->grabCollectionCount('users');
* // or
* $count = $I->grabCollectionCount('users', ['isAdmin' => true]);
* ```
*
* @param array<string, mixed> $criteria
*/
public function grabCollectionCount(string $collection, array $criteria = []): int
{
$collection = $this->driver->getDbh()->selectCollection($collection);
return $collection->count($criteria);
}
/**
* Asserts that an element in a collection exists and is an Array
*
* ```php
* <?php
* $I->seeElementIsArray('users', ['name' => 'John Doe'], 'data.skills');
* ```
*
* @param array<string, mixed> $criteria
*/
public function seeElementIsArray(string $collection, array $criteria, string $elementToCheck): void
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$res = $collection->count(
array_merge(
$criteria,
[
$elementToCheck => ['$exists' => true],
'$where' => sprintf('Array.isArray(this.%s)', $elementToCheck)
]
)
);
if ($res > 1) {
throw new ExpectationFailedException(
'Error: you should test against a single element criteria when asserting that elementIsArray'
);
}
Assert::assertSame(1, $res, 'Specified element is not a Mongo Object');
}
/**
* Asserts that an element in a collection exists and is an Object
*
* ```php
* <?php
* $I->seeElementIsObject('users', ['name' => 'John Doe'], 'data');
* ```
*
* @param array<string, mixed> $criteria
*/
public function seeElementIsObject(string $collection, array $criteria, string $elementToCheck): void
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$res = $collection->count(
array_merge(
$criteria,
[
$elementToCheck => ['$exists' => true],
'$where' => sprintf('! Array.isArray(this.%s) && isObject(this.%s)', $elementToCheck, $elementToCheck)
]
)
);
if ($res > 1) {
throw new ExpectationFailedException(
'Error: you should test against a single element criteria when asserting that elementIsObject'
);
}
Assert::assertSame(1, $res, 'Specified element is not a Mongo Object');
}
/**
* Count number of records in a collection
*
* ```php
* <?php
* $I->seeNumElementsInCollection('users', 2);
* $I->seeNumElementsInCollection('users', 1, ['name' => 'miles']);
* ```
*
* @param array<string, mixed> $criteria
*/
public function seeNumElementsInCollection(string $collection, int $expected, array $criteria = []): void
{
$collection = $this->driver->getDbh()->selectCollection($collection);
$res = $collection->count($criteria);
Assert::assertSame($expected, $res);
}
}