StatusCommand::configure() - Code Metrics - Inspection of "change codecoverage in readme badge" - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5a501b...3982a6 )

by Gaetano

created 2018-06-23 17:41 UTC

StatusCommand::configure() A

↳ Parent: StatusCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	14
cp	0
rs	9.6666
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace Kaliop\eZMigrationBundle\Command;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;
use Kaliop\eZMigrationBundle\API\Value\Migration;
use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;
use Symfony\Component\Console\Helper\Table;

/**
 * Command to display the status of migrations.
 *
 * @todo add option to skip displaying already executed migrations
 */
class StatusCommand extends AbstractCommand
{
    const STATUS_INVALID = -1;

    protected function configure()
    {
        $this->setName('kaliop:migration:status')
            ->setDescription('View the status of all (or a set of) migrations.')
            ->addOption('path', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, "The directory or file to load the migration definitions from")
            ->addOption('summary', null, InputOption::VALUE_NONE, "Only print summary information")
            ->addOption('todo', null, InputOption::VALUE_NONE, "Only print list of migrations to execute (full path to each)")
            ->setHelp(<<<EOT
The <info>kaliop:migration:status</info> command displays the status of all available migrations:

    <info>./ezpublish/console kaliop:migration:status</info>

You can optionally specify the path to migration versions with <info>--path</info>:

    <info>./ezpublish/console kaliop:migrations:status --path=/path/to/bundle/version_directory --path=/path/to/bundle/version_directory/single_migration_file</info>
EOT
            );
    }

