Tenside\Core\SelfTest\Cli\SelfTestCliArguments

Complexity

Total Complexity

20

Size/Duplication

Total Lines	136
Duplicated Lines	5.88 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	check()	0	6	2
A	testOverride()	0	10	2
A	testMaxExecutionTime()	4	12	4
B	doTest()	0	24	4
A	testMemoryLimit()	4	12	4
A	memoryInBytes()	0	19	4

<?php

/**
 * This file is part of tenside/core.
 *
 * (c) Christian Schiffler <c.schiffler@cyberspectrum.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * This project is provided in good faith and hope to be usable by anyone.
 *
 * @package    tenside/core
 * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @copyright  2015 Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @license    https://github.com/tenside/core/blob/master/LICENSE MIT
 * @link       https://github.com/tenside/core
 * @filesource
 */

namespace Tenside\Core\SelfTest\Cli;

use Symfony\Component\Console\Output\BufferedOutput;

/**
 * This class tests that a valid php-cli binary is available.
 */
class SelfTestCliArguments extends AbstractSelfTestCli
{
    /**
     * The output buffer to keep track of the detection.
     *
     * @var BufferedOutput
     */
    private $log;

    /**
     * Check that we have a correct CLI executable of PHP.
     *
     * @return void
     */
    public function doTest()
    {
        $this->setMessage('Check which arguments to pass to the PHP CLI executable.');

        if (!$this->hasInterpreter()) {
            $this->markFailed('No PHP interpreter detected, can not test.');
            return;
        }

        $this->log = new BufferedOutput();

        if ($this->check()) {
            $data = $this->log->fetch();
            if (empty($data)) {
                $data = 'No special arguments needed.';
            }
            $this->markSuccess($data);
            return;
        }

        $this->markWarning(
            'Could not determine command line arguments, leaving unconfigured and hope the best.'
        );
    }

    /**
     * Check the needed parameters.
     *
     * @return bool
     */
    private function check()
    {
        return
            $this->testMemoryLimit()
            && $this->testMaxExecutionTime();
    }

    /**
     * Test if raising the memory limit is needed.
     *
     * @return bool
     */
    private function testMemoryLimit()
    {
        $output = $this->testCliRuntime('echo ini_get(\'memory_limit\');');
        if ('-1' !== $output && ($this->memoryInBytes($output) < 2 * 1024 * 1024 * 1024)) {
            if ($this->testOverride('echo ini_get(\'memory_limit\');', '-d memory_limit=2G', '2G')) {
                $this->getAutoConfig()->addCommandLineArgument('-d memory_limit=2G');
                $this->log->writeln('Will override memory_limit of ' . $output . ' with 2G.');
            }
        }

        return true;
    }

    /**
     * Test if raising the memory limit is needed.
     *
     * @return bool
     */
    private function testMaxExecutionTime()
    {
        $output = $this->testCliRuntime('echo ini_get(\'max_execution_time\');');
        if ((0 !== intval($output)) && (900 > intval($output))) {
            if ($this->testOverride('echo ini_get(\'max_execution_time\');', '-d max_execution_time=900', '900')) {
                $this->getAutoConfig()->addCommandLineArgument('-d max_execution_time=900');
                $this->log->writeln('Will override max_execution_time of ' . $output . ' with 900 seconds.');
            }
        }

        return true;
    }

    /**
     * Test if overriding a parameter works.
     *
     * @param string $script        The script to run.
     *
     * @param string $definition    The argument to pass.
     *
     * @param string $expectedValue The expected output value.
     *
     * @return bool
     */
    private function testOverride($script, $definition, $expectedValue)
    {
        $output = $this->testCliRuntime($script, $definition);
        if ($expectedValue !== $output) {
            $this->log->writeln('Could not override via ' . $definition);
            return false;
        }

        return true;
    }

    /**
     * Convert a human readable memory amount to the exact byte count.
     *
     * @param string $value The human readable memory string.
     *
     * @return int
     */
    private function memoryInBytes($value)
    {
        $unit  = strtolower(substr($value, -1, 1));
        $value = (int) $value;
        switch ($unit) {
            case 'g':
                $value *= 1024;
            // no break (cumulative multiplier)
            case 'm':
                $value *= 1024;
            // no break (cumulative multiplier)
            case 'k':
                $value *= 1024;
                break;
            default:
        }

        return $value;
    }
}