InputManagerTest::testRemoteIP() - Code Metrics - Inspection of "Merge spiral/http component" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 9013bb...125cf1 )

by Kirill
created 2020-08-19 23:24 UTC
InputManagerTest::testRemoteIP() A

↳ Parent: InputManagerTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	27
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	16
c	1
b	0
f	0
dl	0
loc	27
rs	9.7333
cc	1
nc	1
nop	0
<?php

/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

declare(strict_types=1);

namespace Spiral\Tests\Http\Request;

use PHPUnit\Framework\TestCase;
use Psr\Http\Message\ServerRequestInterface;
use Spiral\Core\Container;
use Spiral\Core\Exception\ScopeException;
use Spiral\Http\Exception\InputException;
use Spiral\Http\Request\FilesBag;
use Spiral\Http\Request\HeadersBag;
use Spiral\Http\Request\InputBag;
use Spiral\Http\Request\InputManager;
use Spiral\Http\Request\ServerBag;
use Laminas\Diactoros\ServerRequest;

class InputManagerTest extends TestCase
{
    /**
     * @var Container
     */
    private $container;

    /**
     * @var InputManager
     */
    private $input;

    public function setUp(): void
    {
        $this->container = new Container();
        $this->input = new InputManager($this->container);
    }

    public function testCreateOutsideOfScope(): void
    {
        $this->expectException(ScopeException::class);
        $this->input->request();
    }

    public function testGetRequest(): void
    {
        $this->container->bind(ServerRequestInterface::class, new ServerRequest());
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ new ServerRequest());

