ilChatroomServerSettingsTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Attributes\DataProvider;

class ilChatroomServerSettingsTest extends TestCase
{
    protected ilChatroomServerSettings $settings;

    public static function setterAndGettersProvider(): array
    {
        $assertIsString = static function ($actual): void {
            self::assertIsString($actual, 'The actual return value is not a type of "string"');
        };

        $assertIsInteger = static function ($actual): void {
            self::assertIsInt($actual, 'The actual return value is not a type of "int"');
        };

        $assertIsBool = static function ($actual): void {
            self::assertIsBool($actual, 'The actual return value is not a type of "bool"');
        };

        return [
            ['port', $assertIsInteger, 7373],
            ['protocol', $assertIsString, 'http://'],
            ['domain', $assertIsString, '127.0.0.1'],

            ['authKey', $assertIsString, 'cfdf79fc-4133-4f3b-882f-5162a87dc465'],
            ['authSecret', $assertIsString, 'f8072a49-0488-411f-be0a-723a762700ba'],
            ['clientUrlEnabled', $assertIsBool, true],
            ['clientUrl', $assertIsString, 'http://proxy.localhost'],
            ['iliasUrlEnabled', $assertIsBool, true],
            ['iliasUrl', $assertIsString, 'http://proxy.localhost'],
            //@TODO Remove this properties
            ['instance', $assertIsString, '123456'],
        ];
    }

    #[DataProvider('setterAndGettersProvider')]
    public function testSettersAndGetters(string $property, callable $assertionCallback, $value): void
    {
        $setter = 'set' . ucfirst($property);
        $getter = 'get' . ucfirst(($property));

        $this->assertTrue(method_exists($this->settings, $setter), sprintf('The Setter "%s" does not exist', $setter));
        $this->assertTrue(method_exists($this->settings, $getter), sprintf('The Getter "%s" does not exist', $setter));

        $this->settings->$setter($value);
        $actual = $this->settings->$getter();

        $this->assertSame($value, $actual, sprintf('The expected value "%s" is not equals to "%s"', $value, $actual));

        $assertionCallback($actual);
    }

    public function testGetBaseUrl(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $port = 7373;
        $expected = sprintf('%s%s:%s', $protocol, $domain, $port);

        $this->settings->setProtocol($protocol);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);

        $this->assertSame($expected, $this->settings->getBaseURL());
    }

    public function testGenerateClientUrlIfEnabled(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $clientDomain = 'proxy.localhost';
        $port = 7373;
        $expected = sprintf('%s%s:%s', $protocol, $clientDomain, $port);

        $this->settings->setClientUrlEnabled(true);
        $this->settings->setProtocol($protocol);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);
        $this->settings->setClientUrl(sprintf('%s:%s', $clientDomain, $port));

        $this->assertSame($expected, $this->settings->generateClientUrl());
    }

    public function testGenerateClientUrlIfDisabled(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $clientDomain = 'proxy.localhost';
        $port = 7373;
        $expected = sprintf('%s%s:%s', $protocol, $domain, $port);

        $this->settings->setClientUrlEnabled(false);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);
        $this->settings->setProtocol($protocol);
        $this->settings->setClientUrl(sprintf('%s:%s', $clientDomain, $port));

        $this->assertSame($expected, $this->settings->generateClientUrl());
    }

    public function testGenerateIliasUrlIfEnabled(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $iliasDomain = 'proxy.localhost';
        $port = 7373;
        $expected = sprintf('%s%s:%s', $protocol, $iliasDomain, $port);

        $this->settings->setIliasUrlEnabled(true);
        $this->settings->setProtocol($protocol);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);
        $this->settings->setIliasUrl(sprintf('%s:%s', $iliasDomain, $port));

        $this->assertSame($expected, $this->settings->generateIliasUrl());
    }

    public function testGenerateIliasUrlIfDisabled(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $iliasDomain = 'proxy.localhost';
        $port = 7373;
        $expected = sprintf('%s%s:%s', $protocol, $domain, $port);

        $this->settings->setIliasUrlEnabled(false);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);
        $this->settings->setProtocol($protocol);
        $this->settings->setIliasUrl(sprintf('%s:%s', $iliasDomain, $port));

        $this->assertSame($expected, $this->settings->generateIliasUrl());
    }

    public function testGetUrl(): void
    {
        $protocol = 'http://';
        $domain = '127.0.0.1';
        $iliasDomain = 'proxy.localhost:8080';
        $port = 7373;
        $action = 'Heartbeat';
        $instance = 'master';
        $scope = 123;

        $this->settings->setProtocol($protocol);
        $this->settings->setDomain($domain);
        $this->settings->setPort($port);
        $this->settings->setIliasUrl($iliasDomain);
        $this->settings->setInstance($instance);

        $this->settings->setIliasUrlEnabled(false);
        $expected = sprintf(
            '%s%s:%s%s/%s/%s',
            $protocol,
            $domain,
            $port,
            ilChatroomServerSettings::PREFIX,
            $action,
            $instance
        );
        $this->assertSame($expected, $this->settings->getURL($action));

        $this->settings->setIliasUrlEnabled(false);
        $expected = sprintf(
            '%s%s:%s%s/%s/%s/%s',
            $protocol,
            $domain,
            $port,
            ilChatroomServerSettings::PREFIX,
            $action,
            $instance,
            $scope
        );
        $this->assertSame($expected, $this->settings->getURL($action, $scope));

        $this->settings->setIliasUrlEnabled(true);
        $expected = sprintf(
            '%s%s%s/%s/%s',
            $protocol,
            $iliasDomain,
            ilChatroomServerSettings::PREFIX,
            $action,
            $instance
        );
        $this->assertSame($expected, $this->settings->getURL($action));

        $this->settings->setIliasUrlEnabled(true);
        $expected = sprintf(
            '%s%s%s/%s/%s/%s',
            $protocol,
            $iliasDomain,
            ilChatroomServerSettings::PREFIX,
            $action,
            $instance,
            $scope
        );
        $this->assertSame($expected, $this->settings->getURL($action, $scope));
    }

    protected function setUp(): void
    {
        parent::setUp();

        $this->settings = new ilChatroomServerSettings();
    }
}