Completed
Push — master ( e7f7b5...2ae0e9 )
by Gaetano
06:53
created

MigrateCommand::getFullExceptionMessage()   C

Complexity

Conditions 8
Paths 3

Size

Total Lines 29
Code Lines 18

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 29
rs 5.3846
cc 8
eloc 18
nc 3
nop 1
1
<?php
2
3
namespace Kaliop\eZMigrationBundle\Command;
4
5
use Symfony\Component\Console\Input\ArrayInput;
6
use Symfony\Component\Console\Input\InputInterface;
7
use Symfony\Component\Console\Output\OutputInterface;
8
use Symfony\Component\Console\Input\InputOption;
9
use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;
10
use Kaliop\eZMigrationBundle\API\Value\Migration;
11
12
/**
13
 * Command to execute the available migration definitions.
14
 */
15
class MigrateCommand extends AbstractCommand
16
{
17
    /**
18
     * Set up the command.
19
     *
20
     * Define the name, options and help text.
21
     */
22
    protected function configure()
23
    {
24
        parent::configure();
25
26
        $this
27
            ->setName('kaliop:migration:migrate')
28
            ->setAliases(array('kaliop:migration:update'))
29
            ->setDescription('Execute available migration definitions.')
30
            ->addOption(
31
                'path',
32
                null,
33
                InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
34
                "The directory or file to load the migration definitions from"
35
            )
36
            ->addOption('ignore-failures', null, InputOption::VALUE_NONE, "Keep executing migration even if one fails")
37
            ->addOption('clear-cache', null, InputOption::VALUE_NONE, "Clear the cache after the command finishes")
38
            ->addOption('no-interaction', 'n', InputOption::VALUE_NONE, "Do not ask any interactive question")
39
            ->setHelp(<<<EOT
40
The <info>kaliop:migration:migrate</info> command loads and executes migrations:
41
42
    <info>./ezpublish/console kaliop:migration:migrate</info>
43
44
You can optionally specify the path to migration definitions with <info>--path</info>:
45
46
    <info>./ezpublish/console kaliop:migrations:migrate --path=/path/to/bundle/version_directory --path=/path/to/bundle/version_directory/single_migration_file</info>
47
EOT
48
            );
49
    }
50
51
    /**
52
     * Execute the command.
53
     *
54
     * @param InputInterface $input
55
     * @param OutputInterface $output
56
     * @return null|int null or 0 if everything went fine, or an error code
57
     *
58
     * @todo Add functionality to work with specified version files not just directories.
59
     */
60
    protected function execute(InputInterface $input, OutputInterface $output)
61
    {
62
        $migrationsService = $this->getMigrationService();
63
64
        $paths = $input->getOption('path');
65
        $migrationDefinitions = $migrationsService->getMigrationsDefinitions($paths);
66
        $migrations = $migrationsService->getMigrations();
67
68
        // filter away all migrations except 'to do' ones
69
        $toExecute = array();
70
        foreach($migrationDefinitions as $name => $migrationDefinition) {
71
            if (!isset($migrations[$name]) || (($migration = $migrations[$name]) && $migration->status == Migration::STATUS_TODO)) {
72
                $toExecute[$name] = $migrationsService->parseMigrationDefinition($migrationDefinition);
73
            }
74
        }
75
76
        // if user wants to execute 'all' migrations: look for some which are registered in the database even if not
77
        // found by the loader
78
        if (empty($paths)) {
79
            foreach ($migrations as $migration) {
80
                if ($migration->status == Migration::STATUS_TODO && !isset($toExecute[$migration->name])) {
81
                    $migrationDefinitions = $migrationsService->getMigrationsDefinitions(array($migration->path));
82
                    if (count($migrationDefinitions)) {
83
                        $migrationDefinition = reset($migrationDefinitions);
84
                        $toExecute[$migration->name] = $migrationsService->parseMigrationDefinition($migrationDefinition);
85
                    } else {
0 ignored issues
show
Unused Code introduced by
This else statement is empty and can be removed.

This check looks for the else branches of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These else branches can be removed.

if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}

could be turned into

if (rand(1, 6) > 3) {
    print "Check failed";
}

This is much more concise to read.

Loading history...
86
                        // q: shall we raise a warning here ?
87
                    }
88
                }
89
            }
90
        }
91
92
        ksort($toExecute);
93
94
        if (!count($toExecute)) {
95
            $output->writeln('<info>No migrations to execute</info>');
96
            return;
97
        }
98
99
        $output->writeln("\n <info>==</info> Migrations to be executed\n");
100
101
        $data = array();
102
        $i = 1;
103
        foreach($toExecute as $name => $migrationDefinition) {
104
            $notes = '';
105
            if ($migrationDefinition->status != MigrationDefinition::STATUS_PARSED) {
106
                $notes = '<error>' . $migrationDefinition->parsingError . '</error>';
107
            }
108
            $data[] = array(
109
                $i++,
110
                $name,
111
                $notes
112
            );
113
        }
114
115
        $table = $this->getHelperSet()->get('table');
116
        $table
117
            ->setHeaders(array('#', 'Migration', 'Notes'))
118
            ->setRows($data);
119
        $table->render($output);
120
121
        $output->writeln('');
122
        // ask user for confirmation to make changes
123 View Code Duplication
        if ($input->isInteractive() && !$input->getOption('no-interaction')) {
0 ignored issues
show
Duplication introduced by
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...
124
            $dialog = $this->getHelperSet()->get('dialog');
125
            if (!$dialog->askConfirmation(
126
                $output,
127
                '<question>Careful, the database will be modified. Do you want to continue Y/N ?</question>',
128
                false
129
            )
130
            ) {
131
                $output->writeln('<error>Migration execution cancelled!</error>');
132
                return 0;
133
            }
134
        } else {
135
            $output->writeln("=============================================\n");
136
        }
137
138
        foreach($toExecute as $name => $migrationDefinition) {
139
140
            // let's skip migrations that we know are invalid - user was warned and he decided to proceed anyway
141
            if ($migrationDefinition->status == MigrationDefinition::STATUS_INVALID) {
142
                $output->writeln("<comment>Skipping $name</comment>\n");
143
                continue;
144
            }
145
146
            $output->writeln("<info>Processing $name</info>");
147
148
            try {
149
                $migrationsService->executeMigration($migrationDefinition);
150
            } catch(\Exception $e) {
151
                if ($input->getOption('ignore-failures')) {
152
                    $output->writeln("\n<error>Migration failed! Reason: " . $e->getMessage() . "</error>\n");
153
                    continue;
154
                }
155
                $output->writeln("\n<error>Migration aborted! Reason: " . $e->getMessage() . "</error>");
156
                return 1;
157
            }
158
159
            $output->writeln('');
160
        }
161
162
        if ($input->getOption('clear-cache')) {
163
            $command = $this->getApplication()->find('cache:clear');
164
            $inputArray = new ArrayInput(array('command' => 'cache:clear'));
165
            $command->run($inputArray, $output);
166
        }
167
    }
168
}
169