Merge pull request #13292 from cakephp/schema-cache-commands

4.x Convert Schema cache shell to commands

src/Command/SchemacacheBuildCommand.php

@@ -0,0 +1,84 @@
+<?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         3.6.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Command;
+
+use Cake\Console\Arguments;
+use Cake\Console\Command;
+use Cake\Console\ConsoleIo;
+use Cake\Console\ConsoleOptionParser;
+use Cake\Database\SchemaCache;
+use Cake\Datasource\ConnectionManager;
+use RuntimeException;
+
+/**
+ * Provides CLI tool for updating schema cache.
+ */
+class SchemacacheBuildCommand extends Command
+{
+    /**
+     * Display all routes in an application
+     *
+     * @param \Cake\Console\Arguments $args The command arguments.
+     * @param \Cake\Console\ConsoleIo $io The console io
+     * @return null|int The exit code or null for success
+     */
+    public function execute(Arguments $args, ConsoleIo $io): ?int
+    {
+        try {
+            /** @var \Cake\Database\Connection $connection */
+            $connection = ConnectionManager::get((string)$args->getOption('connection'));
+
+            $cache = new SchemaCache($connection);
+        } catch (RuntimeException $e) {
+            $io->error($e->getMessage());
+
+            return static::CODE_ERROR;
+        }
+        $tables = $cache->build($args->getArgument('name'));
+
+        foreach ($tables as $table) {
+            $io->verbose(sprintf('Cached "%s"', $table));
+        }
+
+        $io->out('<success>Cache build complete</success>');
+
+        return static::CODE_SUCCESS;
+    }
+
+    /**
+     * Get the option parser.
+     *
+     * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update
+     * @return \Cake\Console\ConsoleOptionParser
+     */
+    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+    {
+        $parser->setDescription(
+            'Build all metadata caches for the connection. If a ' .
+            'table name is provided, only that table will be cached.'
+        )->addOption('connection', [
+            'help' => 'The connection to build/clear metadata cache data for.',
+            'short' => 'c',
+            'default' => 'default',
+        ])->addArgument('name', [
+            'help' => 'A specific table you want to refresh cached data for.',
+            'optional' => true,
+        ]);
+
+        return $parser;
+    }
+}

src/Command/SchemacacheClearCommand.php

@@ -0,0 +1,84 @@
+<?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         3.6.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Command;
+
+use Cake\Console\Arguments;
+use Cake\Console\Command;
+use Cake\Console\ConsoleIo;
+use Cake\Console\ConsoleOptionParser;
+use Cake\Database\SchemaCache;
+use Cake\Datasource\ConnectionManager;
+use RuntimeException;
+
+/**
+ * Provides CLI tool for clearing schema cache.
+ */
+class SchemacacheClearCommand extends Command
+{
+    /**
+     * Display all routes in an application
+     *
+     * @param \Cake\Console\Arguments $args The command arguments.
+     * @param \Cake\Console\ConsoleIo $io The console io
+     * @return null|int The exit code or null for success
+     */
+    public function execute(Arguments $args, ConsoleIo $io): ?int
+    {
+        try {
+            /** @var \Cake\Database\Connection $connection */
+            $connection = ConnectionManager::get((string)$args->getOption('connection'));
+
+            $cache = new SchemaCache($connection);
+        } catch (RuntimeException $e) {
+            $io->error($e->getMessage());
+
+            return static::CODE_ERROR;
+        }
+        $tables = $cache->clear($args->getArgument('name'));
+
+        foreach ($tables as $table) {
+            $io->verbose(sprintf('Cleared "%s"', $table));
+        }
+
+        $io->out('<success>Cache clear complete</success>');
+
+        return static::CODE_SUCCESS;
+    }
+
+    /**
+     * Get the option parser.
+     *
+     * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update
+     * @return \Cake\Console\ConsoleOptionParser
+     */
+    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+    {
+        $parser->setDescription(
+            'Clear all metadata caches for the connection. If a ' .
+            'table name is provided, only that table will be removed.'
+        )->addOption('connection', [
+            'help' => 'The connection to build/clear metadata cache data for.',
+            'short' => 'c',
+            'default' => 'default',
+        ])->addArgument('name', [
+            'help' => 'A specific table you want to clear cached data for.',
+            'optional' => true,
+        ]);
+
+        return $parser;
+    }
+}

src/Console/CommandScanner.php

@@ -67,6 +67,16 @@ class CommandScanner
             $command['name'] = str_replace('_', ' ', $command['name']);
             $command['fullName'] = str_replace('_', ' ', $command['fullName']);
             $commands[$i] = $command;
+
+            // Maintain backwards compatibility for schema_cache as it is likely
+            // hooked up to people's deploy tooling
+            if (strpos($command['name'], 'schemacache') === 0) {
+                $compat = [
+                    'name' => str_replace('schemacache', 'schema_cache', $command['name']),
+                    'fullName' => str_replace('schemacache', 'schema_cache', $command['fullName']),
+                ];
+                $commands[] = $compat + $command;
+            }
         }
 
         return $commands;

