EnvironmentTest::testUrl() - Code Metrics - Inspection of "Initial working codebase for 2.0.0" - ericsizemore/utility - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( e6d102...7dc300 )

by Eric
created 2024-01-07 08:33 UTC
EnvironmentTest::testUrl() A

↳ Parent: EnvironmentTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	45
Code Lines	27
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	27
nc	1
nop	0
dl	0
loc	45
rs	9.488
c	0
b	0
f	0
<?php

declare(strict_types=1);

/**
 * Utility - Collection of various PHP utility functions.
 *
 * @author    Eric Sizemore <[email protected]>
 * @version   2.0.0
 * @copyright (C) 2017 - 2024 Eric Sizemore
 * @license   The MIT License (MIT)
 *
 * Copyright (C) 2017 - 2024 Eric Sizemore <https://www.secondversion.com>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Esi\Utility\Tests;

use Esi\Utility\Environment;
use Esi\Utility\Arrays;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Attributes\CoversClass;

use InvalidArgumentException;
use ArgumentCountError;
use RuntimeException;

/**
 * Environment utility tests.
 */
#[CoversClass(Environment::class)]
class EnvironmentTest extends TestCase
{
    /**
     * Test Environment::requestMethod().
     */
    public function testRequestMethod(): void
    {
        Arrays::set($_SERVER, 'HTTP_X_HTTP_METHOD_OVERRIDE', 'GET');
        Arrays::set($_SERVER, 'REQUEST_METHOD', 'POST');

        self::assertSame('GET', Environment::requestMethod());

        Arrays::set($_SERVER, 'HTTP_X_HTTP_METHOD_OVERRIDE', null);

        self::assertSame('POST', Environment::requestMethod());

        Arrays::set($_SERVER, 'HTTP_X_HTTP_METHOD_OVERRIDE', 'GET');
        Arrays::set($_SERVER, 'REQUEST_METHOD', null);

        self::assertSame('GET', Environment::requestMethod());
    }

    /**
     * Test Environment::ipAddress().
     */
    public function testIpAddress(): void
    {
        Arrays::set($_SERVER, 'REMOTE_ADDR', '1.1.1.1');
        Arrays::set($_SERVER, 'HTTP_CLIENT_IP', '1.1.1.2');
        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_FOR', '1.1.1.3');
        Arrays::set($_SERVER, 'HTTP_X_REAL_IP', '1.1.1.4');

        self::assertSame('1.1.1.1', Environment::ipAddress());
        self::assertSame('1.1.1.3', Environment::ipAddress(true));

        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_FOR', null);

        self::assertSame('1.1.1.4', Environment::ipAddress(true));

        Arrays::set($_SERVER, 'HTTP_X_REAL_IP', null);

        self::assertSame('1.1.1.2', Environment::ipAddress(true));

        // What if from cloudflare?
        Arrays::set($_SERVER, 'HTTP_CF_CONNECTING_IP', '1.1.1.5');

        self::assertSame('1.1.1.5', Environment::ipAddress());
        self::assertSame('1.1.1.2', Environment::ipAddress(true));

        Arrays::set($_SERVER, 'HTTP_CF_CONNECTING_IP', null);
    }

    /**
     * Test Environment::isPrivateIp().
     */
    public function testIsPrivateIp(): void
    {
        self::assertTrue(Environment::isPrivateIp('192.168.0.0'));
        self::assertFalse(Environment::isPrivateIp('1.1.1.1'));
    }

    /**
     * Test Environment::isReservedIp().
     */
    public function testIsReservedIp(): void
    {
        self::assertTrue(Environment::isReservedIp('0.255.255.255'));
        self::assertFalse(Environment::isReservedIp('192.168.0.0'));
    }

    /**
     * Test Environment::isPublicIp().
     */
    public function testIsPublicIp(): void
    {
        self::assertTrue(Environment::isPublicIp('1.1.1.1'));
        self::assertFalse(Environment::isPublicIp('192.168.0.0'));
        self::assertFalse(Environment::isPublicIp('0.255.255.255'));
    }

