Start implementing commands using builtin backend

psalm-baseline.xml

@@ -10,15 +10,46 @@
     </DeprecatedClass>
   </file>
   <file src="src/Command/Phinx/Create.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
     <PossiblyUndefinedArrayOffset>
       <code>$phinxName</code>
     </PossiblyUndefinedArrayOffset>
   </file>
+  <file src="src/Command/Phinx/Dump.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
+  <file src="src/Command/Phinx/MarkMigrated.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
+  <file src="src/Command/Phinx/Migrate.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
+  <file src="src/Command/Phinx/Rollback.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
   <file src="src/Command/Phinx/Seed.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
     <PossiblyNullReference>
       <code>setInput</code>
     </PossiblyNullReference>
   </file>
+  <file src="src/Command/Phinx/Status.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
   <file src="src/Config/Config.php">
     <DeprecatedMethod>
       <code>getEnvironments</code>
@@ -125,6 +156,11 @@
       <code>$executedVersion</code>
     </ReferenceReusedFromConfusingScope>
   </file>
+  <file src="src/Migrations.php">
+    <DeprecatedTrait>
+      <code>ConfigurationTrait</code>
+    </DeprecatedTrait>
+  </file>
   <file src="src/TableFinderTrait.php">
     <PossiblyUndefinedArrayOffset>
       <code>$split[0]</code>

src/Command/StatusCommand.php

@@ -0,0 +1,235 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * 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
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Migrations\Command;
+
+use Cake\Command\Command;
+use Cake\Console\Arguments;
+use Cake\Console\ConsoleIo;
+use Cake\Console\ConsoleOptionParser;
+use Cake\Console\Exception\StopException;
+use Cake\Core\Plugin;
+use Cake\Datasource\ConnectionManager;
+use Cake\Utility\Inflector;
+use Migrations\Config\Config;
+use Migrations\Migration\Manager;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Output\StreamOutput;
+
+/**
+ * Status command for built in backend
+ */
+class StatusCommand extends Command
+{
+    /**
+     * Exit code for when status command is run and there are missing migrations
+     *
+     * @var int
+     */
+    public const CODE_STATUS_MISSING = 2;
+
+    /**
+     * Exit code for when status command is run and there are no missing migations,
+     * but does have down migrations
+     *
+     * @var int
+     */
+    public const CODE_STATUS_DOWN = 3;
+
+    /**
+     * The default name added to the application command list
+     *
+     * @return string
+     */
+    public static function defaultName(): string
+    {
+        return 'migrations status';
+    }
+
+    /**
+     * Configure the option parser
+     *
+     * @param \Cake\Console\ConsoleOptionParser $parser The option parser to configure
+     * @return \Cake\Console\ConsoleOptionParser
+     */
+    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+    {
+        $parser->setDescription([
+            'The <info>status</info> command prints a list of all migrations, along with their current status',
+            '',
+            '<info>migrations status -c secondary</info>',
+            '<info>migrations status -c secondary  -f json</info>',
+        ])->addOption('plugin', [
+            'short' => 'p',
+            'help' => 'The plugin to run migrations for',
+        ])->addOption('connection', [
+            'short' => 'c',
+            'help' => 'The datasource connection to use',
+            'default' => 'default',
+        ])->addOption('source', [
+            'short' => 's',
+            'help' => 'The folder under src/Config that migrations are in',
+            'default' => 'Migrations',
+        ])->addOption('format', [
+            'short' => 'f',
+            'help' => 'The output format: text or json. Defaults to text.',
+            'choices' => ['text', 'json'],
+            'default' => 'text',
+        ]);
+
+        return $parser;
+    }
+
+    /**
+     * Generate a configuration object for the migrations operation.
+     *
+     * @param \Cake\Console\Arguments $args The console arguments
+     * @return \Migrations\Config\Config The generated config instance.
+     */
+    protected function getConfig(Arguments $args): Config
+    {
+        $folder = (string)$args->getOption('source');
+
+        // Get the filepath for migrations and seeds(not implemented yet)
+        $dir = ROOT . '/config/' . $folder;
+        if (defined('CONFIG')) {
+            $dir = CONFIG . $folder;
+        }
+        $plugin = $args->getOption('plugin');
+        if ($plugin && is_string($plugin)) {
+            $dir = Plugin::path($plugin) . 'config/' . $folder;
+        }
+
+        // Get the phinxlog table name. Plugins have separate migration history.
+        // The names and separate table history is something we could change in the future.
+        $table = 'phinxlog';
+        if ($plugin && is_string($plugin)) {
+            $prefix = Inflector::underscore($plugin) . '_';
+            $prefix = str_replace(['\\', '/', '.'], '_', $prefix);
+            $table = $prefix . $table;
+        }
+        $templatePath = dirname(__DIR__) . DS . 'templates' . DS;
+        $connectionName = (string)$args->getOption('connection');
+
+        // TODO this all needs to go away. But first Environment and Manager need to work
+        // with Cake's ConnectionManager.
+        $connectionConfig = ConnectionManager::getConfig($connectionName);
+        if (!$connectionConfig) {
+            throw new StopException("Could not find connection `{$connectionName}`");
+        }
+
+        /** @var array<string, string> $connectionConfig */
+        $adapter = $connectionConfig['scheme'] ?? null;
+        $adapterConfig = [
+            'adapter' => $adapter,
+            'user' => $connectionConfig['username'],
+            'pass' => $connectionConfig['password'],
+            'host' => $connectionConfig['host'],
+            'name' => $connectionConfig['database'],
+        ];
+
+        $configData = [
+            'paths' => [
+                'migrations' => $dir,
+            ],
+            'templates' => [
+                'file' => $templatePath . 'Phinx/create.php.template',
+            ],
+            'migration_base_class' => 'Migrations\AbstractMigration',
+            'environments' => [
+                'default_migration_table' => $table,
+                'default' => $adapterConfig,
+            ],
+            // TODO do we want to support the DI container in migrations?
+        ];
+
+        return new Config($configData);
+    }
+
+    /**
+     * Get the migration manager for the current CLI options and application configuration.
+     *
+     * @param \Cake\Console\Arguments $args The command arguments.
+     * @return \Migrations\Migration\Manager
+     */
+    protected function getManager(Arguments $args): Manager
+    {
+        $config = $this->getConfig($args);
+
+        return new Manager($config, new ArgvInput(), new StreamOutput(STDOUT));
+    }
+
+    /**
+     * Execute the command.
+     *
+     * @param \Cake\Console\Arguments $args The command arguments.
+     * @param \Cake\Console\ConsoleIo $io The console io
+     * @return int|null The exit code or null for success
+     */
+    public function execute(Arguments $args, ConsoleIo $io): ?int
+    {
+        /** @var string|null $format */
+        $format = $args->getOption('format');
+        $migrations = $this->getManager($args)->printStatus('default', $format);
+
+        switch ($format) {
+            case 'json':
+                $flags = 0;
+                if ($args->getOption('verbose')) {
+                    $flags = JSON_PRETTY_PRINT;
+                }
+                $migrationString = (string)json_encode($migrations, $flags);
+                $io->out($migrationString);
+                break;
+            default:
+                $this->display($migrations, $io);
+                break;
+        }
+
+        return Command::CODE_SUCCESS;
+    }
+
+    /**
+     * Print migration status to stdout.
+     *
+     * @param array $migrations
+     * @param \Cake\Console\ConsoleIo $io The console io
+     * @return void
+     */
+    protected function display(array $migrations, ConsoleIo $io): void
+    {
+        if (!empty($migrations)) {
+            $rows = [];
+            $rows[] = ['Status', 'Migration ID', 'Migration Name'];
+
+            foreach ($migrations as $migration) {
+                $status = $migration['status'] === 'up' ? '<info>up</info>' : '<error>down</error>';
+                $name = $migration['name'] ?
+                    '<comment>' . $migration['name'] . '</comment>' :
+                    '<error>** MISSING **</error>';
+
+                $missingComment = '';
+                if (!empty($migration['missing'])) {
+                    $missingComment = '<error>** MISSING **</error>';
+                }
+                $rows[] = [$status, sprintf('%14.0f ', $migration['id']), $name . $missingComment];
+            }
+            $io->helper('table')->output($rows);
+        } else {
+            $msg = 'There are no available migrations. Try creating one using the <info>create</info> command.';
+            $io->err('');
+            $io->err($msg);
+            $io->err('');
+        }
+    }
+}

