Merge #16584 - Improve the version handling

Signed-off-by: William Desportes <williamdes@wdes.fr>

2 files changed, 242 insertions, 0 deletions

diff --git a/test/classes/Command/SetVersionCommandTest.php b/test/classes/Command/SetVersionCommandTest.php
new file mode 100644
index 0000000000..d536c7483a
--- /dev/null
+++ b/test/classes/Command/SetVersionCommandTest.php
@@ -0,0 +1,208 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Tests\Command;
+
+use PhpMyAdmin\Command\SetVersionCommand;
+use PhpMyAdmin\Tests\AbstractTestCase;
+use Symfony\Component\Console\Command\Command;
+use RangeException;
+use function sprintf;
+use function class_exists;
+
+class SetVersionCommandTest extends AbstractTestCase
+{
+    /** @var SetVersionCommand */
+    private $command;
+
+    public function setUp(): void
+    {
+        if (! class_exists(Command::class)) {
+            return;
+        }
+
+        $this->command = new SetVersionCommand();
+    }
+
+    /**
+     * @return array[]
+     */
+    public function dataProviderBadVersions(): array
+    {
+        return [
+            [''],
+            ['4.9.0.1'],
+            ['4.9'],
+            ['4-9-0-1'],
+            ['4-9-0'],
+            ['0-0-0'],
+            ['0.0.0'],
+            ['1.0.0'],
+            ['2.0.0'],
+            ['3.0.0'],
+            ['4.0.0'],
+            ['0.0.-1'],
+            ['5.000.0'],
+            ['5.0.000'],
+            ['5.0.0-'],
+            ['5.0.0-foo bar'],
+        ];
+    }
+
+    /**
+     * @dataProvider dataProviderBadVersions
+     */
+    public function testGetGeneratedClassInvalidVersion(string $version): void
+    {
+        if (! class_exists(Command::class)) {
+            $this->markTestSkipped('The Symfony Console is missing');
+        }
+
+        $this->expectException(RangeException::class);
+        $this->expectExceptionMessage('The version number is in the wrong format: ' . $version);
+        $this->callFunction(
+            $this->command,
+            SetVersionCommand::class,
+            'getGeneratedClass',
+            [$version]
+        );
+    }
+
+    /**
+     * @return array[]
+     */
+    public function dataProviderGoodVersions(): array
+    {
+        return [
+            [
+                '5.0.0-rc1',
+                '    public const VERSION = \'5.0.0-rc1\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'rc1\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.0.0-beta',
+                '    public const VERSION = \'5.0.0-beta\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'beta\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.0.0-beta1',
+                '    public const VERSION = \'5.0.0-beta1\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'beta1\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.0.0-alpha',
+                '    public const VERSION = \'5.0.0-alpha\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'alpha\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.0.0-alpha1',
+                '    public const VERSION = \'5.0.0-alpha1\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'alpha1\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.0.0-alpha1',
+                '    public const VERSION = \'5.0.0-alpha1\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.0\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 0;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50000;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'alpha1\';' . "\n"
+                . '    public const IS_DEV = false;',
+            ],
+            [
+                '5.1.0-dev',
+                '    public const VERSION = \'5.1.0-dev\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'5.1\';' . "\n"
+                . '    public const MAJOR = 5;' . "\n"
+                . '    public const MINOR = 1;' . "\n"
+                . '    public const PATCH = 0;' . "\n"
+                . '    public const ID = 50100;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'dev\';' . "\n"
+                . '    public const IS_DEV = true;',
+            ],
+            [
+                '9.99.99-dev',
+                '    public const VERSION = \'9.99.99-dev\' . VERSION_SUFFIX;' . "\n"
+                . '    public const SERIES = \'9.99\';' . "\n"
+                . '    public const MAJOR = 9;' . "\n"
+                . '    public const MINOR = 99;' . "\n"
+                . '    public const PATCH = 99;' . "\n"
+                . '    public const ID = 99999;' . "\n"
+                . '    public const PRE_RELEASE_NAME = \'dev\';' . "\n"
+                . '    public const IS_DEV = true;',
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider dataProviderGoodVersions
+     */
+    public function testGetGeneratedClassValidVersion(string $version, string $content): void
+    {
+        if (! class_exists(Command::class)) {
+            $this->markTestSkipped('The Symfony Console is missing');
+        }
+
+        $output = $this->callFunction(
+            $this->command,
+            SetVersionCommand::class,
+            'getGeneratedClass',
+            [$version]
+        );
+        $template = <<<'PHP'
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin;
+
+/**
+ * This class is generated by scripts/console.
+ *
+ * @see \PhpMyAdmin\Command\SetVersionCommand
+ */
+final class Version
+{
+    // The VERSION_SUFFIX constant is defined at libraries/vendor_config.php
+%s
+}
+
+PHP;
+        $this->assertSame(
+            sprintf($template, $content),
+            $output
+        );
+    }
+}
diff --git a/test/classes/VersionTest.php b/test/classes/VersionTest.php
new file mode 100644
index 0000000000..607c26541b
--- /dev/null
+++ b/test/classes/VersionTest.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Tests;
+
+use PhpMyAdmin\Version;
+use function defined;
+
+class VersionTest extends AbstractTestCase
+{
+    /**
+     * Validate the current version
+     */
+    public function testValidateVersion(): void
+    {
+        $this->assertIsString(Version::VERSION);
+        $this->assertNotEmpty(Version::VERSION);
+        $this->assertStringContainsString(Version::SERIES, Version::VERSION, 'x.y must be found in x.y.z');
+        $this->assertIsInt(Version::MAJOR);
+        $this->assertIsInt(Version::MINOR);
+        $this->assertIsInt(Version::PATCH);
+        $this->assertTrue(Version::MAJOR >= 5);// @phpstan-ignore-line Just checking
+        $this->assertTrue(Version::MINOR >= 0);// @phpstan-ignore-line Just checking
+        $this->assertTrue(Version::PATCH >= 0);// @phpstan-ignore-line Just checking
+        $this->assertTrue(Version::ID >= 50000);// @phpstan-ignore-line Just checking
+        if (defined('VERSION_SUFFIX')) {
+            $this->assertIsString(VERSION_SUFFIX);
+        }
+        $this->assertIsInt(Version::ID);
+        $this->assertIsString(Version::PRE_RELEASE_NAME);
+        $this->assertIsBool(Version::IS_DEV);
+    }
+}