-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
EmailAssertTrait.php
292 lines (265 loc) · 9 KB
/
EmailAssertTrait.php
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.3.3
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\TestSuite;
use Cake\Mailer\Email;
/**
* Email and mailer assertions.
*
* @method \PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount any()
* @method void assertSame($expected, $result, $message)
* @method void assertTextContains($needle, $haystack, $message)
* @method \PHPUnit_Framework_MockObject_MockBuilder getMockBuilder($className)
*/
trait EmailAssertTrait
{
/**
* @var \Cake\Mailer\Email
*/
protected $_email;
/**
* Sends email using the test email instance.
*
* @param array|string|null $content The email's content to send.
* @return void
*/
public function send($content = null)
{
$this->email(true)->send($content);
}
/**
* Creates an email instance overriding its transport for testing purposes.
*
* @param bool $new Tells if new instance should forcibly be created.
* @return \Cake\Mailer\Email
*/
public function email($new = false)
{
if ($new || !$this->_email) {
$this->_email = new Email();
$this->_email->setProfile(['transport' => 'debug'] + $this->_email->getProfile());
}
return $this->_email;
}
/**
* Generates mock for given mailer class.
*
* @param string $className The mailer's FQCN.
* @param array $methods The methods to mock on the mailer.
* @return \Cake\Mailer\Mailer|\PHPUnit_Framework_MockObject_MockObject
*/
public function getMockForMailer($className, array $methods = [])
{
$name = current(array_slice(explode('\\', $className), -1));
if (!in_array('profile', $methods)) {
$methods[] = 'profile';
}
$mailer = $this->getMockBuilder($className)
->setMockClassName($name)
->setMethods($methods)
->setConstructorArgs([$this->email()])
->getMock();
$mailer->expects($this->any())
->method('profile')
->willReturn($mailer);
return $mailer;
}
/**
* Asserts email content (both text and HTML) contains `$needle`.
*
* @param string $needle Text to look for.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailMessageContains($needle, $message = null)
{
$this->assertEmailHtmlMessageContains($needle, $message);
$this->assertEmailTextMessageContains($needle, $message);
}
/**
* Asserts HTML email content contains `$needle`.
*
* @param string $needle Text to look for.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailHtmlMessageContains($needle, $message = null)
{
$haystack = $this->email()->message('html');
$this->assertTextContains($needle, $haystack, $message);
}
/**
* Asserts text email content contains `$needle`.
*
* @param string $needle Text to look for.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailTextMessageContains($needle, $message = null)
{
$haystack = $this->email()->message('text');
$this->assertTextContains($needle, $haystack, $message);
}
/**
* Asserts email's subject contains `$expected`.
*
* @param string $expected Email's subject.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailSubject($expected, $message = null)
{
$result = $this->email()->getSubject();
$this->assertSame($expected, $result, $message);
}
/**
* Asserts email's sender email address and optionally name.
*
* @param string $email Sender's email address.
* @param string|null $name Sender's name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailFrom($email, $name = null, $message = null)
{
if ($name === null) {
$name = $email;
}
$expected = [$email => $name];
$result = $this->email()->getFrom();
$this->assertSame($expected, $result, $message);
}
/**
* Asserts email is CC'd to only one email address (and optionally name).
*
* @param string $email CC'd email address.
* @param string|null $name CC'd person name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailCc($email, $name = null, $message = null)
{
if ($name === null) {
$name = $email;
}
$expected = [$email => $name];
$result = $this->email()->getCc();
$this->assertSame($expected, $result, $message);
}
/**
* Asserts email CC'd addresses contain given email address (and
* optionally name).
*
* @param string $email CC'd email address.
* @param string|null $name CC'd person name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailCcContains($email, $name = null, $message = null)
{
$result = $this->email()->getCc();
$this->assertNotEmpty($result[$email], $message);
if ($name !== null) {
$this->assertEquals($result[$email], $name, $message);
}
}
/**
* Asserts email is BCC'd to only one email address (and optionally name).
*
* @param string $email BCC'd email address.
* @param string|null $name BCC'd person name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailBcc($email, $name = null, $message = null)
{
if ($name === null) {
$name = $email;
}
$expected = [$email => $name];
$result = $this->email()->getBcc();
$this->assertSame($expected, $result, $message);
}
/**
* Asserts email BCC'd addresses contain given email address (and
* optionally name).
*
* @param string $email BCC'd email address.
* @param string|null $name BCC'd person name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailBccContains($email, $name = null, $message = null)
{
$result = $this->email()->getBcc();
$this->assertNotEmpty($result[$email], $message);
if ($name !== null) {
$this->assertEquals($result[$email], $name, $message);
}
}
/**
* Asserts email is sent to only the given recipient's address (and
* optionally name).
*
* @param string $email Recipient's email address.
* @param string|null $name Recipient's name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailTo($email, $name = null, $message = null)
{
if ($name === null) {
$name = $email;
}
$expected = [$email => $name];
$result = $this->email()->getTo();
$this->assertSame($expected, $result, $message);
}
/**
* Asserts email recipients' list contains given email address (and
* optionally name).
*
* @param string $email Recipient's email address.
* @param string|null $name Recipient's name.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailToContains($email, $name = null, $message = null)
{
$result = $this->email()->getTo();
$this->assertNotEmpty($result[$email], $message);
if ($name !== null) {
$this->assertEquals($result[$email], $name, $message);
}
}
/**
* Asserts the email attachments contain the given filename (and optionally
* file info).
*
* @param string $filename Expected attachment's filename.
* @param array|null $file Expected attachment's file info.
* @param string|null $message The failure message to define.
* @return void
*/
public function assertEmailAttachmentsContains($filename, array $file = null, $message = null)
{
$result = $this->email()->getAttachments();
$this->assertNotEmpty($result[$filename], $message);
if ($file === null) {
return;
}
$this->assertContains($file, $result, $message);
$this->assertEquals($file, $result[$filename], $message);
}
}