workDir = sys_get_temp_dir() . '/xc_vm_mgr_' . bin2hex(random_bytes(6)); $this->modulesPath = $this->workDir . '/modules'; $this->overridesPath = $this->workDir . '/modules.php'; mkdir($this->modulesPath, 0775, true); MigrationCallTracker::reset(); } protected function tearDown(): void { $this->deleteDir($this->workDir); MigrationCallTracker::reset(); } // ── installModule() records installed_version ───────────────────────── public function testInstallRecordsInstalledVersion(): void { $this->createModule('install-record', '1.0.0'); $manager = $this->manager(); $manager->installModule('install-record'); $overrides = $this->readOverrides(); $this->assertSame('1.0.0', $overrides['install-record']['installed_version'] ?? null); } public function testInstallsModuleLivingInHashSuffixedDirectory(): void { // Reproduces the upload flow: the module was placed in `{name}_{hash5}`, // never a bare `{name}` dir. installModule() must resolve the real directory // to load the class — otherwise the module unpacks but fails to install. $name = 'hashinstall'; $pascal = $this->pascal($name); $dir = $this->modulesPath . '/' . $name . '_ab123'; mkdir($dir, 0775, true); file_put_contents($dir . '/module.json', json_encode([ 'name' => $name, 'hash_id' => 'ab123def4567890ab123def4567890cc', 'version' => '2.1.0', 'requires_core' => '>=2.0', 'environment' => 'main', 'dependencies' => [], ], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)); file_put_contents($dir . '/' . $pascal . "Module.php", "manager()->installModule($name); // Version comes from the manifest in the hashed dir (proves readModuleManifest // resolved it too), and state is recorded under the canonical name. $this->assertSame('2.1.0', $this->readOverrides()[$name]['installed_version'] ?? null); } // ── uninstallModule() clears installed_version ──────────────────────── public function testUninstallClearsInstalledVersion(): void { $this->createModule('uninstall-clear', '1.0.0'); $this->writeOverrides(['uninstall-clear' => ['installed_version' => '1.0.0']]); $manager = $this->manager(); $manager->uninstallModule('uninstall-clear'); $overrides = $this->readOverrides(); $this->assertArrayNotHasKey('installed_version', $overrides['uninstall-clear'] ?? []); } // ── deleteModule() — removes directory + override ──────────────────── public function testDeleteRemovesModuleDirectoryAndOverride(): void { $this->createModule('delete-me', '1.0.0'); $this->writeOverrides(['delete-me' => ['installed_version' => '1.0.0']]); $dir = $this->modulesPath . '/delete-me'; $this->assertDirectoryExists($dir); $this->manager()->deleteModule('delete-me'); $this->assertDirectoryDoesNotExist($dir); $this->assertArrayNotHasKey('delete-me', $this->readOverrides()); } public function testDeleteBlockedByInstalledDependent(): void { $this->createModuleWithDeps('del-base', '1.0.0', []); $this->createModuleWithDeps('del-consumer', '1.0.0', ['del-base']); $this->writeOverrides([ 'del-base' => ['installed_version' => '1.0.0'], 'del-consumer' => ['installed_version' => '1.0.0'], ]); $this->expectException(\RuntimeException::class); $this->manager()->deleteModule('del-base'); } // ── updateModule() — fallback to installModule() ────────────────────── public function testUpdateWithNoInstalledVersionFallsBackToInstall(): void { $this->createModule('update-fallback', '2.0.0'); $manager = $this->manager(); $manager->updateModule('update-fallback'); $overrides = $this->readOverrides(); $this->assertSame('2.0.0', $overrides['update-fallback']['installed_version'] ?? null); } // ── updateModule() — already up-to-date ────────────────────────────── public function testUpdateWithSameVersionSkipsMigrations(): void { $this->createMigratableModule('update-same', '1.0.0', ['1.0.0']); $this->writeOverrides(['update-same' => ['installed_version' => '1.0.0']]); $manager = $this->manager(); $manager->updateModule('update-same'); // Migration for 1.0.0 must NOT run — fromVersion == toVersion $this->assertSame([], MigrationCallTracker::$calls); } // ── updateModule() — runs pending migrations in semver order ───────── public function testUpdateRunsPendingMigrationsInOrder(): void { $this->createMigratableModule('update-order', '1.3.0', ['0.9.0', '1.1.0', '1.3.0', '1.2.0']); $this->writeOverrides(['update-order' => ['installed_version' => '1.0.0']]); $manager = $this->manager(); $manager->updateModule('update-order'); // 0.9.0 <= 1.0.0 → excluded. 1.1.0, 1.2.0, 1.3.0 → ascending semver order. $this->assertSame(['1.1.0', '1.2.0', '1.3.0'], MigrationCallTracker::$calls); } public function testUpdateExcludesMigrationsAboveToVersion(): void { $this->createMigratableModule('update-cap', '1.1.0', ['1.1.0', '1.2.0', '2.0.0']); $this->writeOverrides(['update-cap' => ['installed_version' => '1.0.0']]); $manager = $this->manager(); $manager->updateModule('update-cap'); // Module version is 1.1.0 → migrations > 1.1.0 must be excluded $this->assertSame(['1.1.0'], MigrationCallTracker::$calls); } // ── updateModule() — records new version after migrations ───────────── public function testUpdateRecordsNewVersionAfterMigrations(): void { $this->createMigratableModule('update-record', '2.5.0', ['2.0.0', '2.5.0']); $this->writeOverrides(['update-record' => ['installed_version' => '1.9.0']]); $manager = $this->manager(); $manager->updateModule('update-record'); $overrides = $this->readOverrides(); $this->assertSame('2.5.0', $overrides['update-record']['installed_version'] ?? null); } public function testUpdateWithNoMigrationsStillRecordsNewVersion(): void { $this->createMigratableModule('update-nomir', '3.0.0', []); $this->writeOverrides(['update-nomir' => ['installed_version' => '2.0.0']]); $manager = $this->manager(); $manager->updateModule('update-nomir'); $overrides = $this->readOverrides(); $this->assertSame('3.0.0', $overrides['update-nomir']['installed_version'] ?? null); } // ── findModuleByHashId() — stable identity lookup (P5 foundation) ───── public function testFindModuleByHashId(): void { $dir = $this->modulesPath . '/id-mod'; mkdir($dir, 0775, true); file_put_contents($dir . '/module.json', json_encode([ 'name' => 'id-mod', 'hash_id' => 'abc123def4567890abc123def4567890', 'version' => '1.0.0', 'environment' => 'main', 'dependencies' => [], 'optional_dependencies' => [], ])); $manager = $this->manager(); $this->assertSame('id-mod', $manager->findModuleByHashId('abc123def4567890abc123def4567890')); $this->assertNull($manager->findModuleByHashId('does-not-exist')); $this->assertNull($manager->findModuleByHashId('')); } // ── migrateLegacyModuleDirs() — bare {name} → {name}_{hash5} ────────── public function testMigrateLegacyDirGeneratesHashAndRenames(): void { // Legacy bare directory with NO hash_id in the manifest. $dir = $this->modulesPath . '/legacy-mod'; mkdir($dir, 0775, true); file_put_contents($dir . '/module.json', json_encode([ 'name' => 'legacy-mod', 'version' => '1.0.0', 'environment' => 'main', 'dependencies' => [], ])); $migrated = $this->manager()->migrateLegacyModuleDirs(); $this->assertSame(['legacy-mod'], $migrated); $this->assertDirectoryDoesNotExist($dir, 'bare directory must be gone'); $hashed = glob($this->modulesPath . '/legacy-mod_*'); $this->assertCount(1, $hashed, 'exactly one {name}_{hash5} directory must exist'); $meta = json_decode((string) file_get_contents($hashed[0] . '/module.json'), true); $hash = (string) ($meta['hash_id'] ?? ''); $this->assertMatchesRegularExpression('/^[a-f0-9]{32}$/', $hash, 'a 32-hex hash_id must be written'); $this->assertSame('legacy-mod_' . substr($hash, 0, 5), basename($hashed[0]), 'suffix = first 5 of hash_id'); } public function testMigrateLegacyDirDropsStaleBareDuplicate(): void { // Both a hashed copy (canonical, active) and a bare dup exist for the same // module — the bare one must be removed, the hashed one kept untouched. $hash = 'aa11bb22cc33dd44ee55ff6600778899'; $hash5 = substr($hash, 0, 5); $bare = $this->modulesPath . '/dup-mod'; mkdir($bare, 0775, true); file_put_contents($bare . '/module.json', json_encode([ 'name' => 'dup-mod', 'hash_id' => $hash, 'version' => '1.0.0', 'environment' => 'main', 'dependencies' => [], ])); $hashed = $this->modulesPath . '/dup-mod_' . $hash5; mkdir($hashed, 0775, true); file_put_contents($hashed . '/module.json', json_encode([ 'name' => 'dup-mod', 'hash_id' => $hash, 'version' => '1.0.0', 'environment' => 'main', 'dependencies' => [], ])); $migrated = $this->manager()->migrateLegacyModuleDirs(); $this->assertSame(['dup-mod'], $migrated); $this->assertDirectoryDoesNotExist($bare, 'stale bare duplicate must be removed'); $this->assertDirectoryExists($hashed, 'canonical hashed directory must be kept'); } public function testMigrateLegacyDirLeavesHashedDirsUntouched(): void { // An already-canonical {name}_{hash5} directory must not be migrated again. $hash = 'abc123def4567890abc123def4567890'; $dir = $this->modulesPath . '/already_' . substr($hash, 0, 5); mkdir($dir, 0775, true); file_put_contents($dir . '/module.json', json_encode([ 'name' => 'already', 'hash_id' => $hash, 'version' => '1.0.0', 'environment' => 'main', 'dependencies' => [], ])); $this->assertSame([], $this->manager()->migrateLegacyModuleDirs()); $this->assertDirectoryExists($dir); } // ── updateModuleFromSource() — bundled path (no network) ────────────── public function testUpdateFromSourceBundledRunsMigrationsAndRecordsVersion(): void { // No `update` block → source is `bundled`: files ship with the panel, so // updateModuleFromSource() just runs the incremental migrations (no fetch). $this->createMigratableModule('bundled-upd', '1.2.0', ['1.1.0', '1.2.0']); $this->writeOverrides(['bundled-upd' => ['installed_version' => '1.0.0']]); $this->manager()->updateModuleFromSource('bundled-upd'); $this->assertSame(['1.1.0', '1.2.0'], MigrationCallTracker::$calls); $this->assertSame('1.2.0', $this->readOverrides()['bundled-upd']['installed_version'] ?? null); } // ── Helpers ─────────────────────────────────────────────────────────── // ── listModules() dependency diagnostics ────────────────────────────── public function testListModulesFlagsDisabledRequiredDependency(): void { // dep-consumer requires dep-base, which is present but disabled. $this->createModuleWithDeps('dep-base', '1.0.0', []); $this->createModuleWithDeps('dep-consumer', '1.0.0', ['dep-base']); $this->writeOverrides(['dep-base' => ['state' => 'disabled']]); $byName = $this->modulesByName(); $this->assertSame([], $byName['dep-base']['dependency_warnings']); $this->assertCount(1, $byName['dep-consumer']['dependency_warnings']); $this->assertStringContainsString('dep-base', $byName['dep-consumer']['dependency_warnings'][0]); $this->assertStringContainsString('not enabled', $byName['dep-consumer']['dependency_warnings'][0]); } public function testListModulesFlagsMissingRequiredDependency(): void { $this->createModuleWithDeps('needs-absent', '1.0.0', ['ghost-module']); $byName = $this->modulesByName(); $this->assertCount(1, $byName['needs-absent']['dependency_warnings']); $this->assertStringContainsString('missing', $byName['needs-absent']['dependency_warnings'][0]); } public function testListModulesNoWarningWhenDependencyEnabled(): void { $this->createModuleWithDeps('ok-base', '1.0.0', []); $this->createModuleWithDeps('ok-consumer', '1.0.0', ['ok-base']); $byName = $this->modulesByName(); $this->assertSame([], $byName['ok-consumer']['dependency_warnings']); } private function manager(): ModuleManager { return new ModuleManager($this->modulesPath, $this->overridesPath, ServiceContainer::getInstance()); } /** @return array listModules() keyed by module name. */ private function modulesByName(): array { $byName = []; foreach ($this->manager()->listModules() as $module) { $byName[$module['name']] = $module; } return $byName; } /** Create a plain module whose manifest declares the given required dependencies. */ private function createModuleWithDeps(string $name, string $version, array $dependencies): void { $dir = $this->modulesPath . '/' . $name; $pascal = $this->pascal($name); $className = $pascal . 'Module'; $namespace = 'XcVm\\Module\\' . $pascal; mkdir($dir, 0775, true); $manifest = $this->manifest($name, $version); $manifest['dependencies'] = $dependencies; file_put_contents( $dir . '/module.json', json_encode($manifest, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) ); file_put_contents($dir . '/' . $className . '.php', "modulesPath . '/' . $name; $pascal = $this->pascal($name); $className = $pascal . 'Module'; $namespace = 'XcVm\\Module\\' . $pascal; mkdir($dir, 0775, true); file_put_contents( $dir . '/module.json', json_encode($this->manifest($name, $version), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) ); file_put_contents($dir . '/' . $className . '.php', "modulesPath . '/' . $name; $pascal = $this->pascal($name); $className = $pascal . 'Module'; $namespace = 'XcVm\\Module\\' . $pascal; mkdir($dir, 0775, true); file_put_contents( $dir . '/module.json', json_encode($this->manifest($name, $version), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) ); $migLines = ''; foreach ($migrationVersions as $ver) { $migLines .= "\t\t\t'{$ver}' => function(\$c) { \\MigrationCallTracker::record('{$ver}'); },\n"; } file_put_contents($dir . '/' . $className . '.php', " $name, 'description' => 'migration test module', 'version' => $version, 'requires_core' => '>=2.0', 'environment' => 'main', 'dependencies' => [], 'optional_dependencies' => [], 'has_navbar' => false, 'has_settings' => false, 'priority' => 0, ]; } private function writeOverrides(array $overrides): void { $content = "overridesPath, $content); } private function readOverrides(): array { if (!file_exists($this->overridesPath)) { return []; } $data = require $this->overridesPath; return is_array($data) ? $data : []; } private function pascal(string $name): string { return implode('', array_map('ucfirst', explode('-', $name))); } private function deleteDir(string $path): void { if (!file_exists($path)) { return; } if (is_file($path) || is_link($path)) { @unlink($path); return; } foreach (scandir($path) ?: [] as $item) { if ($item === '.' || $item === '..') { continue; } $this->deleteDir($path . '/' . $item); } @rmdir($path); } }