kaliop-uk / ezworkflowenginebundle

Command/WorkflowCommand.php

<?php

namespace Kaliop\eZWorkflowEngineBundle\Command;

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

/**
 * Command to manipulate existing workflows.
 */
class WorkflowCommand extends AbstractCommand
{
    /**
     * Set up the command.
     *
     * Define the name, options and help text.
     */
    protected function configure()
    {
        parent::configure();

        $this
            ->setName('kaliop:workflows:workflow')
            ->setDescription('Manually delete workflows from the database table.')
            ->addOption('delete', null, InputOption::VALUE_NONE, "Delete the specified workflow.")
            ->addOption('info', null, InputOption::VALUE_NONE, "Get info about the specified workflow.")
            ->addOption('fail', null, InputOption::VALUE_NONE, "Mark the specified migration as failed.")
            ->addOption('no-interaction', 'n', InputOption::VALUE_NONE, "Do not ask any interactive question.")
            ->addArgument('workflow', InputArgument::REQUIRED, 'The workflow to view or delete (plain workflow name).', null)
            ->setHelp(<<<EOT
The <info>kaliop:workflows:workflow</info> command allows you to manually manage workflows in the database table.

To see detailed information about a workflow:

    <info>php bin/console kaliop:workflows:workflow --info workflow_name</info>

To remove a workflow from the workflow table, or mark it as failed:

    <info>php bin/console kaliop:workflows:workflow --delete workflow_name</info>

    <info>php bin/console kaliop:workflows:workflow --fail workflow_name</info>
EOT
            );
    }

    /**
     * Execute the command.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return null|int null or 0 if everything went fine, or an error code
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if (!$input->getOption('delete') && !$input->getOption('info') && !$input->getOption('fail')) {
            throw new \InvalidArgumentException('You must specify whether you want to --delete, --fail or --info the specified workflow.');
        }

        $workflowService = $this->getWorkflowService();
        $workflowNameOrPath = $input->getArgument('workflow');

        if ($input->getOption('info')) {
            $output->writeln('');

            $workflow = $workflowService->getWorkflow($workflowNameOrPath);

The method getWorkflow() does not exist on Kaliop\eZWorkflowEngineBundle\Core\WorkflowServiceFacade. Since you implemented __call, consider adding a @method annotation.

            if ($workflow == null) {
                throw new \InvalidArgumentException(sprintf('The workflow "%s" does not exist in the database table.', $workflowNameOrPath));

It seems like $workflowNameOrPath can also be of type string[]; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

            }

            switch ($workflow->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;
            }

            $output->writeln('<info>Workflow: ' . $workflow->name . '</info>');
            $output->writeln('Status: ' . $status);

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

            $output->writeln('Executed on: <info>' . ($workflow->executionDate != null ? date("Y-m-d H:i:s", $workflow->executionDate) : '--'). '</info>');
            $output->writeln('Execution notes: <info>' . $workflow->executionError . '</info>');
            $output->writeln('Signal: <info>' . $workflow->signalName . '</info>');

            if ($workflow->status == Migration::STATUS_SUSPENDED) {
                /// @todo decode the suspension context: date, step, ...
            }

            $output->writeln('Definition path: <info>' . $workflow->path . '</info>');
            $output->writeln('Definition md5: <info>' . $workflow->md5 . '</info>');

            if ($workflow->path != '') {
                // q: what if we have a loader which does not work with is_file? We could probably remove this check...
                if (is_file($workflow->path)) {
                    try {
                        $workflowDefinitionCollection = $workflowService->getWorkflowsDefinitions(array($workflow->path));
                        if (count($workflowDefinitionCollection)) {
                            $workflowDefinition = $workflowDefinitionCollection->reset();
                            $workflowDefinition = $workflowService->parseWorkflowDefinition($workflowDefinition);

The method parseWorkflowDefinition() does not exist on Kaliop\eZWorkflowEngineBundle\Core\WorkflowServiceFacade. Since you implemented __call, consider adding a @method annotation.

                            if ($workflowDefinition->status != MigrationDefinition::STATUS_PARSED) {
                                $output->writeln('Definition error: <error>' . $workflowDefinition->parsingError . '</error>');
                            }

                            if (md5($workflowDefinition->rawDefinition) != $workflow->md5) {
                                $output->writeln('Notes: <comment>The workflow definition file has now a different checksum</comment>');
                            }

                            $output->writeln('Switch User: <info>' . (($workflowDefinition->runAs === false) ? '-' : $workflowDefinition->runAs) . '</info>');
                            $output->writeln('Use transaction: <info>' . ($workflowDefinition->useTransaction ? 'Y' : 'N') . '</info>');

                        } else {
                            $output->writeln('Definition error: <error>The workflow definition file can not be loaded</error>');
                        }
                    } catch (\Exception $e) {
                        /// @todo one day we should be able to limit the kind of exceptions we have to catch here...
                        $output->writeln('Definition parsing error: <error>' . $e->getMessage() . '</error>');
                    }
                } else {
                    $output->writeln('Definition error: <error>The workflow definition file can not be found any more</error>');
                }
            }

            $output->writeln('');
            return 0;
        }

        // ask user for confirmation to make changes
        if ($input->isInteractive() && !$input->getOption('no-interaction')) {
            $dialog = $this->getHelperSet()->get('dialog');
            if (!$dialog->askConfirmation(

The method askConfirmation() does not exist on Symfony\Component\Console\Helper\Helper. It seems like you code against a sub-type of Symfony\Component\Console\Helper\Helper such as Symfony\Component\Console\Helper\DialogHelper.

                $output,
                '<question>Careful, the database will be modified. Do you want to continue Y/N ?</question>',
                false
            )
            ) {
                $output->writeln('<error>Workflow change cancelled!</error>');
                return 0;
            }
        }

        if ($input->getOption('delete') || $input->getOption('fail')) {
            $workflow = $workflowService->getWorkflow($workflowNameOrPath);
            if ($workflow == null) {
                throw new \InvalidArgumentException(sprintf('The workflow "%s" does not exist in the database table.', $workflowNameOrPath));
            }

            if ($input->getOption('delete')) {
                $workflowService->deleteWorkflow($workflow);

The method deleteWorkflow() does not exist on Kaliop\eZWorkflowEngineBundle\Core\WorkflowServiceFacade. Since you implemented __call, consider adding a @method annotation.

            } else {
                $errorMessage = 'Manually failed on ' . date("Y-m-d H:i:s");
                if ($workflow->executionError != '') {
                    $errorMessage .= ". Previous notes: " . $workflow->executionError;
                }
                $workflowService->failWorkflow($workflow, $errorMessage);

The method failWorkflow() does not exist on Kaliop\eZWorkflowEngineBundle\Core\WorkflowServiceFacade. Since you implemented __call, consider adding a @method annotation.

            }

            return 0;
        }
    }
}