friendica-github/tests/src/Core/Hooks/Model/InstanceManagerTest.php

<?php
/**
 * @copyright Copyright (C) 2010-2023, the Friendica project
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */

namespace Friendica\Test\src\Core\Hooks\Model;

use Dice\Dice;
use Friendica\Core\Hooks\Exceptions\HookInstanceException;
use Friendica\Core\Hooks\Exceptions\HookRegisterArgumentException;
use Friendica\Core\Hooks\Model\DiceInstanceManager;
use Friendica\Core\Hooks\Util\StrategiesFileManager;
use Friendica\Test\MockedTest;
use Friendica\Test\Util\Hooks\InstanceMocks\FakeInstance;
use Friendica\Test\Util\Hooks\InstanceMocks\FakeInstanceDecorator;
use Friendica\Test\Util\Hooks\InstanceMocks\IAmADecoratedInterface;
use Mockery\MockInterface;

class InstanceManagerTest extends MockedTest
{
	/** @var StrategiesFileManager|MockInterface */
	protected $hookFileManager;

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

		$this->hookFileManager = \Mockery::mock(StrategiesFileManager::class);
		$this->hookFileManager->shouldReceive('setupStrategies')->withAnyArgs();
	}

	protected function tearDown(): void
	{
		FakeInstanceDecorator::$countInstance = 0;

		parent::tearDown();
	}

	public function testEqualButNotSameInstance()
	{
		$instance = new DiceInstanceManager(new Dice(), $this->hookFileManager);

		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');

		$getInstanceA = $instance->create(IAmADecoratedInterface::class, 'fake');
		$getInstanceB = $instance->create(IAmADecoratedInterface::class, 'fake');

		self::assertEquals($getInstanceA, $getInstanceB);
		self::assertNotSame($getInstanceA, $getInstanceB);
	}

	public function dataTests(): array
	{
		return [
			'only_a' => [
				'aString' => 'test',
			],
			'a_b' => [
				'aString' => 'test',
				'cBool'   => false,
				'bString' => 'test23',

			],
			'a_c' => [
				'aString' => 'test',
				'cBool'   => false,
				'bString' => null,
			],
			'a_b_c' => [
				'aString' => 'test',
				'cBool'   => false,
				'bString' => 'test23',
			],
			'null' => [],
		];
	}

	/**
	 * @dataProvider dataTests
	 */
	public function testInstanceWithArgs(string $aString = null, bool $cBool = null, string $bString = null)
	{
		$instance = new DiceInstanceManager(new Dice(), $this->hookFileManager);

		$args = [];

		if (isset($aString)) {
			$args[] = $aString;
		}
		if (isset($bString)) {
			$args[] = $bString;
		}
		if (isset($cBool)) {
			$args[] = $cBool;
		}

		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');

		/** @var IAmADecoratedInterface $getInstanceA */
		$getInstanceA = $instance->create(IAmADecoratedInterface::class, 'fake', $args);
		/** @var IAmADecoratedInterface $getInstanceB */
		$getInstanceB = $instance->create(IAmADecoratedInterface::class, 'fake', $args);

		self::assertEquals($getInstanceA, $getInstanceB);
		self::assertNotSame($getInstanceA, $getInstanceB);
		self::assertEquals($aString, $getInstanceA->getAText());
		self::assertEquals($aString, $getInstanceB->getAText());
		self::assertEquals($bString, $getInstanceA->getBText());
		self::assertEquals($bString, $getInstanceB->getBText());
		self::assertEquals($cBool, $getInstanceA->getCBool());
		self::assertEquals($cBool, $getInstanceB->getCBool());
	}

	/**
	 * @dataProvider dataTests
	 */
	public function testInstanceWithTwoStrategies(string $aString = null, bool $cBool = null, string $bString = null)
	{
		$instance = new DiceInstanceManager(new Dice(), $this->hookFileManager);

		$args = [];

		if (isset($aString)) {
			$args[] = $aString;
		}
		if (isset($bString)) {
			$args[] = $bString;
		}
		if (isset($cBool)) {
			$args[] = $cBool;
		}

		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');
		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake23');

		/** @var IAmADecoratedInterface $getInstanceA */
		$getInstanceA = $instance->create(IAmADecoratedInterface::class, 'fake', $args);
		/** @var IAmADecoratedInterface $getInstanceB */
		$getInstanceB = $instance->create(IAmADecoratedInterface::class, 'fake23', $args);

		self::assertEquals($getInstanceA, $getInstanceB);
		self::assertNotSame($getInstanceA, $getInstanceB);
		self::assertEquals($aString, $getInstanceA->getAText());
		self::assertEquals($aString, $getInstanceB->getAText());
		self::assertEquals($bString, $getInstanceA->getBText());
		self::assertEquals($bString, $getInstanceB->getBText());
		self::assertEquals($cBool, $getInstanceA->getCBool());
		self::assertEquals($cBool, $getInstanceB->getCBool());
	}

	/**
	 * Test the exception in case the interface was already registered
	 */
	public function testDoubleRegister()
	{
		self::expectException(HookRegisterArgumentException::class);
		self::expectExceptionMessage(sprintf('A class with the name %s is already set for the interface %s', 'fake', IAmADecoratedInterface::class));

		$instance = new DiceInstanceManager(new Dice(), $this->hookFileManager);
		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');
		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');
	}

	/**
	 * Test the exception in case the name of the instance isn't registered
	 */
	public function testWrongInstanceName()
	{
		self::expectException(HookInstanceException::class	);
		self::expectExceptionMessage(sprintf('The class with the name %s isn\'t registered for the class or interface %s', 'fake', IAmADecoratedInterface::class));

		$instance = new DiceInstanceManager(new Dice(), $this->hookFileManager);
		$instance->create(IAmADecoratedInterface::class, 'fake');
	}

	/**
	 * Test in case there are already some rules
	 *
	 * @dataProvider dataTests
	 */
	public function testWithGivenRules(string $aString = null, bool $cBool = null, string $bString = null)
	{
		$args = [];

		if (isset($aString)) {
			$args[] = $aString;
		}
		if (isset($bString)) {
			$args[] = $bString;
		}

		$dice = (new Dice())->addRules([
			FakeInstance::class => [
				'constructParams' => $args,
			],
		]);

		$args = [];

		if (isset($cBool)) {
			$args[] = $cBool;
		}

		$instance = new DiceInstanceManager($dice, $this->hookFileManager);

		$instance->registerStrategy(IAmADecoratedInterface::class, FakeInstance::class, 'fake');

		/** @var IAmADecoratedInterface $getInstanceA */
		$getInstanceA = $instance->create(IAmADecoratedInterface::class, 'fake', $args);
		/** @var IAmADecoratedInterface $getInstanceB */
		$getInstanceB = $instance->create(IAmADecoratedInterface::class, 'fake', $args);

		self::assertEquals($getInstanceA, $getInstanceB);
		self::assertNotSame($getInstanceA, $getInstanceB);
		self::assertEquals($aString, $getInstanceA->getAText());
		self::assertEquals($aString, $getInstanceB->getAText());
		self::assertEquals($bString, $getInstanceA->getBText());
		self::assertEquals($bString, $getInstanceB->getBText());
		self::assertEquals($cBool, $getInstanceA->getCBool());
		self::assertEquals($cBool, $getInstanceB->getCBool());
	}
}