/
FlashComponentTest.php
315 lines (286 loc) · 9.57 KB
/
FlashComponentTest.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Controller\Component\FlashComponent;
use Cake\Controller\Controller;
use Cake\Core\Configure;
use Cake\Network\Request;
use Cake\Network\Session;
use Cake\TestSuite\TestCase;
use Exception;
/**
* FlashComponentTest class
*/
class FlashComponentTest extends TestCase
{
/**
* setUp method
*
* @return void
*/
public function setUp()
{
parent::setUp();
Configure::write('App.namespace', 'TestApp');
$this->Controller = new Controller(new Request(['session' => new Session()]));
$this->ComponentRegistry = new ComponentRegistry($this->Controller);
$this->Flash = new FlashComponent($this->ComponentRegistry);
$this->Session = new Session();
}
/**
* tearDown method
*
* @return void
*/
public function tearDown()
{
parent::tearDown();
$this->Session->destroy();
}
/**
* testSet method
*
* @return void
* @covers \Cake\Controller\Component\FlashComponent::set
*/
public function testSet()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->set('This is a test message');
$expected = [
[
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'Flash/default',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->set('This is a test message', ['element' => 'test', 'params' => ['foo' => 'bar']]);
$expected[] = [
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'Flash/test',
'params' => ['foo' => 'bar']
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->set('This is a test message', ['element' => 'MyPlugin.alert']);
$expected[] = [
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'MyPlugin.Flash/alert',
'params' => []
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->set('This is a test message', ['key' => 'foobar']);
$expected = [
[
'message' => 'This is a test message',
'key' => 'foobar',
'element' => 'Flash/default',
'params' => []
]
];
$result = $this->Session->read('Flash.foobar');
$this->assertEquals($expected, $result);
}
public function testDuplicateIgnored()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->config('duplicate', false);
$this->Flash->set('This test message should appear once only');
$this->Flash->set('This test message should appear once only');
$result = $this->Session->read('Flash.flash');
$this->assertCount(1, $result);
}
/**
* @return void
*/
public function testSetEscape()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->set('This is a <b>test</b> message', ['escape' => false, 'params' => ['foo' => 'bar']]);
$expected = [
[
'message' => 'This is a <b>test</b> message',
'key' => 'flash',
'element' => 'Flash/default',
'params' => ['foo' => 'bar', 'escape' => false]
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->set('This is a test message', ['key' => 'escaped', 'escape' => false, 'params' => ['foo' => 'bar', 'escape' => true]]);
$expected = [
[
'message' => 'This is a test message',
'key' => 'escaped',
'element' => 'Flash/default',
'params' => ['foo' => 'bar', 'escape' => true]
]
];
$result = $this->Session->read('Flash.escaped');
$this->assertEquals($expected, $result);
}
/**
* test setting messages with using the clear option
*
* @return void
* @covers \Cake\Controller\Component\FlashComponent::set
*/
public function testSetWithClear()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->set('This is a test message');
$expected = [
[
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'Flash/default',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->set('This is another test message', ['clear' => true]);
$expected = [
[
'message' => 'This is another test message',
'key' => 'flash',
'element' => 'Flash/default',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
}
/**
* testSetWithException method
*
* @return void
* @covers \Cake\Controller\Component\FlashComponent::set
*/
public function testSetWithException()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->set(new Exception('This is a test message', 404));
$expected = [
[
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'Flash/default',
'params' => ['code' => 404]
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
}
/**
* testSetWithComponentConfiguration method
*
* @return void
*/
public function testSetWithComponentConfiguration()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Controller->loadComponent('Flash', ['element' => 'test']);
$this->Controller->Flash->set('This is a test message');
$expected = [
[
'message' => 'This is a test message',
'key' => 'flash',
'element' => 'Flash/test',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
}
/**
* Test magic call method.
*
* @covers \Cake\Controller\Component\FlashComponent::__call
* @return void
*/
public function testCall()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->success('It worked');
$expected = [
[
'message' => 'It worked',
'key' => 'flash',
'element' => 'Flash/success',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->error('It did not work', ['element' => 'error_thing']);
$expected[] = [
'message' => 'It did not work',
'key' => 'flash',
'element' => 'Flash/error',
'params' => []
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result, 'Element is ignored in magic call.');
$this->Flash->success('It worked', ['plugin' => 'MyPlugin']);
$expected[] = [
'message' => 'It worked',
'key' => 'flash',
'element' => 'MyPlugin.Flash/success',
'params' => []
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
}
/**
* Test a magic call with the "clear" flag to true
*
* @return void
* @covers \Cake\Controller\Component\FlashComponent::set
*/
public function testCallWithClear()
{
$this->assertNull($this->Session->read('Flash.flash'));
$this->Flash->success('It worked');
$expected = [
[
'message' => 'It worked',
'key' => 'flash',
'element' => 'Flash/success',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
$this->Flash->success('It worked too', ['clear' => true]);
$expected = [
[
'message' => 'It worked too',
'key' => 'flash',
'element' => 'Flash/success',
'params' => []
]
];
$result = $this->Session->read('Flash.flash');
$this->assertEquals($expected, $result);
}
}