/
HelpFormatterTest.php
529 lines (464 loc) · 15.6 KB
/
HelpFormatterTest.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
<?php
/**
* HelpFormatterTest file
*
* 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 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Console;
use Cake\Console\ConsoleOptionParser;
use Cake\Console\HelpFormatter;
use Cake\TestSuite\TestCase;
/**
* HelpFormatterTest
*/
class HelpFormatterTest extends TestCase
{
/**
* test that the console max width is respected when generating help.
*
* @return void
*/
public function testWidthFormatting()
{
$parser = new ConsoleOptionParser('test', false);
$parser->description('This is fifteen This is fifteen This is fifteen')
->addOption('four', ['help' => 'this is help text this is help text'])
->addArgument('four', ['help' => 'this is help text this is help text'])
->addSubcommand('four', ['help' => 'this is help text this is help text']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text(30);
$expected = <<<txt
This is fifteen This is
fifteen This is fifteen
<info>Usage:</info>
cake test [subcommand] [--four] [-h] [<four>]
<info>Subcommands:</info>
four this is help text this
is help text
To see help on a subcommand use <info>`cake test [subcommand] --help`</info>
<info>Options:</info>
--four this is help text
this is help text
--help, -h Display this help.
<info>Arguments:</info>
four this is help text this
is help text
<comment>(optional)</comment>
txt;
$this->assertTextEquals($expected, $result, 'Generated help is too wide');
}
/**
* test help() with options and arguments that have choices.
*
* @return void
*/
public function testHelpWithChoices()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.', 'choices' => ['one', 'two']])
->addArgument('type', [
'help' => 'Resource type.',
'choices' => ['aco', 'aro'],
'required' => true
])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = <<<txt
<info>Usage:</info>
cake mycommand [-h] [--test one|two] <aco|aro> [<other_longer>]
<info>Options:</info>
--help, -h Display this help.
--test A test option. <comment>(choices: one|two)</comment>
<info>Arguments:</info>
type Resource type. <comment>(choices: aco|aro)</comment>
other_longer Another argument. <comment>(optional)</comment>
txt;
$this->assertTextEquals($expected, $result, 'Help does not match');
}
/**
* test description and epilog in the help
*
* @return void
*/
public function testHelpDescriptionAndEpilog()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->description('Description text')
->epilog('epilog text')
->addOption('test', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true]);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = <<<txt
Description text
<info>Usage:</info>
cake mycommand [-h] [--test] <model>
<info>Options:</info>
--help, -h Display this help.
--test A test option.
<info>Arguments:</info>
model The model to make.
epilog text
txt;
$this->assertTextEquals($expected, $result, 'Help is wrong.');
}
/**
* test that help() outputs subcommands.
*
* @return void
*/
public function testHelpSubcommand()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addSubcommand('method', ['help' => 'This is another command'])
->addOption('test', ['help' => 'A test option.']);
$parser->addSubcommand('plugin', ['help' =>
'Create the directory structure, AppController class and testing setup for a new plugin. ' .
'Can create plugins in any of your bootstrapped plugin paths.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = <<<txt
<info>Usage:</info>
cake mycommand [subcommand] [-h] [--test]
<info>Subcommands:</info>
method This is another command
plugin Create the directory structure, AppController class and testing
setup for a new plugin. Can create plugins in any of your
bootstrapped plugin paths.
To see help on a subcommand use <info>`cake mycommand [subcommand] --help`</info>
<info>Options:</info>
--help, -h Display this help.
--test A test option.
txt;
$this->assertTextEquals($expected, $result, 'Help is not correct.');
}
/**
* test getting help with defined options.
*
* @return void
*/
public function testHelpWithOptions()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.'])
->addOption('connection', [
'short' => 'c', 'help' => 'The connection to use.', 'default' => 'default'
]);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = <<<txt
<info>Usage:</info>
cake mycommand [-c default] [-h] [--test]
<info>Options:</info>
--connection, -c The connection to use. <comment>(default:
default)</comment>
--help, -h Display this help.
--test A test option.
txt;
$this->assertTextEquals($expected, $result, 'Help does not match');
}
/**
* test getting help with defined options.
*
* @return void
*/
public function testHelpWithOptionsAndArguments()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = <<<xml
<info>Usage:</info>
cake mycommand [-h] [--test] <model> [<other_longer>]
<info>Options:</info>
--help, -h Display this help.
--test A test option.
<info>Arguments:</info>
model The model to make.
other_longer Another argument. <comment>(optional)</comment>
xml;
$this->assertTextEquals($expected, $result, 'Help does not match');
}
/**
* Test that a long set of options doesn't make useless output.
*
* @return void
*/
public function testHelpWithLotsOfOptions()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser
->addOption('test', ['help' => 'A test option.'])
->addOption('test2', ['help' => 'A test option.'])
->addOption('test3', ['help' => 'A test option.'])
->addOption('test4', ['help' => 'A test option.'])
->addOption('test5', ['help' => 'A test option.'])
->addOption('test6', ['help' => 'A test option.'])
->addOption('test7', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = 'cake mycommand [options] <model> [<other_longer>]';
$this->assertContains($expected, $result);
}
/**
* Test that a long set of arguments doesn't make useless output.
*
* @return void
*/
public function testHelpWithLotsOfArguments()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser
->addArgument('test', ['help' => 'A test option.', 'required' => true])
->addArgument('test2', ['help' => 'A test option.', 'required' => true])
->addArgument('test3', ['help' => 'A test option.'])
->addArgument('test4', ['help' => 'A test option.'])
->addArgument('test5', ['help' => 'A test option.'])
->addArgument('test6', ['help' => 'A test option.'])
->addArgument('test7', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.'])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->text();
$expected = 'cake mycommand [-h] [arguments]';
$this->assertContains($expected, $result);
}
/**
* test help() with options and arguments that have choices.
*
* @return void
*/
public function testXmlHelpWithChoices()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.', 'choices' => ['one', 'two']])
->addArgument('type', [
'help' => 'Resource type.',
'choices' => ['aco', 'aro'],
'required' => true
])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml();
$expected = <<<xml
<?xml version="1.0"?>
<shell>
<name>mycommand</name>
<description>Description text</description>
<subcommands />
<options>
<option name="--help" short="-h" help="Display this help." boolean="1">
<default></default>
<choices></choices>
</option>
<option name="--test" short="" help="A test option." boolean="0">
<default></default>
<choices>
<choice>one</choice>
<choice>two</choice>
</choices>
</option>
</options>
<arguments>
<argument name="type" help="Resource type." required="1">
<choices>
<choice>aco</choice>
<choice>aro</choice>
</choices>
</argument>
</arguments>
<epilog>epilog text</epilog>
</shell>
xml;
$this->assertXmlStringNotEqualsXmlString($expected, $result, 'Help does not match');
}
/**
* test description and epilog in the help
*
* @return void
*/
public function testXmlHelpDescriptionAndEpilog()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->description('Description text')
->epilog('epilog text')
->addOption('test', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true]);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml();
$expected = <<<xml
<?xml version="1.0"?>
<shell>
<name>mycommand</name>
<description>Description text</description>
<subcommands />
<options>
<option name="--help" short="-h" help="Display this help." boolean="1">
<default></default>
<choices></choices>
</option>
<option name="--test" short="" help="A test option." boolean="0">
<default></default>
<choices></choices>
</option>
</options>
<arguments>
<argument name="model" help="The model to make." required="1">
<choices></choices>
</argument>
</arguments>
<epilog>epilog text</epilog>
</shell>
xml;
$this->assertXmlStringNotEqualsXmlString($expected, $result, 'Help does not match');
}
/**
* test that help() outputs subcommands.
*
* @return void
*/
public function testXmlHelpSubcommand()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addSubcommand('method', ['help' => 'This is another command'])
->addOption('test', ['help' => 'A test option.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml();
$expected = <<<xml
<?xml version="1.0"?>
<shell>
<name>mycommand</name>
<description/>
<subcommands>
<command name="method" help="This is another command" />
</subcommands>
<options>
<option name="--help" short="-h" help="Display this help." boolean="1">
<default></default>
<choices></choices>
</option>
<option name="--test" short="" help="A test option." boolean="0">
<default></default>
<choices></choices>
</option>
</options>
<arguments/>
<epilog/>
</shell>
xml;
$this->assertXmlStringNotEqualsXmlString($expected, $result, 'Help does not match');
}
/**
* test getting help with defined options.
*
* @return void
*/
public function testXmlHelpWithOptions()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.'])
->addOption('connection', [
'short' => 'c', 'help' => 'The connection to use.', 'default' => 'default'
]);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml();
$expected = <<<xml
<?xml version="1.0"?>
<shell>
<name>mycommand</name>
<description/>
<subcommands/>
<options>
<option name="--help" short="-h" help="Display this help." boolean="1">
<default></default>
<choices></choices>
</option>
<option name="--test" short="" help="A test option." boolean="0">
<default></default>
<choices></choices>
</option>
<option name="--connection" short="-c" help="The connection to use." boolean="0">
<default>default</default>
<choices></choices>
</option>
</options>
<arguments/>
<epilog/>
</shell>
xml;
$this->assertXmlStringNotEqualsXmlString($expected, $result, 'Help does not match');
}
/**
* test getting help with defined options.
*
* @return void
*/
public function testXmlHelpWithOptionsAndArguments()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml();
$expected = <<<xml
<?xml version="1.0"?>
<shell>
<name>mycommand</name>
<description/>
<subcommands/>
<options>
<option name="--help" short="-h" help="Display this help." boolean="1">
<default></default>
<choices></choices>
</option>
<option name="--test" short="" help="A test option." boolean="0">
<default></default>
<choices></choices>
</option>
</options>
<arguments>
<argument name="model" help="The model to make." required="1">
<choices></choices>
</argument>
<argument name="other_longer" help="Another argument." required="0">
<choices></choices>
</argument>
</arguments>
<epilog/>
</shell>
xml;
$this->assertXmlStringNotEqualsXmlString($expected, $result, 'Help does not match');
}
/**
* Test xml help as object
*
* @return void
*/
public function testXmlHelpAsObject()
{
$parser = new ConsoleOptionParser('mycommand', false);
$parser->addOption('test', ['help' => 'A test option.'])
->addArgument('model', ['help' => 'The model to make.', 'required' => true])
->addArgument('other_longer', ['help' => 'Another argument.']);
$formatter = new HelpFormatter($parser);
$result = $formatter->xml(false);
$this->assertInstanceOf('SimpleXmlElement', $result);
}
}