`composer install`済みだが`bin/cake migrations`などのコマンドが見つからない

Question

前提・実現したいこと

Vagrant環境にて、CakePHP3のmigrationsを実行しようとしたのですが、
Composer install済みであるにもかかわらずコマンドが無いと表示されてしまいます。
migrationsに限らず、bake等もできない状態です。

発生している問題・エラーメッセージ

vagrant ssh
$ cd /Path/to/src
$ sh bin/cake migrations status

Exception: Unknown command `cake migrations`. Run `cake --help` to get the list of valid commands. in [/srv/httpd/vendor/cakephp/cakephp/src/Console/CommandRunner.php, line 346]

試したこと

bin/cake -hでコマンドの有無を確認すると以下の結果となりました。

Current Paths:

* app:  src/
* root: /srv/httpd/
* core: /srv/httpd/vendor/cakephp/cakephp/

Available Commands:

- help
- version

To run a command, type `cake command_name [args|options]`
To get help on a specific command, type `cake command_name --help`

確かにコマンドが存在していない様なのですが、vender/cakephp以下には該当のフォルダが存在しており、
composer show | grep cakephpを行った結果も下記の通りです。

cakephp/bake                          1.9.5   Bake plugin for CakePHP 3
cakephp/cakephp                       3.7.9   The CakePHP framework
cakephp/cakephp-codesniffer           3.1.1   CakePHP CodeSniffer Standards
cakephp/chronos                       1.2.8   A simple API extension for DateTime.
cakephp/debug_kit                     3.18.0  CakePHP Debug Kit
cakephp/migrations                    2.3.0   Database Migration plugin for CakePHP 3.0 based on P...
cakephp/plugin-installer              1.1.1   A composer installer for CakePHP 3.0+ plugins.

• vender以下を削除、再度composer installを実行

→状況変わらず。実行中に以下のwarningが大量に出続けていました。

warning:  cannot set modif./access times for /srv/httpd/vendor/composer/23b5a519/cakephp-bake-b1fa1d2/
          Operation not permitted
warning:  cannot set permissions for /srv/httpd/vendor/composer/23b5a519/cakephp-bake-b1fa1d2/
          Operation not permitted
warning:  set times/attribs failed for /srv/httpd/vendor/composer/23b5a519/cakephp-bake-b1fa1d2/

• vagrantをdestroyして再度up

→状況変わらず

補足情報（FW/ツールのバージョンなど）

win10、Vagrant + Virtualbox、CentOS7、php7.3、CakePHP3.7.9
同じvagrantをmacで実行すると、問題なく動作していました。
(vagrant upを行った段階で、composer installも済んでいる状態です)

これまでに、この様なことが起こったことがなく、
また、今のところOSでの挙動の違いしかわかっておりません。
他に確認すべきところなどありましたらご教授いただけると幸いです。

追記

Application.php

class Application extends BaseApplication
{
    /**
     * {@inheritDoc}
     */
    public function bootstrap()
    {
        // Call parent to load bootstrap from files.
        parent::bootstrap();

        if (PHP_SAPI === 'cli') {
            $this->bootstrapCli();
        } else {
            // Load more plugins here
            $this->addPlugin('Froala');
        }

        /*
         * Only try to load DebugKit in development mode
         * Debug Kit should not be installed on a production system
         */
        if (Configure::read('debug')) {
            $this->addPlugin(\DebugKit\Plugin::class);
        }
    }

    /**
     * Setup the middleware queue your application will use.
     *
     * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to setup.
     * @return \Cake\Http\MiddlewareQueue The updated middleware queue.
     */
    public function middleware($middlewareQueue)
    {
        $middlewareQueue
            // Catch any exceptions in the lower layers,
            // and make an error page/response
            ->add(new ErrorHandlerMiddleware(null, Configure::read('Error')))

            // Handle plugin/theme assets like CakePHP normally does.
            ->add(new AssetMiddleware([
                'cacheTime' => Configure::read('Asset.cacheTime')
            ]))

            // Add routing middleware.
            // If you have a large number of routes connected, turning on routes
            // caching in production could improve performance. For that when
            // creating the middleware instance specify the cache config name by
            // using it's second constructor argument:
            // `new RoutingMiddleware($this, '_cake_routes_')`
            ->add(new RoutingMiddleware($this));

            $cookies = new EncryptedCookieMiddleware(['rememberMe'], Configure::read('Security.cookieKey'));
            $middlewareQueue->add($cookies);

        return $middlewareQueue;
    }

