Vateron-Media/XC_VM
1
0
Fork 0
mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-09-26 20:01:57 +02:00
Code Issues 2 Packages Projects Releases 6 Wiki Activity

feat(modules): enhance module manifest structure and loader functionality

Browse Source 
- Added new fields to module.json: environment, dependencies, has_navbar, and has_settings.
- Updated ModuleLoader to support environment filtering and topological sorting of modules based on dependencies.
- Implemented error handling for missing and cyclic dependencies during module loading.
- Enhanced documentation for module.json structure and ModuleLoader functionality.
- Introduced unit tests for ModuleLoader to validate loading behavior and dependency resolution.
- Updated existing modules' manifest files to include new fields.

Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
Divarion-D
2026-05-06 21:53:37 +03:00
co-authored by Copilot
parent eeed5c7187
commit e629101d15
14 changed files with 689 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/Unit/ModuleLoaderTest.php
+99
View File
@@ -0,0 +1,99 @@
<?php
use PHPUnit\Framework\TestCase;
final class ModuleLoaderTest extends TestCase {
public function testLoadAllThrowsWhenDependencyMissing(): void {
$root = $this->createModulesRoot();
$this->createModule($root, 'missing-alpha', [
'dependencies' => ['missing-module'],
]);
$loader = new ModuleLoader();
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage('requires missing dependency missing-module');
$loader->loadAll($root);
}
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);
$className = $this->resolveClassName($name);
$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"
. '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(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(): void {}" . "\n"
. '}' . "\n";
file_put_contents($modulePath . '/' . $className . '.php', $php);
}
private function resolveClassName(string $name): string {
$parts = explode('-', $name);
return implode('', array_map('ucfirst', $parts)) . 'Module';
}
}