cakephp/tests/TestCase/Http/Client/RequestTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Http\Client;

use Cake\Http\Client\Request;
use Cake\TestSuite\TestCase;
use Zend\Diactoros\Uri;

/**
 * HTTP request test.
 */
class RequestTest extends TestCase
{
    /**
     * test string ata, header and constructor
     *
     * @return void
     */
    public function testConstructorStringData()
    {
        $headers = [
            'Content-Type' => 'application/json',
            'Authorization' => 'Bearer valid-token',
        ];
        $data = ['a' => 'b', 'c' => 'd'];
        $request = new Request('http://example.com', 'POST', $headers, json_encode($data));

        $this->assertEquals('http://example.com', (string)$request->getUri());
        $this->assertContains($request->getMethod(), 'POST');
        $this->assertEquals('application/json', $request->getHeaderLine('Content-Type'));
        $this->assertEquals(json_encode($data), $request->body());
    }

    /**
     * @param array $headers The HTTP headers to set.
     * @param array|string|null $data The request body to use.
     * @param string $method The HTTP method to use.
     * @dataProvider additionProvider
     */
    public function testMethods(array $headers, $data, $method)
    {
        $request = new Request('http://example.com', $method, $headers, json_encode($data));

        $this->assertEquals($request->getMethod(), $method);
        $this->assertEquals('http://example.com', (string)$request->getUri());
        $this->assertEquals('application/json', $request->getHeaderLine('Content-Type'));
        $this->assertEquals(json_encode($data), $request->body());
    }

    /**
     * @dataProvider additionProvider
     */
    public function additionProvider()
    {
        $headers = [
            'Content-Type' => 'application/json',
            'Authorization' => 'Bearer valid-token',
        ];
        $data = ['a' => 'b', 'c' => 'd'];

        return [
            [$headers, $data, Request::METHOD_POST],
            [$headers, $data, Request::METHOD_GET],
            [$headers, $data, Request::METHOD_PUT],
            [$headers, $data, Request::METHOD_DELETE],
        ];
    }

    /**
     * test array data, header and constructor
     *
     * @return void
     */
    public function testConstructorArrayData()
    {
        $headers = [
            'Content-Type' => 'application/json',
            'Authorization' => 'Bearer valid-token',
        ];
        $data = ['a' => 'b', 'c' => 'd'];
        $request = new Request('http://example.com', 'POST', $headers, $data);

        $this->assertEquals('http://example.com', (string)$request->getUri());
        $this->assertEquals('POST', $request->getMethod());
        $this->assertEquals('application/x-www-form-urlencoded', $request->getHeaderLine('Content-Type'));
        $this->assertEquals('a=b&c=d', $request->body());
    }

    /**
     * test nested array data for encoding of brackets, header and constructor
     *
     * @return void
     */
    public function testConstructorArrayNestedData()
    {
        $headers = [
            'Content-Type' => 'application/json',
            'Authorization' => 'Bearer valid-token',
        ];
        $data = ['a' => 'b', 'c' => ['foo', 'bar']];
        $request = new Request('http://example.com', 'POST', $headers, $data);

        $this->assertEquals('http://example.com', (string)$request->getUri());
        $this->assertEquals('POST', $request->getMethod());
        $this->assertEquals('application/x-www-form-urlencoded', $request->getHeaderLine('Content-Type'));
        $this->assertEquals('a=b&c%5B0%5D=foo&c%5B1%5D=bar', $request->body());
    }

    /**
     * test url method
     *
     * @group deprecated
     * @return void
     */
    public function testUrl()
    {
        $this->deprecated(function () {
            $request = new Request();
            $this->assertSame($request, $request->url('http://example.com'));

            $this->assertEquals('http://example.com', $request->url());
        });
    }

    /**
     * Test that url() modifies the PSR7 stream
     *
     * @group deprecated
     * @return void
     */
    public function testUrlInteroperability()
    {
        $this->deprecated(function () {
            $request = new Request();
            $request->url('http://example.com');
            $this->assertSame('http://example.com', $request->url());
            $this->assertSame('http://example.com', $request->getUri()->__toString());

            $uri = 'http://example.com/test';
            $request = new Request();
            $request = $request->withUri(new Uri($uri));
            $this->assertSame($uri, $request->url());
            $this->assertSame($uri, $request->getUri()->__toString());
        });
    }

    /**
     * test method method.
     *
     * @group deprecated
     * @return void
     */
    public function testMethod()
    {
        $this->deprecated(function () {
            $request = new Request();
            $this->assertSame($request, $request->method(Request::METHOD_GET));

            $this->assertEquals(Request::METHOD_GET, $request->method());
        });
    }

    /**
     * test method interoperability.
     *
     * @group deprecated
     * @return void
     */
    public function testMethodInteroperability()
    {
        $this->deprecated(function () {
            $request = new Request();
            $this->assertSame($request, $request->method(Request::METHOD_GET));

            $this->assertEquals(Request::METHOD_GET, $request->method());
            $this->assertEquals(Request::METHOD_GET, $request->getMethod());

            $request = $request->withMethod(Request::METHOD_GET);
            $this->assertEquals(Request::METHOD_GET, $request->method());
            $this->assertEquals(Request::METHOD_GET, $request->getMethod());
        });
    }

