UriTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Http;
 
use ‪TYPO3\CMS\Core\Http\Uri;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪UriTest extends UnitTestCase
{
    public function ‪constructorSetsAllProperties(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        self::assertEquals('https', $uri->getScheme());
        self::assertEquals('user:pass', $uri->getUserInfo());
        self::assertEquals('local.example.com', $uri->getHost());
        self::assertEquals(3001, $uri->getPort());
        self::assertEquals('user:pass@local.example.com:3001', $uri->getAuthority());
        self::assertEquals('/foo', $uri->getPath());
        self::assertEquals('bar=baz', $uri->getQuery());
        self::assertEquals('quz', $uri->getFragment());
    }
 
    public function ‪canSerializeToStringDataProvider(): array
    {
        return [
            'full uri' => [ 'https://user:pass@local.example.com:3001/foo?bar=baz#quz' ],
            'double slash' => [ 'https://user:pass@local.example.com:3001//' ],
        ];
    }
 
    public function ‪canSerializeToString(string $uri): void
    {
        self::assertEquals($uri, (string)(new ‪Uri($uri)));
    }
 
    public function ‪withSchemeReturnsNewInstanceWithNewScheme(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withScheme('http');
        self::assertNotSame($uri, $new);
        self::assertEquals('http', $new->getScheme());
        self::assertEquals('http://user:pass@local.example.com:3001/foo?bar=baz#quz', (string)$new);
    }
 
    public function ‪withUserInfoReturnsNewInstanceWithProvidedUser(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withUserInfo('matthew');
        self::assertNotSame($uri, $new);
        self::assertEquals('matthew', $new->getUserInfo());
        self::assertEquals('https://matthew@local.example.com:3001/foo?bar=baz#quz', (string)$new);
    }
 
    public function ‪withUserInfoReturnsNewInstanceWithProvidedUserAndPassword(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withUserInfo('matthew', 'zf2');
        self::assertNotSame($uri, $new);
        self::assertEquals('matthew:zf2', $new->getUserInfo());
        self::assertEquals('https://matthew:zf2@local.example.com:3001/foo?bar=baz#quz', (string)$new);
    }
 
    public function ‪withHostReturnsNewInstanceWithProvidedHost(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withHost('framework.zend.com');
        self::assertNotSame($uri, $new);
        self::assertEquals('framework.zend.com', $new->getHost());
        self::assertEquals('https://user:pass@framework.zend.com:3001/foo?bar=baz#quz', (string)$new);
    }
 
    public function ‪withPortAndNullValueReturnsInstanceWithProvidedPort(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withPort(null);
        self::assertEquals(
            'https://user:pass@local.example.com/foo?bar=baz#quz',
            (string)$new
        );
    }
    public function ‪validPortsDataProvider(): array
    {
        return [
            'int'    => [3000],
            'string' => ['3000'],
        ];
    }
 
    public function ‪withPortReturnsNewInstanceWithProvidedPort($port): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withPort($port);
        self::assertNotSame($uri, $new);
        self::assertEquals($port, $new->getPort());
        self::assertEquals(
            sprintf('https://user:pass@local.example.com:%d/foo?bar=baz#quz', $port),
            (string)$new
        );
    }
 
    public function ‪invalidPortsDataProviderType(): array
    {
        return [
            'false'     => [false],
            'string'    => ['string'],
            'array'     => [[3000]],
            'object'    => [(object)[3000]],
        ];
    }
 
    public function ‪withPortRaisesExceptionForInvalidPortsByType($port): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717324);
        $uri->withPort($port);
    }
 
    public function ‪invalidPortsDataProviderRange(): array
    {
        return [
            'zero'      => [0],
            'too-small' => [-1],
            'too-big'   => [65536],
        ];
    }
 
    public function ‪withPortAcceptsBooleanTrueAsPortOne(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withPort(true);
        self::assertNotSame($uri, $new);
        self::assertEquals(1, $new->getPort());
    }
 
    public function ‪withPortRaisesExceptionForInvalidPortsByRange($port): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717326);
        $uri->withPort($port);
    }
 
    public function ‪standardPortAndSchemeDoesNotRenderPort(): void
    {
        $subject = new ‪Uri('http://www.example.com:80');
        self::assertEquals('http://www.example.com', (string)$subject);
    }
 
    public function ‪standardPortAndNoSchemeDoesRenderPort(): void
    {
        $subject = new ‪Uri('www.example.com:80');
        self::assertEquals('//www.example.com:80', (string)$subject);
    }
 
    public function ‪noPortAndNoSchemeDoesNotRenderPort(): void
    {
        $subject = new ‪Uri('www.example.com');
        self::assertEquals('/www.example.com', (string)$subject);
    }
 
    public function ‪withPathReturnsNewInstanceWithProvidedPath(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withPath('/bar/baz');
        self::assertNotSame($uri, $new);
        self::assertEquals('/bar/baz', $new->getPath());
        self::assertEquals('https://user:pass@local.example.com:3001/bar/baz?bar=baz#quz', (string)$new);
    }
 
    public function ‪invalidPathsDataProvider(): array
    {
        return [
            'null'     => [null],
            'true'     => [true],
            'false'    => [false],
            'array'    => [['/bar/baz']],
            'object'   => [(object)['/bar/baz']],
        ];
    }
 
    public function ‪withPathRaisesExceptionForInvalidPaths($path): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717328);
        $uri->withPath($path);
    }
 
    public function ‪withPathRaisesExceptionForInvalidPathsWithQuery(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717330);
        $uri->withPath('/bar/baz?bat=quz');
    }
 
    public function ‪withPathRaisesExceptionForInvalidPathsWithFragment(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717332);
        $uri->withPath('/bar/baz#bat');
    }
 
    public function ‪withQueryReturnsNewInstanceWithProvidedQuery(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withQuery('baz=bat');
        self::assertNotSame($uri, $new);
        self::assertEquals('baz=bat', $new->getQuery());
        self::assertEquals('https://user:pass@local.example.com:3001/foo?baz=bat#quz', (string)$new);
    }
 
    public function ‪invalidQueryStringsDataProvider(): array
    {
        return [
            'null'     => [null],
            'true'     => [true],
            'false'    => [false],
            'array'    => [['baz=bat']],
            'object'   => [(object)['baz=bat']],
        ];
    }
 
    public function ‪withQueryRaisesExceptionForInvalidQueryStringsByType($query): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717334);
        $uri->withQuery($query);
    }
 
    public function ‪withQueryRaisesExceptionForInvalidQueryStringsByFragment(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717336);
        $uri->withQuery('baz=bat#quz');
    }
 
    public function ‪withFragmentReturnsNewInstanceWithProvidedFragment(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withFragment('qat');
        self::assertNotSame($uri, $new);
        self::assertEquals('qat', $new->getFragment());
        self::assertEquals('https://user:pass@local.example.com:3001/foo?bar=baz#qat', (string)$new);
    }
 
    public function ‪authorityInfoDataProvider(): array
    {
        return [
            'host-only'      => ['http://foo.com/bar', 'foo.com'],
            'host-port'      => ['http://foo.com:3000/bar', 'foo.com:3000'],
            'user-host'      => ['http://me@foo.com/bar', 'me@foo.com'],
            'user-host-port' => ['http://me@foo.com:3000/bar', 'me@foo.com:3000'],
        ];
    }
 
    public function ‪getAuthorityReturnsExpectedValues($url, $expected): void
    {
        $uri = new ‪Uri($url);
        self::assertEquals($expected, $uri->getAuthority());
    }
 
    public function ‪canEmitOriginFormUrl(): void
    {
        $url = '/foo/bar?baz=bat';
        $uri = new ‪Uri($url);
        self::assertEquals($url, (string)$uri);
    }
 
    public function ‪settingEmptyPathOnAbsoluteUriReturnsAnEmptyPath(): void
    {
        $uri = new ‪Uri('http://example.com/foo');
        $new = $uri->withPath('');
        self::assertEquals('', $new->getPath());
    }
 
    public function ‪stringRepresentationOfAbsoluteUriWithNoPathSetsAnEmptyPath(): void
    {
        $uri = new ‪Uri('http://example.com');
        self::assertEquals('http://example.com', (string)$uri);
    }
 
    public function ‪getPathOnOriginFormRemainsAnEmptyPath(): void
    {
        $uri = new ‪Uri('?foo=bar');
        self::assertEquals('', $uri->getPath());
    }
 
    public function ‪stringRepresentationOfOriginFormWithNoPathRetainsEmptyPath(): void
    {
        $uri = new ‪Uri('?foo=bar');
        self::assertEquals('?foo=bar', (string)$uri);
    }
 
    public function ‪invalidConstructorUrisDataProvider(): array
    {
        return [
            'null'   => [null],
            'true'   => [true],
            'false'  => [false],
            'int'    => [1],
            'float'  => [1.1],
            'array'  => [['http://example.com/']],
            'object' => [(object)['uri' => 'http://example.com/']],
        ];
    }
 
    public function ‪constructorRaisesExceptionForNonStringURI($uri): void
    {
        $this->expectException(\InvalidArgumentException::class);
        new ‪Uri($uri);
    }
 
    public function ‪constructorRaisesExceptionForSeriouslyMalformedURI(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        new ‪Uri('http:///www.php-fig.org/');
    }
 
    public function ‪withSchemeStripsOffDelimiter(): void
    {
        $uri = new ‪Uri('http://example.com');
        $new = $uri->withScheme('https://');
        self::assertEquals('https', $new->getScheme());
    }
 
    public function ‪invalidSchemesDataProvider(): array
    {
        return [
            'mailto' => ['mailto'],
            'ftp'    => ['ftp'],
            'telnet' => ['telnet'],
            'ssh'    => ['ssh'],
            'git'    => ['git'],
        ];
    }
 
    public function ‪constructWithUnsupportedSchemeRaisesAnException($scheme): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717338);
        new ‪Uri($scheme . '://example.com');
    }
 
    public function ‪withSchemeUsingUnsupportedSchemeRaisesAnException($scheme): void
    {
        $uri = new ‪Uri('http://example.com');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717338);
        $uri->withScheme($scheme);
    }
 
    public function ‪withPathIsNotPrefixedWithSlashIfSetWithoutOne(): void
    {
        $uri = new ‪Uri('http://example.com');
        $new = $uri->withPath('foo/bar');
        self::assertEquals('foo/bar', $new->getPath());
    }
 
    public function ‪withEmptySchemeReturnsNewInstanceWithAbsoluteUri(): void
    {
        $uri = new ‪Uri('https://user:pass@local.example.com:3001/foo?bar=baz#quz');
        $new = $uri->withScheme('');
        self::assertNotSame($uri, $new);
        self::assertNotSame((string)$uri, (string)$new);
        self::assertEquals('', $new->getScheme());
        self::assertEquals('//user:pass@local.example.com:3001/foo?bar=baz#quz', (string)$new);
    }
 
    public function ‪withPathNotSlashPrefixedIsEmittedWithSlashDelimiterWhenUriIsCastToString(): void
    {
        $uri = new ‪Uri('http://example.com');
        $new = $uri->withPath('foo/bar');
        self::assertEquals('http://example.com/foo/bar', $new->__toString());
    }
 
    public function ‪withQueryStripsQueryPrefixIfPresent(): void
    {
        $uri = new ‪Uri('http://example.com');
        $new = $uri->withQuery('?foo=bar');
        self::assertEquals('foo=bar', $new->getQuery());
    }
 
    public function ‪withFragmentStripsFragmentPrefixIfPresent(): void
    {
        $uri = new ‪Uri('http://example.com');
        $new = $uri->withFragment('#/foo/bar');
        self::assertEquals('/foo/bar', $new->getFragment());
    }
 
    public function ‪standardSchemePortCombinationsDataProvider(): array
    {
        return [
            'http'  => ['http', 80],
            'https' => ['https', 443],
        ];
    }
 
    public function ‪getAuthorityOmitsPortForStandardSchemePortCombinations($scheme, $port): void
    {
        $uri = (new ‪Uri())
            ->withHost('example.com')
            ->withScheme($scheme)
            ->withPort($port);
        self::assertEquals('example.com', $uri->getAuthority());
    }
 
    public function ‪getPathIsProperlyEncoded(): void
    {
        $uri = (new ‪Uri())->withPath('/foo^bar');
        $expected = '/foo%5Ebar';
        self::assertEquals($expected, $uri->getPath());
    }
 
    public function ‪getPathDoesNotBecomeDoubleEncoded(): void
    {
        $uri = (new ‪Uri())->withPath('/foo%5Ebar');
        $expected = '/foo%5Ebar';
        self::assertEquals($expected, $uri->getPath());
    }
 
    public function ‪queryStringsForEncodingDataProvider(): array
    {
        return [
            'key-only'        => ['k^ey', 'k%5Eey'],
            'key-value'       => ['k^ey=valu`', 'k%5Eey=valu%60'],
            'array-key-only'  => ['key[]', 'key%5B%5D'],
            'array-key-value' => ['key[]=valu`', 'key%5B%5D=valu%60'],
            'complex'         => ['k^ey&key[]=valu`&f<>=`bar', 'k%5Eey&key%5B%5D=valu%60&f%3C%3E=%60bar'],
        ];
    }
 
    public function ‪getQueryIsProperlyEncoded($query, $expected): void
    {
        $uri = (new ‪Uri())->withQuery($query);
        self::assertEquals($expected, $uri->getQuery());
    }
 
    public function ‪getQueryIsNotDoubleEncoded($query, $expected): void
    {
        $uri = (new ‪Uri())->withQuery($expected);
        self::assertEquals($expected, $uri->getQuery());
    }
 
    public function ‪getFragmentIsProperlyEncoded(): void
    {
        $uri = (new ‪Uri())->withFragment('/p^th?key^=`bar#b@z');
        $expected = '/p%5Eth?key%5E=%60bar%23b@z';
        self::assertEquals($expected, $uri->getFragment());
    }
 
    public function ‪getFragmentIsNotDoubleEncoded(): void
    {
        $expected = '/p%5Eth?key%5E=%60bar%23b@z';
        $uri = (new ‪Uri())->withFragment($expected);
        self::assertEquals($expected, $uri->getFragment());
    }
}