icingaweb2-module-director/test/php/library/Director/IcingaConfig/IcingaConfigHelperTest.php

<?php

namespace Tests\Icinga\Module\Director\IcingaConfig;

use Icinga\Module\Director\IcingaConfig\IcingaConfigHelper as c;
use Icinga\Module\Director\Test\BaseTestCase;

class IcingaConfigHelperTest extends BaseTestCase
{
    public function testWhetherIntervalStringIsCorrectlyParsed()
    {
        $this->assertEquals(c::parseInterval('0'), 0);
        $this->assertEquals(c::parseInterval('0s'), 0);
        $this->assertEquals(c::parseInterval('10'), 10);
        $this->assertEquals(c::parseInterval('70s'), 70);
        $this->assertEquals(c::parseInterval('5m 10s'), 310);
        $this->assertEquals(c::parseInterval('5m 60s'), 360);
        $this->assertEquals(c::parseInterval('1h 5m 60s'), 3960);
    }

    public function testWhetherInvalidIntervalStringRaisesException()
    {
        $this->expectException(\InvalidArgumentException::class);

        c::parseInterval('1h 5m 60x');
    }

    public function testWhetherAnEmptyValueGivesNull()
    {
        $this->assertNull(c::parseInterval(''));
        $this->assertNull(c::parseInterval(null));
    }

    public function testWhetherIntervalStringIsCorrectlyRendered()
    {
        $this->assertEquals(c::renderInterval(10), '10s');
        $this->assertEquals(c::renderInterval(60), '1m');
        $this->assertEquals(c::renderInterval(121), '121s');
        $this->assertEquals(c::renderInterval(3600), '1h');
        $this->assertEquals(c::renderInterval(86400), '1d');
        $this->assertEquals(c::renderInterval(86459), '86459s');
    }

    public function testCorrectlyIdentifiesReservedWords()
    {
        $this->assertTrue(c::isReserved('include'), 'include is a reserved word');
        $this->assertFalse(c::isReserved(0), '(int) 0 is not a reserved word');
        $this->assertFalse(c::isReserved(1), '(int) 1 is not a reserved word');
        $this->assertFalse(c::isReserved(true), '(boolean) true is not a reserved word');
        $this->assertTrue(c::isReserved('true'), '(string) true is a reserved word');
    }

    public function testWhetherDictionaryRendersCorrectly()
    {
        $dict = (object) [
            'key1'     => 'bla',
            'include'  => 'reserved',
            'spe cial' => 'value',
            '0'        => 'numeric',
        ];
        $this->assertEquals(
            c::renderDictionary($dict),
            rtrim($this->loadRendered('dict1'))
        );
    }

    protected function loadRendered($name)
    {
        return file_get_contents(__DIR__ . '/rendered/' . $name . '.out');
    }

    public function testRenderStringIsCorrectlyRendered()
    {
        $this->assertEquals(c::renderString('val1\\\val2'), '"val1\\\\\\\\val2"');
        $this->assertEquals(c::renderString('"val1"'), '"\"val1\""');
        $this->assertEquals(c::renderString('\$val\$'), '"\\\\$val\\\\$"');
        $this->assertEquals(c::renderString('\t'), '"\\\\t"');
        $this->assertEquals(c::renderString('\r'), '"\\\\r"');
        $this->assertEquals(c::renderString('\n'), '"\\\\n"');
        $this->assertEquals(c::renderString('\f'), '"\\\\f"');
    }

    public function testMacrosAreDetected()
    {
        $this->assertFalse(c::stringHasMacro('$$vars$'));
        $this->assertFalse(c::stringHasMacro('$$'));
        $this->assertTrue(c::stringHasMacro('$vars$$'));
        $this->assertTrue(c::stringHasMacro('$multiple$$vars.nested.name$$vars$ is here'));
        $this->assertTrue(c::stringHasMacro('some $vars.nested.name$ is here'));
        $this->assertTrue(c::stringHasMacro('some $vars.nested.name$$vars.even.more$'));
        $this->assertTrue(c::stringHasMacro('$vars.nested.name$$a$$$$not$'));
        $this->assertTrue(c::stringHasMacro('MSSQL$$$config$'));
        $this->assertTrue(c::stringHasMacro('MSSQL$$$config$', 'config'));
        $this->assertTrue(c::stringHasMacro('MSSQL$$$nix$ and $config$', 'config'));
        $this->assertFalse(c::stringHasMacro('MSSQL$$$nix$config$ and $$', 'config'));
        $this->assertFalse(c::stringHasMacro('MSSQL$$$nix$ and $$config$', 'config'));
        $this->assertFalse(c::stringHasMacro('MSSQL$$$config$', 'conf'));
    }

