BEdita\Core\Shell\Task\CheckSchemaTask

Complexity

Total Complexity

40

Size/Duplication

Total Lines	304
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptionParser()	0	21	1
C	formatMessages()	0	55	12
A	checkMigrationsStatus()	0	21	3
A	main()	0	25	6
B	checkDiff()	0	48	9
A	checkSymbol()	0	10	2
A	checkConventions()	0	41	5
A	filterPhinxlogTables()	0	4	2

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2017 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Shell\Task;

use BEdita\Core\Model\Validation\SqlConventionsValidator;
use Cake\Console\ConsoleOptionParser;
use Cake\Console\Exception\MissingTaskException;
use Cake\Console\Shell;
use Cake\Core\Plugin;
use Cake\Database\Connection;
use Cake\Database\Driver\Mysql;
use Cake\Datasource\ConnectionManager;
use Cake\Utility\Hash;
use Cake\Utility\Inflector;
use Migrations\Migrations;

/**
 * Task to check if current schema is up to date, and if SQL standards are satisfied.
 *
 * @since 4.0.0
 */
class CheckSchemaTask extends Shell
{
    /**
     * Registry of all issues found.
     *
     * @var array
     */
    protected $messages = [];

    /**
     * List of SQL reserved words.
     *
     * @var array
     */
    protected $reservedWords = [];

    /**
     * {@inheritDoc}
     *
     * @codeCoverageIgnore
     */
    public function getOptionParser(): ConsoleOptionParser
    {
        $parser = parent::getOptionParser();
        $parser
            ->setDescription([
                'Current schema is compared with versioned schema dump to check if it is up to date.',
                'Also, migrations status and SQL naming conventions are checked.',
            ])
            ->addOption('connection', [
                'help' => 'Connection name to use.',
                'short' => 'c',
                'required' => false,
                'default' => 'default',
                'choices' => ConnectionManager::configured(),
            ])
            ->addOption('ignore-migration-status', [
                'help' => 'Skip checks on migration status.',
                'boolean' => true,
            ]);

        return $parser;
    }

    /**
     * Run checks on schema.
     *
     * @return bool
     */
    public function main()
    {
        if (!Plugin::isLoaded('Migrations')) {
            $this->abort('Plugin "Migrations" must be loaded in order to perform schema checks');
        }

        $connection = ConnectionManager::get($this->param('connection'));
        if (!($connection instanceof Connection)) {
            $this->abort('Unknown connection type');
        }

        if (!$this->param('ignore-migration-status')) {
            $this->checkMigrationsStatus($connection);
        }

        // check real vendor for DB like MariaDB or Aurora using MySQL driver where migration based check diff fails
        $realVendor = Hash::get((array)$connection->config(), 'realVendor');
        if (($connection->getDriver() instanceof Mysql) && empty($realVendor)) {
            $this->checkConventions($connection);
            $this->checkDiff($connection);
        } else {
            $this->out('=====> <warning>SQL conventions and schema differences can only be checked on MySQL</warning>');
        }

        return $this->formatMessages();
    }

    /**
     * Check if all migrations have already been migrated.
     *
     * @param \Cake\Database\Connection $connection Connection instance.
     * @return void
     */
    protected function checkMigrationsStatus(Connection $connection)
    {
        $migrations = new Migrations([
            'connection' => $connection->configName(),
            'plugin' => 'BEdita/Core',
        ]);
        $status = $migrations->status();

        $this->verbose('=====> Checking migrations status:');
        foreach ($status as $item) {
            $info = sprintf('=====>  - Migration <comment>%s</comment> (%s) is ', $item['name'], $item['id']);
            if ($item['status'] === 'up') {
                $this->verbose($info . '<info>UP</info>');
                continue;
            }

            $this->verbose($info . '<error>DOWN</error>');
            $this->messages['phinxlog'] = true;
        }

        $this->verbose('=====> ');
    }

    /**
     * Filter Phinxlog tables out of a list of table names.
     *
     * @param array $tables Table names.
     * @return array
     * @internal
     */
    protected function filterPhinxlogTables(array $tables)
    {
        return array_filter($tables, function ($table) {
            return $table !== 'phinxlog' && substr($table, -strlen('_phinxlog')) !== '_phinxlog';
        });
    }

    /**
     * Check if a symbol is valid.
     *
     * @param string $symbol Symbol to check.
     * @param array $context Index or constraint options.
     * @return array
     * @internal
     */
    protected function checkSymbol($symbol, array $context = [])
    {
        $validator = new SqlConventionsValidator();
        foreach ($context as $key => $value) {
            $validator->setProvider($key, $value);
        }

        $errors = $validator->validate(compact('symbol'));

        return Hash::get($errors, 'symbol', []);
    }

