/
CommandRunnerTest.php
390 lines (344 loc) · 12.5 KB
/
CommandRunnerTest.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
<?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.5.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\Console;
use Cake\Console\CommandCollection;
use Cake\Console\CommandRunner;
use Cake\Console\ConsoleIo;
use Cake\Console\Shell;
use Cake\Core\Configure;
use Cake\Http\BaseApplication;
use Cake\TestSuite\Stub\ConsoleOutput;
use Cake\TestSuite\TestCase;
use TestApp\Command\DemoCommand;
use TestApp\Shell\SampleShell;
/**
* Test case for the CommandCollection
*/
class CommandRunnerTest extends TestCase
{
/**
* Tracking property for event triggering
*
* @var bool
*/
protected $eventTriggered = false;
/**
* setup
*
* @return void
*/
public function setUp()
{
parent::setUp();
Configure::write('App.namespace', 'TestApp');
$this->config = dirname(dirname(__DIR__));
}
/**
* Test that the console hook not returning a command collection
* raises an error.
*
* @return void
*/
public function testRunConsoleHookFailure()
{
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('The application\'s `console` method did not return a CommandCollection.');
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['console', 'middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$runner = new CommandRunner($app);
$runner->run(['cake', '-h']);
}
/**
* Test that running with empty argv fails
*
* @return void
*/
public function testRunMissingRootCommand()
{
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Cannot run any commands. No arguments received.');
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$runner = new CommandRunner($app);
$runner->run([]);
}
/**
* Test that running an unknown command raises an error.
*
* @return void
*/
public function testRunInvalidCommand()
{
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Unknown command `cake nope`. Run `cake --help` to get the list of valid commands.');
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$runner = new CommandRunner($app);
$runner->run(['cake', 'nope', 'nope', 'nope']);
}
/**
* Test using `cake --help` invokes the help command
*
* @return void
*/
public function testRunHelpLongOption()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', '--help'], $this->getMockIo($output));
$this->assertSame(0, $result);
$messages = implode("\n", $output->messages());
$this->assertContains('Current Paths', $messages);
$this->assertContains('- i18n', $messages);
$this->assertContains('Available Commands', $messages);
}
/**
* Test using `cake -h` invokes the help command
*
* @return void
*/
public function testRunHelpShortOption()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', '-h'], $this->getMockIo($output));
$this->assertSame(0, $result);
$messages = implode("\n", $output->messages());
$this->assertContains('- i18n', $messages);
$this->assertContains('Available Commands', $messages);
}
/**
* Test that no command outputs the command list
*
* @return void
*/
public function testRunNoCommand()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app);
$result = $runner->run(['cake'], $this->getMockIo($output));
$this->assertSame(0, $result, 'help output is success.');
$messages = implode("\n", $output->messages());
$this->assertContains('No command provided. Choose one of the available commands', $messages);
$this->assertContains('- i18n', $messages);
$this->assertContains('Available Commands', $messages);
}
/**
* Test using `cake --verson` invokes the version command
*
* @return void
*/
public function testRunVersionAlias()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', '--version'], $this->getMockIo($output));
$this->assertContains(Configure::version(), $output->messages()[0]);
}
/**
* Test running a valid command
*
* @return void
*/
public function testRunValidCommand()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'routes'], $this->getMockIo($output));
$this->assertSame(Shell::CODE_SUCCESS, $result);
$contents = implode("\n", $output->messages());
$this->assertContains('URI template', $contents);
}
/**
* Test running a valid command and that backwards compatible
* inflection is hooked up.
*
* @return void
*/
public function testRunValidCommandInflection()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'OrmCache', 'build'], $this->getMockIo($output));
$this->assertSame(Shell::CODE_SUCCESS, $result);
$contents = implode("\n", $output->messages());
$this->assertContains('Cache', $contents);
}
/**
* Test running a valid raising an error
*
* @return void
*/
public function testRunValidCommandWithAbort()
{
$app = $this->makeAppWithCommands(['failure' => SampleShell::class]);
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'failure', 'with_abort'], $this->getMockIo($output));
$this->assertSame(Shell::CODE_ERROR, $result);
}
/**
* Test returning a non-zero value
*
* @return void
*/
public function testRunValidCommandReturnInteger()
{
$app = $this->makeAppWithCommands(['failure' => SampleShell::class]);
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'failure', 'returnValue'], $this->getMockIo($output));
$this->assertSame(99, $result);
}
/**
* Ensure that the root command name propagates to shell help
*
* @return void
*/
public function testRunRootNamePropagates()
{
$app = $this->makeAppWithCommands(['sample' => SampleShell::class]);
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'widget');
$runner->run(['widget', 'sample', '-h'], $this->getMockIo($output));
$result = implode("\n", $output->messages());
$this->assertContains('widget sample [-h]', $result);
$this->assertNotContains('cake sample [-h]', $result);
}
/**
* Test running a valid command
*
* @return void
*/
public function testRunValidCommandClass()
{
$app = $this->makeAppWithCommands(['ex' => DemoCommand::class]);
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'ex'], $this->getMockIo($output));
$this->assertSame(Shell::CODE_SUCCESS, $result);
$messages = implode("\n", $output->messages());
$this->assertContains('Demo Command!', $messages);
}
/**
* Test running a command class' help
*
* @return void
*/
public function testRunValidCommandClassHelp()
{
$app = $this->makeAppWithCommands(['ex' => DemoCommand::class]);
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', 'ex', '-h'], $this->getMockIo($output));
$this->assertSame(Shell::CODE_SUCCESS, $result);
$messages = implode("\n", $output->messages());
$this->assertContains("\ncake ex [-h]", $messages);
$this->assertNotContains('Demo Command!', $messages);
}
/**
* Test that run() fires off the buildCommands event.
*
* @return void
*/
public function testRunTriggersBuildCommandsEvent()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap'])
->setConstructorArgs([$this->config])
->getMock();
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$runner->getEventManager()->on('Console.buildCommands', function ($event, $commands) {
$this->assertInstanceOf(CommandCollection::class, $commands);
$this->eventTriggered = true;
});
$result = $runner->run(['cake', '--version'], $this->getMockIo($output));
$this->assertTrue($this->eventTriggered, 'Should have triggered event.');
}
/**
* Test that run calls plugin hook methods
*
* @return void
*/
public function testRunCallsPluginHookMethods()
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap', 'pluginBootstrap', 'pluginConsole'])
->setConstructorArgs([$this->config])
->getMock();
$app->expects($this->once())
->method('pluginBootstrap');
$commands = new CommandCollection();
$app->expects($this->once())
->method('pluginConsole')
->with($this->isinstanceOf(CommandCollection::class))
->will($this->returnCallback(function ($commands) {
return $commands;
}));
$output = new ConsoleOutput();
$runner = new CommandRunner($app, 'cake');
$result = $runner->run(['cake', '--version'], $this->getMockIo($output));
$this->assertContains(Configure::version(), $output->messages()[0]);
}
protected function makeAppWithCommands($commands)
{
$app = $this->getMockBuilder(BaseApplication::class)
->setMethods(['middleware', 'bootstrap', 'console'])
->setConstructorArgs([$this->config])
->getMock();
$collection = new CommandCollection($commands);
$app->method('console')->will($this->returnValue($collection));
return $app;
}
protected function getMockIo($output)
{
$io = $this->getMockBuilder(ConsoleIo::class)
->setConstructorArgs([$output, $output, null, null])
->setMethods(['in'])
->getMock();
return $io;
}
}