HttpTransportTest::testSslOptionsAreUsed() - Code Metrics - Inspection of "Run psalm in CI" - bzikarsky/gelf-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 8dceab...2d1996 )

by Benjamin
created 2022-04-05 13:50 UTC
HttpTransportTest::testSslOptionsAreUsed() A

↳ Parent: HttpTransportTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	10
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	15
rs	9.9332
<?php
declare(strict_types=1);

/*
 * This file is part of the php-gelf package.
 *
 * (c) Benjamin Zikarsky <http://benjamin-zikarsky.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gelf\Test\Transport;

use Gelf\Encoder\CompressedJsonEncoder;
use Gelf\Encoder\EncoderInterface;
use Gelf\MessageInterface;
use Gelf\Transport\HttpTransport;
use Gelf\Transport\SslOptions;
use Gelf\Transport\StreamSocketClient;
use InvalidArgumentException;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use ReflectionObject;
use RuntimeException;

class HttpTransportTest extends TestCase
{
    private MockObject|StreamSocketClient $socketClient;
    private MockObject|MessageInterface $message;
    private MockObject|EncoderInterface $encoder;
    
    private HttpTransport $transport;
    private string $testMessage;

    public function setUp(): void
    {
        $this->testMessage = str_repeat("0123456789", 30); // 300 char string

        $this->socketClient = $this->createMock(StreamSocketClient::class);
        $this->message = $this->createMock(MessageInterface::class);

        // create an encoder always return $testMessage
        $this->encoder = $this->createMock(EncoderInterface::class);
        $this->encoder->expects($this->any())->method('encode')->will(
            $this->returnValue($this->testMessage)
        );

        $this->transport = $this->getTransport();
    }

    private function getTransport(): HttpTransport
    {
        // initialize transport with an unlimited packet-size
        // and the mocked message encoder
        $transport = new HttpTransport();
        $transport->setMessageEncoder($this->encoder);

        // replace internal stream socket client with our mock
        $reflectedTransport = new ReflectionObject($transport);
        $reflectedClient = $reflectedTransport->getProperty('socketClient');
        $reflectedClient->setAccessible(true);

        $reflectedClient->setValue($transport, $this->socketClient);

        return $transport;
    }

    public function testConstructor(): void
    {
        $transport = new HttpTransport();
        $this->validateTransport($transport, '127.0.0.1', 12202, '/gelf');

        $transport = new HttpTransport('test.local', 80, '');
        $this->validateTransport($transport, 'test.local', 80, '');

        // test defaults:
        //   path NULL                                   => path: /gelf
        //   port 443 without explicit SSL options       => sslOptions: default
        $transport = new HttpTransport('localhost', 443);
        $this->validateTransport($transport, 'localhost', 443, '/gelf', new SslOptions());
    }

    public function testFromUrlConstructorInvalidUri(): void
    {
        self::expectException(InvalidArgumentException::class);
              expectException(InvalidArgumentException::class);
        HttpTransport::fromUrl('-://:-');
    }

    public function testFromUrlConstructorInvalidScheme(): void
    {
        self::expectException(InvalidArgumentException::class);
              expectException(InvalidArgumentException::class);
        HttpTransport::fromUrl('ftp://foobar');
    }

    public function testFromUrlConstructor()
    {
        $transport = HttpTransport::fromUrl('HTTP://localhost');
        $this->validateTransport($transport, 'localhost', 80, '', null, null);

        $transport = HttpTransport::fromUrl('http://localhost:1234');
        $this->validateTransport($transport, 'localhost', 1234, '', null, null);
        
        $transport = HttpTransport::fromUrl('http://localhost/abc');
        $this->validateTransport($transport, 'localhost', 80, '/abc', null, null);
        
        $transport = HttpTransport::fromUrl('http://localhost:1234/abc');
        $this->validateTransport($transport, 'localhost', 1234, '/abc', null, null);

        $transport = HttpTransport::fromUrl('http://user@localhost');
        $this->validateTransport($transport, 'localhost', 80, '', null, 'user:');

        $transport = HttpTransport::fromUrl('http://user:pass@localhost');
        $this->validateTransport($transport, 'localhost', 80, '', null, 'user:pass');

        $transport = HttpTransport::fromUrl('https://localhost');
        $this->validateTransport($transport, 'localhost', 443, '', new SslOptions(), null);
        
        $sslOptions = new SslOptions();
        $sslOptions->setVerifyPeer(false);
        $transport = HttpTransport::fromUrl('HTTPS://localhost', $sslOptions);
        $this->validateTransport($transport, 'localhost', 443, '', $sslOptions, null);
    }

    public function validateTransport(
        HttpTransport $transport,
        $host,
        $port,
        $path,
        $sslOptions = null,
        $authentication = null
    ): void {
        $r = new ReflectionObject($transport);

        $testProperties = array(
            'host' => $host,
            'port' => $port,
            'path' => $path,
            'sslOptions' => $sslOptions,
            'authentication' => $authentication
        );

        foreach ($testProperties as $property => $value) {
            $p = $r->getProperty($property);
            $p->setAccessible(true);
            self::assertEquals($value, $p->getValue($transport));
        }
    }

    public function testSslOptionsAreUsed(): void
    {
        $sslOptions = $this->createMock(SslOptions::class);
        $sslOptions->expects($this->exactly(2))
            ->method('toStreamContext')
            ->will($this->returnValue(array('ssl' => null)));

        $transport = new HttpTransport("localhost", 12345, "/gelf", $sslOptions);

        $reflectedTransport = new ReflectionObject($transport);
        $reflectedGetContext = $reflectedTransport->getMethod('getContext');
        $reflectedGetContext->setAccessible(true);
        $context = $reflectedGetContext->invoke($transport);

        self::assertEquals(array('ssl' => null), $context);
    }

    public function testSetEncoder(): void
    {
        $encoder = $this->createMock(EncoderInterface::class);
        $this->transport->setMessageEncoder($encoder);

        self::assertEquals($encoder, $this->transport->getMessageEncoder());
    }

    public function testEmptyResponseException(): void
    {
        self::expectException(RuntimeException::class);
              expectException(RuntimeException::class);
        self::expectExceptionMessage(
              expectExceptionMessage(
            "Graylog-Server didn't answer properly, expected 'HTTP/1.x 202 Accepted', response is ''"
        );

        $this->transport->send($this->message);
    }

    public function testSendUncompressed(): void
    {
        $request = "POST /gelf HTTP/1.1"."\r\n"
                 . "Host: 127.0.0.1:12202"."\r\n"
                 . "Content-Length: 300"."\r\n"
                 . "Content-Type: application/json"."\r\n"
                 . "Connection: Keep-Alive"."\r\n"
                 . "Accept: */*"."\r\n"
                 . "\r\n"
                 . $this->testMessage;

        $this->socketClient
            ->expects($this->once())
              expects($this->once())
            ->method("write")
            ->with($request);

        $this->socketClient
            ->expects($this->once())
            ->method("read")
            ->will($this->returnValue("HTTP/1.1 202 Accepted\r\n\r\n"));

        $this->transport->send($this->message);
    }

    public function testAuthentication(): void
    {
        $this->transport->setAuthentication("test", "test");

        $this->socketClient->expects($this->once())
            ->method("write")
            ->will($this->returnCallback(function ($data) {
                self::assertStringContainsString("Authorization: Basic " . base64_encode("test:test"), $data);
                return 1;
            }));



        $this->socketClient
            ->expects($this->once())
            ->method("read")
            ->will($this->returnValue("HTTP/1.1 202 Accepted\r\n\r\n"));

        $this->transport->send($this->message);
    }

    public function testProxy(): void
    {
        $this->socketClient->expects($this->once())
            ->method("setContext")
            ->willReturnCallback(function (array $context) {
                self::assertArrayHasKey("http", $context);
                self::assertEquals(
                    array(
                        "proxy" => "tcp://proxy.example.com:5100",
                        "request_fulluri" => true
                    ),
                    $context["http"]
                );
            });

        $this->transport->setProxy("tcp://proxy.example.com:5100", true);
    }

    public function testSendCompressed(): void
    {
        $request = "POST /gelf HTTP/1.1"."\r\n"
                 . "Host: 127.0.0.1:12202"."\r\n"
                 . "Content-Length: 300"."\r\n"
                 . "Content-Type: application/json"."\r\n"
                 . "Connection: Keep-Alive"."\r\n"
                 . "Accept: */*"."\r\n"
                 . "Content-Encoding: gzip"."\r\n"
                 . ""."\r\n"
                 . $this->testMessage;

        $this->socketClient
            ->expects($this->once())
            ->method("write")
            ->with($request);

        $this->socketClient
            ->expects($this->once())
            ->method("read")
            ->will($this->returnValue("HTTP/1.1 202 Accepted\r\n\r\n"));

        $compressedEncoder = $this->createMock(CompressedJsonEncoder::class);
        $compressedEncoder
            ->expects($this->any())
            ->method('encode')
            ->will(
                $this->returnValue($this->testMessage)
            );
        $this->transport->setMessageEncoder($compressedEncoder);

        $this->transport->send($this->message);
    }

    public function testCloseSocketOnHttpOneZero(): void
    {
        $this->socketClient
            ->expects($this->once())
            ->method("read")
            ->will($this->returnValue("HTTP/1.0 202 Accepted\r\n\r\n"));

        $this->socketClient
            ->expects($this->once())
            ->method("close");

        $this->transport->send($this->message);
    }

    public function testCloseSocketOnConnectionClose(): void
    {
        $this->socketClient
            ->expects($this->once())
            ->method("read")
            ->will($this->returnValue("HTTP/1.1 202 Accepted\r\nConnection: Close\r\n\r\n"));

        $this->socketClient
            ->expects($this->once())
            ->method("close");

        $this->transport->send($this->message);
    }

    public function testConnectTimeout(): void
    {
        $this->socketClient
            ->expects($this->once())
            ->method('getConnectTimeout')
            ->will($this->returnValue(123));

        self::assertEquals(123, $this->transport->getConnectTimeout());

        $this->socketClient
            ->expects($this->once())
            ->method('setConnectTimeout')
            ->with(123);

        $this->transport->setConnectTimeout(123);
    }
}

bzikarsky / gelf-php

Push — master ( 8dceab...2d1996 )

HttpTransportTest::testSslOptionsAreUsed() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
