This repository was archived by the owner on Mar 2, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDrupalMailSystem.php
More file actions
244 lines (214 loc) · 6.29 KB
/
Copy pathDrupalMailSystem.php
File metadata and controls
244 lines (214 loc) · 6.29 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
<?php
namespace Codeception\Module;
use Codeception\Exception\ModuleConfig;
use Codeception\TestCase;
class DrupalMailSystem extends \Codeception\Module
{
/**
* @var array
* Array of required config fields.
*/
protected $requiredFields = array('enabled');
/**
* @var string
* The previous email system in use.
*/
protected $previousMailSystem;
/**
* @var bool
* If true, emails will not be cleared in _before().
*/
protected $preserveEmails = false;
/**
* @var DrupalVariable
*/
protected $variableModule;
/**
* Store the current mail system.
*
* @param array $settings
*
* @throws ModuleConfig
* If DrupalVariable module is not enabled.
*/
public function _beforeSuite($settings = array())
{
if (!$this->hasModule("DrupalVariable")) {
throw new ModuleConfig(
"DrupalMailSystem",
"DrupalMailSystem requires DrupalVariable module."
);
}
$this->variableModule = $this->getModule("DrupalVariable");
if ($this->config['enabled']) {
$this->previousMailSystem = $this->enableTestingMailSystem();
}
}
/**
* Restore the previous mail system.
*/
public function _afterSuite()
{
if ($this->config['enabled']) {
$this->restoreMailSystem();
}
}
/**
* Delete all stored emails prior to each test.
*/
public function _before(TestCase $test)
{
if ($this->config['enabled']) {
if (!$this->preserveEmails) {
$this->clearSentEmails();
}
$this->preserveEmails = false;
}
}
/**
* Enable the testing mail system.
*
* @return array
* The previous mail system.
*/
protected function enableTestingMailSystem()
{
$system = $this->variableModule->getVariable("mail_system");
if (!$system) {
$system = array('default-system' => 'DefaultMailSystem');
}
$test_system = array('default-system' => 'TestingMailSystem');
$this->variableModule
->haveVariable("mail_system", $test_system);
$this->clearSentEmails();
return $system;
}
/**
* Restore the previous mail system.
*/
protected function restoreMailSystem()
{
if (empty($this->previousMailSystem)) {
throw new \LogicException("previous_mail_system has not been set yet.");
}
$this->variableModule
->haveVariable("mail_system", $this->previousMailSystem);
}
/**
* Clear any sent emails.
*
* Useful in preparation for next tests.
*/
public function clearSentEmails()
{
$this->variableModule
->dontHaveVariable('drupal_test_email_collector');
}
/**
* Return the emails sent so far.
*
* @return array
* An array of message arrays, as described in hook_mail_alter().
*/
public function grabSentEmails()
{
return $this->variableModule
->getVariable("drupal_test_email_collector", array());
}
/**