Limoncello\Testing\PhpUnitTestCase

Complexity

Total Complexity

11

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	createApplication()	0	1	?
	createSapi()	0	8	?
B	call()	0	30	1
A	get()	0	4	1
A	post()	0	5	1
A	put()	0	5	1
A	patch()	0	5	1
A	delete()	0	4	1
A	streamFromString()	0	7	1
A	applyHeadersToServer()	0	13	4

<?php namespace Limoncello\Testing;

/**
 * Copyright 2015-2016 info@neomerx.com (www.neomerx.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Core\Contracts\Application\ApplicationInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use Zend\Diactoros\Stream;

/**
 * @package Limoncello\Testing
 */
abstract class PhpUnitTestCase extends \PHPUnit_Framework_TestCase
{
    /** Header name */
    const HEADER_CONTENT_TYPE = 'CONTENT_TYPE';

    use MeasureExecutionTimeTrait;

    /**
     * @param array|null                      $server
     * @param array|null                      $queryParams
     * @param array|object|null               $parsedBody

Consider making the type for parameter $parsedBody a bit more specific; maybe use null|array.

     * @param array|null                      $cookies
     * @param array|null                      $files
     * @param string|resource|StreamInterface $messageBody
     *
     * @return Sapi
     */
    abstract protected function createSapi(
        array $server = null,
        array $queryParams = null,
        array $parsedBody = null,
        array $cookies = null,
        array $files = null,
        $messageBody = 'php://input'
    );

    /**
     * @param Sapi $sapi
     *
     * @return ApplicationInterface
     */
    abstract protected function createApplication(Sapi $sapi);

    /** @noinspection PhpTooManyParametersInspection
     * @param string                          $method
     * @param string                          $uri
     * @param array                           $queryParams
     * @param array                           $parsedBody
     * @param array                           $headers
     * @param array                           $cookies
     * @param array                           $files
     * @param array                           $server
     * @param string|resource|StreamInterface $content
     * @param string                          $host
     *
     * @return ResponseInterface
     */
    protected function call(
        $method,
        $uri,
        array $queryParams = [],
        array $parsedBody = [],
        array $headers = [],
        array $cookies = [],
        array $files = [],
        array $server = [],
        $content = 'php://input',
        $host = 'localhost'
    ) {
        $headers['host'] = $host;

        $server = $this->applyHeadersToServer($headers, $server);

        $server['REQUEST_URI']    = $uri;
        $server['REQUEST_METHOD'] = $method;

        $sapi = $this->createSapi($server, $queryParams, $parsedBody, $cookies, $files, $content);
        $app  = $this->createApplication($sapi);

        $app->run();
        unset($app);

        $response = $sapi->getResponse();
        unset($sapi);

        return $response;
    }

    /**
     * @param string $uri
     * @param array $queryParams
     * @param array $headers
     * @param array $cookies
     *
     * @return ResponseInterface
     */
    protected function get($uri, array $queryParams = [], array $headers = [], array $cookies = [])
    {
        return $this->call('GET', $uri, $queryParams, [], $headers, $cookies);
    }

    /**
     * @param string $uri
     * @param array  $data
     * @param array  $headers
     * @param array  $cookies
     *
     * @return ResponseInterface
     */
    protected function post($uri, array $data = [], array $headers = [], array $cookies = [])
    {
        $headers[self::HEADER_CONTENT_TYPE] = 'application/x-www-form-urlencoded';
        return $this->call('POST', $uri, [], $data, $headers, $cookies);
    }

    /**
     * @param string $uri
     * @param array  $data
     * @param array  $headers
     * @param array  $cookies
     *
     * @return ResponseInterface
     */
    protected function put($uri, array $data = [], array $headers = [], array $cookies = [])
    {
        $headers[self::HEADER_CONTENT_TYPE] = 'application/x-www-form-urlencoded';
        return $this->call('PUT', $uri, [], $data, $headers, $cookies);
    }

    /**
     * @param string $uri
     * @param array  $data
     * @param array  $headers
     * @param array  $cookies
     *
     * @return ResponseInterface
     */
    protected function patch($uri, array $data = [], array $headers = [], array $cookies = [])
    {
        $headers[self::HEADER_CONTENT_TYPE] = 'application/x-www-form-urlencoded';
        return $this->call('PATCH', $uri, [], $data, $headers, $cookies);
    }

    /**
     * @param string $uri
     * @param array  $data
     * @param array  $headers
     * @param array  $cookies
     *
     * @return ResponseInterface
     */
    protected function delete($uri, array $data = [], array $headers = [], array $cookies = [])
    {
        return $this->call('DELETE', $uri, [], $data, $headers, $cookies);
    }

    /**
     * @param string $content
     *
     * @return StreamInterface
     */
    protected function streamFromString($content)
    {
        $stream = new Stream('php://temp', 'wb+');
        $stream->write($content);

        return $stream;
    }

    /**
     * @param array $headers
     * @param array $server
     *
     * @return array
     */
    private function applyHeadersToServer(array $headers, array $server = [])
    {
        $prefix = 'HTTP_';
        foreach ($headers as $name => $value) {
            $name = strtr(strtoupper($name), '-', '_');
            if ($name !== self::HEADER_CONTENT_TYPE && strpos($name, $prefix) !== 0) {
                $name = $prefix . $name;
            }
            $server[$name] = $value;
        }

        return $server;
    }
}