BaseConsoleRequestTest.php

<?php
/**
 * This file is part of stubbles.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package  stubbles\input
 */
namespace stubbles\input\console;
use stubbles\input\ValueReader;
use stubbles\input\ValueValidator;
use stubbles\input\errors\ParamErrors;

use function bovigo\assert\assert;
use function bovigo\assert\assertFalse;
use function bovigo\assert\assertTrue;
use function bovigo\assert\predicate\equals;
use function bovigo\assert\predicate\isInstanceOf;
/**
 * Tests for stubbles\input\console\BaseConsoleRequest.
 *
 * @since  2.0.0
 * @group  console
 */
class BaseConsoleRequestTest extends \PHPUnit_Framework_TestCase
{
    /**
     * instance to test
     *
     * @type  BaseConsoleRequest
     */
    private $baseConsoleRequest;
    /**
     * backup of $_SERVER['argv']
     *
     * @type array
     */
    private $serverBackup;

    /**
     * set up test environment
     */
    public function setUp()
    {
        $this->serverBackup       = $_SERVER;
        $this->baseConsoleRequest = new BaseConsoleRequest(
                ['foo' => 'bar', 'roland' => 'TB-303'],
                ['SCRIPT_NAME' => 'example.php',
                 'PHP_SELF'    => 'example.php'
                ]
        );
    }

    /**
     * clean up test environment
     */
    public function tearDown()
    {
        $_SERVER = $this->serverBackup;
    }

    /**
     * @test
     */
    public function requestMethodIsAlwaysCli()
    {
        assert($this->baseConsoleRequest->method(), equals('cli'));
    }

    /**
     * @test
     */
    public function returnsListOfParamNames()
    {
        assert($this->baseConsoleRequest->paramNames(), equals(['foo', 'roland']));
    }

    /**
     * @test
     */
    public function createFromRawSourceUsesServerArgsForParams()
    {
        $_SERVER['argv'] = ['foo' => 'bar', 'roland' => 'TB-303'];
        assert(
                BaseConsoleRequest::fromRawSource()->paramNames(),
                equals(['foo', 'roland'])
        );
    }

    /**
     * @test
     */
    public function returnsListOfEnvNames()
    {
        assert(
                $this->baseConsoleRequest->envNames(),
                equals(['SCRIPT_NAME', 'PHP_SELF'])
        );
    }

    /**
     * @test
     */
    public function returnsEnvErrors()
    {
        assert(
                $this->baseConsoleRequest->envErrors(),
                isInstanceOf(ParamErrors::class)
        );
    }

    /**
     * @test
     */
    public function returnsFalseOnCheckForNonExistingEnv()
    {
        assertFalse($this->baseConsoleRequest->hasEnv('baz'));
    }

    /**
     * @test
     */
    public function returnsTrueOnCheckForExistingEnv()
    {
        assertTrue($this->baseConsoleRequest->hasEnv('SCRIPT_NAME'));
    }

    /**
     * @test
     */
    public function validateEnvReturnsValueValidator()
    {
        assert(
                $this->baseConsoleRequest->validateEnv('SCRIPT_NAME'),
                isInstanceOf(ValueValidator::class)
        );
    }

    /**
     * @test
     */
    public function validateEnvReturnsValueValidatorForNonExistingParam()
    {
        assert(
                $this->baseConsoleRequest->validateEnv('baz'),
                isInstanceOf(ValueValidator::class)
        );
    }

    /**
     * @test
     */
    public function readEnvReturnsValueReader()
    {
        assert(
                $this->baseConsoleRequest->readEnv('SCRIPT_NAME'),
                isInstanceOf(ValueReader::class)
        );
    }

    /**
     * @test
     */
    public function readEnvReturnsValueReaderForNonExistingParam()
    {
        assert(
                $this->baseConsoleRequest->readEnv('baz'),
                isInstanceOf(ValueReader::class)
        );
    }

    /**
     * @test
     */
    public function createFromRawSourceUsesServerForEnv()
    {
        $_SERVER = ['argv'        => ['foo' => 'bar', 'roland' => 'TB-303'],
                    'SCRIPT_NAME' => 'example.php'
                   ];
        assert(
                BaseConsoleRequest::fromRawSource()->envNames(),
                equals(['argv', 'SCRIPT_NAME'])
        );
    }
}