src/Shell/SchemaCacheShell.php

@@ -1,116 +0,0 @@
-<?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         3.6.0
- * @license       https://opensource.org/licenses/mit-license.php MIT License
- */
-namespace Cake\Shell;
-
-use Cake\Console\ConsoleOptionParser;
-use Cake\Console\Shell;
-use Cake\Database\SchemaCache;
-use Cake\Datasource\ConnectionManager;
-use RuntimeException;
-
-/**
- * Schema Cache Shell.
- *
- * Provides a CLI interface to the schema metadata caching features.
- * This tool is intended to be used by deployment scripts so that you
- * can prevent "thundering herd" effect on the metadata cache when new
- * versions of your application is deployed, or when migrations
- * requiring updated metadata are required.
- */
-class SchemaCacheShell extends Shell
-{
-    /**
-     * Build metadata.
-     *
-     * @param string|null $name The name of the table to build cache data for.
-     * @return bool
-     */
-    public function build(?string $name = null): bool
-    {
-        $cache = $this->_getSchemaCache();
-        $tables = $cache->build($name);
-
-        foreach ($tables as $table) {
-            $this->verbose(sprintf('Cached "%s"', $table));
-        }
-
-        $this->out('<success>Cache build complete</success>');
-
-        return true;
-    }
-
-    /**
-     * Clear metadata.
-     *
-     * @param string|null $name The name of the table to clear cache data for.
-     * @return void
-     */
-    public function clear(?string $name = null): void
-    {
-        $cache = $this->_getSchemaCache();
-        $tables = $cache->clear($name);
-
-        foreach ($tables as $table) {
-            $this->verbose(sprintf('Cleared "%s"', $table));
-        }
-
-        $this->out('<success>Cache clear complete</success>');
-    }
-
-    /**
-     * Gets the Schema Cache instance
-     *
-     * @return \Cake\Database\SchemaCache
-     */
-    protected function _getSchemaCache(): SchemaCache
-    {
-        try {
-            /** @var \Cake\Database\Connection $connection */
-            $connection = ConnectionManager::get($this->params['connection']);
-
-            return new SchemaCache($connection);
-        } catch (RuntimeException $e) {
-            $this->abort($e->getMessage());
-        }
-    }
-
-    /**
-     * Get the option parser for this shell.
-     *
-     * @return \Cake\Console\ConsoleOptionParser
-     */
-    public function getOptionParser(): ConsoleOptionParser
-    {
-        $parser = parent::getOptionParser();
-        $parser->addSubcommand('clear', [
-            'help' => 'Clear all metadata caches for the connection. If a ' .
-                'table name is provided, only that table will be removed.',
-        ])->addSubcommand('build', [
-            'help' => 'Build all metadata caches for the connection. If a ' .
-            'table name is provided, only that table will be cached.',
-        ])->addOption('connection', [
-            'help' => 'The connection to build/clear metadata cache data for.',
-            'short' => 'c',
-            'default' => 'default',
-        ])->addArgument('name', [
-            'help' => 'A specific table you want to clear/refresh cached data for.',
-            'optional' => true,
-        ]);
-
-        return $parser;
-    }
-}

tests/TestCase/Command/HelpCommandTest.php

@@ -121,7 +121,8 @@ class HelpCommandTest extends TestCase
         $find = '<shell name="sample" call_as="sample" provider="TestApp\Shell\SampleShell" help="sample -h"';
         $this->assertOutputContains($find);
 
-        $find = '<shell name="schema_cache" call_as="schema_cache" provider="Cake\Shell\SchemaCacheShell" help="schema_cache -h"';
+        $find = '<shell name="schema_cache build" call_as="schema_cache build" ' .
+            'provider="Cake\Command\SchemacacheBuildCommand" help="schema_cache build -h"';
         $this->assertOutputContains($find);
 
         $find = '<shell name="test_plugin.sample" call_as="test_plugin.sample" provider="TestPlugin\Shell\SampleShell" help="test_plugin.sample -h"';

tests/TestCase/Shell/SchemaCacheShellTest.php

@@ -14,19 +14,20 @@ declare(strict_types=1);
  * @since         3.6.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-namespace Cake\Test\TestCase\Shell;
+namespace Cake\Test\TestCase\Command;
 
 use Cake\Cache\Cache;
-use Cake\Console\Exception\StopException;
 use Cake\Datasource\ConnectionManager;
-use Cake\Shell\SchemaCacheShell;
+use Cake\TestSuite\ConsoleIntegrationTestTrait;
 use Cake\TestSuite\TestCase;
 
 /**
- * SchemaCacheShell test.
+ * SchemacacheCommands test.
  */