    /**
     * Check if SQL conventions are followed.
     *
     * @param \Cake\Database\Connection $connection Connection instance.
     * @return void
     */
    protected function checkConventions(Connection $connection)
    {
        $this->verbose('=====> Checking SQL conventions:');
        $allColumns = [];
        $tables = $this->filterPhinxlogTables($connection->getSchemaCollection()->listTables());
        foreach ($tables as $table) {
            $this->verbose(sprintf('=====>  - Checking table <comment>%s</comment>... ', $table), 0);

            $schema = $connection->getSchemaCollection()->describe($table);
            $errors = [];

            $errors['table']['naming'] = $this->checkSymbol($table);

            foreach ($schema->columns() as $column) {
                $errors['column'][$column]['naming'] = $this->checkSymbol(
                    $column,
                    compact('table', 'allColumns')
                );
                $allColumns[$column] = $table;
            }

            foreach ($schema->indexes() as $index) {
                $errors['index'][$index]['naming'] = $this->checkSymbol(
                    $index,
                    $schema->getIndex($index) + compact('table')
                );
            }

            foreach ($schema->constraints() as $constraint) {
                $errors['constraint'][$constraint]['naming'] = $this->checkSymbol(
                    $constraint,
                    $schema->getConstraint($constraint) + compact('table')
                );
            }

            $this->messages[$table] = $errors;

            $this->verbose('<info>DONE</info>');
        }

        $this->verbose('=====> ');
    }

    /**
     * Check if changes in schema occurred.
     *
     * @param \Cake\Database\Connection $connection Connection instance.
     * @return void
     */
    protected function checkDiff(Connection $connection)
    {
        try {
            $diffTask = $this->Tasks->load('Migrations.MigrationDiff');
        } catch (MissingTaskException $e) {
            $this->out(sprintf('=====> <error>Unable to check schema differences: %s</error>', $e->getMessage()));

            return;
        }

        $this->verbose('=====> Checking schema differences:');

        $diffTask->connection = $connection->configName();
        $diffTask->params['plugin'] = 'BEdita/Core';
        $diffTask->setup();

The method setup() does not exist on Cake\Console\Shell. It seems like you code against a sub-type of Cake\Console\Shell such as BEdita\Core\Shell\BeditaShell or Migrations\Shell\Task\MigrationDiffTask.

        $diff = $diffTask->templateData();

The method templateData() does not exist on Cake\Console\Shell. It seems like you code against a sub-type of Cake\Console\Shell such as Bake\Shell\Task\SimpleBakeTask.

        if (empty($diff['data'])) {
            return;
        }
        $diff = $diff['data'];

        $this->verbose('=====>  - Checking tables added or removed... ', 0);
        foreach ($this->filterPhinxlogTables(array_keys($diff['fullTables']['add'])) as $table) {
            $this->messages[$table]['table'][$table]['add'] = true;
        }
        foreach ($this->filterPhinxlogTables(array_keys($diff['fullTables']['remove'])) as $table) {
            $this->messages[$table]['table'][$table]['remove'] = true;
        }
        unset($diff['fullTables']);
        $this->verbose('<info>DONE</info>');

        foreach ($diff as $table => $elements) {
            $this->verbose(sprintf('=====>  - Checking table <comment>%s</comment>... ', $table), 0);

            foreach ($elements as $type => $changes) {
                $type = Inflector::singularize($type);
                foreach ($changes as $action => $list) {
                    foreach (array_keys($list) as $symbol) {
                        $this->messages[$table][$type][$symbol][$action] = true;
                    }
                }
            }

            $this->verbose('<info>DONE</info>');
        }

        $this->verbose('=====> ');
    }

    /**
     * Send all messages to output.
     *
     * @return bool
     */
    protected function formatMessages()
    {
        if (!empty($this->messages['phinxlog'])) {
            $this->quiet('=====> <warning>Migration history is not in sync with migration files.</warning>');
        }
        unset($this->messages['phinxlog']);

        ksort($this->messages);

        $check = true;
        foreach ($this->messages as $table => $elements) {
            $lines = [];
            foreach ($elements as $type => $list) {
                $type = Inflector::humanize($type);
                foreach ($list as $symbol => $messages) {
                    $messages = array_filter($messages);
                    foreach ($messages as $errorType => $details) {
                        switch ($errorType) {
                            case 'naming':
                                $lines[] = sprintf('%s name "%s" is not valid (%s)', $type, $symbol, implode(', ', $details));
                                break;
                            case 'add':
                                $lines[] = sprintf('%s "%s" has been added', $type, $symbol);
                                break;
                            case 'remove':
                                $lines[] = sprintf('%s "%s" has been removed', $type, $symbol);
                                break;
                            case 'changed':
                                $lines[] = sprintf('%s "%s" has been changed', $type, $symbol);
                                break;
                        }
                    }
                }
            }

            if (!empty($lines)) {
                $this->quiet(sprintf('=====> Table <comment>%s</comment>:', $table));
                $this->quiet(array_map(
                    function ($line) {
                        return sprintf('=====>  - <warning>%s</warning>', $line);
                    },
                    $lines
                ));
                $check = false;
            } else {
                $this->verbose(sprintf('=====> Table <comment>%s</comment>: <info>OK</info>', $table));
            }
        }

        if ($check) {
            $this->verbose('=====> ');
            $this->out('=====> <success>Everything seems just fine. Have a nice day!</success>');
        }

        return $check;
    }
}