-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathExtensionLoader.php
More file actions
162 lines (137 loc) · 4.82 KB
/
Copy pathExtensionLoader.php
File metadata and controls
162 lines (137 loc) · 4.82 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
<?php
declare(strict_types=1);
namespace Codeception\Subscriber;
use Codeception\Configuration;
use Codeception\Event\SuiteEvent;
use Codeception\Events;
use Codeception\Exception\ConfigurationException;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use function class_exists;
use function is_array;
use function key;
use function reset;
class ExtensionLoader implements EventSubscriberInterface
{
use Shared\StaticEventsTrait;
/**
* @var array<string, string>
*/
protected static array $events = [
Events::MODULE_INIT => 'registerSuiteExtensions',
Events::SUITE_AFTER => 'stopSuiteExtensions'
];
/**
* @var array<string, mixed>
*/
protected array $config = [];
/**
* @var array<string, mixed>
*/
protected array $options = [];
/**
* @var array<class-string, EventSubscriberInterface>
*/
protected array $globalExtensions = [];
/**
* @var array<class-string, EventSubscriberInterface>
*/
protected array $suiteExtensions = [];
public function __construct(protected EventDispatcher $dispatcher)
{
$this->config = Configuration::config();
}
/**
* @param array<string, mixed> $options
* @throws ConfigurationException
*/
public function bootGlobalExtensions(array $options): void
{
$this->options = $options;
$this->globalExtensions = $this->bootExtensions($this->config);
}
public function registerGlobalExtensions(): void
{
foreach ($this->globalExtensions as $extension) {
$this->dispatcher->addSubscriber($extension);
}
}
public function registerSuiteExtensions(SuiteEvent $event): void
{
$suiteConfig = $event->getSettings();
$extensions = $this->bootExtensions($suiteConfig);
$this->suiteExtensions = [];
foreach ($extensions as $extension) {
$extensionClass = $extension::class;
if (isset($this->globalExtensions[$extensionClass])) {
continue; // already globally enabled
}
$this->dispatcher->addSubscriber($extension);
$this->suiteExtensions[$extensionClass] = $extension;
}
}
public function stopSuiteExtensions(): void
{
foreach ($this->suiteExtensions as $extension) {
$this->dispatcher->removeSubscriber($extension);
}
$this->suiteExtensions = [];
}
/**
* @param array<string, mixed> $config
* @return array<class-string, EventSubscriberInterface>
* @throws ConfigurationException
*/
protected function bootExtensions(array $config): array
{
$extensions = [];
foreach ($config['extensions']['enabled'] as $extensionClass) {
if (is_array($extensionClass)) {
$extensionClass = key($extensionClass);
}
if (!class_exists($extensionClass)) {
throw new ConfigurationException(
"Class `{$extensionClass}` is not defined. Autoload it or include into "
. "'_bootstrap.php' file of 'tests' directory"
);
}
$extensionConfig = $this->getExtensionConfig($extensionClass, $config);
$extension = new $extensionClass($extensionConfig, $this->options);
if (!$extension instanceof EventSubscriberInterface) {
throw new ConfigurationException(
"Class {$extensionClass} is not an EventListener. Please create it as Extension or GroupObject."
);
}
$extensions[$extension::class] = $extension;
}
return $extensions;
}
/**
* @param array<string, mixed> $config
* @return array<string, mixed>
*/
private function getExtensionConfig(string $extension, array $config): array
{
$extensionConfig = $config['extensions']['config'][$extension] ?? [];
if (!isset($config['extensions']['enabled'])) {
return $extensionConfig;
}
if (!is_array($config['extensions']['enabled'])) {
return $extensionConfig;
}
foreach ($config['extensions']['enabled'] as $enabledExtensionsConfig) {
if (!is_array($enabledExtensionsConfig)) {
continue;
}
$enabledExtension = key($enabledExtensionsConfig);
if ($enabledExtension === $extension) {
$enabledExtensionConfig = reset($enabledExtensionsConfig);
if (!is_array($enabledExtensionConfig)) {
return $extensionConfig;
}
return Configuration::mergeConfigs($enabledExtensionConfig, $extensionConfig);
}
}
return $extensionConfig;
}
}