App\Action\AbstractAction

Complexity

Total Complexity

13

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

36.84%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	runHooks()	0	42	6
A	info()	0	10	2
A	error()	0	10	2
A	isHookable()	0	3	1
A	setEventFinder()	0	3	1
A	getKey()	0	12	1

<?php

namespace App\Action;

use App\Action\ActionInterface;
use App\Action\Context;
use App\Model\Deployment;
use App\Model\Finder\EventFinder;
use ReflectionClass;
use Ronanchilvers\Foundation\Config;
use Ronanchilvers\Foundation\Traits\Optionable;
use Ronanchilvers\Utility\Str;
use RuntimeException;
use Symfony\Component\Process\Process;

/**
 * Action to symlink the deployment in to the live location
 *
 * @author Ronan Chilvers <ronan@d3r.com>
 */
abstract class AbstractAction implements ActionInterface
{
    use Optionable;

    /**
     * @var \App\Model\Finder\EventFinder
     */
    protected $eventFinder = null;

    /**
     * @var boolean
     */
    protected $hookable = true;

    /**
     * @see \App\Action\ActionInterface::getKey()
     */
    public function getKey()
    {
        $reflection = new ReflectionClass($this);
        $name       = Str::snake(
            str_replace(
                'Action',
                '',
                $reflection->getShortName()
            )
        );

        return $name;
    }

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function setEventFinder(EventFinder $eventFinder)
    {
        $this->eventFinder = $eventFinder;
    }

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function isHookable()
    {
        return $this->hookable;
    }

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function runHooks($hook, Config $configuration, Context $context)
    {
        $deployment = $context->getOrThrow(
            'deployment',
            'Invalid or missing deployment in hook runner'
        );
        $deploymentDir = $context->getOrThrow(
            'deployment_dir',
            'Invalid or missing deployment directory'
        );
        $hook = strtolower($hook);
        if (!in_array($hook, ['before', 'after'])) {
            return;
        }
        $key   = $this->getKey() . '.' . $hook;
        $hooks = $configuration->get($key);
        if (!is_array($hooks) || empty($hooks)) {
            $this->info(
                $deployment,
                sprintf('%s hooks not defined', $key)
            );
            return;
        }
        foreach ($hooks as $command) {
            $this->info(
                $deployment,
                sprintf('%s hook running - %s', $key, $command)
            );
            $process = new Process($command, $deploymentDir);
            $process->run();
            if (!$process->isSuccessful()) {
                $this->error(
                    $deployment,
                    sprintf('%s hook failed to run : %s', $key, $command),
                    [$process->getOutput, $process->getErrorOutput()]
                );
                throw new RuntimeException('Unable to run deployment hook');
            }
            $this->info(
                $deployment,
                sprintf('%s hook ran successfully', $key),
                $process->getOutput()
            );
        }
    }

    /**
     * @see \App\Action\ActionInterface::run()
     */
    abstract public function run(Config $configuration, Context $context);

    /**
     * Log an info event
     *
     * @param \App\Model\Deployment $deployment
     * @param string $header
     * @param mixed $detail
     * @return bool|\App\Model\Event
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    protected function info(Deployment $deployment, string $header, $detail = '')
    {
        if (is_array($detail)) {
            $detail = implode("\n", $detail);
        }
        return $this->eventFinder->event(
            EventFinder::INFO,
            $deployment,
            $header,
            $detail
        );
    }

    /**
     * Log an error event
     *
     * @param \App\Model\Deployment $deployment
     * @param string $header
     * @param mixed $detail
     * @return bool|\App\Model\Event
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    protected function error(Deployment $deployment, string $header, $detail = '')
    {
        if (is_array($detail)) {
            $detail = implode("\n", $detail);
        }
        return $this->eventFinder->event(
            EventFinder::ERROR,
            $deployment,
            $header,
            $detail
        );
    }
}