Repository navigation
Expand file tree
/
Copy pathFilesystem.php
More file actions
343 lines (312 loc) · 7.77 KB
/
Copy pathFilesystem.php
File metadata and controls
343 lines (312 loc) · 7.77 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
<?php
namespace Codeception\Module;
use Codeception\Util\FileSystem as Util;
use Symfony\Component\Finder\Finder;
use Codeception\Module as CodeceptionModule;
use Codeception\TestInterface;
use Codeception\Configuration;
/**
* Module for testing local filesystem.
* Fork it to extend the module for FTP, Amazon S3, others.
*
* ## Status
*
* * Maintainer: **davert**
* * Stability: **stable**
* * Contact: codecept@davert.mail.ua
*
* Module was developed to test Codeception itself.
*/
class Filesystem extends CodeceptionModule
{
protected $file = null;
protected $filepath = null;
protected $path = '';
public function _before(TestInterface $test)
{
$this->path = Configuration::projectDir();
}
/**
* Enters a directory In local filesystem.
* Project root directory is used by default
*
* @param string $path
*/
public function amInPath($path)
{
chdir($this->path = $this->absolutizePath($path) . DIRECTORY_SEPARATOR);
$this->debug('Moved to ' . getcwd());
}
/**
* @param string $path
* @return string
*/
protected function absolutizePath($path)
{
// *nix way
if (strpos($path, '/') === 0) {
return $path;
}
// windows
if (strpos($path, ':\\') === 1) {
return $path;
}
return $this->path . $path;
}
/**
* Opens a file and stores it's content.
*
* Usage:
*
* ``` php
* <?php
* $I->openFile('composer.json');
* $I->seeInThisFile('codeception/codeception');
* ?>
* ```
*
* @param string $filename
*/
public function openFile($filename)
{
$this->file = file_get_contents($this->absolutizePath($filename));
$this->filepath = $filename;
}
/**
* Deletes a file
*
* ``` php
* <?php
* $I->deleteFile('composer.lock');
* ?>
* ```
*
* @param string $filename
*/
public function deleteFile($filename)
{
if (!file_exists($this->absolutizePath($filename))) {
\PHPUnit_Framework_Assert::fail('file not found');
}
unlink($this->absolutizePath($filename));
}
/**
* Deletes directory with all subdirectories
*
* ``` php
* <?php
* $I->deleteDir('vendor');
* ?>
* ```
*
* @param string $dirname
*/
public function deleteDir($dirname)
{
$dir = $this->absolutizePath($dirname);
Util::deleteDir($dir);
}
/**
* Copies directory with all contents
*
* ``` php
* <?php
* $I->copyDir('vendor','old_vendor');
* ?>
* ```
*
* @param string $src
* @param string $dst
*/
public function copyDir($src, $dst)
{
Util::copyDir($src, $dst);
}
/**
* Checks If opened file has `text` in it.
*
* Usage:
*
* ``` php
* <?php
* $I->openFile('composer.json');
* $I->seeInThisFile('codeception/codeception');
* ?>
* ```
*
* @param string $text
*/
public function seeInThisFile($text)
{
$this->assertContains($text, $this->file, "No text '$text' in currently opened file");
}
/**
* Checks If opened file has the `number` of new lines.
*
* Usage:
*
* ``` php
* <?php
* $I->openFile('composer.json');
* $I->seeNumberNewLines(5);
* ?>
* ```
*
* @param int $number New lines
*/
public function seeNumberNewLines($number)
{
$lines = preg_split('/\n|\r/', $this->file);
$this->assertTrue(
(int) $number === count($lines),
"The number of new lines does not match with $number"
);
}
/**
* Checks that contents of currently opened file matches $regex
*
* @param string $regex
*/
public function seeThisFileMatches($regex)
{
$this->assertRegExp($regex, $this->file, "Contents of currently opened file does not match '$regex'");
}
/**
* Checks the strict matching of file contents.
* Unlike `seeInThisFile` will fail if file has something more than expected lines.
* Better to use with HEREDOC strings.
* Matching is done after removing "\r" chars from file content.
*
* ``` php
* <?php
* $I->openFile('process.pid');
* $I->seeFileContentsEqual('3192');
* ?>
* ```
*
* @param string $text
*/
public function seeFileContentsEqual($text)
{
$file = str_replace("\r", '', $this->file);
\PHPUnit_Framework_Assert::assertEquals($text, $file);
}
/**
* Checks If opened file doesn't contain `text` in it
*
* ``` php
* <?php
* $I->openFile('composer.json');
* $I->dontSeeInThisFile('codeception/codeception');
* ?>
* ```
*
* @param string $text
*/
public function dontSeeInThisFile($text)
{
$this->assertNotContains($text, $this->file, "Found text '$text' in currently opened file");
}
/**
* Deletes a file
*/
public function deleteThisFile()
{
$this->deleteFile($this->filepath);
}
/**
* Checks if file exists in path.
* Opens a file when it's exists
*
* ``` php
* <?php
* $I->seeFileFound('UserModel.php','app/models');
* ?>
* ```
*
* @param string $filename
* @param string $path
*/
public function seeFileFound($filename, $path = '')
{
if ($path === '' && file_exists($filename)) {
$this->openFile($filename);
\PHPUnit_Framework_Assert::assertFileExists($filename);
return;
}
$found = $this->findFileInPath($filename, $path);
if ($found === false) {
$this->fail("File \"$filename\" not found at \"$path\"");
}
$this->openFile($found);
\PHPUnit_Framework_Assert::assertFileExists($found);
}
/**
* Checks if file does not exist in path
*
* @param string $filename
* @param string $path
*/
public function dontSeeFileFound($filename, $path = '')
{
if ($path === '') {
\PHPUnit_Framework_Assert::assertFileNotExists($filename);
return;
}
$found = $this->findFileInPath($filename, $path);
if ($found === false) {
//this line keeps a count of assertions correct
\PHPUnit_Framework_Assert::assertTrue(true);
return;
}
\PHPUnit_Framework_Assert::assertFileNotExists($found);
}
/**
* Finds the first matching file
*
* @param string $filename
* @param string $path
* @throws \PHPUnit_Framework_AssertionFailedError When path does not exist
* @return string|false Path to the first matching file
*/
private function findFileInPath($filename, $path)
{
$path = $this->absolutizePath($path);
if (!file_exists($path)) {
$this->fail("Directory does not exist: $path");
}
$files = Finder::create()->files()->name($filename)->in($path);
if ($files->count() === 0) {
return false;
}
foreach ($files as $file) {
return $file->getRealPath();
}
}
/**
* Erases directory contents
*
* ``` php
* <?php
* $I->cleanDir('logs');
* ?>
* ```
*
* @param string $dirname
*/
public function cleanDir($dirname)
{
$path = $this->absolutizePath($dirname);
Util::doEmptyDir($path);
}
/**
* Saves contents to file
*
* @param string $filename
* @param string $contents
*/
public function writeToFile($filename, $contents)
{
file_put_contents($filename, $contents);
}
}