src/ConfigurationTrait.php

@@ -33,6 +33,8 @@
  * the methods in phinx that are responsible for reading the project configuration.
  * This is needed so that we can use the application configuration instead of having
  * a configuration yaml file.
+ *
+ * @deprecated 4.2.0 Will be removed in 5.0 alongside phinx.
  */
 trait ConfigurationTrait
 {
@@ -114,15 +116,11 @@ public function getConfig(bool $forceRefresh = false): ConfigInterface
             mkdir($seedsPath, 0777, true);
         }
 
-        // TODO this should use Migrations\Config
         $phinxTable = $this->getPhinxTable($plugin);
 
         $connection = $this->getConnectionName($this->input());
 
         $connectionConfig = (array)ConnectionManager::getConfig($connection);
-
-        // TODO(mark) Replace this with cakephp connection
-        // instead of array parameter passing
         $adapterName = $this->getAdapterName($connectionConfig['driver']);
         $dsnOptions = $this->extractDsnOptions($adapterName, $connectionConfig);
 

src/Migration/Environment.php

@@ -376,6 +376,7 @@ public function getAdapter(): AdapterInterface
             $adapter->setOutput($output);
         }
 
+        // TODO remove this, cake connections don't do prefixes.
         // Use the TablePrefixAdapter if table prefix/suffixes are in use
         if ($adapter->hasOption('table_prefix') || $adapter->hasOption('table_suffix')) {
             $adapter = AdapterFactory::instance()