fix: #3565033 Deprecate using numeric literals for 'version' in .info.yml files, require strings (1c1e7f6d) · Commits · project / drupal

core/lib/Drupal/Core/Extension/InfoParserDynamic.php

+13 −2

Original line number	Diff line number	Diff line
		@@ -64,9 +64,20 @@ public function parse($filename) {
		catch (\UnexpectedValueException) {
		throw new InfoParserException("The 'core_version_requirement' constraint ({$parsed_info['core_version_requirement']}) is not a valid value in $filename");
		}
		if (isset($parsed_info['version']) && $parsed_info['version'] === 'VERSION') {
		if (isset($parsed_info['version'])) {
		if ($parsed_info['version'] === 'VERSION') {
		$parsed_info['version'] = \Drupal::VERSION;
		}
		elseif (!is_scalar($parsed_info['version'])) {
		throw new InfoParserException("The 'version' value must be a scalar in $filename");
		}
		elseif (!is_string($parsed_info['version'])) {
		// @todo Replace this with an InfoParserException in Drupal 13.
		// @see https://www.drupal.org/project/drupal/issues/3576313
		@trigger_error("Using a non-string as the 'version' value in $filename is deprecated in drupal:11.4.0 and will be a fatal error in drupal:13.0.0. Instead, wrap the version value in single quotes. See https://www.drupal.org/node/3576311", E_USER_DEPRECATED);
		$parsed_info['version'] = (string) $parsed_info['version'];
		}
		}
		$parsed_info += [ExtensionLifecycle::LIFECYCLE_IDENTIFIER => ExtensionLifecycle::STABLE];
		$lifecycle = $parsed_info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER];
		if (!ExtensionLifecycle::isValid($lifecycle)) {

core/tests/Drupal/Tests/Core/Extension/InfoParserUnitTest.php

+62 −0

Original line number	Diff line number	Diff line
		@@ -13,6 +13,7 @@
		use PHPUnit\Framework\Attributes\CoversClass;
		use PHPUnit\Framework\Attributes\DataProvider;
		use PHPUnit\Framework\Attributes\Group;
		use PHPUnit\Framework\Attributes\IgnoreDeprecations;

		/**
		* Tests InfoParser class and exception.
		@@ -119,6 +120,18 @@ public static function providerInfoException(): array {
		YML,
		'Missing required keys (type, name) in',
		],
		'version is not scalar' => [
		<<<YML
		package: Core
		type: module
		name: Broken
		core_version_requirement: '*'
		version:
		- Not
		- Scalar
		YML,
		"The 'version' value must be a scalar in",
		],
		];
		}

		@@ -176,6 +189,55 @@ public function testTestingPackageMissingCoreVersionRequirement(): void {
		$this->assertSame($info_values['core_version_requirement'], \Drupal::VERSION);
		}

		/**
		* Tests a version string that looks like a float.
		*
		* @legacy-covers ::parse
		*/
		public function testFloatLikeVersion(): void {
		$float_like_version = <<<VERSION_TEST
		core_version_requirement: '*'
		name: 'Float-like version'
		type: module
		version: '1.0'
		VERSION_TEST;

		vfsStream::setup('modules');
		vfsStream::create([
		'fixtures' => [
		'float_like_version.info.txt' => $float_like_version,
		],
		]);
		$info_values = $this->infoParser->parse(vfsStream::url('modules/fixtures/float_like_version.info.txt'));
		$this->assertSame('1.0', $info_values['version'], 'Version that looks like a float should be a string');
		}

		/**
		* Tests a version string that is a float.
		*
		* @legacy-covers ::parse
		*/
		#[IgnoreDeprecations]
		public function testFloatVersion(): void {
		$float_version = <<<VERSION_TEST
		core_version_requirement: '*'
		name: 'Float version'
		type: module
		version: 1.1
		VERSION_TEST;

		vfsStream::setup('modules');
		vfsStream::create([
		'fixtures' => [
		'float_version.info.txt' => $float_version,
		],
		]);
		$this->expectUserDeprecationMessage("Using a non-string as the 'version' value in vfs://modules/fixtures/float_version.info.txt is deprecated in drupal:11.4.0 and will be a fatal error in drupal:13.0.0. Instead, wrap the version value in single quotes. See https://www.drupal.org/node/3576311");

		$info_values = $this->infoParser->parse(vfsStream::url('modules/fixtures/float_version.info.txt'));
		$this->assertSame('1.1', $info_values['version'], 'Floating point version should be cast to a string');
		}

		/**
		* Tests common info file.
		*