Repository navigation
Expand file tree
/
Copy pathExtension.php
More file actions
152 lines (129 loc) · 3.76 KB
/
Copy pathExtension.php
File metadata and controls
152 lines (129 loc) · 3.76 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
<?php
declare(strict_types=1);
namespace Codeception;
use Codeception\Configuration as Config;
use Codeception\Event\SuiteEvent;
use Codeception\Exception\ModuleRequireException;
use Codeception\Lib\Console\Output;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use function array_keys;
use function array_merge;
use function is_array;
/**
* A base class for all Codeception Extensions and GroupObjects
*
* Available Properties:
*
* * config: current extension configuration
* * options: passed running options
*
*/
abstract class Extension implements EventSubscriberInterface
{
/**
* @var array<int|string, mixed>
*/
protected array $config = [];
protected Output $output;
protected array $globalConfig = [];
/**
* @var array<string, Module>
*/
private array $modules = [];
public function __construct(array $config, protected array $options)
{
$this->config = array_merge($this->config, $config);
$this->output = new Output($options);
$this->_initialize();
}
public static function getSubscribedEvents(): array
{
if (!isset(static::$events)) {
return [Events::SUITE_INIT => 'receiveModuleContainer'];
}
if (isset(static::$events[Events::SUITE_INIT])) {
if (!is_array(static::$events[Events::SUITE_INIT])) {
static::$events[Events::SUITE_INIT] = [[static::$events[Events::SUITE_INIT]]];
}
static::$events[Events::SUITE_INIT][] = ['receiveModuleContainer'];
} else {
static::$events[Events::SUITE_INIT] = 'receiveModuleContainer';
}
return static::$events;
}
public function receiveModuleContainer(SuiteEvent $event): void
{
$this->modules = $event->getSuite()->getModules();
}
/**
* Pass config variables that should be injected into global config.
*/
public function _reconfigure(array $config = []): void
{
Configuration::append($config);
}
/**
* You can do all preparations here. No need to override constructor.
* Also you can skip calling `_reconfigure` if you don't need to.
*/
public function _initialize(): void
{
$this->_reconfigure(); // hook for BC only.
}
/**
* @param string|iterable $messages The message as an iterable of strings or a single string
*/
protected function write(iterable|string $messages): void
{
if (!$this->options['silent'] && $messages) {
$this->output->write($messages);
}
}
/**
* @param string|iterable $messages The message as an iterable of strings or a single string
*/
protected function writeln(iterable|string $messages): void
{
if (!$this->options['silent'] && $messages) {
$this->output->writeln($messages);
}
}
public function hasModule(string $name): bool
{
return isset($this->modules[$name]);
}
/**
* @return string[]
*/
public function getCurrentModuleNames(): array
{
return array_keys($this->modules);
}
public function getModule(string $name): Module
{
if (!$this->hasModule($name)) {
throw new ModuleRequireException($name, 'module is not enabled');
}
return $this->modules[$name];
}
public function getTestsDir(): string
{
return Config::testsDir();
}
public function getLogDir(): string
{
return Config::outputDir();
}
public function getDataDir(): string
{
return Config::dataDir();
}
public function getRootDir(): string
{
return Config::projectDir();
}
public function getGlobalConfig(): array
{
return Config::config();
}
}