Mage\Deploy\Strategy\ReleasesStrategy

Complexity

Total Complexity

27

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getPostReleaseTasks()	0	10	2
A	getOnReleaseTasks()	0	10	2
B	getPostDeployTasks()	0	18	7
A	setRuntime()	0	3	1
A	checkStage()	0	5	2
A	getName()	0	3	1
B	getPreDeployTasks()	0	18	7
A	getOnDeployTasks()	0	14	5

<?php

/*
 * This file is part of the Magallanes package.
 *
 * (c) Andrés Montañez <andres@andresmontanez.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Mage\Deploy\Strategy;

use Mage\Runtime\Exception\RuntimeException;
use Mage\Runtime\Runtime;

/**
 * Strategy for Deployment with Releases, using Tar and SCP
 *
 * @author Andrés Montañez <andresmontanez@gmail.com>
 */
class ReleasesStrategy implements StrategyInterface
{
    protected Runtime $runtime;

    public function getName(): string
    {
        return 'Releases';
    }

    public function setRuntime(Runtime $runtime): void
    {
        $this->runtime = $runtime;
    }

    public function getPreDeployTasks(): array
    {
        $this->checkStage(Runtime::PRE_DEPLOY);
        $tasks = $this->runtime->getTasks();

        if (
            ($this->runtime->getBranch() || $this->runtime->getTag()) &&
            !$this->runtime->inRollback() &&
            !in_array('git/change-branch', $tasks)
        ) {
            array_unshift($tasks, 'git/change-branch');
        }

        if (!$this->runtime->inRollback() && !in_array('deploy/tar/prepare', $tasks)) {
            array_push($tasks, 'deploy/tar/prepare');
        }

        return $tasks;
    }

    public function getOnDeployTasks(): array
    {
        $this->checkStage(Runtime::ON_DEPLOY);
        $tasks = $this->runtime->getTasks();

        if (!$this->runtime->inRollback() && !in_array('deploy/tar/copy', $tasks)) {
            array_unshift($tasks, 'deploy/tar/copy');
        }

        if (!$this->runtime->inRollback() && !in_array('deploy/release/prepare', $tasks)) {
            array_unshift($tasks, 'deploy/release/prepare');
        }

        return $tasks;
    }

    public function getOnReleaseTasks(): array
    {
        $this->checkStage(Runtime::ON_RELEASE);
        $tasks = $this->runtime->getTasks();

        if (!in_array('deploy/release', $tasks)) {
            array_unshift($tasks, 'deploy/release');
        }

        return $tasks;
    }

    public function getPostReleaseTasks(): array
    {
        $this->checkStage(Runtime::POST_RELEASE);
        $tasks = $this->runtime->getTasks();

        if (!in_array('deploy/release/cleanup', $tasks)) {
            array_unshift($tasks, 'deploy/release/cleanup');
        }

        return $tasks;
    }

    public function getPostDeployTasks(): array
    {
        $this->checkStage(Runtime::POST_DEPLOY);
        $tasks = $this->runtime->getTasks();

        if (
            ($this->runtime->getBranch() || $this->runtime->getTag()) &&
            !$this->runtime->inRollback() &&
            !in_array('git/change-branch', $tasks)
        ) {
            array_unshift($tasks, 'git/change-branch');
        }

        if (!$this->runtime->inRollback() && !in_array('deploy/tar/cleanup', $tasks)) {
            array_unshift($tasks, 'deploy/tar/cleanup');
        }

        return $tasks;
    }

    /**
     * Check the runtime stage is correct
     *
     * @throws RuntimeException
     */
    private function checkStage(string $stage): void
    {
        if ($this->runtime->getStage() !== $stage) {
            throw new RuntimeException(
                sprintf('Invalid stage, got "%s" but expected "%s"', $this->runtime->getStage(), $stage)
            );
        }
    }
}