<?php
// Same namespace as target class
namespace Org\Mxchange\CoreFramework\Bootstrap;

// Inport framework stuff
use Org\Mxchange\CoreFramework\Console\Tools\ConsoleTools;
use Org\Mxchange\CoreFramework\Generic\NullPointerException;
use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
use Org\Mxchange\CoreFramework\Loader\ClassLoader;

// Import PHPUnit stuff
use PHPUnit\Framework\Error\Notice;
use PHPUnit\Framework\TestCase;

// Import SPL stuff
use \InvalidArgumentException;
use \SplFileInfo;

/*
 * Copyright (C) 2017 - 2023 Core Developer Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
class FrameworkBootstrapTest extends TestCase {

	/**
	 * Own IP address
	 */
	private static $ipAddress = '0.0.0.0';

	/**
	 * Own host name
	 */
	private static $hostname = 'host.invalid';

	/**
	 * Setup test case
	 */
	public function setUp() {
		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);

		// Call parent method
		parent::setUp();

		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
	}

	/**
	 * Setup test case
	 */
	public static function setUpBeforeClass() {
		// Trace message
		/* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);

		// Call parent method
		parent::setUpBeforeClass();

		// Lookup own hostname
		self::$hostname = ConsoleTools::acquireHostname();

		// Lookup own IP address
		self::$ipAddress = ConsoleTools::acquireSelfIpAddress();

		// Trace message
		/* NOISY-DEBUG: */ printf('[%s:%d]: self::ipAddress[%s]=%s,self::hostname=%s - EXIT!' . PHP_EOL, __METHOD__, __LINE__, gettype(self::$ipAddress), self::$ipAddress, self::$hostname);
	}

	/**
	 * Tests setting an empty default timezone
	 */
	public function testSettingEmptyDefaultTimezone () {
		// Will throw this exception
		$this->expectException(InvalidArgumentException::class);

		// Test it
		FrameworkBootstrap::setDefaultTimezone('');
	}

	/**
	 * Tests setting invalid timezone
	 */
	public function testSettingInvalidDefaultTimezone () {
		// Expect Notice
		$this->expectException(Notice::class);

		// Try to set it
		FrameworkBootstrap::setDefaultTimezone('!invalid!');
	}

	/**
	 * Tests setting valid timezone
	 */
	public function testSettingValidDefaultTimezone () {
		// Will be true
		$this->assertTrue(FrameworkBootstrap::setDefaultTimezone('Europe/Berlin'));
	}

	/**
	 * Tests if detectServerAddress() is returning what it should for tests.
	 * This will always be 127.0.0.1.
	 */
	public function testBootstrapDetectServerAddress () {
		// Call it
		$serverAddress = FrameworkBootstrap::detectServerAddress();

		// Should be the same
		$this->assertEquals(self::$ipAddress, $serverAddress);
	}

	/**
	 * Re-tests if detectServerAddress() is returning what it should for tests.
	 * This will always be 127.0.0.1. This method should not invoke
	 * ConsoleTools's method as the configuration entry is already cached.
	 */
	public function testBootstrapDetectServerAddressCached () {
		// Call it
		//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
		$serverAddress = FrameworkBootstrap::detectServerAddress();

		// Should be the same
		//* NOISY-DEBUG: */ printf('[%s:%d]: self::ipAddress=%s,serverAddress=%s' . PHP_EOL, __METHOD__, __LINE__, self::$ipAddress, $serverAddress);
		$this->assertEquals(self::$ipAddress, $serverAddress);

		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
	}

	/**
	 * Tests method BootstrapFramework::isReachableFilePath() with a
	 * non-existing path. $isReachable should always return TRUE as nothing is
	 * restricting PHP.
	 */
	public function testBootstrapIsReachableFilePathUnrestrictedNotExisting () {
		// Init SPL file info instance
		//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
		$infoInstance = new SplFileInfo('/does/not/exist/');

		// Invoke method
		/* NOISY-DEBUG: */ printf('[%s:%d]: infoInstance=%s' . PHP_EOL, __METHOD__, __LINE__, get_class($infoInstance));
		$isReachable = FrameworkBootstrap::isReachableFilePath($infoInstance);

		// Test if it is not reachable
		/* NOISY-DEBUG: */ printf('[%s:%d]: isReachable=%d' . PHP_EOL, __METHOD__, __LINE__, intval($isReachable));
		$this->assertTrue($isReachable, 'Returned true on a non-existing path');

		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
	}

	/**
	 * Tests method BootstrapFramework::isReachableFilePath() with a
	 * non-existing path. $isReachable should be FALSE here as it is always
	 * outside the scope of open_basedir.
	 */
	public function testBootstrapIsReachableFilePathRestrictedNotExisting () {
		// Init SPL file info instance
		//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
		$infoInstance = new SplFileInfo('/does/not/exist/');

		// "Detect" root path
		//* NOISY-DEBUG: */ printf('[%s:%d]: infoInstance=%s' . PHP_EOL, __METHOD__, __LINE__, get_class($infoInstance));
		$rootScriptPath = realpath(dirname(dirname(FrameworkBootstrap::detectScriptPath())));

		// Set it
		/* NOISY-DEBUG: */ printf('[%s:%d]: open_basedir=%s,rootScriptPath[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, ini_get('open_basedir'), gettype($rootScriptPath), $rootScriptPath);
		$result = ini_set('open_basedir', $rootScriptPath . ':/etc/');

		// Was it set?
		//* NOISY-DEBUG: */ printf('[%s:%d]: result[]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($result));
		if ($result === FALSE) {
			// Didn't work
			$this->failed(sprintf('Cannot set open_basepath=%s', $rootScriptPath));
		}

		// Invoke method
		//* NOISY-DEBUG: */ printf('[%s:%d]: Testing method FrameworkBootstrap::isReachableFilePath(%s) ...' . PHP_EOL, __METHOD__, __LINE__, get_class($infoInstance));
		$isReachable = FrameworkBootstrap::isReachableFilePath($infoInstance);

		// Test if 
		//* NOISY-DEBUG: */ printf('[%s:%d]: isReachable=%d - Testing method ...' . PHP_EOL, __METHOD__, __LINE__, intval($isReachable));
		$this->assertTrue(!$isReachable, 'Returned true on a non-existing path');

		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
	}

	/**
	 * Tests method BootstrapFramework::isReachableFilePath() with an
	 * existing path. $isReachable should be TRUE here as it is within the scope
	 * of open_basedir.
	 */
	public function testBootstrapIsReachableFilePathRestrictedExisting () {
		// Init SPL file info instance
		//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
		$infoInstance = new SplFileInfo(__DIR__);

		// "Detect" root path
		//* NOISY-DEBUG: */ printf('[%s:%d]: infoInstance=%s' . PHP_EOL, __METHOD__, __LINE__, get_class($infoInstance));
		$rootScriptPath = realpath(dirname(dirname(FrameworkBootstrap::detectScriptPath())));

		// Set it
		//* NOISY-DEBUG: */ printf('[%s:%d]: rootScriptPath[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($rootScriptPath), $rootScriptPath);
		$result = ini_set('open_basedir', $rootScriptPath . ':/etc/');

		// Was it set?
		//* NOISY-DEBUG: */ printf('[%s:%d]: result[]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($result));
		if ($result === FALSE) {
			// Didn't work
			$this->failed(sprintf('Cannot set open_basepath=%s', $rootScriptPath));
		}

		// Invoke method
		//* NOISY-DEBUG: */ printf('[%s:%d]: Testing method FrameworkBootstrap::isReachableFilePath(%s) ...' . PHP_EOL, __METHOD__, __LINE__, get_class($infoInstance));
		$isReachable = FrameworkBootstrap::isReachableFilePath($infoInstance);

		// Test if 
		//* NOISY-DEBUG: */ printf('[%s:%d]: isReachable=%d - Testing method ...' . PHP_EOL, __METHOD__, __LINE__, intval($isReachable));
		$this->assertTrue($isReachable, 'Returned true on a non-existing path');

		// Trace message
		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
	}

}