    /**
     * Test Environment::host().
     */
    public function testHost(): void
    {
        $origHost = Environment::var('HTTP_HOST');
        $origFwdHost = Environment::var('HTTP_X_FORWARDED_HOST');
        $origSrvName = Environment::var('SERVER_NAME');

        Arrays::set($_SERVER, 'HTTP_HOST', 'example.com');
        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_HOST', 'example2.com');
        Arrays::set($_SERVER, 'SERVER_NAME', null);

        self::assertSame('example2.com', Environment::host(false, true));
        self::assertSame('example.com', Environment::host());

        Arrays::set($_SERVER, 'HTTP_HOST', 'www.example.com');

        self::assertSame('www.example.com', Environment::host());
        self::assertSame('example.com', Environment::host(true));

        Arrays::set($_SERVER, 'HTTP_HOST', null);
        Arrays::set($_SERVER, 'SERVER_NAME', null);
        self::assertSame('localhost', Environment::host());

        Arrays::set($_SERVER, 'HTTP_HOST', $origHost);
        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_HOST', $origFwdHost);
        Arrays::set($_SERVER, 'SERVER_NAME', $origSrvName);
    }

    /**
     * Test Environment::isHttps().
     */
    public function testIsHttps(): void
    {
        Arrays::set($_SERVER, 'HTTPS', null);

        self::assertFalse(Environment::isHttps());

        Arrays::set($_SERVER, 'HTTPS', 'on');

        self::assertTrue(Environment::isHttps());

        Arrays::set($_SERVER, 'HTTPS', null);

        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_PROTO', 'https');
        self::assertTrue(Environment::isHttps());

        Arrays::set($_SERVER, 'HTTP_X_FORWARDED_PROTO', null);
    }

    /**
     * Test Environment::url().
     */
    public function testUrl(): void
    {
        $expected = 'http://test.dev/test.php?foo=bar';
        $expectedAuth = 'http://admin:[email protected]/test.php?foo=bar';
        $expectedPort = 'http://test.dev:443/test.php?foo=bar';
        $expectedPort2 = 'https://test.dev:80/test.php?foo=bar';
        $expectedSSL = 'https://test.dev/test.php?foo=bar';

        Arrays::set($_SERVER, 'HTTP_HOST', 'test.dev');
        Arrays::set($_SERVER, 'REQUEST_URI', '/test.php?foo=bar');
        Arrays::set($_SERVER, 'QUERY_STRING', 'foo=bar');
        Arrays::set($_SERVER, 'PHP_SELF', '/test.php');

        // Test basic url.
        self::assertSame($expected, Environment::url());

        // Test server auth.
        Arrays::set($_SERVER, 'PHP_AUTH_USER', 'admin');
        Arrays::set($_SERVER, 'PHP_AUTH_PW', '123');
        self::assertSame($expectedAuth, Environment::url());

        Arrays::set($_SERVER, 'PHP_AUTH_USER', null);
        Arrays::set($_SERVER, 'PHP_AUTH_PW', null);

        // Test port.
        Arrays::set($_SERVER, 'SERVER_PORT', 443);
        self::assertSame($expectedPort, Environment::url());

        // Test SSL.
        Arrays::set($_SERVER, 'HTTPS', 'on');
        self::assertSame($expectedSSL, Environment::url());

        Arrays::set($_SERVER, 'SERVER_PORT', 80);
        self::assertSame($expectedPort2, Environment::url());

        Arrays::set($_SERVER, 'HTTPS', null);

        // Test no $_SERVER['REQUEST_URI'] (e.g., MS IIS).
        Arrays::set($_SERVER, 'REQUEST_URI', null);
        self::assertSame($expected, Environment::url());

        // Reset.
        Arrays::set($_SERVER, 'HTTP_HOST', null);
        Arrays::set($_SERVER, 'QUERY_STRING', null);
        Arrays::set($_SERVER, 'PHP_SELF', null);
    }

    /**
     * Test Environment::iniGet().
     */
    public function testIniGet(): void
    {
        self::assertNotEmpty(Environment::iniGet('request_order'));

        self::assertLessThanOrEqual('1', Environment::iniGet('display_errors', true));

        self::expectException(RuntimeException::class);
              expectException(RuntimeException::class);
        Environment::iniGet('');

        self::expectException(RuntimeException::class);
        Environment::iniGet('this_should_notbe_a_valid_option');
    }

    /**
     * Test Environment::iniSet().
     */
    public function testIniSet(): void
    {
        // @var string $oldValue

        $oldValue = Environment::iniSet('display_errors', Environment::iniGet('display_errors'));

        self::assertSame($oldValue, Environment::iniSet('display_errors', $oldValue));

        self::expectException(ArgumentCountError::class);
              expectException(ArgumentCountError::class);
        // @phpstan-ignore-next-line
        Environment::iniSet('');
                     iniSet('');

        self::expectException(InvalidArgumentException::class);
        Environment::iniSet('', '');
    }
}

ericsizemore / utility

Push — master ( e6d102...7dc300 )

EnvironmentTest::testUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
