MigrateCommand::executeMigrationInSeparateProcess()

Complexity

Conditions	12
Paths	16

Size

Total Lines	75
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	31.418

Importance

Changes	1
Bugs	0	Features	0

<?php
    protected function executeMigrationInSeparateProcess($migrationDefinition, $migrationService, $builder, $builderArgs, $feedback = true)
    {
        $process = $builder
            ->setArguments(array_merge($builderArgs, array('--path=' . $migrationDefinition->path)))
            ->getProcess();

        if ($feedback) {
            $this->writeln('<info>Executing: ' . $process->getCommandLine() . '</info>', OutputInterface::VERBOSITY_NORMAL);
        }

        $this->subProcessErrorString = '';

        // allow long migrations processes by default
        $process->setTimeout($this->subProcessTimeout);

        // and give immediate feedback to the user...
        // NB: if the subprocess writes to stderr then terminates with non-0 exit code, this will lead us to echoing the
        // error text twice, once here and once at the end of execution of this command.
        // In order to avoid that, since we can not know at this time what the subprocess exit code will be, we
        // do print the error text now, and compare it to what we get at the end...
        $process->run(
            $feedback ?
                function($type, $buffer) {
                    if ($type == 'err') {
                        $this->subProcessErrorString .= $buffer;
                        $this->writeErrorln($buffer, OutputInterface::VERBOSITY_QUIET, OutputInterface::OUTPUT_RAW);
                    } else {
                        // swallow output of child processes in quiet mode
                        $this->writeLn($buffer, self::$VERBOSITY_CHILD, OutputInterface::OUTPUT_RAW);

self::VERBOSITY_CHILD of type double is incompatible with the type integer expected by parameter $verbosity of Kaliop\eZMigrationBundle\Command\AbstractCommand::writeln().

                    }
                }
                :
                function($type, $buffer) {

The parameter $buffer is not used and could be removed.

The parameter $type is not used and could be removed.

                }
        );

        if (!$process->isSuccessful()) {
            $errorOutput = $process->getErrorOutput();
            /// @todo should we always add the exit code to the error message, even when $errorOutput is not null ?
            if ($errorOutput === '') {
                $errorOutput = "(separate process used to execute migration failed with no stderr output. Its exit code was: " . $process->getExitCode();
                // We go out of our way to help the user finding the cause of the error.
                /// @todo another cause we might check for in case of empty $errorOutput is when error_reporting does
                ///       not include fatal errors (E_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR?)
                $errorLog = ini_get("error_log");
                if ($errorLog != '' && $errorLog != 'syslog') {
                    $errorOutput .= ". Error details might be in file $errorLog";
                }
                if ($process->getExitCode() == -1) {
                    $errorOutput .= ". If you are using Debian or Ubuntu linux, please consider using the --force-sigchild-enabled option.";
                }
                $errorOutput .= ")";
            }
            throw new MigrationBundleException($errorOutput);
        }

        // There are cases where the separate process dies halfway but does not return a non-zero code.
        // That's why we double-check here if the migration is still tagged as 'started'...
        /** @var Migration $migration */
        $migration = $migrationService->getMigration($migrationDefinition->name);

        if (!$migration) {

$migration is of type Kaliop\eZMigrationBundle\API\Value\Migration, thus it always evaluated to true.

            // q: shall we add the migration to the db as failed? In doubt, we let it become a ghost, disappeared without a trace...
            throw new MigrationBundleException("After the separate process charged to execute the migration finished, the migration can not be found in the database any more.");
        } else if ($migration->status == Migration::STATUS_STARTED) {
            $errorMsg = "The separate process charged to execute the migration left it in 'started' state. Most likely it died halfway through execution.";
            $migrationService->endMigration(New Migration(
                $migration->name,
                $migration->md5,
                $migration->path,
                $migration->executionDate,
                Migration::STATUS_FAILED,
                ($migration->executionError != '' ? ($errorMsg . ' ' . $migration->executionError) : $errorMsg)
            ));
            throw new MigrationBundleException($errorMsg);
        }