cakephp/tests/TestCase/Console/ConsoleOptionParserTest.php

<?php
declare(strict_types=1);

/**
 * 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         2.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Console;

use Cake\Console\ConsoleInputArgument;
use Cake\Console\ConsoleInputOption;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;
use Cake\Console\Exception\ConsoleException;
use Cake\Console\Exception\MissingOptionException;
use Cake\Console\TestSuite\StubConsoleInput;
use Cake\Console\TestSuite\StubConsoleOutput;
use Cake\TestSuite\TestCase;
use LogicException;

/**
 * ConsoleOptionParserTest
 */
class ConsoleOptionParserTest extends TestCase
{
    /**
     * @var \Cake\Console\ConsoleIo
     */
    private $io;

    public function setUp(): void
    {
        parent::setUp();
        $this->io = new ConsoleIo(new StubConsoleOutput(), new StubConsoleOutput(), new StubConsoleInput([]));
    }

    /**
     * test setting the console description
     */
    public function testDescription(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->setDescription('A test');

        $this->assertEquals($parser, $result, 'Setting description is not chainable');
        $this->assertSame('A test', $parser->getDescription(), 'getting value is wrong.');

        $parser->setDescription(['A test', 'something']);
        $this->assertSame("A test\nsomething", $parser->getDescription(), 'getting value is wrong.');
    }

    /**
     * test setting and getting the console epilog
     */
    public function testEpilog(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->setEpilog('A test');

        $this->assertEquals($parser, $result, 'Setting epilog is not chainable');
        $this->assertSame('A test', $parser->getEpilog(), 'getting value is wrong.');

        $parser->setEpilog(['A test', 'something']);
        $this->assertSame("A test\nsomething", $parser->getEpilog(), 'getting value is wrong.');
    }

    /**
     * test adding an option returns self.
     */
    public function testAddOptionReturnSelf(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addOption('test');
        $this->assertEquals($parser, $result, 'Did not return $this from addOption');
    }

    /**
     * test removing an option
     */
    public function testRemoveOption(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addOption('test')
            ->removeOption('test')
            ->removeOption('help');
        $this->assertSame($parser, $result, 'Did not return $this from removeOption');
        $this->assertEquals([], $result->options());
    }