    public function testRenderStringWithVariables()
    {
        $this->assertEquals('"Before " + var', c::renderStringWithVariables('Before $var$'));
        $this->assertEquals(c::renderStringWithVariables('$var$ After'), 'var + " After"');
        $this->assertEquals(c::renderStringWithVariables('$var$'), 'var');
        $this->assertEquals(c::renderStringWithVariables('$$var$$'), '"$$var$$"');
        $this->assertEquals(c::renderStringWithVariables('Before $$var$$ After'), '"Before $$var$$ After"');
        $this->assertEquals(
            '"Before " + name1 + " " + name2 + " After"',
            c::renderStringWithVariables('Before $name1$ $name2$ After')
        );
    }

    public function testRenderStringWithVariablesX()
    {
        $this->assertEquals(
            '"Before " + var1 + " " + var2 + " After"',
            c::renderStringWithVariables('Before $var1$ $var2$ After')
        );
        $this->assertEquals(
            'host.vars.custom',
            c::renderStringWithVariables('$host.vars.custom$')
        );
        $this->assertEquals('"$var\"$"', c::renderStringWithVariables('$var"$'));
        $this->assertEquals(
            '"\\\\tI am\\\\rrendering\\\\nproperly\\\\fand I " + support + " \"multiple\" " + variables + "\\\\$"',
            c::renderStringWithVariables('\tI am\rrendering\nproperly\fand I $support$ "multiple" $variables$\$')
        );
    }

    public function testIsValidMacroNameWithNoWhitelist()
    {
        // Valid names: letter/underscore start, letters/digits/underscores/dots, no trailing dot
        $this->assertTrue(c::isValidMacroName('host.vars.custom'));
        $this->assertTrue(c::isValidMacroName('value.path'));
        $this->assertTrue(c::isValidMacroName('check_interval'));
        $this->assertTrue(c::isValidMacroName('ab'));

        // Single character is invalid: the pattern requires at least 2 characters
        $this->assertFalse(c::isValidMacroName('a'));

        // Trailing dot is explicitly rejected
        $this->assertFalse(c::isValidMacroName('value.'));
        $this->assertFalse(c::isValidMacroName('host.'));

        // Starts with a digit: not matched by [A-z_]
        $this->assertFalse(c::isValidMacroName('1invalid'));

        // Empty string
        $this->assertFalse(c::isValidMacroName(''));
    }

    public function testIsValidMacroNameNullWhitelistBehavesLikeNoWhitelist()
    {
        // Passing null explicitly is the same as omitting the argument
        $this->assertTrue(c::isValidMacroName('host.vars.custom', null));
        $this->assertFalse(c::isValidMacroName('a', null));
        $this->assertFalse(c::isValidMacroName('value.', null));
    }

    public function testIsValidMacroNameExactWhitelistMatch()
    {
        $this->assertTrue(c::isValidMacroName('value.path', ['value.path']));
        $this->assertTrue(c::isValidMacroName('value.mount_point', ['value.path', 'value.mount_point']));
    }

    public function testIsValidMacroNameWildcardWhitelistMatch()
    {
        $this->assertTrue(c::isValidMacroName('value.mount_point', ['value.*']));
        $this->assertTrue(c::isValidMacroName('value.warn', ['value.*']));
        $this->assertTrue(c::isValidMacroName('host.custom', ['host.*', 'value.*']));
    }

    public function testIsValidMacroNameWhitelistNoMatch()
    {
        // Name not in whitelist and not matching any wildcard returns false
        $this->assertFalse(c::isValidMacroName('host.vars.custom', ['value.*']));
        $this->assertFalse(c::isValidMacroName('host.vars.custom', ['other.field']));
    }

    public function testIsValidMacroNameEmptyWhitelistReturnsFalse()
    {
        // When a non-null whitelist is provided, only whitelist matches count —
        // an empty whitelist means nothing is permitted
        $this->assertFalse(c::isValidMacroName('host.vars.custom', []));
        $this->assertFalse(c::isValidMacroName('value.path', []));
    }

    public function testIsValidMacroNameWhitelistOverridesPatternCheck()
    {
        // A name that does not match the base macro pattern is still valid when
        // explicitly listed in the whitelist
        $this->assertTrue(c::isValidMacroName('a', ['a']));
        $this->assertTrue(c::isValidMacroName('value.', ['value.']));
    }
}