deployphp/deployer

View on GitHub
src/Executor/Messenger.php

Summary

Maintainability
C
1 day
Test Coverage
<?php

declare(strict_types=1);

/* (c) Anton Medvedev <anton@medv.io>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Executor;

use Deployer\Exception\Exception;
use Deployer\Exception\RunException;
use Deployer\Host\Host;
use Deployer\Logger\Logger;
use Deployer\Task\Task;
use Symfony\Component\Console\Input\Input;
use Symfony\Component\Console\Output\Output;
use Throwable;

class Messenger
{
    /**
     * @var Input
     */
    private $input;

    /**
     * @var Output
     */
    private $output;

    /**
     * @var Logger
     */
    private $logger;

    /**
     * @var int|double
     */
    private $startTime;

    public function __construct(Input $input, Output $output, Logger $logger)
    {
        $this->input = $input;
        $this->output = $output;
        $this->logger = $logger;
    }

    public function startTask(Task $task): void
    {
        $this->startTime = round(microtime(true) * 1000);
        if (getenv('GITHUB_WORKFLOW')) {
            $this->output->writeln("::group::task {$task->getName()}");
        } elseif (getenv('GITLAB_CI')) {
            $sectionId = md5($task->getName());
            $start = round($this->startTime / 1000);
            $this->output->writeln("\e[0Ksection_start:{$start}:{$sectionId}\r\e[0K{$task->getName()}");
        } else {
            $this->output->writeln("<fg=cyan;options=bold>task</> {$task->getName()}");
        }
        $this->logger->log("task {$task->getName()}");
    }

    /*
     * Print task was ok.
     */
    public function endTask(Task $task, bool $error = false): void
    {
        if (empty($this->startTime)) {
            $this->startTime = round(microtime(true) * 1000);
        }

        $endTime = round(microtime(true) * 1000);
        $millis = $endTime - $this->startTime;
        $seconds = floor($millis / 1000);
        $millis = $millis - $seconds * 1000;
        $taskTime = ($seconds > 0 ? "{$seconds}s " : "") . "{$millis}ms";

        if (getenv('GITHUB_WORKFLOW')) {
            $this->output->writeln("::endgroup::");
        } elseif (getenv('GITLAB_CI')) {
            $sectionId = md5($task->getName());
            $endTime = round($endTime / 1000);
            $this->output->writeln("\e[0Ksection_end:{$endTime}:{$sectionId}\r\e[0K");
        } elseif ($this->output->isVeryVerbose()) {
            $this->output->writeln("<fg=yellow;options=bold>done</> {$task->getName()} $taskTime");
        }
        if ($error) {
            $this->output->writeln("\e[0K\e[31;1mERROR: Task {$task->getName()} failed!\e[0;m");
            return;
        }
        $this->logger->log("done {$task->getName()} $taskTime");

        if (!empty($this->input->getOption('profile'))) {
            $line = sprintf("%s\t%s\n", $task->getName(), $taskTime);
            file_put_contents($this->input->getOption('profile'), $line, FILE_APPEND);
        }
    }

    public function endOnHost(Host $host): void
    {
        if ($this->output->isVeryVerbose()) {
            $this->output->writeln("<fg=yellow;options=bold>done</> on $host");
        }
    }

    public function renderException(Throwable $exception, Host $host): void
    {
        if ($exception instanceof RunException) {

            $message = "";
            $message .= "[$host] <fg=white;bg=red> error </> <comment>in {$exception->getTaskFilename()} on line {$exception->getTaskLineNumber()}:</>\n";
            if ($this->output->getVerbosity() === Output::VERBOSITY_NORMAL) {
                $message .= "[$host] <fg=green;options=bold>run</> {$exception->getCommand()}\n";
                foreach (explode("\n", $exception->getErrorOutput()) as $line) {
                    $line = trim($line);
                    if ($line !== "") {
                        $message .= "[$host] <fg=red>err</> $line\n";
                    }
                }
                foreach (explode("\n", $exception->getOutput()) as $line) {
                    $line = trim($line);
                    if ($line !== "") {
                        $message .= "[$host] $line\n";
                    }
                }
            }
            $message .= "[$host] <fg=red>exit code</> {$exception->getExitCode()} ({$exception->getExitCodeText()})\n";
            $this->output->write($message);

        } else {
            $message = "";
            $class = get_class($exception);
            $file = basename($exception->getFile());
            $line = $exception->getLine();
            if ($exception instanceof Exception) {
                $file = $exception->getTaskFilename();
                $line = $exception->getTaskLineNumber();
            }
            $message .= "[$host] <fg=white;bg=red> $class </> <comment>in $file on line $line:</>\n";
            $message .= "[$host]\n";
            foreach (explode("\n", $exception->getMessage()) as $line) {
                $line = trim($line);
                if ($line !== "") {
                    $message .= "[$host]   <comment>$line</comment>\n";
                }
            }
            $message .= "[$host]\n";
            if ($this->output->isDebug()) {
                foreach (explode("\n", $exception->getTraceAsString()) as $line) {
                    $line = trim($line);
                    if ($line !== "") {
                        $message .= "[$host] $line\n";
                    }
                }
            }
            $this->output->write($message);
        }

        $this->logger->log($exception->__toString());

        if ($exception->getPrevious()) {
            $this->renderException($exception->getPrevious(), $host);
        }
    }
}