friendica/tests/Unit/Core/Addon/AddonManagerHelperTest.php

<?php

// Copyright (C) 2010-2024, the Friendica project
// SPDX-FileCopyrightText: 2010-2024 the Friendica project
//
// SPDX-License-Identifier: AGPL-3.0-or-later

declare(strict_types=1);

namespace Friendica\Test\Unit\Core\Addon;

use Exception;
use Friendica\Core\Addon\AddonInfo;
use Friendica\Core\Addon\AddonManagerHelper;
use Friendica\Core\Addon\Exception\AddonInvalidConfigFileException;
use Friendica\Core\Addon\Exception\InvalidAddonException;
use Friendica\Core\Cache\Capability\ICanCache;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Database\Database;
use Friendica\Util\Profiler;
use org\bovigo\vfs\vfsStream;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

class AddonManagerHelperTest extends TestCase
{
	public function testGetAddonInfoReturnsAddonInfo(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => <<<PHP
					<?php
					/**
					 * Name: Hello Addon
					 * Description: For testing purpose only
					 * Version: 1.0
					 * Author: Artur Weigandt <dont-mail-me@example.com>
					 */
					PHP,
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$info = $addonManagerHelper->getAddonInfo('helloaddon');

		$this->assertInstanceOf(AddonInfo::class, $info);

		$this->assertEquals('Hello Addon', $info->getName());
	}

	public function testGetAddonInfoThrowsInvalidAddonException(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => <<<PHP
					<?php
					// This is not a valid addon comment section
					PHP,
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(InvalidAddonException::class);
		$this->expectExceptionMessage('Could not find valid comment block in addon file:');

		$addonManagerHelper->getAddonInfo('helloaddon');
	}

	public function testGetAddonDependencyConfigReturnsArray(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'static' => [
					'dependencies.config.php' => <<<PHP
					<?php
					return [
						'foo' => 'bar',
					];
					PHP,
				],
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame(['foo' => 'bar'], $addonManagerHelper->getAddonDependencyConfig('helloaddon'));
	}

	public function testGetAddonDependencyConfigWithoutConfigFileReturnsEmptyArray(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => []
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame([], $addonManagerHelper->getAddonDependencyConfig('helloaddon'));
	}

	public function testGetAddonDependencyConfigWithoutReturningAnArrayThrowsException(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'static' => [
					'dependencies.config.php' => '<?php return null;',
				],
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(AddonInvalidConfigFileException::class);
		$this->expectExceptionMessageMatches('#Error loading config file .+/helloaddon/static/dependencies\.config\.php#');

		$addonManagerHelper->getAddonDependencyConfig('helloaddon');
	}

	public function testEnabledAddons(): void
	{
		$config = $this->createStub(IManageConfigValues::class);
		$config->method('get')->willReturn([
			'helloaddon' => [
				'last_update' => 1738760499,
				'admin'       => false,
			],
		]);

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, []);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame([], $addonManagerHelper->getEnabledAddons());
		$this->assertFalse($addonManagerHelper->isAddonEnabled('helloaddon'));

		$addonManagerHelper->loadAddons();

