silverstripe-framework/tests/php/Core/Manifest/ModuleManifestTest.php

<?php

namespace SilverStripe\Core\Tests\Manifest;

use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\Core\Manifest\ModuleManifest;
use SilverStripe\Dev\SapphireTest;

class ModuleManifestTest extends SapphireTest
{
    /**
     * @var string
     */
    protected $base;

    /**
     * @var ModuleManifest
     */
    protected $manifest;

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

        $this->base = dirname(__FILE__) . '/fixtures/classmanifest';
        $this->manifest = new ModuleManifest($this->base);
        $this->manifest->init();
    }

    public function testGetModules()
    {
        $modules = $this->manifest->getModules();
        $this->assertEquals(
            [
                'module',
                'silverstripe/awesome-module',
                'silverstripe/modulec',
                'silverstripe/modulecbetter',
                'silverstripe/root-module',
            ],
            array_keys($modules ?? [])
        );
    }

    public function testGetLegacyModule()
    {
        $module = $this->manifest->getModule('module');
        $this->assertNotEmpty($module);
        $this->assertEquals('module', $module->getName());
        $this->assertEquals('module', $module->getShortName());
        $this->assertEquals('module', $module->getRelativePath());
        $this->assertEmpty($module->getComposerName());
    }

    public function testGetComposerModule()
    {
        // Get by installer-name (folder)
        $moduleByShortName = $this->manifest->getModule('moduleb');
        $this->assertNotEmpty($moduleByShortName);

        // Can also get this by full composer name
        $module = $this->manifest->getModule('silverstripe/awesome-module');
        $this->assertNotEmpty($module);
        $this->assertEquals($moduleByShortName->getPath(), $module->getPath());

        // correctly respects vendor
        $this->assertEmpty($this->manifest->getModule('wrongvendor/awesome-module'));
        $this->assertEmpty($this->manifest->getModule('wrongvendor/moduleb'));

        // Properties of module
        $this->assertEquals('silverstripe/awesome-module', $module->getName());
        $this->assertEquals('silverstripe/awesome-module', $module->getComposerName());
        $this->assertEquals('moduleb', $module->getShortName());
        $this->assertEquals('moduleb', $module->getRelativePath());
    }

    public function testGetResourcePath()
    {
        // Root module
        $moduleb = $this->manifest->getModule('moduleb');
        $this->assertTrue($moduleb->getResource('composer.json')->exists());
        $this->assertFalse($moduleb->getResource('package.json')->exists());
        $this->assertEquals(
            'moduleb/composer.json',
            $moduleb->getResource('composer.json')->getRelativePath()
        );
    }

    public function testGetResourcePathsInVendor()
    {
        // Vendor module
        $modulec = $this->manifest->getModule('silverstripe/modulec');
        $this->assertTrue($modulec->getResource('composer.json')->exists());
        $this->assertFalse($modulec->getResource('package.json')->exists());
        $this->assertEquals(
            'vendor/silverstripe/modulec/composer.json',
            $modulec->getResource('composer.json')->getRelativePath()
        );
    }

    public function testGetResourcePathOnRoot()
    {
        $module = $this->manifest->getModule('silverstripe/root-module');
        $this->assertTrue($module->getResource('composer.json')->exists());
        $this->assertEquals(
            'composer.json',
            $module->getResource('composer.json')->getRelativePath()
        );
    }

    /**
     * @return array
     */
    public function providerTestGetModuleByPath()
    {
        return [
            ['vendor/silverstripe/modulec/code/VendorClassA.php', 'silverstripe/modulec'],
            ['vendor/silverstripe/modulecbetter/code/VendorClassX.php', 'silverstripe/modulecbetter'],
        ];
    }

    /**
     * @dataProvider providerTestGetModuleByPath
     * @param string $path
     * @param string $expectedModuleName
     */
    public function testGetModuleByPath($path, $expectedModuleName)
    {
        // important - load the manifest that we are working with to the ModuleLoader
        ModuleLoader::inst()->pushManifest($this->manifest);

        // work out variables
        $path = $this->base . '/' . $path;
        $module = $this->manifest->getModuleByPath($path);
        $actualModuleName = $module->getName();

        // it is testing time!
        $this->assertEquals($expectedModuleName, $actualModuleName);

        // bye bye bogus manifest
        ModuleLoader::inst()->popManifest();
    }
}