    public function execute(InputInterface $input, OutputInterface $output)
    {
        $migrationsService = $this->getMigrationService();

        $migrationDefinitions = $migrationsService->getMigrationsDefinitions($input->getOption('path'));
        $migrations = $migrationsService->getMigrations();

        if (!count($migrationDefinitions) && !count($migrations)) {
            $output->writeln('<info>No migrations found</info>');
            return;
        }

        // create a unique ist of all migrations (coming from db) and definitions (coming from disk)
        $index = array();
        foreach ($migrationDefinitions as $migrationDefinition) {
            $index[$migrationDefinition->name] = array('definition' => $migrationDefinition);
        }
        foreach ($migrations as $migration) {
            if (isset($index[$migration->name])) {
                $index[$migration->name]['migration'] = $migration;
            } else {
                $index[$migration->name] = array('migration' => $migration);

                // no definition, but a migration is there. Check if the definition sits elsewhere on disk than we expect it to be...
                // q: what if we have a loader which does not work with is_file? Could we remove this check?
                if ($migration->path != '' && is_file($migration->path)) {
                    try {
                        $migrationDefinitionCollection = $migrationsService->getMigrationsDefinitions(array($migration->path));
                        if (count($migrationDefinitionCollection)) {
                            $index[$migration->name]['definition'] = reset($migrationDefinitionCollection);
                        }
                    } catch (\Exception $e) {
                        /// @todo one day we should be able to limit the kind of exceptions we have to catch here...
                    }
                }
            }
        }
        ksort($index);

        if (!$input->getOption('summary') && !$input->getOption('todo')) {
            if (count($index) > 50000) {
                $output->writeln("WARNING: printing the status table might take a while as it contains many rows. Please wait...");
            }
            $output->writeln("\n <info>==</info> All Migrations\n");
        }

        $summary = array(
            self::STATUS_INVALID => array('Invalid', 0),
            Migration::STATUS_TODO => array('To do', 0),
            Migration::STATUS_STARTED => array('Started', 0),
            Migration::STATUS_DONE => array('Done', 0),
            Migration::STATUS_SUSPENDED => array('Suspended', 0),
            Migration::STATUS_FAILED => array('Failed', 0),
            Migration::STATUS_SKIPPED => array('Skipped', 0),
            Migration::STATUS_PARTIALLY_DONE => array('Partially done', 0),
        );
        $data = array();

        $i = 1;
        foreach ($index as $name => $value) {
            if (!isset($value['migration'])) {
                $migrationDefinition = $migrationsService->parseMigrationDefinition($value['definition']);
                $notes = '';
                if ($migrationDefinition->status != MigrationDefinition::STATUS_PARSED) {
                    $notes = '<error>' . $migrationDefinition->parsingError . '</error>';
                    $summary[self::STATUS_INVALID][1]++;
                } else {
                    $summary[Migration::STATUS_TODO][1]++;
                }
                if ($input->getOption('todo')) {
                    $data[] = $migrationDefinition->path;
                } else {
                    $data[] = array(
                        $i++,
                        $name,
                        '<error>not executed</error>',
                        '',
                        $notes
                    );

                }
            } else {
                $migration = $value['migration'];

                if (!isset($summary[$migration->status])) {
                    $summary[$migration->status] = array($migration->status, 0);
                }
                $summary[$migration->status][1]++;
                if ($input->getOption('summary')) {
                    continue;
                }

                if ($input->getOption('todo')) {
                    if ($migration->status == Migration::STATUS_TODO) {
                        $data[] = $migration->path;
                    }

                    continue;
                }

                switch ($migration->status) {

                    case Migration::STATUS_DONE:
                        $status = '<info>executed</info>';
                        break;
                    case Migration::STATUS_STARTED:
                        $status = '<comment>execution started</comment>';
                        break;
                    case Migration::STATUS_TODO:
                        // bold to-migrate!
                        $status = '<error>not executed</error>';
                        break;
                    case Migration::STATUS_SKIPPED:
                        $status = '<comment>skipped</comment>';
                        break;
                    case Migration::STATUS_PARTIALLY_DONE:
                        $status = '<comment>partially executed</comment>';
                        break;
                    case Migration::STATUS_SUSPENDED:
                        $status = '<comment>suspended</comment>';
                        break;
                    case Migration::STATUS_FAILED:
                        $status = '<error>failed</error>';
                        break;
                }
                $notes = array();
                if ($migration->executionError != '') {
                    $notes[] = "<error>{$migration->executionError}</error>";
                }
                if (!isset($value['definition'])) {
                    $notes[] = '<comment>The migration definition file can not be found any more</comment>';
                } else {
                    $migrationDefinition = $value['definition'];
                    if (md5($migrationDefinition->rawDefinition) != $migration->md5) {
                        $notes[] = '<comment>The migration definition file has now a different checksum</comment>';
                    }
                    if ($migrationDefinition->path != $migrationDefinition->path) {
                        $notes[] = '<comment>The migration definition file has now moved</comment>';
                    }
                }
                $notes = implode(' ', $notes);
                $data[] = array(
                    $i++,
                    $migration->name,
                    $status,
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    ($migration->executionDate != null ? date("Y-m-d H:i:s", $migration->executionDate) : ''),
                    $notes
                );
            }
        }

        if ($input->getOption('todo')) {
            foreach ($data as $migrationData) {
                echo "$migrationData\n";
            }
            return;
        }

        if ($input->getOption('summary')) {
            $output->writeln("\n <info>==</info> Migrations Summary\n");
            // do not print info about the not yet supported case
            unset($summary[Migration::STATUS_PARTIALLY_DONE]);
            $data = $summary;
            $headers = array('Status', 'Count');
        } else {
            $headers = array('#', 'Migration', 'Status', 'Executed on', 'Notes');
        }

        $table = new Table($output);
        $table
            ->setHeaders($headers)
            ->setRows($data);
        $table->render();
    }
}