    /**
     * test invalid method.
     *
     * @group deprecated
     * @return void
     */
    public function testMethodInvalid()
    {
        $this->expectException(\Cake\Core\Exception\Exception::class);
        $this->deprecated(function () {
            $request = new Request();
            $request->method('set on fire');
        });
    }

    /**
     * test body method.
     *
     * @return void
     */
    public function testBody()
    {
        $data = '{"json":"data"}';
        $request = new Request();
        $this->assertSame($request, $request->body($data));

        $this->assertEquals($data, $request->body());
    }

    /**
     * test body method with array payload
     *
     * @group deprecated
     * @return void
     */
    public function testBodyArray()
    {
        $request = new Request();
        $data = [
            'a' => 'b',
            'c' => 'd',
            'e' => ['f', 'g'],
        ];
        $request->body($data);
        $this->assertEquals('application/x-www-form-urlencoded', $request->getHeaderLine('content-type'));
        $this->assertEquals(
            'a=b&c=d&e%5B0%5D=f&e%5B1%5D=g',
            $request->body(),
            'Body should be serialized'
        );
    }

    /**
     * Test that body() modifies the PSR7 stream
     *
     * @return void
     */
    public function testBodyInteroperability()
    {
        $request = new Request();
        $this->assertSame('', $request->body());

        $data = '{"json":"data"}';
        $request = new Request();
        $request->body($data);
        $this->assertSame($data, $request->body());
        $this->assertSame($data, '' . $request->getBody());
    }

    /**
     * test header method.
     *
     * @group deprecated
     * @return void
     */
    public function testHeader()
    {
        $this->deprecated(function () {
            $request = new Request();
            $type = 'application/json';
            $result = $request->header('Content-Type', $type);
            $this->assertSame($result, $request, 'Should return self');

            $result = $request->header('content-type');
            $this->assertEquals($type, $result, 'lowercase does not work');

            $result = $request->header('ConTent-typE');
            $this->assertEquals($type, $result, 'Funny casing does not work');

            $result = $request->header([
                'Connection' => 'close',
                'user-agent' => 'CakePHP',
            ]);
            $this->assertSame($result, $request, 'Should return self');

            $this->assertEquals('close', $request->header('connection'));
            $this->assertEquals('CakePHP', $request->header('USER-AGENT'));
            $this->assertNull($request->header('not set'));
        });
    }

    /**
     * Test the default headers
     *
     * @return void
     */
    public function testDefaultHeaders()
    {
        $request = new Request();
        $this->assertEquals('CakePHP', $request->getHeaderLine('User-Agent'));
        $this->assertEquals('close', $request->getHeaderLine('Connection'));
    }

    /**
     * Test that header() and PSR7 methods play nice.
     *
     * @group deprecated
     * @return void
     */
    public function testHeaderMethodInteroperability()
    {
        $this->deprecated(function () {
            $request = new Request();
            $request->header('Content-Type', 'application/json');
            $this->assertEquals('application/json', $request->header('Content-Type'), 'Old getter should work');

            $this->assertEquals('application/json', $request->getHeaderLine('Content-Type'), 'getHeaderLine works');
            $this->assertEquals('application/json', $request->getHeaderLine('content-type'), 'getHeaderLine works');
            $this->assertEquals(['application/json'], $request->getHeader('Content-Type'), 'getHeader works');
            $this->assertEquals(['application/json'], $request->getHeader('content-type'), 'getHeader works');
        });
    }

    /**
     * test cookie method.
     *
     * @group deprecated
     * @return void
     */
    public function testCookie()
    {
        $this->deprecated(function () {
            $request = new Request();
            $result = $request->cookie('session', '123456');
            $this->assertSame($result, $request, 'Should return self');

            $this->assertNull($request->cookie('not set'));

            $result = $request->cookie('session');
            $this->assertEquals('123456', $result);
        });
    }

    /**
     * test version method.
     *
     * @group deprecated
     * @return void
     */
    public function testVersion()
    {
        $this->deprecated(function () {
            $request = new Request();
            $result = $request->version('1.0');
            $this->assertSame($request, $result, 'Should return self');

            $this->assertSame('1.0', $request->version());
        });
    }

    /**
     * test version Interoperable.
     *
     * @group deprecated
     * @return void
     */
    public function testVersionInteroperability()
    {
        $this->deprecated(function () {
            $request = new Request();
            $this->assertEquals('1.1', $request->version());
            $this->assertEquals('1.1', $request->getProtocolVersion());

            $request = $request->withProtocolVersion('1.0');
            $this->assertEquals('1.0', $request->version());
            $this->assertEquals('1.0', $request->getProtocolVersion());
        });
    }
}