Fixed namespaces (PHPCI -> PHPCensor)

src/PHPCensor/Plugin/Util/Executor.php

@@ -0,0 +1,254 @@
+<?php
+
+namespace PHPCensor\Plugin\Util;
+
+use b8\Store\Factory as StoreFactory;
+use Exception;
+use PHPCensor\Helper\Lang;
+use PHPCensor\Logging\BuildLogger;
+use PHPCensor\Model\Build;
+use PHPCensor\Store\BuildStore;
+
+/**
+ * Plugin Executor - Runs the configured plugins for a given build stage.
+ * @package PHPCI\Plugin\Util
+ */
+class Executor
+{
+    /**
+     * @var BuildLogger
+     */
+    protected $logger;
+
+    /**
+     * @var Factory
+     */
+    protected $pluginFactory;
+
+    /**
+     * @var BuildStore
+     */
+    protected $store;
+
+    /**
+     * @param Factory $pluginFactory
+     * @param BuildLogger $logger
+     */
+    public function __construct(Factory $pluginFactory, BuildLogger $logger, BuildStore $store = null)
+    {
+        $this->pluginFactory = $pluginFactory;
+        $this->logger = $logger;
+        $this->store = $store ?: StoreFactory::getStore('Build');
+    }
+
+    /**
+     * Execute a the appropriate set of plugins for a given build stage.
+     * @param array $config PHPCI configuration
+     * @param string $stage
+     * @return bool
+     */
+    public function executePlugins(&$config, $stage)
+    {
+        $success          = true;
+        $pluginsToExecute = [];
+
+        // If we have global plugins to execute for this stage, add them to the list to be executed:
+        if (array_key_exists($stage, $config) && is_array($config[$stage])) {
+            $pluginsToExecute[] = $config[$stage];
+        }
+
+        $pluginsToExecute = $this->getBranchSpecificPlugins($config, $stage, $pluginsToExecute);
+
+        foreach ($pluginsToExecute as $pluginSet) {
+            if (!$this->doExecutePlugins($pluginSet, $stage)) {
+                $success = false;
+            }
+        }
+
+        return $success;
+    }
+
+    /**
+     * Check the config for any plugins specific to the branch we're currently building.
+     * @param $config
+     * @param $stage
+     * @param $pluginsToExecute
+     * @return array
+     */
+    protected function getBranchSpecificPlugins(&$config, $stage, $pluginsToExecute)
+    {
+        /** @var \PHPCI\Model\Build $build */
+        $build  = $this->pluginFactory->getResourceFor('PHPCensor\Model\Build');
+        $branch = $build->getBranch();
+
+        // If we don't have any branch-specific plugins:
+        if (!isset($config['branch-' . $branch][$stage]) || !is_array($config['branch-' . $branch][$stage])) {
+            return $pluginsToExecute;
+        }
+
+        // If we have branch-specific plugins to execute, add them to the list to be executed:
+        $branchConfig = $config['branch-' . $branch];
+        $plugins = $branchConfig[$stage];
+
+        $runOption = 'after';
+
+        if (!empty($branchConfig['run-option'])) {
+            $runOption = $branchConfig['run-option'];
+        }
+
+        switch ($runOption) {
+            // Replace standard plugin set for this stage with just the branch-specific ones:
+            case 'replace':
+                $pluginsToExecute   = [];
+                $pluginsToExecute[] = $plugins;
+                break;
+
+            // Run branch-specific plugins before standard plugins:
+            case 'before':
+                array_unshift($pluginsToExecute, $plugins);
+                break;
+
+            // Run branch-specific plugins after standard plugins:
+            case 'after':
+                array_push($pluginsToExecute, $plugins);
+                break;
+
+            default:
+                array_push($pluginsToExecute, $plugins);
+                break;
+        }
+
+        return $pluginsToExecute;
+    }
+
+    /**
+     * Execute the list of plugins found for a given testing stage.
+     * @param $plugins
+     * @param $stage
+     * @return bool
+     * @throws \Exception
+     */
+    protected function doExecutePlugins(&$plugins, $stage)
+    {
+        $success = true;
+
+        foreach ($plugins as $plugin => $options) {
+            $this->logger->log("\n" . Lang::get('running_plugin', Lang::get($plugin)) . ' (' . Lang::get('stage') . ': ' . Lang::get('stage_' . $stage) . ')');
+
+            $this->setPluginStatus($stage, $plugin, Build::STATUS_RUNNING);
+
+            // Try and execute it
+            if ($this->executePlugin($plugin, $options)) {
+                // Execution was successful
+                $this->logger->logSuccess(Lang::get('plugin_success'));
+                $this->setPluginStatus($stage, $plugin, Build::STATUS_SUCCESS);
+            } else {
+                // Execution failed
+                $this->setPluginStatus($stage, $plugin, Build::STATUS_FAILED);
+
+                if ($stage === 'setup') {
+                    $this->logger->logFailure(Lang::get('plugin_failed'));
+                    // If we're in the "setup" stage, execution should not continue after
+                    // a plugin has failed:
+                    throw new Exception('Plugin failed: ' . $plugin);
+                } else {
+                    // If we're in the "test" stage and the plugin is not allowed to fail,
+                    // then mark the build as failed:
+                    if (empty($options['allow_failures']) && $stage === 'test') {
+                        $this->logger->logFailure(Lang::get('plugin_failed'));
+                        $success = false;
+                    } else {
+                        $this->logger->logFailure(Lang::get('plugin_failed') . ' (' . Lang::get('failed_allowed') . ')');
+                    }
+                }
+            }
+        }
+
+        return $success;
+    }
+
+    /**
+     * Executes a given plugin, with options and returns the result.
+     */
+    public function executePlugin($plugin, $options)
+    {
+        // Any plugin name without a namespace separator is a PHPCI built in plugin
+        // if not we assume it's a fully name-spaced class name that implements the plugin interface.
+        // If not the factory will throw an exception.
+        if (strpos($plugin, '\\') === false) {
+            $class = str_replace('_', ' ', $plugin);
+            $class = ucwords($class);
+            $class = 'PHPCensor\\Plugin\\' . str_replace(' ', '', $class);
+        } else {
+            $class = $plugin;
+        }
+
+        if (!class_exists($class)) {
+            $this->logger->logFailure(Lang::get('plugin_missing', $plugin));
+
+            return false;
+        }
+
+        try {
+            // Build and run it
+            $obj = $this->pluginFactory->buildPlugin($class, $options);
+
+            return $obj->execute();
+        } catch (\Exception $ex) {
+            $this->logger->logFailure(Lang::get('exception') . $ex->getMessage(), $ex);
+
+            return false;
+        }
+    }
+
+    /**
+     * Change the status of a plugin for a given stage.
+     *
+     * @param string $stage The builder stage.
+     * @param string $plugin The plugin name.
+     * @param int $status The new status.
+     */
+    protected function setPluginStatus($stage, $plugin, $status)
+    {
+        $summary = $this->getBuildSummary();
+
+        if (!isset($summary[$stage][$plugin])) {
+            $summary[$stage][$plugin] = [];
+        }
+
+        $summary[$stage][$plugin]['status'] = $status;
+
+        if ($status === Build::STATUS_RUNNING) {
+            $summary[$stage][$plugin]['started'] = time();
+        } elseif ($status >= Build::STATUS_SUCCESS) {
+            $summary[$stage][$plugin]['ended'] = time();
+        }
+
+        $this->setBuildSummary($summary);
+    }
+
+    /**
+     * Fetch the summary data of the current build.
+     *
+     * @return array
+     */
+    private function getBuildSummary()
+    {
+        /** @var Build $build */
+        $build = $this->pluginFactory->getResourceFor('PHPCensor\Model\Build');
+        $metas = $this->store->getMeta('plugin-summary', $build->getProjectId(), $build->getId());
+        return isset($metas[0]['meta_value']) ? $metas[0]['meta_value'] : [];
+    }
+
+    /**
+     * Sets the summary data of the current build.
+     *
+     * @param array $summary
+     */
+    private function setBuildSummary($summary)
+    {
+        /** @var Build $build */
+        $build = $this->pluginFactory->getResourceFor('PHPCensor\Model\Build');
+        $this->store->setMeta($build->getProjectId(), $build->getId(), 'plugin-summary', json_encode($summary));
+    }
+}