Db3v4l\Command\SqlExecute

Complexity

Total Complexity

35

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	13	1
A	executeSQL()	0	31	3
B	onSubProcessOutput()	0	26	7
A	replaceDBSpecTokens()	0	7	1
A	hasDBSpecTokens()	0	6	1
A	writeResultsToFile()	0	11	3
D	execute()	0	131	19

<?php

Missing file doc comment

namespace Db3v4l\Command;

use Db3v4l\Core\DatabaseSchemaManager;

The type Db3v4l\Core\DatabaseSchemaManager was not found. Maybe you did not declare it correctly or list all dependencies?

use Db3v4l\Core\SqlAction\Command;
use Db3v4l\Core\SqlAction\File;
use Db3v4l\Core\SqlExecutor\Forked\NativeClient;
use Db3v4l\Core\SqlExecutor\Forked\TimedExecutor;
use Symfony\Component\Console\Input\InputInterface;

The type Symfony\Component\Console\Input\InputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Output\OutputInterface;

The type Symfony\Component\Console\Output\OutputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputOption;

The type Symfony\Component\Console\Input\InputOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Db3v4l\Util\Process;

class SqlExecute extends DatabaseManagingCommand

Missing doc comment for class SqlExecute

{
    protected static $defaultName = 'db3v4l:sql:execute';

    protected function configure()

Missing doc comment for function configure()

    {
        $this
            ->setDescription('Executes an SQL command in parallel on all configured database instances, by default in a dedicated temporary database/user')
            ->addOption('sql', 's', InputOption::VALUE_REQUIRED, 'The sql command(s) string to execute')
            ->addOption('file', null, InputOption::VALUE_REQUIRED, "A file with sql commands to execute. The tokens '{dbtype}' and '{instancename}' will be replaced with actual values")

            ->addOption('database', 'd', InputOption::VALUE_REQUIRED, 'The name of an existing database to use. If omitted, a dedicated temporary database will be created on the fly and disposed after use')
            ->addOption('user', 'u', InputOption::VALUE_REQUIRED, 'The name of the user to use for connecting to the existing database. Temporary databases get created with a temp user and random password')
            ->addOption('password', 'p', InputOption::VALUE_REQUIRED, 'The user password')
            ->addOption('charset', 'c', InputOption::VALUE_REQUIRED, 'The collation/character-set to use, _only_ for the dedicated temporary database. If omitted, the default collation for the instance will be used')

            ->addCommonOptions()

Space after closing parenthesis of function call prohibited

        ;
    }

    /**

Missing short description in doc comment

     * @param InputInterface $input

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param OutputInterface $output

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return int

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws \Exception

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $start = microtime(true);

        // as per https://www.php.net/manual/en/function.ignore-user-abort.php: for cli scripts, it is probably a good idea
        // to use ignore_user_abort
        ignore_user_abort(true);

        $this->setOutput($output);
        $this->setVerbosity($output->getVerbosity());

        $instanceList = $this->parseCommonOptions($input);

        $sql = $input->getOption('sql');
        $file = $input->getOption('file');
        $dbName = $input->getOption('database');
        $userName = $input->getOption('user');
        $password = $input->getOption('password');

        if ($sql == null && $file == null) {
            throw new \Exception("Please provide an sql command or file to be executed");
        }
        if ($sql != null && $file != null) {
            throw new \Exception("Please provide either an sql command or file to be executed, not both");
        }

        if (($dbName == null) xor ($userName == null)) {

            /// @todo is it possible to let the user log in to the 'root' db, regardless of db type ?

            throw new \Exception("Please provide both a custom database name and associated user account");
        }

        $createDB = ($dbName == null);

        if ($createDB) {
            // create temp databases

            if ($this->outputFormat === 'text') {
                $this->writeln('<info>Creating temporary databases...</info>', OutputInterface::VERBOSITY_VERBOSE);
            }

            /// @todo inject more randomness in the username, by allowing more chars than bin2hex produces

            $userName = 'db3v4l_' . substr(bin2hex(random_bytes(5)), 0, 9); // some mysql versions have a limitation of 16 chars for usernames
            $password = bin2hex(random_bytes(15)); // some oracle versions have a limit of 30 chars on passwords
            //$dbName = bin2hex(random_bytes(31));
            $dbName = $userName; // $userName will be used as db name

            $tempDbSpecs = [];
            foreach($instanceList as $instanceName => $instanceSpecs) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                $tempDbSpecs[$instanceName] = [
                    'dbname' => $dbName,
                    'user' => $userName,
                    'password' => $password
                ];
            }

            if (($charset = $input->getOption('charset')) != '') {
                foreach($instanceList as $instanceName) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $tempDbSpecs[$instanceName]['charset'] = $charset;
                }
            }

            // for now, we always use NativeClient for creating/dropping temp dbs
            $previousStrategy = $this->executionStrategy;
            $this->executionStrategy = NativeClient::EXECUTION_STRATEGY;
            $creationResults = $this->createDatabases($instanceList, $tempDbSpecs);
            $this->executionStrategy = $previousStrategy;

            $dbConnectionSpecs = $creationResults['data'];

        } else {
            // use existing databases

            if ($this->outputFormat === 'text') {
                $this->writeln('<info>Using existing databases...</info>', OutputInterface::VERBOSITY_VERBOSE);
            }

            $dbConfig = [
                'user' => $userName,
                'password' => $password,
                'dbname' => $dbName,
            ];

            $dbConnectionSpecs = [];
            foreach($instanceList as $instanceName => $instanceSpecs) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                $dbConnectionSpecs[$instanceName] = array_merge($instanceSpecs, $dbConfig);
            }
        }

        if (count($dbConnectionSpecs)) {

            if ($this->outputFormat === 'text') {
                $this->writeln('<info>Executing sql command/file...</info>', OutputInterface::VERBOSITY_VERBOSE);
            }

            $results = $this->executeSQL($dbConnectionSpecs, $sql, $file);

            if ($this->outputFormat === 'text') {
                $this->writeln('<info>Dropping temporary databases...</info>', OutputInterface::VERBOSITY_VERBOSE);
            }

            if ($createDB) {
                $results['failed'] += $creationResults['failed'];

The variable $creationResults does not seem to be defined for all execution paths leading up to this point.

                foreach($instanceList as $instanceName  => $instanceSpecs) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    if (!isset($dbConnectionSpecs[$instanceName])) {
                        /// @todo retrieve the actual temp db creation error instead of doing this...
                        $results['data'][$instanceName] = [
                            'exitcode' => '1',
                            'stderr' => 'Error in creation of temporary database'
                        ];
                        unset($instanceList[$instanceName]);
                    }
                }
                // for now, we always use NativeClient for creating/dropping temp dbs
                $previousStrategy = $this->executionStrategy;
                $this->executionStrategy = NativeClient::EXECUTION_STRATEGY;
                $this->dropDatabases($instanceList, $dbConnectionSpecs, true);
                $this->executionStrategy = $previousStrategy;
            }
        } else {
            $results = ['succeeded' => 0,  'failed' => 0, 'data' => null];
        }

        $time = microtime(true) - $start;

        $this->writeResults($results, $time);

        return (int)$results['failed'];
    }

    /**

Missing short description in doc comment

     * @param array $dbConnectionSpecs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $sql

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $filename

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $format

Missing parameter comment

Superfluous parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $maxParallel

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

Superfluous parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $timeout

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

Superfluous parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws \Exception

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    protected function executeSQL(array $dbConnectionSpecs, $sql, $filename = null)
    {
        return $this->executeSqlAction(
            $dbConnectionSpecs,
            'Execution of SQL',
            function ($schemaManager, $instanceName) use ($sql, $filename) {
                if ($sql != null) {
                    return new Command(
                        $sql,
                        function ($output, $executor) {
                            /** @var TimedExecutor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                            return array_merge(['stdout' => $output], $executor->getTimingData());
                        }
                    );
                } else {
                    /** @var DatabaseSchemaManager $schemaManager */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                    $realFileName = $this->replaceDBSpecTokens($filename, $instanceName, $schemaManager->getDatabaseConfiguration());
                    if (!is_file($realFileName)) {
                        throw new \RuntimeException("Can not find sql file for execution: '$realFileName'");
                    }
                    return new File(
                        $realFileName,
                        function ($output, $executor) {
                            /** @var TimedExecutor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                            return array_merge(['stdout' => $output], $executor->getTimingData());
                        }
                    );
                }
            },
            true,
            array($this, 'onSubProcessOutput')
        );
    }

    /**

Missing short description in doc comment

Parameter $processIndex should have a doc-comment as per coding-style.

     * @param string $type

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $buffer

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $processIndex;

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Doc comment for parameter $processIndex; does not match actual variable name $processIndex

     * @param Process $process

Missing parameter comment

     */

Missing @return tag in function comment

    public function onSubProcessOutput($type, $buffer, $processIndex, $process = null)
    {
        if (is_object($processIndex) && $process === null) {
            /// @todo php bug ? investigate deeper...
            $process = $processIndex;
            $processIndex = '?';
        }

        $pid = is_object($process) ? $process->getPid() : '';

        $lines = explode("\n", trim($buffer));

        foreach ($lines as $line) {
            // we tag the output from the different processes
            if (trim($line) !== '') {
                if ($type === 'err') {
                    $this->writeErrorln(
                        '[' . $processIndex . '][' . $pid . '] ' . trim($line),
                        OutputInterface::VERBOSITY_VERBOSE,
                        OutputInterface::OUTPUT_RAW
                    );
                } else {
                    $this->writeln(
                        '[' . $processIndex . '][' . $pid . '] ' . trim($line),
                        OutputInterface::VERBOSITY_VERBOSE,
                        OutputInterface::OUTPUT_RAW
                    );
                }
            }
        }
    }

    /**
     * Replaces tokens
     * @param string $string the original string

There must be exactly one blank line before the tags in a doc comment

Expected 3 spaces after parameter type; 1 found

Expected 11 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $instanceName

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string[] $dbConnectionSpec

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     * @todo add support for more tokens, eg '{version}'

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     */
    protected function replaceDBSpecTokens($string, $instanceName, $dbConnectionSpec)
    {
        $dbType = $dbConnectionSpec['vendor'];
        return str_replace(
            array('{dbtype}', '{instancename}', '{vendor}'),
            array($dbType, $instanceName, $dbConnectionSpec['vendor']),
            $string
        );
    }

    protected function hasDBSpecTokens($string)

Missing doc comment for function hasDBSpecTokens()

    {
        return $string != str_replace(
            array('{dbtype}', '{instancename}', '{vendor}'),
            '',
            $string
        );
    }

    protected function writeResultsToFile(array $results)

Missing doc comment for function writeResultsToFile()

    {
        if (!$this->hasDBSpecTokens($this->outputFile)) {
            parent::writeResultsToFile($results);
            return;
        }

        foreach($results['data'] as $instanceName => $data) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $formattedData = $this->formatResults(array('data' => $data));
            $outputFile = $this->replaceDBSpecTokens($this->outputFile, $instanceName, $this->dbConfigurationManager->getInstanceConfiguration($instanceName));
            file_put_contents($outputFile, $formattedData);
        }
    }
}