Repository navigation
Expand file tree
/
Copy pathConfiguration.php
More file actions
742 lines (635 loc) · 22.3 KB
/
Copy pathConfiguration.php
File metadata and controls
742 lines (635 loc) · 22.3 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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
<?php
namespace Codeception;
use Codeception\Exception\ConfigurationException;
use Codeception\Lib\ParamsLoader;
use Codeception\Util\Autoload;
use Codeception\Util\Template;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;
class Configuration
{
protected static $suites = [];
/**
* @var array Current configuration
*/
protected static $config = null;
/**
* @var array environmental files configuration cache
*/
protected static $envConfig = [];
/**
* @var string Directory containing main configuration file.
* @see self::projectDir()
*/
protected static $dir = null;
/**
* @var string Current project logs directory.
*/
protected static $outputDir = null;
/**
* @var string Current project data directory. This directory is used to hold
* sql dumps and other things needed for current project tests.
*/
protected static $dataDir = null;
/**
* @var string Directory with test support files like Actors, Helpers, PageObjects, etc
*/
protected static $supportDir = null;
/**
* @var string Directory containing environment configuration files.
*/
protected static $envsDir = null;
/**
* @var string Directory containing tests and suites of the current project.
*/
protected static $testsDir = null;
public static $lock = false;
protected static $di;
/**
* @var array Default config
*/
public static $defaultConfig = [
'actor_suffix'=> 'Tester',
'namespace' => '',
'include' => [],
'paths' => [],
'suites' => [],
'modules' => [],
'extensions' => [
'enabled' => [],
'config' => [],
'commands' => [],
],
'reporters' => [
'xml' => 'Codeception\PHPUnit\Log\JUnit',
'html' => 'Codeception\PHPUnit\ResultPrinter\HTML',
'tap' => 'PHPUnit_Util_Log_TAP',
'json' => 'PHPUnit_Util_Log_JSON',
'report' => 'Codeception\PHPUnit\ResultPrinter\Report',
],
'groups' => [],
'settings' => [
'colors' => true,
'bootstrap' => false,
'strict_xml' => false,
'lint' => true,
'backup_globals' => true,
'log_incomplete_skipped' => false,
'report_useless_tests' => false,
'disallow_test_output' => false,
'be_strict_about_changes_to_global_state' => false
],
'coverage' => [],
'params' => [],
'gherkin' => []
];
public static $defaultSuiteSettings = [
'actor' => null,
'class_name' => null, // Codeception <2.3 compatibility
'modules' => [
'enabled' => [],
'config' => [],
'depends' => []
],
'path' => null,
'namespace' => null,
'groups' => [],
'shuffle' => false,
'extensions' => [ // suite extensions
'enabled' => [],
'config' => [],
],
'error_level' => 'E_ALL & ~E_STRICT & ~E_DEPRECATED',
];
protected static $params;
/**
* Loads global config file which is `codeception.yml` by default.
* When config is already loaded - returns it.
*
* @param null $configFile
* @return array
* @throws Exception\ConfigurationException
*/
public static function config($configFile = null)
{
if (!$configFile && self::$config) {
return self::$config;
}
if (self::$config && self::$lock) {
return self::$config;
}
if ($configFile === null) {
$configFile = getcwd() . DIRECTORY_SEPARATOR . 'codeception.yml';
}
if (is_dir($configFile)) {
$configFile = $configFile . DIRECTORY_SEPARATOR . 'codeception.yml';
}
$dir = realpath(dirname($configFile));
self::$dir = $dir;
$configDistFile = $dir . DIRECTORY_SEPARATOR . 'codeception.dist.yml';
if (!(file_exists($configDistFile) || file_exists($configFile))) {
throw new ConfigurationException("Configuration file could not be found.\nRun `bootstrap` to initialize Codeception.", 404);
}
// Preload config to retrieve params such that they are applied to codeception config file below
$tempConfig = self::$defaultConfig;
$distConfigContents = "";
if (file_exists($configDistFile)) {
$distConfigContents = file_get_contents($configDistFile);
$tempConfig = self::mergeConfigs($tempConfig, self::getConfFromContents($distConfigContents, $configDistFile));
}
$configContents = "";
if (file_exists($configFile)) {
$configContents = file_get_contents($configFile);
$tempConfig = self::mergeConfigs($tempConfig, self::getConfFromContents($configContents, $configFile));
}
self::prepareParams($tempConfig);
// load config using params
$config = self::mergeConfigs(self::$defaultConfig, self::getConfFromContents($distConfigContents, $configDistFile));
$config = self::mergeConfigs($config, self::getConfFromContents($configContents, $configFile));
if ($config == self::$defaultConfig) {
throw new ConfigurationException("Configuration file is invalid");
}
self::$config = $config;
// compatibility with 1.x, 2.0
if (!isset($config['paths']['output']) and isset($config['paths']['log'])) {
$config['paths']['output'] = $config['paths']['log'];
}
if (isset(self::$config['actor'])) {
self::$config['actor_suffix'] = self::$config['actor']; // old compatibility
}
if (!isset($config['paths']['support']) and isset($config['paths']['helpers'])) {
$config['paths']['support'] = $config['paths']['helpers'];
}
if (!isset($config['paths']['output'])) {
throw new ConfigurationException('Output path is not defined by key "paths: output"');
}
self::$outputDir = $config['paths']['output'];
// fill up includes with wildcard expansions
$config['include'] = self::expandWildcardedIncludes($config['include']);
// config without tests, for inclusion of other configs
if (count($config['include'])) {
self::$config = $config;
if (!isset($config['paths']['tests'])) {
return $config;
}
}
if (!isset($config['paths']['tests'])) {
throw new ConfigurationException(
'Tests directory is not defined in Codeception config by key "paths: tests:"'
);
}
if (!isset($config['paths']['data'])) {
throw new ConfigurationException('Data path is not defined Codeception config by key "paths: data"');
}
if (!isset($config['paths']['support'])) {
throw new ConfigurationException('Helpers path is not defined by key "paths: support"');
}
self::$dataDir = $config['paths']['data'];
self::$supportDir = $config['paths']['support'];
self::$testsDir = $config['paths']['tests'];
if (isset($config['paths']['envs'])) {
self::$envsDir = $config['paths']['envs'];
}
Autoload::addNamespace(self::$config['namespace'], self::supportDir());
self::loadBootstrap($config['settings']['bootstrap']);
self::loadSuites();
return $config;
}
protected static function loadBootstrap($bootstrap)
{
if (!$bootstrap) {
return;
}
$bootstrap = self::$dir . DIRECTORY_SEPARATOR . self::$testsDir . DIRECTORY_SEPARATOR . $bootstrap;
if (file_exists($bootstrap)) {
include_once $bootstrap;
}
}
protected static function loadSuites()
{
$suites = Finder::create()
->files()
->name('*.{suite,suite.dist}.yml')
->in(self::$dir . DIRECTORY_SEPARATOR . self::$testsDir)
->depth('< 1')
->sortByName();
self::$suites = [];
foreach (array_keys(self::$config['suites']) as $suite) {
self::$suites[$suite] = $suite;
}
/** @var SplFileInfo $suite */
foreach ($suites as $suite) {
preg_match('~(.*?)(\.suite|\.suite\.dist)\.yml~', $suite->getFilename(), $matches);
self::$suites[$matches[1]] = $matches[1];
}
}
/**
* Returns suite configuration. Requires suite name and global config used (Configuration::config)
*
* @param string $suite
* @param array $config
* @return array
* @throws \Exception
*/
public static function suiteSettings($suite, $config)
{
// cut namespace name from suite name
if ($suite != $config['namespace'] && substr($suite, 0, strlen($config['namespace'])) == $config['namespace']) {
$suite = substr($suite, strlen($config['namespace']));
}
if (!in_array($suite, self::$suites)) {
throw new ConfigurationException("Suite $suite was not loaded");
}
// load global config
$globalConf = $config['settings'];
foreach (['modules', 'coverage', 'namespace', 'groups', 'env', 'gherkin', 'extensions'] as $key) {
if (isset($config[$key])) {
$globalConf[$key] = $config[$key];
}
}
$settings = self::mergeConfigs(self::$defaultSuiteSettings, $globalConf);
// load suite config
$settings = self::loadSuiteConfig($suite, $config['paths']['tests'], $settings);
// load from environment configs
if (isset($config['paths']['envs'])) {
$envConf = self::loadEnvConfigs(self::$dir . DIRECTORY_SEPARATOR . $config['paths']['envs']);
$settings = self::mergeConfigs($settings, $envConf);
}
if (!$settings['actor']) {
// Codeception 2.2 compatibility
$settings['actor'] = $settings['class_name'];
}
if (!$settings['path']) {
// take a suite path from its name
$settings['path'] = $suite;
}
$settings['path'] = self::$dir . DIRECTORY_SEPARATOR . $config['paths']['tests']
. DIRECTORY_SEPARATOR . $settings['path'] . DIRECTORY_SEPARATOR;
return $settings;
}
/**
* Loads environments configuration from set directory
*
* @param string $path path to the directory
* @return array
*/
protected static function loadEnvConfigs($path)
{
if (isset(self::$envConfig[$path])) {
return self::$envConfig[$path];
}
if (!is_dir($path)) {
self::$envConfig[$path] = [];
return self::$envConfig[$path];
}
$envFiles = Finder::create()
->files()
->name('*.yml')
->in($path)
->depth('< 2');
$envConfig = [];
/** @var SplFileInfo $envFile */
foreach ($envFiles as $envFile) {
$env = str_replace(['.dist.yml', '.yml'], '', $envFile->getFilename());
$envConfig[$env] = [];
$envPath = $path;
if ($envFile->getRelativePath()) {
$envPath .= DIRECTORY_SEPARATOR . $envFile->getRelativePath();
}
foreach (['.dist.yml', '.yml'] as $suffix) {
$envConf = self::getConfFromFile($envPath . DIRECTORY_SEPARATOR . $env . $suffix, null);
if ($envConf === null) {
continue;
}
$envConfig[$env] = self::mergeConfigs($envConfig[$env], $envConf);
}
}
self::$envConfig[$path] = ['env' => $envConfig];
return self::$envConfig[$path];
}
/**
* Loads configuration from Yaml data
*
* @param string $contents Yaml config file contents
* @param string $filename which is supposed to be loaded
* @return array
* @throws ConfigurationException
*/
protected static function getConfFromContents($contents, $filename = '(.yml)')
{
if (self::$params) {
$template = new Template($contents, '%', '%');
$template->setVars(self::$params);
$contents = $template->produce();
}
try {
return Yaml::parse($contents);
} catch (ParseException $exception) {
throw new ConfigurationException(
sprintf(
"Error loading Yaml config from `%s`\n \n%s\nRead more about Yaml format https://goo.gl/9UPuEC",
$filename,
$exception->getMessage()
)
);
}
}
/**
* Loads configuration from Yaml file or returns given value if the file doesn't exist
*
* @param string $filename filename
* @param mixed $nonExistentValue value used if filename is not found
* @return array
*/
protected static function getConfFromFile($filename, $nonExistentValue = [])
{
if (file_exists($filename)) {
$yaml = file_get_contents($filename);
return self::getConfFromContents($yaml, $filename);
}
return $nonExistentValue;
}
/**
* Returns all possible suite configurations according environment rules.
* Suite configurations will contain `current_environment` key which specifies what environment used.
*
* @param $suite
* @return array
*/
public static function suiteEnvironments($suite)
{
$settings = self::suiteSettings($suite, self::config());
if (!isset($settings['env']) || !is_array($settings['env'])) {
return [];
}
$environments = [];
foreach ($settings['env'] as $env => $envConfig) {
$environments[$env] = $envConfig ? self::mergeConfigs($settings, $envConfig) : $settings;
$environments[$env]['current_environment'] = $env;
}
return $environments;
}
public static function suites()
{
return self::$suites;
}
/**
* Return list of enabled modules according suite config.
*
* @param array $settings suite settings
* @return array
*/
public static function modules($settings)
{
return array_filter(
array_map(
function ($m) {
return is_array($m) ? key($m) : $m;
},
$settings['modules']['enabled'],
array_keys($settings['modules']['enabled'])
),
function ($m) use ($settings) {
if (!isset($settings['modules']['disabled'])) {
return true;
}
return !in_array($m, $settings['modules']['disabled']);
}
);
}
public static function isExtensionEnabled($extensionName)
{
return isset(self::$config['extensions'])
&& isset(self::$config['extensions']['enabled'])
&& in_array($extensionName, self::$config['extensions']['enabled']);
}
/**
* Returns current path to `_data` dir.
* Use it to store database fixtures, sql dumps, or other files required by your tests.
*
* @return string
*/
public static function dataDir()
{
return self::$dir . DIRECTORY_SEPARATOR . self::$dataDir . DIRECTORY_SEPARATOR;
}
/**
* Return current path to `_helpers` dir.
* Helpers are custom modules.
*
* @return string
*/
public static function supportDir()
{
return self::$dir . DIRECTORY_SEPARATOR . self::$supportDir . DIRECTORY_SEPARATOR;
}
/**
* Returns actual path to current `_output` dir.
* Use it in Helpers or Groups to save result or temporary files.
*
* @return string
* @throws Exception\ConfigurationException
*/
public static function outputDir()
{
if (!self::$outputDir) {
throw new ConfigurationException("Path for output not specified. Please, set output path in global config");
}
$dir = self::$outputDir . DIRECTORY_SEPARATOR;
if (strcmp(self::$outputDir[0], "/") !== 0) {
$dir = self::$dir . DIRECTORY_SEPARATOR . $dir;
}
if (!file_exists($dir)) {
@mkdir($dir, 0777, true);
}
if (!is_writable($dir)) {
@chmod($dir, 0777);
}
if (!is_writable($dir)) {
throw new ConfigurationException(
"Path for output is not writable. Please, set appropriate access mode for output path."
);
}
return $dir;
}
/**
* Compatibility alias to `Configuration::logDir()`
* @return string
*/
public static function logDir()
{
return self::outputDir();
}
/**
* Returns path to the root of your project.
* Basically returns path to current `codeception.yml` loaded.
* Use this method instead of `__DIR__`, `getcwd()` or anything else.
* @return string
*/
public static function projectDir()
{
return self::$dir . DIRECTORY_SEPARATOR;
}
/**
* Returns path to tests directory
*
* @return string
*/
public static function testsDir()
{
return self::$dir . DIRECTORY_SEPARATOR . self::$testsDir . DIRECTORY_SEPARATOR;
}
/**
* Return current path to `_envs` dir.
* Use it to store environment specific configuration.
*
* @return string
*/
public static function envsDir()
{
if (!self::$envsDir) {
return null;
}
return self::$dir . DIRECTORY_SEPARATOR . self::$envsDir . DIRECTORY_SEPARATOR;
}
/**
* Is this a meta-configuration file that just points to other `codeception.yml`?
* If so, it may have no tests by itself.
*
* @return bool
*/
public static function isEmpty()
{
return !(bool)self::$testsDir;
}
/**
* Adds parameters to config
*
* @param array $config
* @return array
*/
public static function append(array $config = [])
{
self::$config = self::mergeConfigs(self::$config, $config);
if (isset(self::$config['paths']['output'])) {
self::$outputDir = self::$config['paths']['output'];
}
if (isset(self::$config['paths']['data'])) {
self::$dataDir = self::$config['paths']['data'];
}
if (isset(self::$config['paths']['support'])) {
self::$supportDir = self::$config['paths']['support'];
}
if (isset(self::$config['paths']['tests'])) {
self::$testsDir = self::$config['paths']['tests'];
}
return self::$config;
}
public static function mergeConfigs($a1, $a2)
{
if (!is_array($a1)) {
return $a2;
}
if (!is_array($a2)) {
return $a1;
}
$res = [];
// for sequential arrays
if (isset($a1[0]) && isset($a2[0])) {
return array_merge_recursive($a2, $a1);
}
// for associative arrays
foreach ($a2 as $k2 => $v2) {
if (!isset($a1[$k2])) { // if no such key
$res[$k2] = $v2;
unset($a1[$k2]);
continue;
}
$res[$k2] = self::mergeConfigs($a1[$k2], $v2);
unset($a1[$k2]);
}
foreach ($a1 as $k1 => $v1) { // only single elements here left
$res[$k1] = $v1;
}
return $res;
}
/**
* Loads config from *.dist.suite.yml and *.suite.yml
*
* @param $suite
* @param $path
* @param $settings
* @return array
*/
protected static function loadSuiteConfig($suite, $path, $settings)
{
if (isset(self::$config['suites'][$suite])) {
// bundled config
return self::mergeConfigs($settings, self::$config['suites'][$suite]);
}
$suiteDistConf = self::getConfFromFile(
self::$dir . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . "$suite.suite.dist.yml"
);
$suiteConf = self::getConfFromFile(
self::$dir . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . "$suite.suite.yml"
);
$settings = self::mergeConfigs($settings, $suiteDistConf);
$settings = self::mergeConfigs($settings, $suiteConf);
return $settings;
}
/**
* Replaces wildcarded items in include array with real paths.
*
* @param $includes
* @return array
*/
protected static function expandWildcardedIncludes(array $includes)
{
if (empty($includes)) {
return $includes;
}
$expandedIncludes = [];
foreach ($includes as $include) {
$expandedIncludes = array_merge($expandedIncludes, self::expandWildcardsFor($include));
}
return $expandedIncludes;
}
/**
* Finds config files in given wildcarded include path.
* Returns the expanded paths or the original if not a wildcard.
*
* @param $include
* @return array
* @throws ConfigurationException
*/
protected static function expandWildcardsFor($include)
{
if (1 !== preg_match('/[\?\.\*]/', $include)) {
return [$include,];
}
try {
$configFiles = Finder::create()->files()
->name('/codeception(\.dist\.yml|\.yml)/')
->in(self::$dir . DIRECTORY_SEPARATOR . $include);
} catch (\InvalidArgumentException $e) {
throw new ConfigurationException(
"Configuration file(s) could not be found in \"$include\"."
);
}
$paths = [];
foreach ($configFiles as $file) {
$paths[] = codecept_relative_path($file->getPath());
}
return $paths;
}
private static function prepareParams($settings)
{
self::$params = [];
$paramsLoader = new ParamsLoader();
foreach ($settings['params'] as $paramStorage) {
static::$params = array_merge(self::$params, $paramsLoader->load($paramStorage));
}
}
}