yii2/tests/framework/console/controllers/HelpControllerTest.php

<?php

/**
 * @link https://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license https://www.yiiframework.com/license/
 */

namespace yiiunit\framework\console\controllers;

use yii\console\controllers\HelpController;
use yii\helpers\Console;
use yiiunit\TestCase;

/**
 * Unit test for [[\yii\console\controllers\HelpController]].
 * @see HelpController
 * @group console
 */
class HelpControllerTest extends TestCase
{
    /**
     * {@inheritdoc}
     */
    protected function setUp(): void
    {
        $this->mockApplication();
    }

    /**
     * Creates controller instance.
     * @return BufferedHelpController
     */
    protected function createController()
    {
        $module = $this->getMockBuilder('yii\\base\\Module')
            ->setMethods(['fake'])
            ->setConstructorArgs(['console'])
            ->getMock();
        return new BufferedHelpController('help', $module);
    }

    /**
     * Emulates running controller action.
     * @param string $actionID id of action to be run.
     * @param array $actionParams action arguments.
     * @return string command output.
     */
    protected function runControllerAction($actionID, $actionParams = [])
    {
        $controller = $this->createController();
        $action = $controller->createAction($actionID);
        $action->runWithParams($actionParams);
        return $controller->flushStdOutBuffer();
    }

    public function testModuleControllersList()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'modules' => [
                'magic' => 'yiiunit\data\modules\magic\Module',
            ],
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('list'));
        $this->assertEqualsWithoutLE(<<<'STRING'
help
help/index
help/list
help/list-action-options
help/usage
magic/e-tag/delete
magic/e-tag/list-e-tags
magic/subFolder/sub/test

STRING
            , $result);
    }

    public function testActionList()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'controllerMap' => [
                'migrate' => 'yii\console\controllers\MigrateController',
                'cache' => 'yii\console\controllers\CacheController',
            ],
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('list'));
        $this->assertEqualsWithoutLE(<<<'STRING'
cache
cache/flush
cache/flush-all
cache/flush-schema
cache/index
help
help/index
help/list
help/list-action-options
help/usage
migrate
migrate/create
migrate/down
migrate/fresh
migrate/history
migrate/mark
migrate/new
migrate/redo
migrate/to
migrate/up

STRING
            , $result);
    }

    public function testActionListActionOptions()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'controllerMap' => [
                'migrate' => 'yii\console\controllers\MigrateController',
                'cache' => 'yii\console\controllers\CacheController',
            ],
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('list-action-options', ['action' => 'help/list-action-options']));
        $this->assertEqualsWithoutLE(<<<'STRING'
action: route to action

--interactive: whether to run the command interactively.
--color: whether to enable ANSI color in the output.If not set, ANSI color will only be enabled for terminals that support it.
--help: whether to display help information about current command.
--silent-exit-on-exception: if true - script finish with `ExitCode\:\:OK` in case of exception.false - `ExitCode\:\:UNSPECIFIED_ERROR`.Default\: `YII_ENV_TEST`

STRING
            , $result);
    }

    public function testActionUsage()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'controllerMap' => [
                'migrate' => 'yii\console\controllers\MigrateController',
                'cache' => 'yii\console\controllers\CacheController',
            ],
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('usage', ['action' => 'help/list-action-options']));
        $this->assertEqualsWithoutLE(<<<'STRING'
bootstrap.php help/list-action-options <action>

STRING
            , $result);
    }

    public function testActionIndex()
    {
        $result = Console::stripAnsiFormat($this->runControllerAction('index'));
        $this->assertStringContainsString('This is Yii version ', $result);
        $this->assertStringContainsString('The following commands are available:', $result);
        $this->assertStringContainsString('To see the help of each command, enter:', $result);
        $this->assertStringContainsString('bootstrap.php help', $result);
    }

    public function testActionIndexWithHelpCommand()
    {
        $result = Console::stripAnsiFormat($this->runControllerAction('index', ['command' => 'help/index']));
        $this->assertStringContainsString('Displays available commands or the detailed information', $result);
        $this->assertStringContainsString('bootstrap.php help [command] [...options...]', $result);
        $this->assertStringContainsString('--appconfig: string', $result);
        $this->assertStringContainsString('- command: string', $result);
        $this->assertStringContainsString('--color: boolean, 0 or 1', $result);
        $this->assertStringContainsString('--help, -h: boolean, 0 or 1', $result);
        $this->assertStringContainsString('--interactive: boolean, 0 or 1 (defaults to 1)', $result);
    }

    public function testActionIndexWithServeCommand()
    {
        $result = Console::stripAnsiFormat($this->runControllerAction('index', ['command' => 'serve']));
        $this->assertStringContainsString('Runs PHP built-in web server', $result);
        $this->assertStringContainsString('bootstrap.php serve [address] [...options...]', $result);
        $this->assertStringContainsString('- address: string (defaults to \'localhost\')', $result);
        $this->assertStringContainsString('--appconfig: string', $result);
        $this->assertStringContainsString('--color: boolean, 0 or 1', $result);
        $this->assertStringContainsString('--docroot, -t: string (defaults to \'@app/web\')', $result);
        $this->assertStringContainsString('--help, -h: boolean, 0 or 1', $result);
        $this->assertStringContainsString('--interactive: boolean, 0 or 1 (defaults to 1)', $result);
        $this->assertStringContainsString('--port, -p: int (defaults to 8080)', $result);
        $this->assertStringContainsString('--router, -r: string', $result);
    }

    public function testActionListContainsNoEmptyCommands()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'controllerNamespace' => 'yiiunit\data\console\controllers',
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('list'));
        $this->assertStringNotContainsString("fake-empty\n", $result);
        $this->assertStringNotContainsString("fake-no-default\n", $result);
        $this->assertStringContainsString("fake-no-default/index\n", $result);
    }

    public function testActionIndexContainsNoEmptyCommands()
    {
        $this->mockApplication([
            'enableCoreCommands' => false,
            'controllerNamespace' => 'yiiunit\data\console\controllers',
        ]);
        $result = Console::stripAnsiFormat($this->runControllerAction('index'));
        $this->assertStringNotContainsString('- fake-empty', $result);
        $this->assertStringContainsString('- fake-no-default', $result);
        $this->assertStringContainsString('    fake-no-default/index', $result);
        $this->assertStringNotContainsString('    fake-no-default/index (default)', $result);
    }
}


class BufferedHelpController extends HelpController
{
    use StdOutBufferControllerTrait;
}