-class SchemaCacheShellTest extends TestCase
+class SchemacacheCommandsTest extends TestCase
 {
+    use ConsoleIntegrationTestTrait;
+
     /**
      * Fixtures.
      *
@@ -42,8 +43,8 @@ class SchemaCacheShellTest extends TestCase
     public function setUp(): void
     {
         parent::setUp();
-        $this->io = $this->getMockBuilder('Cake\Console\ConsoleIo')->getMock();
-        $this->shell = new SchemaCacheShell($this->io);
+        $this->setAppNamespace();
+        $this->useCommandRunner();
 
         $this->cache = $this->getMockBuilder('Cake\Cache\CacheEngine')->getMock();
         $this->cache->expects($this->any())
@@ -79,8 +80,8 @@ class SchemaCacheShellTest extends TestCase
         $ds = ConnectionManager::get('test');
         $ds->cacheMetadata(false);
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->clear();
+        $this->exec('schema_cache clear --connection test');
+        $this->assertExitSuccess();
         $this->assertInstanceOf('Cake\Database\Schema\CachedCollection', $ds->getSchemaCollection());
     }
 
@@ -94,8 +95,8 @@ class SchemaCacheShellTest extends TestCase
         $ds = ConnectionManager::get('test');
         $ds->cacheMetadata(false);
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->build();
+        $this->exec('schema_cache build --connection test');
+        $this->assertExitSuccess();
         $this->assertInstanceOf('Cake\Database\Schema\CachedCollection', $ds->getSchemaCollection());
     }
 
@@ -114,8 +115,8 @@ class SchemaCacheShellTest extends TestCase
             ->with('test_articles')
             ->will($this->returnValue(true));
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->build();
+        $this->exec('schema_cache build --connection test');
+        $this->assertExitSuccess();
     }
 
     /**
@@ -133,8 +134,8 @@ class SchemaCacheShellTest extends TestCase
             ->method('delete')
             ->will($this->returnValue(false));
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->build('articles');
+        $this->exec('schema_cache build --connection test articles');
+        $this->assertExitSuccess();
     }
 
     /**
@@ -154,8 +155,8 @@ class SchemaCacheShellTest extends TestCase
             ->method('delete')
             ->will($this->returnValue(false));
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->build('articles');
+        $this->exec('schema_cache build --connection test articles');
+        $this->assertExitSuccess();
     }
 
     /**
@@ -165,9 +166,8 @@ class SchemaCacheShellTest extends TestCase
      */
     public function testBuildInvalidConnection()
     {
-        $this->expectException(StopException::class);
-        $this->shell->params['connection'] = 'derpy-derp';
-        $this->shell->build('articles');
+        $this->exec('schema_cache build --connection derpy-derp articles');
+        $this->assertExitError();
     }
 
     /**
@@ -177,9 +177,8 @@ class SchemaCacheShellTest extends TestCase
      */
     public function testClearInvalidConnection()
     {
-        $this->expectException(StopException::class);
-        $this->shell->params['connection'] = 'derpy-derp';
-        $this->shell->clear('articles');
+        $this->exec('schema_cache clear --connection derpy-derp articles');
+        $this->assertExitError();
     }
 
     /**
@@ -195,8 +194,8 @@ class SchemaCacheShellTest extends TestCase
             ->method('delete')
             ->with('test_articles');
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->clear();
+        $this->exec('schema_cache clear --connection test');
+        $this->assertExitSuccess();
     }
 
     /**
@@ -214,7 +213,7 @@ class SchemaCacheShellTest extends TestCase
             ->with('test_articles')
             ->will($this->returnValue(false));
 
-        $this->shell->params['connection'] = 'test';
-        $this->shell->clear('articles');
+        $this->exec('schema_cache clear --connection test articles');
+        $this->assertExitSuccess();
     }
 }

tests/TestCase/Console/CommandCollectionTest.php

@@ -263,7 +263,8 @@ class CommandCollectionTest extends TestCase
         $this->assertTrue($collection->has('version'));
         $this->assertTrue($collection->has('routes'));
         $this->assertTrue($collection->has('i18n'));
-        $this->assertTrue($collection->has('schema_cache'));
+        $this->assertTrue($collection->has('schema_cache build'));
+        $this->assertTrue($collection->has('schema_cache clear'));
         $this->assertTrue($collection->has('server'));
         $this->assertTrue($collection->has('cache clear'));
         $this->assertFalse($collection->has('command_list'), 'Hidden commands should stay hidden');

tests/TestCase/Console/CommandRunnerTest.php

@@ -259,7 +259,7 @@ class CommandRunnerTest extends TestCase
         $output = new ConsoleOutput();
 
         $runner = new CommandRunner($app, 'cake');
-        $result = $runner->run(['cake', 'SchemaCache', 'build'], $this->getMockIo($output));
+        $result = $runner->run(['cake', 'schema_cache', 'build'], $this->getMockIo($output));
         $this->assertSame(Shell::CODE_SUCCESS, $result);
 
         $contents = implode("\n", $output->messages());