XC_VM/tests/Unit/ModuleLoaderTest.php

<?php

use XcVm\Cli\CommandRegistry;
use XcVm\Core\Container\ServiceContainer;
use XcVm\Core\Module\ModuleLoader;
use XcVm\Core\Module\NavbarRegistry;
use XcVm\Core\Module\ModuleInterface;
use XcVm\Core\Http\Router;
use PHPUnit\Framework\TestCase;

final class ModuleLoaderTest extends TestCase {
	public function testLoadAllSkipsModuleWithMissingDependencyInsteadOfThrowing(): void {
		$root = $this->createModulesRoot();
		// 'missing-alpha' requires a module that does not exist; a healthy sibling
		// must still load. A missing required dependency must not abort the whole
		// load (which would brick the panel and CLI).
		$this->createModule($root, 'missing-alpha', [
			'dependencies' => ['missing-module'],
		]);
		$this->createModule($root, 'healthy-beta');

		$loader = new ModuleLoader();
		$loader->loadAll($root);

		$this->assertFalse($loader->isLoaded('missing-alpha'));
		$this->assertTrue($loader->isLoaded('healthy-beta'));
	}

	public function testLoadAllSkipsTransitiveDependentsOfMissingDependency(): void {
		$root = $this->createModulesRoot();
		// chain-gamma -> chain-beta -> missing-module (absent). Both gamma and beta
		// must be skipped; an unrelated module must still load.
		$this->createModule($root, 'chain-beta', ['dependencies' => ['missing-module']]);
		$this->createModule($root, 'chain-gamma', ['dependencies' => ['chain-beta']]);
		$this->createModule($root, 'chain-solo');

		$loader = new ModuleLoader();
		$loader->loadAll($root);

		$this->assertFalse($loader->isLoaded('chain-beta'));
		$this->assertFalse($loader->isLoaded('chain-gamma'));
		$this->assertTrue($loader->isLoaded('chain-solo'));
	}

	public function testLoadAllThrowsWhenDependenciesAreCyclic(): void {
		$root = $this->createModulesRoot();
		$this->createModule($root, 'cycle-alpha', ['dependencies' => ['cycle-beta']]);
		$this->createModule($root, 'cycle-beta', ['dependencies' => ['cycle-alpha']]);

		$loader = new ModuleLoader();

		$this->expectException(RuntimeException::class);
		$this->expectExceptionMessage('cyclic module dependency detected');
		$loader->loadAll($root);
	}

	public function testLoadAllSortsModulesByDependencies(): void {
		$root = $this->createModulesRoot();
		$this->createModule($root, 'order-base');
		$this->createModule($root, 'order-feature', ['dependencies' => ['order-base']]);

		$loader = new ModuleLoader();
		$loader->loadAll($root);

		$this->assertSame(['order-base', 'order-feature'], array_keys($loader->getModules()));
	}

	public function testLoadAllSkipsForeignEnvironmentModules(): void {
		$root = $this->createModulesRoot();
		$this->createModule($root, 'env-main-only', ['environment' => 'main']);
		$this->createModule($root, 'env-lb-only', ['environment' => 'lb']);

		$loader = new ModuleLoader();
		$loader->loadAll($root);

		$this->assertTrue($loader->isLoaded('env-main-only'));
		$this->assertFalse($loader->isLoaded('env-lb-only'));
	}

	private function createModulesRoot(): string {
		$path = sys_get_temp_dir() . '/xc_vm_modules_test_' . bin2hex(random_bytes(6));
		mkdir($path, 0775, true);
		return $path;
	}

	private function createModule(string $root, string $name, array $manifestOverrides = []): void {
		$modulePath = $root . '/' . $name;
		mkdir($modulePath, 0775, true);

		$pascal    = implode('', array_map('ucfirst', explode('-', $name)));
		$className = $pascal . 'Module';
		$namespace = 'XcVm\\Module\\' . $pascal;

		$manifest = array_merge([
			'name' => $name,
			'description' => 'test module',
			'version' => '1.0.0',
			'requires_core' => '>=2.0',
			'environment' => 'main',
			'dependencies' => [],
			'has_navbar' => false,
			'has_settings' => false,
		], $manifestOverrides);

		file_put_contents($modulePath . '/module.json', json_encode($manifest, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

		$php = '<?php' . "\n"
			. 'namespace ' . $namespace . ';' . "\n"
			. 'use XcVm\Core\Module\ModuleInterface;' . "\n"
			. 'use XcVm\Core\Container\ServiceContainer;' . "\n"
			. 'use Router;' . "\n"
			. 'use XcVm\Cli\CommandRegistry;' . "\n"
			. 'use XcVm\Core\Module\NavbarRegistry;' . "\n"
			. 'class ' . $className . ' implements ModuleInterface {' . "\n"
			. "\tpublic function getName(): string { return '{$name}'; }" . "\n"
			. "\tpublic function getVersion(): string { return '1.0.0'; }" . "\n"
			. "\tpublic function boot(ServiceContainer \$container): void {}" . "\n"
			. "\tpublic function registerRoutes(\\XcVm\\Core\\Http\\Router \$router): void {}" . "\n"
			. "\tpublic function registerCommands(CommandRegistry \$registry): void {}" . "\n"
			. "\tpublic function getEventSubscribers(): array { return []; }" . "\n"
			. "\tpublic function install(): void {}" . "\n"
			. "\tpublic function uninstall(): void {}" . "\n"
			. "\tpublic function registerNavbar(NavbarRegistry \$registry): void {}" . "\n"
			. '}' . "\n";

		file_put_contents($modulePath . '/' . $className . '.php', $php);
	}
}