-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
TestTask.php
520 lines (482 loc) · 15.1 KB
/
TestTask.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
<?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 1.3.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console\Command\Task;
use Cake\Console\Shell;
use Cake\Controller\Controller;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Error;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\ORM\Association;
use Cake\ORM\Table;
use Cake\ORM\TableRegistry;
use Cake\Utility\Folder;
use Cake\Utility\Inflector;
/**
* Task class for creating and updating test files.
*
*/
class TestTask extends BakeTask {
/**
* Tasks used.
*
* @var array
*/
public $tasks = ['Template'];
/**
* class types that methods can be generated for
*
* @var array
*/
public $classTypes = [
'Entity' => 'Model\Entity',
'Table' => 'Model\Table',
'Controller' => 'Controller',
'Component' => 'Controller\Component',
'Behavior' => 'Model\Behavior',
'Helper' => 'View\Helper',
'Shell' => 'Console\Command',
'Cell' => 'View\Cell',
];
/**
* class types that methods can be generated for
*
* @var array
*/
public $classSuffixes = [
'entity' => '',
'table' => 'Table',
'controller' => 'Controller',
'component' => 'Component',
'behavior' => 'Behavior',
'helper' => 'Helper',
'shell' => 'Shell',
'cell' => 'Cell',
];
/**
* Internal list of fixtures that have been added so far.
*
* @var array
*/
protected $_fixtures = [];
/**
* Execution method always used for tasks
*
* @param string $type Class type.
* @param string $name Name.
* @return void
*/
public function main($type = null, $name = null) {
parent::main();
if (empty($type) && empty($name)) {
return $this->outputTypeChoices();
}
if (empty($name)) {
return $this->outputClassChoices($type);
}
if ($this->bake($type, $name)) {
$this->out('<success>Done</success>');
}
}
/**
* Output a list of class types you can bake a test for.
*
* @return void
*/
public function outputTypeChoices() {
$this->out(
__d('cake_console', 'You must provide a class type to bake a test for. The valid types are:'),
2
);
$i = 0;
foreach ($this->classTypes as $option => $package) {
$this->out(++$i . '. ' . $option);
}
$this->out('');
$this->out('Re-run your command as Console/cake bake <type> <classname>');
}
/**
* Output a list of possible classnames you might want to generate a test for.
*
* @param string $type The typename to get classes for.
* @return void
*/
public function outputClassChoices($type) {
$type = $this->mapType($type);
$plugin = null;
if (!empty($this->plugin)) {
$plugin = $this->plugin;
}
$this->out(
__d('cake_console', 'You must provide a class to bake a test for. Some possible options are:'),
2
);
$options = $this->_getClassOptions($type);
$i = 0;
foreach ($options as $option) {
$this->out(++$i . '. ' . $option);
}
$this->out('');
$this->out('Re-run your command as Console/cake bake ' . $type . ' <classname>');
}
/**
* Get the possible classes for a given type.
*
* @param string $namespace The namespace fragment to look for classes in.
* @return array
*/
protected function _getClassOptions($namespace) {
$classes = [];
$base = APP;
if ($this->plugin) {
$base = Plugin::classPath($this->plugin);
}
$path = $base . str_replace('\\', DS, $namespace);
$folder = new Folder($path);
list($dirs, $files) = $folder->read();
foreach ($files as $file) {
$classes[] = str_replace('.php', '', $file);
}
return $classes;
}
/**
* Completes final steps for generating data to create test case.
*
* @param string $type Type of object to bake test case for ie. Model, Controller
* @param string $className the 'cake name' for the class ie. Posts for the PostsController
* @return string|bool
*/
public function bake($type, $className) {
$fullClassName = $this->getRealClassName($type, $className);
if (!empty($this->params['fixtures'])) {
$fixtures = array_map('trim', explode(',', $this->params['fixtures']));
$this->_fixtures = array_filter($fixtures);
} elseif ($this->typeCanDetectFixtures($type) && class_exists($fullClassName)) {
$this->out(__d('cake_console', 'Bake is detecting possible fixtures...'));
$testSubject = $this->buildTestSubject($type, $fullClassName);
$this->generateFixtureList($testSubject);
}
$methods = [];
if (class_exists($fullClassName)) {
$methods = $this->getTestableMethods($fullClassName);
}
$mock = $this->hasMockClass($type, $fullClassName);
list($preConstruct, $construction, $postConstruct) = $this->generateConstructor($type, $fullClassName);
$uses = $this->generateUses($type, $fullClassName);
$subject = $className;
list($namespace, $className) = namespaceSplit($fullClassName);
list($baseNamespace, $subNamespace) = explode('\\', $namespace, 2);
$this->out("\n" . __d('cake_console', 'Baking test case for %s ...', $fullClassName), 1, Shell::QUIET);
$this->Template->set('fixtures', $this->_fixtures);
$this->Template->set('plugin', $this->plugin);
$this->Template->set(compact(
'subject', 'className', 'methods', 'type', 'fullClassName', 'mock',
'realType', 'preConstruct', 'postConstruct', 'construction',
'uses', 'baseNamespace', 'subNamespace', 'namespace'
));
$out = $this->Template->generate('classes', 'test');
$filename = $this->testCaseFileName($type, $fullClassName);
if ($this->createFile($filename, $out)) {
return $out;
}
return false;
}
/**
* Checks whether the chosen type can find its own fixtures.
* Currently only model, and controller are supported
*
* @param string $type The Type of object you are generating tests for eg. controller
* @return bool
*/
public function typeCanDetectFixtures($type) {
$type = strtolower($type);
return in_array($type, ['controller', 'table']);
}
/**
* Construct an instance of the class to be tested.
* So that fixtures can be detected
*
* @param string $type The type of object you are generating tests for eg. controller
* @param string $class The classname of the class the test is being generated for.
* @return object And instance of the class that is going to be tested.
*/
public function buildTestSubject($type, $class) {
if (strtolower($type) === 'table') {
list($namespace, $name) = namespaceSplit($class);
$name = str_replace('Table', '', $name);
if ($this->plugin) {
$name = $this->plugin . '.' . $name;
}
$instance = TableRegistry::get($name);
} elseif (strtolower($type) === 'controller') {
$instance = new $class(new Request(), new Response());
} else {
$instance = new $class();
}
return $instance;
}
/**
* Gets the real class name from the cake short form. If the class name is already
* suffixed with the type, the type will not be duplicated.
*
* @param string $type The Type of object you are generating tests for eg. controller.
* @param string $class the Classname of the class the test is being generated for.
* @return string Real class name
*/
public function getRealClassName($type, $class) {
$namespace = Configure::read('App.namespace');
if ($this->plugin) {
$namespace = Plugin::getNamespace($this->plugin);
}
$suffix = $this->classSuffixes[strtolower($type)];
$subSpace = $this->mapType($type);
if ($suffix && strpos($class, $suffix) === false) {
$class .= $suffix;
}
return $namespace . '\\' . $subSpace . '\\' . $class;
}
/**
* Map the types that TestTask uses to concrete types that App::className can use.
*
* @param string $type The type of thing having a test generated.
* @return string
* @throws \Cake\Error\Exception When invalid object types are requested.
*/
public function mapType($type) {
$type = ucfirst($type);
if (empty($this->classTypes[$type])) {
throw new Error\Exception('Invalid object type.');
}
return $this->classTypes[$type];
}
/**
* Get methods declared in the class given.
* No parent methods will be returned
*
* @param string $className Name of class to look at.
* @return array Array of method names.
*/
public function getTestableMethods($className) {
$classMethods = get_class_methods($className);
$parentMethods = get_class_methods(get_parent_class($className));
$thisMethods = array_diff($classMethods, $parentMethods);
$out = [];
foreach ($thisMethods as $method) {
if (substr($method, 0, 1) !== '_' && $method != strtolower($className)) {
$out[] = $method;
}
}
return $out;
}
/**
* Generate the list of fixtures that will be required to run this test based on
* loaded models.
*
* @param object $subject The object you want to generate fixtures for.
* @return array Array of fixtures to be included in the test.
*/
public function generateFixtureList($subject) {
$this->_fixtures = [];
if ($subject instanceof Table) {
$this->_processModel($subject);
} elseif ($subject instanceof Controller) {
$this->_processController($subject);
}
return array_values($this->_fixtures);
}
/**
* Process a model recursively and pull out all the
* model names converting them to fixture names.
*
* @param Model $subject A Model class to scan for associations and pull fixtures off of.
* @return void
*/
protected function _processModel($subject) {
$this->_addFixture($subject->alias());
foreach ($subject->associations()->keys() as $alias) {
$assoc = $subject->association($alias);
$name = $assoc->target()->alias();
if (!isset($this->_fixtures[$name])) {
$this->_processModel($assoc->target());
}
if ($assoc->type() === Association::MANY_TO_MANY) {
$junction = $assoc->junction();
if (!isset($this->_fixtures[$junction->alias()])) {
$this->_processModel($junction);
}
}
}
}
/**
* Process all the models attached to a controller
* and generate a fixture list.
*
* @param \Cake\Controller\Controller $subject A controller to pull model names off of.
* @return void
*/
protected function _processController($subject) {
$subject->constructClasses();
$models = [$subject->modelClass];
foreach ($models as $model) {
list(, $model) = pluginSplit($model);
$this->_processModel($subject->{$model});
}
}
/**
* Add class name to the fixture list.
* Sets the app. or plugin.plugin_name. prefix.
*
* @param string $name Name of the Model class that a fixture might be required for.
* @return void
*/
protected function _addFixture($name) {
if ($this->plugin) {
$prefix = 'plugin.' . Inflector::underscore($this->plugin) . '.';
} else {
$prefix = 'app.';
}
$fixture = $prefix . $this->_fixtureName($name);
$this->_fixtures[$name] = $fixture;
}
/**
* Is a mock class required for this type of test?
* Controllers require a mock class.
*
* @param string $type The type of object tests are being generated for eg. controller.
* @return bool
*/
public function hasMockClass($type) {
$type = strtolower($type);
return $type === 'controller';
}
/**
* Generate a constructor code snippet for the type and class name
*
* @param string $type The Type of object you are generating tests for eg. controller
* @param string $fullClassName The full classname of the class the test is being generated for.
* @return array Constructor snippets for the thing you are building.
*/
public function generateConstructor($type, $fullClassName) {
list($namespace, $className) = namespaceSplit($fullClassName);
$type = strtolower($type);
$pre = $construct = $post = '';
if ($type === 'table') {
$className = str_replace('Table', '', $className);
$pre = "\$config = TableRegistry::exists('{$className}') ? [] : ['className' => '{$fullClassName}'];\n";
$construct = "TableRegistry::get('{$className}', \$config);\n";
}
if ($type === 'behavior' || $type === 'entity') {
$construct = "new {$className}();\n";
}
if ($type === 'helper') {
$pre = "\$view = new View();\n";
$construct = "new {$className}(\$view);\n";
}
if ($type === 'component') {
$pre = "\$registry = new ComponentRegistry();\n";
$construct = "new {$className}(\$registry);\n";
}
if ($type === 'shell') {
$pre = "\$this->io = \$this->getMock('Cake\Console\ConsoleIo');\n";
$construct = "new {$className}(\$this->io);\n";
}
if ($type === 'cell') {
$pre = "\$this->request = \$this->getMock('Cake\Network\Request');\n";
$pre .= "\t\t\$this->response = \$this->getMock('Cake\Network\Response');\n";
$construct = "new {$className}(\$this->request, \$this->response);\n";
}
return [$pre, $construct, $post];
}
/**
* Generate the uses() calls for a type & class name
*
* @param string $type The Type of object you are generating tests for eg. controller
* @param string $fullClassName The Classname of the class the test is being generated for.
* @return array An array containing used classes
*/
public function generateUses($type, $fullClassName) {
$uses = [];
$type = strtolower($type);
if ($type === 'component') {
$uses[] = 'Cake\Controller\ComponentRegistry';
}
if ($type === 'table') {
$uses[] = 'Cake\ORM\TableRegistry';
}
if ($type === 'helper') {
$uses[] = 'Cake\View\View';
}
$uses[] = $fullClassName;
return $uses;
}
/**
* Get the file path.
*
* @return string
*/
public function getPath() {
$dir = 'tests/TestCase/';
$path = ROOT . DS . $dir;
if (isset($this->plugin)) {
$path = $this->_pluginPath($this->plugin) . 'tests/TestCase/';
}
return $path;
}
/**
* Make the filename for the test case. resolve the suffixes for controllers
* and get the plugin path if needed.
*
* @param string $type The Type of object you are generating tests for eg. controller
* @param string $className The fully qualified classname of the class the test is being generated for.
* @return string filename the test should be created on.
*/
public function testCaseFileName($type, $className) {
$path = $this->getPath();
$namespace = Configure::read('App.namespace');
if ($this->plugin) {
$namespace = Plugin::getNamespace($this->plugin);
}
$classTail = substr($className, strlen($namespace) + 1);
$path = $path . $classTail . 'Test.php';
return str_replace(['/', '\\'], DS, $path);
}
/**
* Gets the option parser instance and configures it.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser() {
$parser = parent::getOptionParser();
$parser->description(
__d('cake_console', 'Bake test case skeletons for classes.')
)->addArgument('type', [
'help' => __d('cake_console', 'Type of class to bake, can be any of the following: controller, model, helper, component or behavior.'),
'choices' => [
'Controller', 'controller',
'Table', 'table',
'Entity', 'entity',
'Helper', 'helper',
'Component', 'component',
'Behavior', 'behavior'
]
])->addArgument('name', [
'help' => __d('cake_console', 'An existing class to bake tests for.')
])->addOption('fixtures', [
'help' => __d('cake_console', 'A comma separated list of fixture names you want to include.')
]);
return $parser;
}
}