class InfoParserUnitTest

class InfoParserUnitTest extends UnitTestCase {
    
    /**
     * The InfoParser object.
     *
     * @var \Drupal\Core\Extension\InfoParser
     */
    protected $infoParser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Use a fake DRUPAL_ROOT.
        $this->infoParser = new InfoParser('vfs:/');
    }
    
    /**
     * Tests the functionality of the infoParser object.
     *
     * @covers ::parse
     */
    public function testInfoParserNonExisting() : void {
        vfsStream::setup('modules');
        $this->expectException('\\Drupal\\Core\\Extension\\InfoParserException');
        $this->expectExceptionMessage('Unable to parse vfs://modules/does_not_exist.info.txt as it does not exist');
        $this->infoParser
            ->parse(vfsStream::url('modules') . '/does_not_exist.info.txt');
    }
    
    /**
     * Tests if correct exception is thrown for a broken info file.
     *
     * @param string $yaml
     *   The YAML to use to create the file to parse.
     * @param string $expected_exception_message
     *   The expected exception message.
     *
     * @dataProvider providerInfoException
     */
    public function testInfoException($yaml, $expected_exception_message) : void {
        vfsStream::setup('modules');
        vfsStream::create([
            'fixtures' => [
                "broken.info.txt" => $yaml,
                "broken-duplicate.info.txt" => $yaml,
            ],
        ]);
        try {
            $this->infoParser
                ->parse(vfsStream::url("modules/fixtures/broken.info.txt"));
        } catch (InfoParserException $exception) {
            $this->assertSame("{$expected_exception_message} vfs://modules/fixtures/broken.info.txt", $exception->getMessage());
        }
        $this->expectException(InfoParserException::class);
        $this->expectExceptionMessage("{$expected_exception_message} vfs://modules/fixtures/broken-duplicate.info.txt");
        $this->infoParser
            ->parse(vfsStream::url("modules/fixtures/broken-duplicate.info.txt"));
    }
    
    /**
     * Data provider for testInfoException().
     */
    public static function providerInfoException() : array {
        return [
            'missing required key, type' => [
                <<<YML
name: File
description: Missing key
package: Core
version: VERSION
dependencies:
  - field
YML
,
                "Missing required keys (type) in",
            ],
            'missing core_version_requirement' => [
                <<<YML
version: VERSION
type: module
name: Skynet
dependencies:
  - self_awareness
YML
,
                "The 'core_version_requirement' key must be present in",
            ],
            'missing two required keys' => [
                <<<YML
package: Core
version: VERSION
dependencies:
  - field
YML
,
                'Missing required keys (type, name) in',
            ],
        ];
    }
    
    /**
     * Tests that the correct exception is thrown for a broken info file.
     *
     * @covers ::parse
     */
    public function testInfoParserBroken() : void {
        $broken_info = <<<BROKEN_INFO
# info.yml for testing broken YAML parsing exception handling.
name: File
type: module
description: 'Defines a file field type.'
package: Core
version: VERSION
core_version_requirement: '*'
dependencies::;;
  - field
BROKEN_INFO;
        vfsStream::setup('modules');
        vfsStream::create([
            'fixtures' => [
                'broken.info.txt' => $broken_info,
            ],
        ]);
        $filename = vfsStream::url('modules/fixtures/broken.info.txt');
        $this->expectException('\\Drupal\\Core\\Extension\\InfoParserException');
        $this->expectExceptionMessage('Unable to parse vfs://modules/fixtures/broken.info.txt');
        $this->infoParser
            ->parse($filename);
    }
    
    /**
     * Tests that Testing package modules use a default core_version_requirement.
     *
     * @covers ::parse
     */
    public function testTestingPackageMissingCoreVersionRequirement() : void {
        $missing_core_version_requirement = <<<MISSING_CORE_VERSION_REQUIREMENT
# info.yml for testing core_version_requirement.
package: Testing
version: VERSION
type: module
name: Skynet
MISSING_CORE_VERSION_REQUIREMENT;
        vfsStream::setup('modules');
        vfsStream::create([
            'fixtures' => [
                'missing_core_version_requirement.info.txt' => $missing_core_version_requirement,
            ],
        ]);
        $info_values = $this->infoParser
            ->parse(vfsStream::url('modules/fixtures/missing_core_version_requirement.info.txt'));
        $this->assertSame($info_values['core_version_requirement'], \Drupal::VERSION);
    }
    
    /**
     * Tests common info file.
     *
     * @covers ::parse
     */
    public function testInfoParserCommonInfo() : void {
        $common = <<<COMMON
core_version_requirement: '*'
name: common_test
type: module
description: 'testing info file parsing'
simple_string: 'A simple string'
version: "VERSION"
double_colon: dummyClassName::method
COMMON;
        vfsStream::setup('modules');
        foreach ([
            '1',
            '2',
        ] as $file_delta) {
            $filename = "common_test-{$file_delta}.info.txt";
            vfsStream::create([
                'fixtures' => [
                    $filename => $common,
                ],
            ]);
            $info_values = $this->infoParser
                ->parse(vfsStream::url("modules/fixtures/{$filename}"));
            $this->assertEquals('A simple string', $info_values['simple_string'], 'Simple string value was parsed correctly.');
            $this->assertEquals(\Drupal::VERSION, $info_values['version'], 'Constant value was parsed correctly.');
            $this->assertEquals('dummyClassName::method', $info_values['double_colon'], 'Value containing double-colon was parsed correctly.');
            $this->assertFalse($info_values['core_incompatible']);
        }
    }
    
    /**
     * Tests common info file.
     *
     * @covers ::parse
     */
    public function testInfoParserCoreInfo() : void {
        $common = <<<CORE
name: core_test
type: module
version: "VERSION"
description: 'testing info file parsing'
CORE;
        vfsStream::setup('core');
        $filename = "core_test.info.txt";
        vfsStream::create([
            'fixtures' => [
                $filename => $common,
            ],
        ]);
        $info_values = $this->infoParser
            ->parse(vfsStream::url("core/fixtures/{$filename}"));
        $this->assertEquals(\Drupal::VERSION, $info_values['version'], 'Constant value was parsed correctly.');
        $this->assertFalse($info_values['core_incompatible']);
        $this->assertEquals(\Drupal::VERSION, $info_values['core_version_requirement']);
    }
    
    /**
     * @covers ::parse
     *
     * @dataProvider providerCoreIncompatibility
     */
    public function testCoreIncompatibility($test_case, $constraint, $expected) : void {
        $core_incompatibility = <<<CORE_INCOMPATIBILITY
core_version_requirement: {<span class="php-variable">$constraint</span>}
name: common_test
type: module
description: 'testing info file parsing'
simple_string: 'A simple string'
version: "VERSION"
double_colon: dummyClassName::method
CORE_INCOMPATIBILITY;
        vfsStream::setup('modules');
        foreach ([
            '1',
            '2',
        ] as $file_delta) {
            $filename = "core_incompatible-{$test_case}-{$file_delta}.info.txt";
            vfsStream::create([
                'fixtures' => [
                    $filename => $core_incompatibility,
                ],
            ]);
            $info_values = $this->infoParser
                ->parse(vfsStream::url("modules/fixtures/{$filename}"));
            $this->assertSame($expected, $info_values['core_incompatible'], "core_incompatible correct in file: {$filename}");
        }
    }
    
    /**
     * Data provider for testCoreIncompatibility().
     */
    public static function providerCoreIncompatibility() {
        // Remove possible stability suffix to properly parse 11.0-dev.
        $version = preg_replace('/-dev$/', '', \Drupal::VERSION);
        [
            $major,
            $minor,
        ] = explode('.', $version, 2);
        $next_minor = $minor + 1;
        $next_major = $major + 1;
        return [
            'next_minor' => [
                'next_minor',
                "^{$major}.{$next_minor}",
                TRUE,
            ],
            'current_major_next_major' => [
                'current_major_next_major',
                "^{$major} || ^{$next_major}",
                FALSE,
            ],
            'previous_major_next_major' => [
                'previous_major_next_major',
                "^1 || ^{$next_major}",
                TRUE,
            ],
            'current_minor' => [
                'current_minor',
                "~{$major}.{$minor}",
                FALSE,
            ],
        ];
    }
    
    /**
     * Tests a profile info file.
     */
    public function testProfile() : void {
        $profile = <<<PROFILE_TEST
core_version_requirement: '*'
name: The Perfect Profile
type: profile
description: 'This profile makes Drupal perfect. You should have no complaints.'
PROFILE_TEST;
        vfsStream::setup('profiles');
        vfsStream::create([
            'fixtures' => [
                'invalid_profile.info.txt' => $profile,
            ],
        ]);
        $info = $this->infoParser
            ->parse(vfsStream::url('profiles/fixtures/invalid_profile.info.txt'));
        $this->assertFalse($info['core_incompatible']);
    }
    
    /**
     * Tests the exception for an unparsable 'core_version_requirement' value.
     *
     * @covers ::parse
     */
    public function testUnparsableCoreVersionRequirement() : void {
        $unparsable_core_version_requirement = <<<UNPARSABLE_CORE_VERSION_REQUIREMENT
# info.yml for testing invalid core_version_requirement value.
name: Not this module
description: 'Not the module you are looking for.'
package: Core
type: module
version: VERSION
core_version_requirement: not-this-version
UNPARSABLE_CORE_VERSION_REQUIREMENT;
        vfsStream::setup('modules');
        vfsStream::create([
            'fixtures' => [
                'unparsable_core_version_requirement.info.txt' => $unparsable_core_version_requirement,
            ],
        ]);
        $this->expectException(InfoParserException::class);
        $this->expectExceptionMessage("The 'core_version_requirement' constraint (not-this-version) is not a valid value in vfs://modules/fixtures/unparsable_core_version_requirement.info.txt");
        $this->infoParser
            ->parse(vfsStream::url('modules/fixtures/unparsable_core_version_requirement.info.txt'));
    }
    
    /**
     * Tests an info file with valid lifecycle values.
     *
     * @covers ::parse
     *
     * @dataProvider providerValidLifecycle
     */
    public function testValidLifecycle($lifecycle, $expected) : void {
        $info = <<<INFO
package: Core
core_version_requirement: '*'
version: VERSION
type: module
name: Module for That
INFO;
        if (!empty($lifecycle)) {
            $info .= "\nlifecycle: {$lifecycle}\n";
        }
        if (in_array($lifecycle, [
            ExtensionLifecycle::DEPRECATED,
            ExtensionLifecycle::OBSOLETE,
        ], TRUE)) {
            $info .= "\nlifecycle_link: http://example.com\n";
        }
        vfsStream::setup('modules');
        $filename = "lifecycle-{$lifecycle}.info.yml";
        vfsStream::create([
            'fixtures' => [
                $filename => $info,
            ],
        ]);
        $info_values = $this->infoParser
            ->parse(vfsStream::url("modules/fixtures/{$filename}"));
        $this->assertSame($expected, $info_values[ExtensionLifecycle::LIFECYCLE_IDENTIFIER]);
    }
    
    /**
     * Data provider for testValidLifecycle().
     */
    public static function providerValidLifecycle() {
        return [
            'empty' => [
                '',
                ExtensionLifecycle::STABLE,
            ],
            'experimental' => [
                ExtensionLifecycle::EXPERIMENTAL,
                ExtensionLifecycle::EXPERIMENTAL,
            ],
            'stable' => [
                ExtensionLifecycle::STABLE,
                ExtensionLifecycle::STABLE,
            ],
            'deprecated' => [
                ExtensionLifecycle::DEPRECATED,
                ExtensionLifecycle::DEPRECATED,
            ],
            'obsolete' => [
                ExtensionLifecycle::OBSOLETE,
                ExtensionLifecycle::OBSOLETE,
            ],
        ];
    }
    
    /**
     * Tests an info file with invalid lifecycle values.
     *
     * @covers ::parse
     *
     * @dataProvider providerInvalidLifecycle
     */
    public function testInvalidLifecycle($lifecycle, $exception_message) : void {
        $info = <<<INFO
package: Core
core_version_requirement: '*'
version: VERSION
type: module
name: Module for That
INFO;
        $info .= "\nlifecycle: {$lifecycle}\n";
        vfsStream::setup('modules');
        $filename = "lifecycle-{$lifecycle}.info.txt";
        vfsStream::create([
            'fixtures' => [
                $filename => $info,
            ],
        ]);
        $this->expectException('\\Drupal\\Core\\Extension\\InfoParserException');
        $this->expectExceptionMessage($exception_message);
        $info_values = $this->infoParser
            ->parse(vfsStream::url("modules/fixtures/{$filename}"));
        $this->assertEmpty($info_values);
    }
    
    /**
     * Data provider for testInvalidLifecycle().
     */
    public static function providerInvalidLifecycle() {
        return [
            'bogus' => [
                'bogus',
                "'lifecycle: bogus' is not valid",
            ],
            'two words' => [
                'deprecated obsolete',
                "'lifecycle: deprecated obsolete' is not valid",
            ],
            'wrong case' => [
                'Experimental',
                "'lifecycle: Experimental' is not valid",
            ],
        ];
    }
    
    /**
     * Tests an info file's lifecycle_link values.
     *
     * @covers ::parse
     *
     * @dataProvider providerLifecycleLink
     */
    public function testLifecycleLink($lifecycle, $lifecycle_link = NULL, $exception_message = NULL) : void {
        $info = <<<INFO
package: Core
core_version_requirement: '*'
version: VERSION
type: module
name: Module for That
lifecycle: {<span class="php-variable">$lifecycle</span>}
INFO;
        if ($lifecycle_link) {
            $info .= "\nlifecycle_link: {$lifecycle_link}\n";
        }
        vfsStream::setup('modules');
        // Use a random file name to bypass the static caching in
        // \Drupal\Core\Extension\InfoParser.
        $random = $this->randomMachineName();
        $filename = "lifecycle-{$random}.info.yml";
        vfsStream::create([
            'fixtures' => [
                $filename => $info,
            ],
        ]);
        $path = vfsStream::url("modules/fixtures/{$filename}");
        if ($exception_message) {
            $this->expectException(InfoParserException::class);
            $this->expectExceptionMessage(sprintf($exception_message, $path));
        }
        $info_values = $this->infoParser
            ->parse($path);
        $this->assertSame($lifecycle, $info_values[ExtensionLifecycle::LIFECYCLE_IDENTIFIER]);
    }
    
    /**
     * Data provider for testLifecycleLink().
     */
    public static function providerLifecycleLink() {
        return [
            'valid deprecated' => [
                ExtensionLifecycle::DEPRECATED,
                'http://example.com',
            ],
            'valid obsolete' => [
                ExtensionLifecycle::OBSOLETE,
                'http://example.com',
            ],
            'valid stable' => [
                ExtensionLifecycle::STABLE,
            ],
            'valid experimental' => [
                ExtensionLifecycle::EXPERIMENTAL,
            ],
            'missing deprecated' => [
                ExtensionLifecycle::DEPRECATED,
                NULL,
                "Extension Module for That (%s) has 'lifecycle: deprecated' but is missing a 'lifecycle_link' entry.",
            ],
            'missing obsolete' => [
                ExtensionLifecycle::OBSOLETE,
                NULL,
                "Extension Module for That (%s) has 'lifecycle: obsolete' but is missing a 'lifecycle_link' entry.",
            ],
            'invalid deprecated' => [
                ExtensionLifecycle::DEPRECATED,
                'look ma, not a url',
                "Extension Module for That (%s) has a 'lifecycle_link' entry that is not a valid URL.",
            ],
            'invalid obsolete' => [
                ExtensionLifecycle::OBSOLETE,
                'I think you may find that this is also not a url',
                "Extension Module for That (%s) has a 'lifecycle_link' entry that is not a valid URL.",
            ],
        ];
    }

}