    /**
     * @return void
     */
    protected function bootstrapCli()
    {
        try {
            $this->addPlugin('Bake');
        } catch (MissingPluginException $e) {
            // Do not halt if the plugin is missing
        }

        $this->addPlugin('Migrations');

        // Load more plugins here
    }
}

Comments

[nojimage]

bin/cake plugin loaded の結果はどうなっていますか？

[yme2zk]

ありがとうございます。
bin/cake plugin loaded の結果は以下です。

```
Exception: Unknown command `cake plugin`. Run `cake --help` to get the list of valid commands. in [/srv/httpd/vendor/cakephp/cakephp/src/Console/CommandRunner.php, line 346]
```

[nojimage]

helpの出力通り、help, version以外のシェルタスクが読み込まれていない状態ですね。となると、App\Applicationクラスでconsole, pluginConsoleを上書きしている or DIRECTORY_SEPARATORが”\”になってしまっているとかでしょうか。
Application.phpの確認と、php -r "echo DIRECTORY_SEPARATOR;" で、定数の確認をしてみたください。

[nojimage]

warningの内容からして、WSL上でvagrantを動かしていたりしますか？

[yme2zk]

php -r "echo DIRECTORY_SEPARATOR;" の結果は「/」でした。
Application.phpを確認しましたが、特に書き換えなどは行っていないようです。
(念のため中身を追記しました。)

Vagrant + Virtualboxで、WSL上では動かしておりません。

Answer 1

同じような事象に遭いましたが、 composer update することで解決しました。

Answer 2

直接の原因は判りませんが、どのあたりに問題があるかは判りますので参考にしてください。

TL;DR Cake\Console\CommandScanner::scanDir の挙動を確認してください。

bin/cake -h の結果で、Available Commandsが "help", "version" のみということは、CakePHP本体のShellコマンドも呼び出されていない状態です。

"help", "version"のみ、コマンドが表示されるのは、以下のようにCommandRunnerクラスにて読み込みがハードコーディングされているためです。

    public function run(array $argv, ConsoleIo $io = null)
    {
        $this->bootstrap();

        $commands = new CommandCollection([
            'version' => VersionCommand::class,
            'help' => HelpCommand::class,
        ]);
        $commands = $this->app->console($commands);
        $this->checkCollection($commands, 'console');

cakephp/CommandRunner.php#L134 at 3.7.9 · cakephp/cakephp

他のコマンドはどこで読み込まれているのかというと、その下の$commands = $this->app->console($commands); の部分で、Application::console()を呼び出してセットしています。

Applicationは、Cake\Http\BaseApplicationを継承していますので、オーバーライドしていなければBaseApplicationの以下のコードが該当します。

    public function console($commands)
    {
        return $commands->addMany($commands->autoDiscover());
    }

cakephp/BaseApplication.php#L206 at 3.7.9 · cakephp/cakephp

ここで、$commandsは、Cake\Console\CommandCollection のインスタンスですので、CommandCollection::autoDiscover を見てみます。

    public function autoDiscover()
    {
        $scanner = new CommandScanner();

        $core = $this->resolveNames($scanner->scanCore());
        $app = $this->resolveNames($scanner->scanApp());

        return array_merge($core, $app);
    }

cakephp/CommandCollection.php#L218 at 3.7.9 · cakephp/cakephp

Cake\Console\CommandScannerがコマンドの探査を行っていることが判ります。

CommandScanner::scanCore メソッドは以下のようになっています。

    public function scanCore()
    {
        $coreShells = $this->scanDir(
            dirname(__DIR__) . DIRECTORY_SEPARATOR . 'Shell' . DIRECTORY_SEPARATOR,
            'Cake\Shell\',
            '',
            ['command_list']
        );
        $coreCommands = $this->scanDir(
            dirname(__DIR__) . DIRECTORY_SEPARATOR . 'Command' . DIRECTORY_SEPARATOR,
            'Cake\Command\',
            '',
            ['command_list']
        );

        return array_merge($coreShells, $coreCommands);
    }

cakephp/CommandScanner.php#L36 at 3.7.9 · cakephp/cakephp

というわけで、ディレクトリをスキャンしてコマンドをリストアップしているのは、CommandScanner::scanDir と言うことが判ります。

cakephp/CommandScanner.php#L109 at 3.7.9 · cakephp/cakephp

あとは、CommandScanner::scanDir にデバッグを仕込んで引数の内容、ステップごとの結果を正常な環境と比較すれば、解決の糸口が見つかるかもしれません。

Comments

[yme2zk]

詳細にありがとうございます。

正常に動く環境と照らし合わせつつ確認してみたいと思います。