pfsense/tests/ConfigLibTest.php

<?php
set_include_path(get_include_path() . PATH_SEPARATOR . realpath(__DIR__ . '/../src/etc/inc'));
require_once('globals.inc');
require_once('config.lib.inc');
use PHPUnit\Framework\TestCase;

class ConfigLibTest extends TestCase {
	public function test_config_get_path(): void {
		// Root element access
		$this->assertEquals("bar", config_get_path("foo"));
		// With leading /
		$this->assertEquals("bar", config_get_path("/foo"));
		// Unfound element returns default, even if non-null
		$this->assertNull(config_get_path("foobaz", null));
		$this->assertEquals("test", config_get_path("foobaz", "test"));
		// Subarray
		$this->assertIsArray(config_get_path("bar", null));
		$this->assertEquals("bang", config_get_path("bar/baz", null));
		// Root
		$this->assertIsArray(config_get_path("/"));
		// Sublist
		$this->assertEquals('one', config_get_path("sublist/0"));
		// Non-null default returned for key to empty string element
		$this->assertEquals('', config_get_path('bar/foobang'));
		$this->assertEquals('foo', config_get_path('bar/foobang', 'foo'));
		// Non-null default not returned for key to 0
		$this->assertEquals(0, config_get_path('bar/foobaz'));
		$this->assertEquals(0, config_get_path('bar/foobaz', 'foo'));

	}

	public function test_config_set_path(): void {
		// Root element
		$this->assertEquals("barbaz", config_set_path("baz", "barbaz"));
		$this->assertEquals("barbaz", config_get_path("baz", "barbaz"));
		// Root element already exists
		$this->assertEquals("barbaz", config_set_path("bar", "barbaz"));
		$this->assertEquals("barbaz", config_get_path("bar", "barbaz"));
		// Replace root
		$expect = config_get_path('');
		$expect['bangbaz'] = 'bar';
		$this->assertIsArray(config_set_path('', $expect));
		$this->assertEquals($expect, config_get_path(''));
		// Array root is not treated as a list
		$expect = config_get_path('');
		$this->assertEquals(null, config_set_path('/', 'bang'));
		$this->assertEquals($expect, config_get_path(''));		
		// Parent doesn't exist
		$this->assertEquals("bang", config_set_path("barbang/baz", "bang"));
		$this->assertEquals("bang", config_get_path("barbang/baz"));
		// Path doesn't exist
		$this->assertEquals("bang", config_set_path("foobar/foobaz/foobang", "bang"));
		$this->assertEquals("bang", config_get_path("foobar/foobaz/foobang"));
		// Parent is scalar, no changes are made
		$this->assertNull(config_set_path("barbang/baz/foo", "bar"));
		$this->assertEquals("bang", config_get_path("barbang/baz"));
		// Parent is scalar, non-null default return and no changes are made
		$this->assertEquals(-1, config_set_path("barbang/baz/foo", "bang", -1));
		$this->assertEquals("bang", config_get_path("barbang/baz"));
		// Parent is empty scalar, replaced with array
		$this->assertEquals("bang", config_set_path("emptybar/baz", "bang"));
		$this->assertEquals("bang", config_get_path("emptybar/baz"));
		// Subarray
		$this->assertIsArray(config_set_path("barbang", []));
		$this->assertEquals("bang", config_set_path("barbang/baz", "bang"));
		$this->assertEquals("bang", config_get_path("barbang/baz"));
		// Key exists, replace with array
		$this->assertNotNull(config_get_path("foo"));
		$this->assertNotNull(config_set_path("foo", ["bar" => "barbaz", "baz" => "barbaz"]));
		$this->assertEquals("barbaz", config_get_path("foo/bar"));
		$this->assertEquals("barbaz", config_get_path("foo/baz"));
		// Key in subarray exists
		$this->assertIsArray(config_set_path("bar", []));
		$this->assertEquals("barbaz", config_set_path("bar/baz", "barbaz"));
		$this->assertEquals("barbaz", config_get_path("bar/baz"));
		// Sublist
		$this->assertIsArray(config_set_path('sublist/0', ['0_foo' => '0_bar']));
		$this->assertEquals('0_bar', config_get_path('sublist/0/0_foo'));
		// Add to leaf node array
		$this->assertIsArray(config_set_path('sublist', [['0_foo' => '0_bar']]));
		$this->assertIsArray(config_set_path('sublist/', ['1_foo' => '1_bar']));
		$this->assertEquals('1_bar', config_get_path('sublist/1/1_foo'));
		// Scalar leaf node is replaced with array
		$this->assertEquals('foo', config_set_path('sublist', 'foo'));
		$this->assertIsArray(config_set_path('sublist/', ['0_foo' => '0_bar']));
		$this->assertEquals('0_bar', config_get_path('sublist/0/0_foo'));
	}

	public function test_config_path_enabled(): void {
		// True value in enable
		$this->assertTrue(config_path_enabled('servicefoo'));
		// False value in enable
		$this->assertTrue(config_path_enabled('servicebar'));
		// null value in enable
		$this->assertFalse(config_path_enabled('servicebaz'));
		// Alternate enable key
		$this->assertTrue(config_path_enabled('servicebang', 'otherkey'));
		// nonexistent path
		$this->assertFalse(config_path_enabled('servicebazbang'));
		// Key in root
		$this->assertTrue(config_path_enabled('', 'rootkey'));
		$this->assertTrue(config_path_enabled('/', 'rootkey'));
	}

	public function test_config_del_path(): void {
		// Path not in config
		$this->assertNull(config_del_path("foobang/fooband"));
		// Scalar value
		$this->assertEquals('bar', config_del_path('foo'));
		$this->assertArrayNotHasKey('foo', config_get_path(''));
		// Subarray
		$expect = config_get_path('bar');
		$val = config_del_path('bar');
		$this->assertSame($expect, $val);
		$this->assertArrayNotHasKey('bar', config_get_path(''));
		// Sublist
		$expect = config_get_path('sublist/0');
		$val = config_del_path('sublist/0');
		$this->assertSame($expect, $val);
		$this->assertArrayNotHasKey('0', config_get_path('sublist'));
	}

	public function setUp(): void {
		global $config;
		$config = array(
			"foo" => "bar",
			"bar" => array(
				"baz" => "bang",
				"foobar" => "foobaz",
				"foobang" => "",
				"foobaz" => 0
			),
			"emptybar" => null,
			"servicefoo" => array(
				"enable" => true
			),
			"servicebar" => array(
				"enable" => false
			),
			"servicebaz" => array(
				"enable" => null
			),
			"servicebang" => array(
				"otherkey" => true
			),
			"rootkey" => true,
			"sublist" => ["one", "two", "three"]
		);
	}
}
?>