    /**
     * test adding an option and using the long value for parsing.
     */
    public function testAddOptionLong(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', [
            'short' => 't',
        ]);
        $result = $parser->parse(['--test', 'value'], $this->io);
        $this->assertEquals(['test' => 'value', 'help' => false], $result[0], 'Long parameter did not parse out');
    }

    /**
     * test adding an option with a zero value
     */
    public function testAddOptionZero(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('count', []);
        $result = $parser->parse(['--count', '0'], $this->io);
        $this->assertEquals(['count' => '0', 'help' => false], $result[0], 'Zero parameter did not parse out');
    }

    /**
     * test addOption with an object.
     */
    public function testAddOptionObject(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption(new ConsoleInputOption('test', 't'));
        $result = $parser->parse(['--test=value'], $this->io);
        $this->assertEquals(['test' => 'value', 'help' => false], $result[0], 'Long parameter did not parse out');
    }

    /**
     * test adding an option and using the long value for parsing.
     */
    public function testAddOptionLongEquals(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', [
            'short' => 't',
        ]);
        $result = $parser->parse(['--test=value'], $this->io);
        $this->assertEquals(['test' => 'value', 'help' => false], $result[0], 'Long parameter did not parse out');
    }

    /**
     * test adding an option and using the default.
     */
    public function testAddOptionDefault(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser
            ->addOption('test', [
                'default' => 'default value',
            ])
            ->addOption('no-default', []);

        $result = $parser->parse(['--test'], $this->io);
        $this->assertSame(
            ['test' => 'default value', 'help' => false],
            $result[0],
            'Default value did not parse out'
        );

        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', [
            'default' => 'default value',
        ]);
        $result = $parser->parse([], $this->io);
        $this->assertEquals(['test' => 'default value', 'help' => false], $result[0], 'Default value did not parse out');
    }

    /**
     * test adding an option and using the short value for parsing.
     */
    public function testAddOptionShort(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', [
            'short' => 't',
        ]);
        $result = $parser->parse(['-t', 'value'], $this->io);
        $this->assertEquals(['test' => 'value', 'help' => false], $result[0], 'Short parameter did not parse out');
    }

    /**
     * test adding an option and using the short value for parsing.
     */
    public function testAddOptionWithMultipleShort(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('source', [
            'multiple' => true,
            'short' => 's',
        ]);
        $result = $parser->parse(['-s', 'mysql', '-s', 'postgres'], $this->io);
        $this->assertEquals(
            [
                'source' => ['mysql', 'postgres'],
                'help' => false,
            ],
            $result[0],
            'Short parameter did not parse out'
        );
    }

    /**
     * Test that adding an option using a two letter short value causes an exception.
     * As they will not parse correctly.
     */
    public function testAddOptionShortOneLetter(): void
    {
        $this->expectException(ConsoleException::class);
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', ['short' => 'te']);
    }

    /**
     * test adding and using boolean options.
     */
    public function testAddOptionBoolean(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', [
            'boolean' => true,
        ]);

        $result = $parser->parse(['--test', 'value'], $this->io);
        $expected = [['test' => true, 'help' => false], ['value']];
        $this->assertEquals($expected, $result);

        $result = $parser->parse(['value'], $this->io);
        $expected = [['test' => false, 'help' => false], ['value']];
        $this->assertEquals($expected, $result);
    }

    /**
     * test adding an multiple shorts.
     */
    public function testAddOptionMultipleShort(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test', ['short' => 't', 'boolean' => true])
            ->addOption('file', ['short' => 'f', 'boolean' => true])
            ->addOption('output', ['short' => 'o', 'boolean' => true]);

        $result = $parser->parse(['-o', '-t', '-f'], $this->io);
        $expected = ['file' => true, 'test' => true, 'output' => true, 'help' => false];
        $this->assertEquals($expected, $result[0], 'Short parameter did not parse out');

        $result = $parser->parse(['-otf'], $this->io);
        $this->assertEquals($expected, $result[0], 'Short parameter did not parse out');
    }

    /**
     * test multiple options at once.
     */
    public function testAddOptionMultipleOptions(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test')
            ->addOption('connection')
            ->addOption('table', ['short' => 't', 'default' => true]);

        $result = $parser->parse(['--test', 'value', '-t', '--connection', 'postgres'], $this->io);
        $expected = ['test' => 'value', 'table' => true, 'connection' => 'postgres', 'help' => false];
        $this->assertEquals($expected, $result[0], 'multiple options did not parse');
    }

    /**
     * test adding an option that accepts multiple values.
     */
    public function testAddOptionWithMultiple(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('source', ['short' => 's', 'multiple' => true]);

        $result = $parser->parse(['--source', 'mysql', '-s', 'postgres'], $this->io);
        $expected = [
            'source' => [
                'mysql',
                'postgres',
            ],
            'help' => false,
        ];
        $this->assertEquals($expected, $result[0], 'options with multiple values did not parse');
    }

    /**
     * test adding multiple options, including one that accepts multiple values.
     */
    public function testAddOptionMultipleOptionsWithMultiple(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser
            ->addOption('source', ['multiple' => true])
            ->addOption('name')
            ->addOption('export', ['boolean' => true]);

        $result = $parser->parse(['--export', '--source', 'mysql', '--name', 'annual-report', '--source', 'postgres'], $this->io);
        $expected = [
            'export' => true,
            'source' => [
                'mysql',
                'postgres',
            ],
            'name' => 'annual-report',
            'help' => false,
        ];
        $this->assertEquals($expected, $result[0], 'options with multiple values did not parse');
    }

    /**
     * test adding a required option with a default.
     */
    public function testAddOptionRequiredDefaultValue(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser
            ->addOption('test', [
                'default' => 'default value',
                'required' => true,
            ])
            ->addOption('no-default', [
                'required' => true,
            ]);
        $result = $parser->parse(['--test', '--no-default', 'value'], $this->io);
        $this->assertSame(
            ['test' => 'default value', 'no-default' => 'value', 'help' => false],
            $result[0]
        );

        $result = $parser->parse(['--no-default', 'value'], $this->io);
        $this->assertSame(
            ['no-default' => 'value', 'help' => false, 'test' => 'default value'],
            $result[0]
        );
    }

    /**
     * test adding a required option that is missing.
     */
    public function testAddOptionRequiredMissing(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser
            ->addOption('test', [
                'default' => 'default value',
                'required' => true,
            ])
            ->addOption('no-default', [
                'required' => true,
            ]);

        $this->expectException(ConsoleException::class);
        $parser->parse(['--test'], $this->io);
    }

    /**
     * test adding an option and prompting and optional options
     */
    public function testAddOptionWithPromptNoIo(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('color', [
            'prompt' => 'What is your favorite?',
        ]);
        $this->expectException(ConsoleException::class);
        $parser->parse([]);
    }

    /**
     * test adding an option and prompting and optional options
     */
    public function testAddOptionWithPrompt(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('color', [
            'prompt' => 'What is your favorite?',
        ]);
        $out = new StubConsoleOutput();
        $io = new ConsoleIo($out, new StubConsoleOutput(), new StubConsoleInput(['red']));

        $result = $parser->parse([], $io);
        $this->assertEquals(['color' => 'red', 'help' => false], $result[0]);
        $messages = $out->messages();

        $this->assertCount(1, $messages);
        $expected = "<question>What is your favorite?</question>\n> ";
        $this->assertEquals($expected, $messages[0]);
    }

    /**
     * test adding an option and default values
     */
    public function testAddOptionWithPromptAndDefault(): void
    {
        $parser = new ConsoleOptionParser('test', false);

        $this->expectException(ConsoleException::class);
        $this->expectExceptionMessage('You cannot set both `prompt` and `default`');
        $parser->addOption('color', [
            'prompt' => 'What is your favorite?',
            'default' => 'blue',
        ]);
    }

    /**
     * test adding an option and prompting with cli data
     */
    public function testAddOptionWithPromptAndProvidedValue(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('color', [
            'prompt' => 'What is your favorite?',
        ]);
        $out = new StubConsoleOutput();
        $io = new ConsoleIo($out, new StubConsoleOutput(), new StubConsoleInput([]));

        $result = $parser->parse(['--color', 'blue'], $io);
        $this->assertEquals(['color' => 'blue', 'help' => false], $result[0]);
        $this->assertCount(0, $out->messages());
    }

    /**
     * test adding an option and prompting and required options
     */
    public function testAddOptionWithPromptAndRequired(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('color', [
            'required' => true,
            'prompt' => 'What is your favorite?',
        ]);
        $out = new StubConsoleOutput();
        $io = new ConsoleIo($out, new StubConsoleOutput(), new StubConsoleInput(['red']));

        $result = $parser->parse([], $io);
        $this->assertEquals(['color' => 'red', 'help' => false], $result[0]);
        $messages = $out->messages();

        $this->assertCount(1, $messages);
        $expected = "<question>What is your favorite?</question>\n> ";
        $this->assertEquals($expected, $messages[0]);
    }

    /**
     * test adding an option and prompting for additional values.
     */
    public function testAddOptionWithPromptAndOptions(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('color', [
            'required' => true,
            'prompt' => 'What is your favorite?',
            'choices' => ['red', 'green', 'blue'],
        ]);
        $out = new StubConsoleOutput();
        $io = new ConsoleIo($out, new StubConsoleOutput(), new StubConsoleInput(['purple', 'red']));

        $result = $parser->parse([], $io);
        $this->assertEquals(['color' => 'red', 'help' => false], $result[0]);
        $messages = $out->messages();

        $this->assertCount(2, $messages);
        $expected = "<question>What is your favorite?</question> (red/green/blue) \n> ";
        $this->assertEquals($expected, $messages[0]);
        $this->assertEquals($expected, $messages[1]);
    }

    /**
     * Test adding multiple options.
     */
    public function testAddOptions(): void
    {
        $parser = new ConsoleOptionParser('something', false);
        $result = $parser->addOptions([
            'name' => ['help' => 'The name'],
            'other' => ['help' => 'The other arg'],
        ]);
        $this->assertEquals($parser, $result, 'addOptions is not chainable.');

        $result = $parser->options();
        $this->assertCount(3, $result, 'Not enough options');
    }

    /**
     * test that boolean options work
     */
    public function testOptionWithBooleanParam(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('no-commit', ['boolean' => true])
            ->addOption('table', ['short' => 't']);

        $result = $parser->parse(['--table', 'posts', '--no-commit', 'arg1', 'arg2'], $this->io);
        $expected = [['table' => 'posts', 'no-commit' => true, 'help' => false], ['arg1', 'arg2']];
        $this->assertEquals($expected, $result, 'Boolean option did not parse correctly.');
    }

    /**
     * test parsing options that do not exist.
     */
    public function testOptionThatDoesNotExist(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('no-commit', ['boolean' => true]);

        try {
            $parser->parse(['--he', 'other'], $this->io);
        } catch (MissingOptionException $e) {
            $this->assertStringContainsString(
                "Unknown option `he`.\n" .
                "Did you mean: `help`?\n" .
                "\n" .
                "Other valid choices:\n" .
                "\n" .
                '- help',
                $e->getFullMessage()
            );
        }
    }

    /**
     * test parsing short options that do not exist.
     */
    public function testShortOptionThatDoesNotExist(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('no-commit', ['boolean' => true, 'short' => 'n']);
        $parser->addOption('construct', ['boolean' => true]);
        $parser->addOption('clear', ['boolean' => true, 'short' => 'c']);

        try {
            $parser->parse(['-f'], $this->io);
        } catch (MissingOptionException $e) {
            $this->assertStringContainsString('Unknown short option `f`.', $e->getFullMessage());
        }
    }

    /**
     * test that options with choices enforce them.
     */
    public function testOptionWithChoices(): void
    {
        $this->expectException(ConsoleException::class);
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('name', ['choices' => ['mark', 'jose']]);

        $result = $parser->parse(['--name', 'mark'], $this->io);
        $expected = ['name' => 'mark', 'help' => false];
        $this->assertEquals($expected, $result[0], 'Got the correct value.');

        $parser->parse(['--name', 'jimmy'], $this->io);
    }

    /**
     * Ensure that option values can start with -
     */
    public function testOptionWithValueStartingWithMinus(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('name')
            ->addOption('age');

        $result = $parser->parse(['--name', '-foo', '--age', 'old'], $this->io);
        $expected = ['name' => '-foo', 'age' => 'old', 'help' => false];
        $this->assertEquals($expected, $result[0], 'Option values starting with "-" are broken.');
    }

    /**
     * test positional argument parsing.
     */
    public function testAddArgument(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addArgument('name', ['help' => 'An argument']);
        $this->assertEquals($parser, $result, 'Should return this');
    }

    /**
     * test positional argument with default parsing.
     */
    public function testAddArgumentWithDefault(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addArgument('name', ['help' => 'An argument', 'default' => 'foo']);
        $args = $parser->arguments();
        $this->assertEquals($parser, $result, 'Should return this');
        $this->assertEquals('foo', $args[0]->defaultValue());
    }

    /**
     * Add arguments that were once considered the same
     */
    public function testAddArgumentDuplicate(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser
            ->addArgument('first', ['help' => 'An argument', 'choices' => [1, 2]])
            ->addArgument('second', ['help' => 'An argument', 'choices' => [1, 2]]);
        $args = $parser->arguments();
        $this->assertCount(2, $args);
        $this->assertEquals('first', $args[0]->name());
        $this->assertEquals('second', $args[1]->name());
    }

    /**
     * test addOption with an object.
     */
    public function testAddArgumentObject(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument(new ConsoleInputArgument('test'));
        $result = $parser->arguments();
        $this->assertCount(1, $result);
        $this->assertSame('test', $result[0]->name());
    }

    /**
     * Test adding arguments out of order.
     */
    public function testAddArgumentOutOfOrder(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument('name', ['index' => 1, 'help' => 'first argument'])
            ->addArgument('bag', ['index' => 2, 'help' => 'second argument'])
            ->addArgument('other', ['index' => 0, 'help' => 'Zeroth argument']);

        $result = $parser->arguments();
        $this->assertCount(3, $result);
        $this->assertSame('other', $result[0]->name());
        $this->assertSame('name', $result[1]->name());
        $this->assertSame('bag', $result[2]->name());
        $this->assertSame([0, 1, 2], array_keys($result));
        $this->assertEquals(
            ['other', 'name', 'bag'],
            $parser->argumentNames()
        );
    }

    /**
     * test overwriting positional arguments.
     */
    public function testPositionalArgOverwrite(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument('name', ['help' => 'An argument'])
            ->addArgument('other', ['index' => 0]);

        $result = $parser->arguments();
        $this->assertCount(1, $result, 'Overwrite did not occur');
    }

    /**
     * test parsing arguments.
     */
    public function testParseArgumentTooMany(): void
    {
        $this->expectException(ConsoleException::class);
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument('name', ['help' => 'An argument'])
            ->addArgument('other');

        $expected = ['one', 'two'];
        $result = $parser->parse($expected, $this->io);
        $this->assertEquals($expected, $result[1], 'Arguments are not as expected');

        $parser->parse(['one', 'two', 'three'], $this->io);
    }

    /**
     * test parsing arguments with 0 value.
     */
    public function testParseArgumentZero(): void
    {
        $parser = new ConsoleOptionParser('test', false);

        $expected = ['one', 'two', 0, 'after', 'zero'];
        $result = $parser->parse($expected, $this->io);
        $this->assertEquals($expected, $result[1], 'Arguments are not as expected');
    }

    /**
     * test that when there are not enough arguments an exception is raised
     */
    public function testPositionalArgNotEnough(): void
    {
        $this->expectException(ConsoleException::class);
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument('name', ['required' => true])
            ->addArgument('other', ['required' => true]);

        $parser->parse(['one'], $this->io);
    }

    /**
     * test that when there are required arguments after optional ones an exception is raised
     */
    public function testPositionalArgRequiredAfterOptional(): void
    {
        $this->expectException(LogicException::class);
        $parser = new ConsoleOptionParser('test');
        $parser->addArgument('name', ['required' => false])
            ->addArgument('other', ['required' => true]);
    }

    /**
     * test that arguments with choices enforce them.
     */
    public function testPositionalArgWithChoices(): void
    {
        $this->expectException(ConsoleException::class);
        $parser = new ConsoleOptionParser('test', false);
        $parser->addArgument('name', ['choices' => ['mark', 'jose']])
            ->addArgument('alias', ['choices' => ['cowboy', 'samurai']])
            ->addArgument('weapon', ['choices' => ['gun', 'sword']]);

        $result = $parser->parse(['mark', 'samurai', 'sword'], $this->io);
        $expected = ['mark', 'samurai', 'sword'];
        $this->assertEquals($expected, $result[1], 'Got the correct value.');

        $parser->parse(['jose', 'coder'], $this->io);
    }

    /**
     * test argument with default value.
     */
    public function testPositionalArgumentWithDefault(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addArgument('name', ['help' => 'An argument', 'default' => 'foo']);

        $result = $parser->parse(['bar'], $this->io);
        $this->assertEquals(['bar'], $result[1], 'Got the correct value.');

        $result = $parser->parse([], $this->io);
        $this->assertEquals(['foo'], $result[1], 'Got the correct default value.');
    }

    /**
     * Test adding multiple arguments.
     */
    public function testAddArguments(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $result = $parser->addArguments([
            'name' => ['help' => 'The name'],
            'other' => ['help' => 'The other arg'],
        ]);
        $this->assertEquals($parser, $result, 'addArguments is not chainable.');

        $result = $parser->arguments();
        $this->assertCount(2, $result, 'Not enough arguments');
    }

    public function testParseArgumentsDoubleDash(): void
    {
        $parser = new ConsoleOptionParser('test');

        $result = $parser->parse(['one', 'two', '--', '-h', '--help', '--test=value'], $this->io);
        $this->assertEquals(['one', 'two', '-h', '--help', '--test=value'], $result[1]);
    }

    public function testParseArgumentsOptionsDoubleDash(): void
    {
        $parser = new ConsoleOptionParser('test', false);
        $parser->addOption('test');

        $result = $parser->parse(['--test=value', '--', '--test'], $this->io);
        $this->assertEquals(['test' => 'value', 'help' => false], $result[0]);
        $this->assertEquals(['--test'], $result[1]);

        $result = $parser->parse(['--', '--test'], $this->io);
        $this->assertEquals(['help' => false], $result[0]);
        $this->assertEquals(['--test'], $result[1]);
    }

    /**
     * test that no exception is triggered for required arguments when help is being generated
     */
    public function testHelpNoExceptionForRequiredArgumentsWhenGettingHelp(): void
    {
        $parser = new ConsoleOptionParser('mycommand', false);
        $parser->addOption('test', ['help' => 'A test option.'])
            ->addArgument('model', ['help' => 'The model to make.', 'required' => true]);

        $result = $parser->parse(['--help'], $this->io);
        $this->assertTrue($result[0]['help']);
    }

    /**
     * test that no exception is triggered for required options when help is being generated
     */
    public function testHelpNoExceptionForRequiredOptionsWhenGettingHelp(): void
    {
        $parser = new ConsoleOptionParser('mycommand', false);
        $parser->addOption('test', ['help' => 'A test option.'])
            ->addOption('model', ['help' => 'The model to make.', 'required' => true]);

        $result = $parser->parse(['--help']);
        $this->assertTrue($result[0]['help']);
    }

    /**
     * test that help() with a custom rootName
     */
    public function testHelpWithRootName(): void
    {
        $parser = new ConsoleOptionParser('sample', false);
        $parser->setDescription('A command!')
            ->setRootName('tool')
            ->addOption('test', ['help' => 'A test option.'])
            ->addOption('reqd', ['help' => 'A required option.', 'required' => true])
            ->addArgument('name', ['help' => 'An argument', 'default' => 'foo']);

        $result = $parser->help();
        $expected = <<<TEXT
A command!

<info>Usage:</info>
tool sample [-h] --reqd [--test] [<name>]

<info>Options:</info>

--help, -h  Display this help.
--reqd      A required option. <comment>(required)</comment>
--test      A test option.

<info>Arguments:</info>

name  An argument <comment>(optional)</comment> <comment>default:
      "foo"</comment>

TEXT;
        $this->assertTextEquals($expected, $result, 'Help is not correct.');
    }

    /**
     * test building a parser from an array.
     */
    public function testBuildFromArray(): void
    {
        $spec = [
            'command' => 'test',
            'arguments' => [
                'name' => ['help' => 'The name'],
                'other' => ['help' => 'The other arg'],
            ],
            'options' => [
                'name' => ['help' => 'The name'],
                'other' => ['help' => 'The other arg'],
            ],
            'description' => 'description text',
            'epilog' => 'epilog text',
        ];
        $parser = ConsoleOptionParser::buildFromArray($spec);

        $this->assertSame($spec['description'], $parser->getDescription());
        $this->assertSame($spec['epilog'], $parser->getEpilog());

        $options = $parser->options();
        $this->assertArrayHasKey('name', $options);
        $this->assertArrayHasKey('other', $options);

        $args = $parser->arguments();
        $this->assertCount(2, $args);
    }

    /**
     * test that create() returns instances
     */
    public function testCreateFactory(): void
    {
        $parser = ConsoleOptionParser::create('factory', false);
        $this->assertInstanceOf('Cake\Console\ConsoleOptionParser', $parser);
        $this->assertSame('factory', $parser->getCommand());
    }

    /**
     * test that getCommand() inflects the command name.
     */
    public function testCommandInflection(): void
    {
        $parser = new ConsoleOptionParser('CommandLine');
        $this->assertSame('command_line', $parser->getCommand());
    }

    /**
     * Tests toArray()
     */
    public function testToArray(): void
    {
        $spec = [
            'command' => 'test',
            'arguments' => [
                'name' => ['help' => 'The name', 'default' => 'foo'],
                'other' => ['help' => 'The other arg'],
            ],
            'options' => [
                'name' => ['help' => 'The name'],
                'other' => ['help' => 'The other arg'],
            ],
            'description' => 'description text',
            'epilog' => 'epilog text',
        ];
        $parser = ConsoleOptionParser::buildFromArray($spec);
        $result = $parser->toArray();

        $this->assertSame($spec['description'], $result['description']);
        $this->assertSame($spec['epilog'], $result['epilog']);

        $options = $result['options'];
        $this->assertArrayHasKey('name', $options);
        $this->assertArrayHasKey('other', $options);

        $this->assertCount(2, $result['arguments']);
    }

    /**
     * Tests merge()
     */
    public function testMerge(): void
    {
        $parser = new ConsoleOptionParser('test');
        $parser->addOption('test', ['short' => 't', 'boolean' => true])
            ->addArgument('one', ['required' => true, 'choices' => ['a', 'b']])
            ->addArgument('two', ['required' => true]);

        $parserTwo = new ConsoleOptionParser('test');
        $parserTwo->addOption('file', ['short' => 'f', 'boolean' => true])
            ->addOption('output', ['short' => 'o', 'boolean' => true])
            ->addArgument('one', ['required' => true, 'choices' => ['a', 'b']]);

        $parser->merge($parserTwo);
        $result = $parser->toArray();

        $options = $result['options'];
        $this->assertArrayHasKey('quiet', $options);
        $this->assertArrayHasKey('test', $options);
        $this->assertArrayHasKey('file', $options);
        $this->assertArrayHasKey('output', $options);

        $this->assertCount(2, $result['arguments']);
        $this->assertCount(6, $result['options']);
    }
}