		$this->assertSame(['helloaddon'], $addonManagerHelper->getEnabledAddons());
		$this->assertTrue($addonManagerHelper->isAddonEnabled('helloaddon'));
	}

	public function testGetVisibleEnabledAddons(): void
	{
		$config = $this->createStub(IManageConfigValues::class);
		$config->method('get')->willReturn([
			'helloaddon' => [
				'last_update' => 1738760499,
				'admin'       => false,
			],
		]);

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, []);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame(['helloaddon'], $addonManagerHelper->getVisibleEnabledAddons());
	}

	public function testGetEnabledAddonsWithAdminSettings(): void
	{
		$config = $this->createStub(IManageConfigValues::class);
		$config->method('get')->willReturn([
			'helloaddon' => [
				'last_update' => 1738760499,
				'admin'       => false,
			],
			'addonwithadminsettings' => [
				'last_update' => 1738760499,
				'admin'       => true,
			],
		]);

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, []);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame(['addonwithadminsettings'], $addonManagerHelper->getEnabledAddonsWithAdminSettings());
	}

	public function testGetAvailableAddons(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => <<<PHP
					<?php
					/**
					 * Name: Hello Addon
					 * Description: For testing purpose only
					 * Version: 1.0
					 * Author: Artur Weigandt <dont-mail-me@example.com>
					 */
					PHP,
			],
			'invalidaddon' => [
				'invalidaddon.php' => 'This addon should not be loaded, because it does not contain a valid comment section.',
			],
			'.hidden' => [
				'.hidden.php' => 'This folder should be ignored',
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame(['helloaddon'], $addonManagerHelper->getAvailableAddons());
	}

	public function testInstallAddonIncludesAddonFile(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php throw new \Exception("Addon file loaded");',
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Addon file loaded');

		$addonManagerHelper->installAddon('helloaddon');
	}

	public function testInstallAddonCallsInstallFunction(): void
	{
		// We need a unique name for the addon to avoid conflicts
		// with other tests that may define the same install function.
		$addonName = __FUNCTION__;

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			$addonName => [
				$addonName . '.php' => <<<PHP
					<?php
					function {$addonName}_install()
					{
						throw new \Exception("Addon installed");
					}
					PHP,
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Addon installed');

		$addonManagerHelper->installAddon($addonName);
	}

	public function testInstallAddonUpdatesConfig(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php',
			]
		]);

		$root->getChild('helloaddon/helloaddon.php')->lastModified(1234567890);

		$config = $this->createMock(IManageConfigValues::class);
		$config->expects($this->once())->method('set')->with(
			'addons',
			'helloaddon',
			['last_update' => 1234567890, 'admin' => false]
		);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$addonManagerHelper->installAddon('helloaddon');
	}

	public function testInstallAddonEnablesAddon(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php',
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->assertSame([], $addonManagerHelper->getEnabledAddons());

		$this->assertTrue($addonManagerHelper->installAddon('helloaddon'));

		$this->assertSame(['helloaddon'], $addonManagerHelper->getEnabledAddons());
	}
	public function testUninstallAddonIncludesAddonFile(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php throw new \Exception("Addon file loaded");',
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Addon file loaded');

		$addonManagerHelper->uninstallAddon('helloaddon');
	}

	public function testUninstallAddonCallsUninstallFunction(): void
	{
		// We need a unique name for the addon to avoid conflicts
		// with other tests that may define the same install function.
		$addonName = __FUNCTION__;

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			$addonName => [
				$addonName . '.php' => <<<PHP
					<?php
					function {$addonName}_uninstall()
					{
						throw new \Exception("Addon uninstalled");
					}
					PHP,
			]
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Addon uninstalled');

		$addonManagerHelper->uninstallAddon($addonName);
	}

	public function testUninstallAddonRemovesHooksFromDatabase(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php',
			]
		]);

		$database = $this->createMock(Database::class);
		$database->expects($this->once())
			->method('delete')
			->with(
				'hook',
				['`file` LIKE ?', '%/helloaddon/helloaddon.php']
			);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$database,
			$this->createStub(IManageConfigValues::class),
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$addonManagerHelper->uninstallAddon('helloaddon');
	}

	public function testUninstallAddonDisablesAddon(): void
	{
		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			'helloaddon' => [
				'helloaddon.php' => '<?php',
			]
		]);

		$config = $this->createStub(IManageConfigValues::class);
		$config->method('get')->willReturn([
			'helloaddon' => [
				'last_update' => 1234567890,
				'admin'       => false,
			],
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$addonManagerHelper->loadAddons();

		$this->assertSame(['helloaddon'], $addonManagerHelper->getEnabledAddons());

		$addonManagerHelper->uninstallAddon('helloaddon');

		$this->assertSame([], $addonManagerHelper->getEnabledAddons());
	}

	public function testReloadAddonsInstallsAddon(): void
	{
		// We need a unique name for the addon to avoid conflicts
		// with other tests that may define the same install function.
		$addonName = __FUNCTION__;

		$root = vfsStream::setup(__FUNCTION__ . '_addons', 0777, [
			$addonName => [
				$addonName . '.php' => <<<PHP
					<?php
					function {$addonName}_install()
					{
						throw new \Exception("Addon reinstalled");
					}
					PHP,
			]
		]);

		$root->getChild($addonName . '/' . $addonName . '.php')->lastModified(1234567890);

		$config = $this->createStub(IManageConfigValues::class);
		$config->method('get')->willReturn([
			$addonName => [
				'last_update' => 0,
				'admin'       => false,
			],
		]);

		$addonManagerHelper = new AddonManagerHelper(
			$root->url(),
			$this->createStub(Database::class),
			$config,
			$this->createStub(ICanCache::class),
			$this->createStub(LoggerInterface::class),
			$this->createStub(Profiler::class)
		);

		$addonManagerHelper->loadAddons();

		$this->assertSame([$addonName], $addonManagerHelper->getEnabledAddons());

		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Addon reinstalled');

		$addonManagerHelper->reloadAddons();
	}
}