-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
CellTest.php
553 lines (498 loc) · 17.4 KB
/
CellTest.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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
<?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.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\View;
use Cake\Cache\Cache;
use Cake\Core\Plugin;
use Cake\TestSuite\TestCase;
use Cake\View\Exception\MissingCellViewException;
use Cake\View\Exception\MissingTemplateException;
use Cake\View\View;
use TestApp\Controller\CellTraitTestController;
use TestApp\View\CustomJsonView;
/**
* CellTest class.
*
* For testing both View\Cell & Utility\CellTrait
*/
class CellTest extends TestCase
{
/**
* @var \Cake\View\View
*/
public $View;
/**
* setUp method
*
* @return void
*/
public function setUp()
{
parent::setUp();
static::setAppNamespace();
$this->loadPlugins(['TestPlugin', 'TestTheme']);
$request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
$response = $this->getMockBuilder('Cake\Http\Response')->getMock();
$this->View = new View($request, $response);
}
/**
* tearDown method
*
* @return void
*/
public function tearDown()
{
parent::tearDown();
Plugin::unload();
unset($this->View);
}
/**
* Tests basic cell rendering.
*
* @return void
*/
public function testCellRender()
{
$cell = $this->View->cell('Articles::teaserList');
$render = "{$cell}";
$this->assertEquals('teaser_list', $cell->viewBuilder()->getTemplate());
$this->assertContains('<h2>Lorem ipsum</h2>', $render);
$this->assertContains('<h2>Usectetur adipiscing eli</h2>', $render);
$this->assertContains('<h2>Topis semper blandit eu non</h2>', $render);
$this->assertContains('<h2>Suspendisse gravida neque</h2>', $render);
$cell = $this->View->cell('Cello');
$this->assertInstanceOf('TestApp\View\Cell\CelloCell', $cell);
$this->assertEquals("Cellos\n", $cell->render());
}
/**
* Tests debug output.
*
* @return void
*/
public function testDebugInfo()
{
$cell = $this->View->cell('Articles::teaserList');
$data = $cell->__debugInfo();
$this->assertArrayHasKey('request', $data);
$this->assertArrayHasKey('response', $data);
$this->assertEquals('teaserList', $data['action']);
$this->assertEquals([], $data['args']);
}
/**
* Test __toString() hitting an error when rendering views.
*
* @return void
*/
public function testCellImplictRenderWithError()
{
$capture = function ($errno, $msg) {
restore_error_handler();
$this->assertEquals(E_USER_WARNING, $errno);
$this->assertContains('Could not render cell - Cell view file', $msg);
};
set_error_handler($capture);
$cell = $this->View->cell('Articles::teaserList');
$cell->viewBuilder()->setTemplate('nope');
$result = "{$cell}";
}
/**
* Tests that we are able pass multiple arguments to cell methods.
*
* This test sets its own error handler, as PHPUnit won't convert
* errors into exceptions when the caller is a __toString() method.
*
* @return void
*/
public function testCellWithArguments()
{
$cell = $this->View->cell('Articles::doEcho', ['msg1' => 'dummy', 'msg2' => ' message']);
$render = "{$cell}";
$this->assertContains('dummy message', $render);
}
/**
* Tests that cell runs default action when none is provided.
*
* @return void
*/
public function testDefaultCellAction()
{
$appCell = $this->View->cell('Articles');
$this->assertEquals('display', $appCell->viewBuilder()->getTemplate());
$this->assertContains('dummy', "{$appCell}");
$pluginCell = $this->View->cell('TestPlugin.Dummy');
$this->assertContains('dummy', "{$pluginCell}");
$this->assertEquals('display', $pluginCell->viewBuilder()->getTemplate());
}
/**
* Tests that cell action setting the template using the property renders the correct template
*
* @return void
*/
public function testSettingCellTemplateFromAction()
{
$this->deprecated(function () {
$appCell = $this->View->cell('Articles::customTemplate');
$this->assertContains('This is the alternate template', "{$appCell}");
$this->assertEquals('alternate_teaser_list', $appCell->viewBuilder()->getTemplate());
$this->assertEquals('alternate_teaser_list', $appCell->template);
});
}
/**
* Tests that cell action setting the templatePath
*
* @return void
*/
public function testSettingCellTemplatePathFromAction()
{
$appCell = $this->View->cell('Articles::customTemplatePath');
$this->assertContains('Articles subdir custom_template_path template', "{$appCell}");
$this->assertEquals('custom_template_path', $appCell->viewBuilder()->getTemplate());
$this->assertEquals('Cell/Articles/Subdir', $appCell->viewBuilder()->getTemplatePath());
}
/**
* Tests that cell action setting the template using the ViewBuilder renders the correct template
*
* @return void
*/
public function testSettingCellTemplateFromActionViewBuilder()
{
$appCell = $this->View->cell('Articles::customTemplateViewBuilder');
$this->assertContains('This is the alternate template', "{$appCell}");
$this->assertEquals('alternate_teaser_list', $appCell->viewBuilder()->getTemplate());
}
/**
* Tests manual render() invocation.
*
* @return void
*/
public function testCellManualRender()
{
$cell = $this->View->cell('Articles::doEcho', ['msg1' => 'dummy', 'msg2' => ' message']);
$this->assertContains('dummy message', $cell->render());
$cell->teaserList();
$this->assertContains('<h2>Lorem ipsum</h2>', $cell->render('teaser_list'));
}
/**
* Tests manual render() invocation with error
*
* @return void
*/
public function testCellManualRenderError()
{
$cell = $this->View->cell('Articles');
$e = null;
try {
$cell->render('derp');
} catch (MissingCellViewException $e) {
}
$this->assertNotNull($e);
$this->assertEquals('Cell view file "derp" is missing.', $e->getMessage());
$this->assertInstanceOf(MissingTemplateException::class, $e->getPrevious());
}
/**
* Test rendering a cell with a theme.
*
* @return void
*/
public function testCellRenderThemed()
{
$this->View->setTheme('TestTheme');
$cell = $this->View->cell('Articles', ['msg' => 'hello world!']);
$this->assertEquals($this->View->getTheme(), $cell->viewBuilder()->getTheme());
$this->assertContains('Themed cell content.', $cell->render());
}
/**
* Test that a cell can render a plugin view.
*
* @return void
*/
public function testCellRenderPluginTemplate()
{
$cell = $this->View->cell('Articles');
$this->assertContains(
'TestPlugin Articles/display',
$cell->render('TestPlugin.display')
);
$cell = $this->View->cell('Articles');
$cell->viewBuilder()->setPlugin('TestPlugin');
$this->assertContains(
'TestPlugin Articles/display',
$cell->render('display')
);
}
/**
* Tests that using plugin's cells works.
*
* @return void
*/
public function testPluginCell()
{
$cell = $this->View->cell('TestPlugin.Dummy::echoThis', ['msg' => 'hello world!']);
$this->assertContains('hello world!', "{$cell}");
}
/**
* Tests that using namespaced cells works.
*
* @return void
*/
public function testNamespacedCell()
{
$cell = $this->View->cell('Admin/Menu');
$this->assertContains('Admin Menu Cell', $cell->render());
}
/**
* Tests that using namespaced cells in plugins works
*
* @return void
*/
public function testPluginNamespacedCell()
{
$cell = $this->View->cell('TestPlugin.Admin/Menu');
$this->assertContains('Test Plugin Admin Menu Cell', $cell->render());
}
/**
* Test that plugin cells can render other view templates.
*
* @return void
*/
public function testPluginCellAlternateTemplate()
{
$cell = $this->View->cell('TestPlugin.Dummy::echoThis', ['msg' => 'hello world!']);
$cell->viewBuilder()->setTemplate('../../Element/translate');
$this->assertContains('This is a translatable string', "{$cell}");
}
/**
* Test that plugin cells can render other view templates.
*
* @return void
*/
public function testPluginCellAlternateTemplateRenderParam()
{
$cell = $this->View->cell('TestPlugin.Dummy::echoThis', ['msg' => 'hello world!']);
$result = $cell->render('../../Element/translate');
$this->assertContains('This is a translatable string', $result);
}
/**
* Tests that using an non-existent cell throws an exception.
*
* @return void
*/
public function testNonExistentCell()
{
$this->expectException(\Cake\View\Exception\MissingCellException::class);
$cell = $this->View->cell('TestPlugin.Void::echoThis', ['arg1' => 'v1']);
$cell = $this->View->cell('Void::echoThis', ['arg1' => 'v1', 'arg2' => 'v2']);
}
/**
* Tests missing method errors
*
* @return void
*/
public function testCellMissingMethod()
{
$this->expectException(\BadMethodCallException::class);
$this->expectExceptionMessage('Class TestApp\View\Cell\ArticlesCell does not have a "nope" method.');
$cell = $this->View->cell('Articles::nope');
$cell->render();
}
/**
* Test that cell options are passed on.
*
* @return void
*/
public function testCellOptions()
{
$cell = $this->View->cell('Articles', [], ['limit' => 10, 'nope' => 'nope']);
$this->assertEquals(10, $cell->limit);
$this->assertObjectNotHasAttribute('nope', $cell, 'Not a valid option');
}
/**
* Test that cells get the helper configuration from the view that created them.
*
* @return void
*/
public function testCellInheritsHelperConfig()
{
$request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
$response = $this->getMockBuilder('Cake\Http\Response')->getMock();
$helpers = ['Url', 'Form', 'Banana'];
$view = new View($request, $response, null, ['helpers' => $helpers]);
$cell = $view->cell('Articles');
$this->assertSame($helpers, $cell->viewBuilder()->getHelpers());
$this->deprecated(function () use ($cell, $helpers) {
$this->assertSame($helpers, $cell->helpers);
});
}
/**
* Test that cells the view class name of a custom view passed on.
*
* @return void
*/
public function testCellInheritsCustomViewClass()
{
$request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
$response = $this->getMockBuilder('Cake\Http\Response')->getMock();
$view = new CustomJsonView($request, $response);
$view->setTheme('Pretty');
$cell = $view->cell('Articles');
$this->assertSame('TestApp\View\CustomJsonView', $cell->viewClass);
$this->assertSame('TestApp\View\CustomJsonView', $cell->viewBuilder()->getClassName());
$this->assertSame('Pretty', $cell->viewBuilder()->getTheme());
}
/**
* Test that cells the view class name of a controller passed on.
*
* @return void
*/
public function testCellInheritsController()
{
$request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
$response = $this->getMockBuilder('Cake\Http\Response')->getMock();
$controller = new CellTraitTestController($request, $response);
$controller->viewBuilder()->setTheme('Pretty');
$controller->viewClass = 'Json';
$cell = $controller->cell('Articles');
$this->assertSame('Json', $cell->viewClass);
$this->assertSame('Json', $cell->viewBuilder()->getClassName());
$this->assertSame('Pretty', $cell->viewBuilder()->getTheme());
}
/**
* Test cached render.
*
* @return void
*/
public function testCachedRenderSimple()
{
$mock = $this->getMockBuilder('Cake\Cache\CacheEngine')->getMock();
$mock->method('init')
->will($this->returnValue(true));
$mock->method('read')
->will($this->returnValue(false));
$mock->expects($this->once())
->method('write')
->with('cell_test_app_view_cell_articles_cell_display_default', "dummy\n");
Cache::setConfig('default', $mock);
$cell = $this->View->cell('Articles', [], ['cache' => true]);
$result = $cell->render();
$this->assertEquals("dummy\n", $result);
Cache::drop('default');
}
/**
* Test read cached cell.
*
* @return void
*/
public function testReadCachedCell()
{
$mock = $this->getMockBuilder('Cake\Cache\CacheEngine')->getMock();
$mock->method('init')
->will($this->returnValue(true));
$mock->method('read')
->will($this->returnValue("dummy\n"));
$mock->expects($this->never())
->method('write');
Cache::setConfig('default', $mock);
$cell = $this->View->cell('Articles', [], ['cache' => true]);
$result = $cell->render();
$this->assertEquals("dummy\n", $result);
Cache::drop('default');
}
/**
* Test cached render array config
*
* @return void
*/
public function testCachedRenderArrayConfig()
{
$mock = $this->getMockBuilder('Cake\Cache\CacheEngine')->getMock();
$mock->method('init')
->will($this->returnValue(true));
$mock->method('read')
->will($this->returnValue(false));
$mock->expects($this->once())
->method('write')
->with('my_key', "dummy\n");
Cache::setConfig('cell', $mock);
$cell = $this->View->cell('Articles', [], [
'cache' => ['key' => 'my_key', 'config' => 'cell']
]);
$result = $cell->render();
$this->assertEquals("dummy\n", $result);
Cache::drop('cell');
}
/**
* Test cached render when using an action changing the template used
*
* @return void
*/
public function testCachedRenderSimpleCustomTemplate()
{
$mock = $this->getMockBuilder('Cake\Cache\CacheEngine')->getMock();
$mock->method('init')
->will($this->returnValue(true));
$mock->method('read')
->will($this->returnValue(false));
$mock->expects($this->once())
->method('write')
->with('cell_test_app_view_cell_articles_cell_customTemplate_default', "<h1>This is the alternate template</h1>\n");
Cache::setConfig('default', $mock);
$this->deprecated(function () {
$cell = $this->View->cell('Articles::customTemplate', [], ['cache' => true]);
$result = $cell->render();
$this->assertContains('This is the alternate template', $result);
});
Cache::drop('default');
}
/**
* Test that when the cell cache is enabled, the cell action is only invoke the first
* time the cell is rendered
*
* @return void
*/
public function testCachedRenderSimpleCustomTemplateViewBuilder()
{
Cache::setConfig('default', [
'className' => 'File',
'path' => CACHE,
]);
$cell = $this->View->cell('Articles::customTemplateViewBuilder', [], ['cache' => ['key' => 'celltest']]);
$result = $cell->render();
$this->assertEquals(1, $cell->counter);
$cell->render();
$this->assertEquals(1, $cell->counter);
$this->assertContains('This is the alternate template', $result);
Cache::delete('celltest');
Cache::drop('default');
}
/**
* Test that when the cell cache is enabled, the cell action is only invoke the first
* time the cell is rendered
*
* @return void
*/
public function testACachedViewCellReRendersWhenGivenADifferentTemplate()
{
Cache::setConfig('default', [
'className' => 'File',
'path' => CACHE,
]);
$cell = $this->View->cell('Articles::customTemplateViewBuilder', [], ['cache' => true]);
$result = $cell->render('alternate_teaser_list');
$result2 = $cell->render('not_the_alternate_teaser_list');
$this->assertContains('This is the alternate template', $result);
$this->assertContains('This is NOT the alternate template', $result2);
Cache::delete('celltest');
Cache::drop('default');
}
}