        $this->assertNotNull($this->input->request());
        $this->assertSame($this->input->request(), $this->input->request());
    }

    public function testChangeRequest(): void
    {
        $this->container->bind(ServerRequestInterface::class, new ServerRequest([], [], '/hello'));
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ new ServerRequest([], [], '/hello'));
        $this->assertSame('/hello', $this->input->path());

        $this->container->bind(ServerRequestInterface::class, new ServerRequest([], [], '/other'));
        $this->assertSame('/other', $this->input->path());
    }

    public function testUri(): void
    {
        $request = new ServerRequest([], [], 'http://domain.com/hello-world');
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertSame('/hello-world', $this->input->path());

        $request = new ServerRequest([], [], 'http://domain.com/new-one');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertSame('/new-one', $this->input->path());

        $request = new ServerRequest([], [], '');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertSame('/', $this->input->path());


        $request = new ServerRequest([], [], 'hello');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertSame('/hello', $this->input->path());
    }

    public function testMethod(): void
    {
        $request = new ServerRequest([], [], 'http://domain.com/hello-world', 'GET');
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertSame('GET', $this->input->method());

        $request = new ServerRequest([], [], 'http://domain.com/hello-world', 'POST');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertSame('POST', $this->input->method());

        //case fixing
        $request = new ServerRequest([], [], 'http://domain.com/hello-world', 'put');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertSame('PUT', $this->input->method());
    }

    public function testIsSecure(): void
    {
        $request = new ServerRequest([], [], 'http://domain.com/hello-world', 'GET');
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertFalse($this->input->isSecure());

        $request = new ServerRequest([], [], 'https://domain.com/hello-world', 'POST');
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertTrue($this->input->isSecure());
    }

    public function testIsAjax(): void
    {
        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            []
        );
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertFalse($this->input->isAjax());

        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            ['X-Requested-With' => 'xmlhttprequest']
        );
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertTrue($this->input->isAjax());
    }

    /**
     * @dataProvider isJsonExpectedProvider
     * @param bool        $expected
     * @param string|null $acceptHeader
     */
    public function testIsJsonExpected(bool $expected, ?string $acceptHeader): void
    {
        $input = $this->input->withJsonType('application/vnd.api+json');

        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            $acceptHeader !== null ? ['Accept' => $acceptHeader] : []
        );
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertSame($expected, $input->isJsonExpected());
    }

    /**
     * @return iterable
     */
    public function isJsonExpectedProvider(): iterable
    {
        return [
            [false, null],
            [false, 'text/html'],
            [true, 'application/json'],
            [true, 'application/vnd.api+json'],
        ];
    }

    /**
     * @dataProvider isJsonExpectedOnSoftMatchProvider
     * @param bool        $expected
     * @param string|null $acceptHeader
     */
    public function testIsJsonExpectedOnSoftMatch(bool $expected, ?string $acceptHeader): void
    {
        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            $acceptHeader !== null ? ['Accept' => $acceptHeader] : []
        );
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertFalse($this->input->isJsonExpected());
        $this->assertSame($expected, $this->input->isJsonExpected(true));
    }

    /**
     * @return iterable
     */
    public function isJsonExpectedOnSoftMatchProvider(): iterable
    {
        return [
            [false, null],
            [false, 'text/html'],
            [true, 'text/json'],
            [true, 'application/vnd.api+json'],
        ];
    }

    public function testRemoteIP(): void
    {
        $request = new ServerRequest(
            ['REMOTE_ADDR' => '127.0.0.1'],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            []
        );
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertSame('127.0.0.1', $this->input->remoteAddress());

        $request = new ServerRequest(
            ['REMOTE_ADDR' => null],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            ['Accept' => 'application/json']
        );
        $this->container->bind(ServerRequestInterface::class, $request);

        $this->assertTrue($this->input->isJsonExpected());

        $this->assertNull($this->input->remoteAddress());
    }

    public function testGetBag(): void
    {
        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            []
        );
        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);

        $this->assertInstanceOf(ServerBag::class, $this->input->server);
        $this->assertInstanceOf(InputBag::class, $this->input->attributes);
        $this->assertInstanceOf(InputBag::class, $this->input->data);
        $this->assertInstanceOf(InputBag::class, $this->input->cookies);
        $this->assertInstanceOf(InputBag::class, $this->input->query);
        $this->assertInstanceOf(FilesBag::class, $this->input->files);
        $this->assertInstanceOf(HeadersBag::class, $this->input->headers);

        $this->assertInstanceOf(ServerBag::class, $this->input->server);
        $this->assertInstanceOf(InputBag::class, $this->input->attributes);
        $this->assertInstanceOf(InputBag::class, $this->input->data);
        $this->assertInstanceOf(InputBag::class, $this->input->cookies);
        $this->assertInstanceOf(InputBag::class, $this->input->query);
        $this->assertInstanceOf(FilesBag::class, $this->input->files);
        $this->assertInstanceOf(HeadersBag::class, $this->input->headers);

        $input = clone $this->input;
        $this->assertInstanceOf(ServerBag::class, $input->server);
    }

    public function testWrongBad(): void
    {
        $this->expectException(InputException::class);
        $request = new ServerRequest(
            [],
            [],
            'http://domain.com/hello-world',
            'GET',
            'php://input',
            []
        );

        $this->container->bind(ServerRequestInterface::class, $request);
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ $request);
        $this->input->invalid;

    }

    public function testShortcuts(): void
    {
        $this->container->bind(ServerRequestInterface::class, (new ServerRequest())->withParsedBody([
        $this->container->bind(ServerRequestInterface::class, /** @scrutinizer ignore-type */ (new ServerRequest())->withParsedBody([
            'array' => [
                'key' => [
                    'name' => 'value'
                ]
            ],
            'name'  => 'xx'
        ])->withQueryParams([
            'name' => 'value',
            'key'  => ['name' => 'hi']
        ])->withAttribute('attr', 'value')->withCookieParams([
            'cookie' => 'cookie-value'
        ]));

        $this->assertSame('value', $this->input->data('array.key.name'));
        $this->assertSame('value', $this->input->post('array.key.name'));

        $this->assertSame('value', $this->input->query('name'));
        $this->assertSame('hi', $this->input->query('key.name'));

        $this->assertSame('xx', $this->input->input('name'));
        $this->assertSame('hi', $this->input->input('key.name'));
        $this->assertSame('value', $this->input->attribute('attr'));

        $this->assertSame('cookie-value', $this->input->cookie('cookie'));
    }
}

spiral / framework

Push — master ( 9013bb...125cf1 )

InputManagerTest::testRemoteIP() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
