Codeception\Extension\PhiremockProcess

Complexity

Total Complexity

21

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	start()	0	13	3
A	stop()	0	7	2
A	setUpProcessCompatibility()	0	7	2
A	initProcess()	0	9	3
A	logPhiremockCommand()	0	9	4
A	getCommandPrefix()	0	4	2
A	isWindows()	0	4	3
A	isPcntlEnabled()	0	4	2

<?php
/**
 * This file is part of codeception-phiremock-extension.
 *
 * phiremock-codeception-extension is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * phiremock-codeception-extension is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with phiremock-codeception-extension.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace Codeception\Extension;

use Symfony\Component\Process\Process;
use Codeception\PHPUnit\Constraint\Page;

/**
 * Manages the current running Phiremock process.
 */
class PhiremockProcess
{
    /**
     * Phiremock server log.
     *
     * @var string
     */
    const LOG_FILE_NAME = 'phiremock.log';

    /**
     * @var \Symfony\Component\Process\Process
     */
    private $process;

    /**
     * Starts Phiremock.
     *
     * @param string $ip
     * @param int    $port
     * @param string $path
     * @param string $logsPath
     * @param bool   $debug
     * @param mixed  $expectationsPath
     */
    public function start($ip, $port, $path, $logsPath, $debug, $expectationsPath)
    {
        $phiremockPath = is_file($path) ? $path : $path . DIRECTORY_SEPARATOR . 'phiremock';
        $expectationsPath = is_dir($expectationsPath) ? $expectationsPath : '';

        $this->logPhiremockCommand($ip, $port, $debug, $expectationsPath, $phiremockPath);
        $this->initProcess($ip, $port, $debug, $expectationsPath, $phiremockPath);
        $logFile = $logsPath . DIRECTORY_SEPARATOR . self::LOG_FILE_NAME;
        $this->process->start(function ($type, $buffer) use ($logFile) {
            file_put_contents($logFile, $buffer, FILE_APPEND);
        });
        $this->setUpProcessCompatibility();
    }

    /**
     * Stops the process.
     */
    public function stop()
    {
        if ($this->isPcntlEnabled()) {
            $this->process->signal(SIGTERM);
            $this->process->stop(3, SIGKILL);
        }
    }

    private function setUpProcessCompatibility()
    {
        $this->process->setEnhanceSigchildCompatibility(true);

The method Symfony\Component\Process\Process::setEnhanceSigchildCompatibility() has been deprecated with message: since version 3.3, to be removed in 4.0.

        if ($this->isWindows()) {
            $this->process->setEnhanceWindowsCompatibility(true);

The method Symfony\Component\Process\Process::setEnhanceWindowsCompatibility() has been deprecated with message: since version 3.3, to be removed in 4.0. Enhanced Windows compatibility will always be enabled.

        }
    }

    /**
     * @param string $ip
     * @param int    $port
     * @param bool   $debug
     * @param string $expectationsPath
     * @param string $phiremockPath
     */
    private function initProcess($ip, $port, $debug, $expectationsPath, $phiremockPath)
    {
        $this->process = new Process(
            $this->getCommandPrefix()
            . "{$phiremockPath} -i {$ip} -p {$port}"
            . ($debug ? ' -d' : '')
            . ($expectationsPath ? " -e {$expectationsPath}" : '')
        );
    }

    /**
     * @param string $ip
     * @param int    $port
     * @param bool   $debug
     * @param string $expectationsPath
     * @param string $phiremockPath
     */
    private function logPhiremockCommand($ip, $port, $debug, $expectationsPath, $phiremockPath)
    {
        if ($debug) {
            echo 'Running ' . $this->getCommandPrefix()
                . "{$phiremockPath} -i {$ip} -p {$port}"
                . ($debug ? ' -d' : '')
                . ($expectationsPath ? " -e {$expectationsPath}" : '') . PHP_EOL;
        }
    }

    /**
     * @return string
     */
    private function getCommandPrefix()
    {
        return $this->isWindows() ? '' : 'exec ';
    }

    /**
     * @return bool
     */
    private function isWindows()
    {
        return PHP_OS === 'WIN32' || PHP_OS === 'WINNT' || PHP_OS === 'Windows';
    }

    /**
     * @return boolean
     */
    private function isPcntlEnabled()
    {
        return !$this->isWindows() && defined(SIGTERM);
    }
}