<?php

/*
 * Copyright (C) 2025-2026 Deciso B.V.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 *  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 *  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

namespace tests\OPNsense\Core;

use OPNsense\Core\AppConfig;
use OPNsense\Core\Config;

class ConfigTest extends \PHPUnit\Framework\TestCase
{
    private static $configDir = __DIR__ . '/ConfigConfig';

    public static function cleanupTestFiles()
    {
        @unlink(self::$configDir . '/config.xml');
    }

    /**
     * test construct
     */
    public function testCanBeArray()
    {
        self::cleanupTestFiles();

        (new AppConfig())->update('application.configDir', self::$configDir);
        (new AppConfig())->update('application.configDefault', self::$configDir . '/backup/array.xml');
        Config::getInstance()->forceReload();

        $this->assertNotEmpty(Config::getInstance()->toArray(array_flip(['rule'])));
    }

    /**
     * @depends testCanBeArray
     */
    public function test_to_from_array()
    {
        $cnf = Config::getInstance();

        /* no $forceList influences array result */
        $test = $cnf->toArray();

        /* 'item' will not be an array, instead we see children */
        $this->assertEquals(count($test['sysctl']['item']), 2);
        /* 'rule' is recurring so $forceList is automatic */
        $this->assertEquals(count($test['filter']['rule']), 2);

        /* proper way with $forceList set using array_flip() */
        $test = $cnf->toArray(array_flip(['item', 'rule']));

        /* 'item' will be an array, with one item */
        $this->assertEquals(count($test['sysctl']['item']), 1);
        /* 'rule' is forced but same result as above */
        $this->assertEquals(count($test['filter']['rule']), 2);

        /* manipulate indexes here to mock delte operation */
        $test['filter']['rule'][3] = $test['filter']['rule'][0];
        $test['filter']['rule'][5] = $test['filter']['rule'][1];
        unset($test['filter']['rule'][0]);
        unset($test['filter']['rule'][1]);

        $cnf->fromArray($test);

        $this->assertEquals(file_get_contents(self::$configDir . '/backup/array.xml'), (string)$cnf);
    }

    /**
     * test construct
     */
    public function testCanBeObject()
    {
        self::cleanupTestFiles();

        (new AppConfig())->update('application.configDir', self::$configDir);
        (new AppConfig())->update('application.configDefault', self::$configDir . '/backup/object.xml');
        Config::getInstance()->forceReload();

        $this->assertNotEmpty(Config::getInstance()->object());
    }

    /**
     * @depends testCanBeObject
     */
    public function test_to_from_object()
    {
        $cnf = Config::getInstance();

        $ramode = (string)$cnf->object()->dhcpdv6->lan->ramode;

        /* test that deleting items does not leave whitespace behind and closes parent */
        unset($cnf->object()->dhcpdv6->lan->ramode);
        $this->assertEquals($cnf->object()->dhcpdv6->lan->asXml(), '<lan/>');

        /* put the node back with the previous value and check that it opens again too */
        $cnf->object()->dhcpdv6->lan->addChild('ramode', $ramode);
        $this->assertEquals(file_get_contents(self::$configDir . '/backup/object.xml'), (string)$cnf);
    }

    /**
     * @afterClass
     */
    public static function postCleanup()
    {
        self::cleanupTestFiles();
    }
}