1		<?php
2
3		namespace Kaliop\eZMigrationBundle\Command;
4
5		use Symfony\Component\Console\Input\InputInterface;
6		use Symfony\Component\Console\Output\OutputInterface;
7		use Symfony\Component\Console\Input\InputOption;
8		use Kaliop\eZMigrationBundle\API\Value\Migration;
9		use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;
10		use Symfony\Component\Console\Helper\Table;
11
12		/**
13		* Command to display the status of migrations.
14		*
15		* @todo add option to skip displaying already executed migrations
16		*/
17		class StatusCommand extends AbstractCommand
18		{
19		const STATUS_INVALID = -1;
20
21		protected function configure()
22		{
23		$this->setName('kaliop:migration:status')
24		->setDescription('View the status of all (or a set of) migrations.')
25		->addOption('path', null, InputOption::VALUE_OPTIONAL \| InputOption::VALUE_IS_ARRAY, "The directory or file to load the migration definitions from")
26		->addOption('summary', null, InputOption::VALUE_NONE, "Only print summary information")
27		->addOption('todo', null, InputOption::VALUE_NONE, "Only print list of migrations to execute (full path to each)")
28		->setHelp(<<<EOT
29		The <info>kaliop:migration:status</info> command displays the status of all available migrations:
30
31		<info>./ezpublish/console kaliop:migration:status</info>
32
33		You can optionally specify the path to migration versions with <info>--path</info>:
34
35		<info>./ezpublish/console kaliop:migrations:status --path=/path/to/bundle/version_directory --path=/path/to/bundle/version_directory/single_migration_file</info>
36		EOT
37		);
38		}
39
40		public function execute(InputInterface $input, OutputInterface $output)
41		{
42		$migrationsService = $this->getMigrationService();
43
44		$migrationDefinitions = $migrationsService->getMigrationsDefinitions($input->getOption('path'));
45		$migrations = $migrationsService->getMigrations();
46
47		if (!count($migrationDefinitions) && !count($migrations)) {
48		$output->writeln('<info>No migrations found</info>');
49		return;
50		}
51
52		// create a unique ist of all migrations (coming from db) and definitions (coming from disk)
53		$index = array();
54		foreach ($migrationDefinitions as $migrationDefinition) {
55		$index[$migrationDefinition->name] = array('definition' => $migrationDefinition);
56		}
57		foreach ($migrations as $migration) {
58		if (isset($index[$migration->name])) {
59		$index[$migration->name]['migration'] = $migration;
60		} else {
61		$index[$migration->name] = array('migration' => $migration);
62
63		// no definition, but a migration is there. Check if the definition sits elsewhere on disk than we expect it to be...
64		// q: what if we have a loader which does not work with is_file? Could we remove this check?
65		if ($migration->path != '' && is_file($migration->path)) {
66		try {
67		$migrationDefinitionCollection = $migrationsService->getMigrationsDefinitions(array($migration->path));
68		if (count($migrationDefinitionCollection)) {
69		$index[$migration->name]['definition'] = reset($migrationDefinitionCollection);
70		}
71		} catch (\Exception $e) {
72		/// @todo one day we should be able to limit the kind of exceptions we have to catch here...
73		}
74		}
75		}
76		}
77		ksort($index);
78
79		if (!$input->getOption('summary') && !$input->getOption('todo')) {
80		if (count($index) > 50000) {
81		$output->writeln("WARNING: printing the status table might take a while as it contains many rows. Please wait...");
82		}
83		$output->writeln("\n <info>==</info> All Migrations\n");
84		}
85
86		$summary = array(
87		self::STATUS_INVALID => array('Invalid', 0),
88		Migration::STATUS_TODO => array('To do', 0),
89		Migration::STATUS_STARTED => array('Started', 0),
90		Migration::STATUS_DONE => array('Done', 0),
91		Migration::STATUS_SUSPENDED => array('Suspended', 0),
92		Migration::STATUS_FAILED => array('Failed', 0),
93		Migration::STATUS_SKIPPED => array('Skipped', 0),
94		Migration::STATUS_PARTIALLY_DONE => array('Partially done', 0),
95		);
96		$data = array();
97
98		$i = 1;
99		foreach ($index as $name => $value) {
100		if (!isset($value['migration'])) {
101		$migrationDefinition = $migrationsService->parseMigrationDefinition($value['definition']);
102		$notes = '';
103		if ($migrationDefinition->status != MigrationDefinition::STATUS_PARSED) {
104		$notes = '<error>' . $migrationDefinition->parsingError . '</error>';
105		$summary[self::STATUS_INVALID][1]++;
106		} else {
107		$summary[Migration::STATUS_TODO][1]++;
108		}
109		if ($input->getOption('todo')) {
110		$data[] = $migrationDefinition->path;
111		} else {
112		$data[] = array(
113		$i++,
114		$name,
115		'<error>not executed</error>',
116		'',
117		$notes
118		);
119
120		}
121		} else {
122		$migration = $value['migration'];
123
124		if (!isset($summary[$migration->status])) {
125		$summary[$migration->status] = array($migration->status, 0);
126		}
127		$summary[$migration->status][1]++;
128		if ($input->getOption('summary')) {
129		continue;
130		}
131
132		if ($input->getOption('todo')) {
133		if ($migration->status == Migration::STATUS_TODO) {
134		$data[] = $migration->path;
135		}
136
137		continue;
138		}
139
140	View Code Duplication	switch ($migration->status) {
		0 ignored issues – show Duplication introduced 2017-05-13 23:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141		case Migration::STATUS_DONE:
142		$status = '<info>executed</info>';
143		break;
144		case Migration::STATUS_STARTED:
145		$status = '<comment>execution started</comment>';
146		break;
147		case Migration::STATUS_TODO:
148		// bold to-migrate!
149		$status = '<error>not executed</error>';
150		break;
151		case Migration::STATUS_SKIPPED:
152		$status = '<comment>skipped</comment>';
153		break;
154		case Migration::STATUS_PARTIALLY_DONE:
155		$status = '<comment>partially executed</comment>';
156		break;
157		case Migration::STATUS_SUSPENDED:
158		$status = '<comment>suspended</comment>';
159		break;
160		case Migration::STATUS_FAILED:
161		$status = '<error>failed</error>';
162		break;
163		}
164		$notes = array();
165		if ($migration->executionError != '') {
166		$notes[] = "<error>{$migration->executionError}</error>";
167		}
168		if (!isset($value['definition'])) {
169		$notes[] = '<comment>The migration definition file can not be found any more</comment>';
170		} else {
171		$migrationDefinition = $value['definition'];
172		if (md5($migrationDefinition->rawDefinition) != $migration->md5) {
173		$notes[] = '<comment>The migration definition file has now a different checksum</comment>';
174		}
175		if ($migrationDefinition->path != $migrationDefinition->path) {
176		$notes[] = '<comment>The migration definition file has now moved</comment>';
177		}
178		}
179		$notes = implode(' ', $notes);
180		$data[] = array(
181		$i++,
182		$migration->name,
183		$status,
		0 ignored issues – show Bug introduced 2016-08-05 09:22 UTC by Report Bug Copy Issue Report The variable `$status` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
184		($migration->executionDate != null ? date("Y-m-d H:i:s", $migration->executionDate) : ''),
185		$notes
186		);
187		}
188		}
189
190		if ($input->getOption('todo')) {
191		foreach ($data as $migrationData) {
192		echo "$migrationData\n";
193		}
194		return;
195		}
196
197		if ($input->getOption('summary')) {
198		$output->writeln("\n <info>==</info> Migrations Summary\n");
199		// do not print info about the not yet supported case
200		unset($summary[Migration::STATUS_PARTIALLY_DONE]);
201		$data = $summary;
202		$headers = array('Status', 'Count');
203		} else {
204		$headers = array('#', 'Migration', 'Status', 'Executed on', 'Notes');
205		}
206
207		$table = new Table($output);
208		$table
209		->setHeaders($headers)
210		->setRows($data);
211		$table->render();
212		}
213		}
214

kaliop-uk / ezmigrationbundle

Push — master ( 5a501b...3982a6 )

StatusCommand::configure() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like