Add environment and db driver name to version

Author: bjoern-hempel

composer.json

@@ -21,7 +21,7 @@
         "doctrine/doctrine-bundle": "^2.7",
         "doctrine/doctrine-migrations-bundle": "^3.2",
         "doctrine/orm": "^2.14",
-        "ixnode/bash-version-manager": "^0.1.7",
+        "ixnode/bash-version-manager": "^0.1.8",
         "ixnode/php-array-to-object": "^0.1.1",
         "ixnode/php-checker": "^0.1.9",
         "ixnode/php-container": "^0.1.8",

composer.lock

@@ -2,12 +2,14 @@
     "$schema": "resource.schema.json",
     "name": "ixnode/php-api-version-bundle",
     "description": "Provides the base API plattform functionality",
-    "version": "0.1.9",
-    "date": "Sunday, June 25, 2023 - 08:47:18",
-    "license": "Copyright (c) 2022 Björn Hempel",
+    "version": "0.1.17",
+    "date": "Monday, August 14, 2023 - 18:53:18",
+    "license": "Copyright (c) 2023 Björn Hempel",
     "authors": [
         "Björn Hempel <bjoern@hempel.li>"
     ],
+    "driver-name": "Sqlite - unknown version",
+    "environment": "Test",
     "php-version": "8.2.7",
     "symfony-version": "6.3.0",
     "composer-version": "2.5.1",

data/json/schema/command/version/resource.json

@@ -28,6 +28,12 @@
                 "type": "string"
             }
         },
+        "driver-name": {
+            "type": "string"
+        },
+        "environment": {
+            "type": "string"
+        },
         "php-version": {
             "type": "string",
             "pattern": "^\\d+\\.\\d+\\.\\d+$"

data/json/schema/command/version/resource.schema.json

@@ -0,0 +1,8 @@
+parameters:
+    level: 6
+    paths:
+        - bin/
+        - config/
+        - public/
+        - src/
+        - tests/

phpstan.neon

@@ -13,6 +13,7 @@
 
 namespace Ixnode\PhpApiVersionBundle\Command\Version;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Exception;
 use Ixnode\PhpApiVersionBundle\Utils\TypeCasting\TypeCastingHelper;
 use Ixnode\PhpApiVersionBundle\Utils\Version\Version;
@@ -29,6 +30,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 
 /**
  * Class VersionCommand
@@ -78,16 +80,20 @@ class VersionCommand extends Command
 
     protected const KEY_API_PLATFORM = 'api-platform-version';
 
-    protected Version $version;
+    protected const KEY_DRIVER_NAME = 'driver-name';
+
+    protected const KEY_ENVIRONMENT = 'environment';
 
     /**
      * VersionCommand constructor.
      *
      */
-    public function __construct()
+    public function __construct(
+        protected Version $version,
+        protected KernelInterface $kernel,
+        protected EntityManagerInterface $entityManager
+    )
     {
-        $this->version = new Version();
-
         parent::__construct();
     }
 
@@ -124,6 +130,8 @@ protected function getVersionArray(): array
             self::KEY_DATE => $this->version->getDate(),
             self::KEY_LICENSE => $this->version->getLicense(),
             self::KEY_AUTHORS => $this->version->getAuthors(),
+            self::KEY_DRIVER_NAME => $this->version->getDriverName($this->entityManager),
+            self::KEY_ENVIRONMENT => $this->version->getEnvironment($this->kernel),
             self::KEY_PHP => $this->version->getVersionPhp(),
             self::KEY_SYMFONY => $this->version->getVersionSymfony(),
             self::KEY_COMPOSER => $this->version->getVersionComposer(),

src/Command/Version/VersionCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the ixnode/php-api-version-bundle project.
+ *
+ * (c) Björn Hempel <https://www.hempel.li/>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Ixnode\PhpApiVersionBundle\Constants\Code;
+
+/**
+ * Class Environments
+ *
+ * @author Björn Hempel <bjoern@hempel.li>
+ * @version 0.1.0 (2023-08-14)
+ * @since 0.1.0 (2023-08-14) First version.
+ */
+class Environments
+{
+    final public const DEVELOPMENT = 'dev';
+
+    final public const DEVELOPMENT_NAME = 'Development environment';
+
+    final public const STAGING = 'staging';
+
+    final public const STAGING_NAME = 'Staging environment';
+
+    final public const PRODUCTION = 'prod';
+
+    final public const PRODUCTION_NAME = 'Production environment';
+
+    final public const TEST = 'test';
+
+    final public const TEST_NAME = 'Test';
+}

src/Constants/Code/Environments.php

@@ -13,8 +13,12 @@
 
 namespace Ixnode\PhpApiVersionBundle\Utils\Version;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Ixnode\BashVersionManager\Version as BashVersionManager;
+use Ixnode\PhpApiVersionBundle\Constants\Code\Environments;
+use Ixnode\PhpException\Case\CaseUnsupportedException;
 use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\HttpKernel\KernelInterface;
 
 /**
  * Class Version
@@ -34,4 +38,49 @@ public function getVersionSymfony(): string
     {
         return Kernel::VERSION;
     }
+
+    /**
+     * Returns the db driver name and version.
+     *
+     * @throws CaseUnsupportedException
+     */
+    public function getDriverName(EntityManagerInterface $entityManager): string
+    {
+        $connection = $entityManager->getConnection();
+
+        $driver = $connection->getDriver()->getDatabasePlatform();
+
+        $platformClassName = $driver::class;
+
+        return match (true) {
+            str_contains($platformClassName, 'MariaDBPlatform') => 'MariaDB - unknown version', /* @link MariaDBPlatform */
+            str_contains($platformClassName, 'MariaDb1027Platform') => 'MariaDB - 10.x', /* @link MariaDb1027Platform */
+            str_contains($platformClassName, 'MySQL57Platform') => 'MySQL - 5.7', /* @link MySQL57Platform */
+            str_contains($platformClassName, 'MySQL80Platform') => 'MySQL - 8.0', /* @link MySQL80Platform */
+            str_contains($platformClassName, 'MySQLPlatform') => 'MySQL - unknown version', /* @link MySQLPlatform */
+            str_contains($platformClassName, 'PostgreSQL100Platform') => 'PostgreSQL 10.0', /* @link PostgreSQL100Platform */
+            str_contains($platformClassName, 'PostgreSQL94Platform') => 'PostgreSQL 9.4', /* @link PostgreSQL94Platform */
+            str_contains($platformClassName, 'PostgreSQLPlatform') => 'PostgreSQL - unknown version', /* @link PostgreSQLPlatform */
+            str_contains($platformClassName, 'SqlitePlatform') => 'Sqlite - unknown version', /* @link SqlitePlatform */
+            default => throw new CaseUnsupportedException(sprintf('Unsupported database platform "%s".', $platformClassName)),
+        };
+    }
+
+    /**
+     * Returns the environment name of this application.
+     *
+     * @param KernelInterface $kernel
+     * @return string
+     * @throws CaseUnsupportedException
+     */
+    public function getEnvironment(KernelInterface $kernel): string
+    {
+        return match($kernel->getEnvironment()) {
+            Environments::DEVELOPMENT => Environments::DEVELOPMENT_NAME,
+            Environments::STAGING => Environments::STAGING_NAME,
+            Environments::PRODUCTION => Environments::PRODUCTION_NAME,
+            Environments::TEST => Environments::TEST_NAME,
+            default => throw new CaseUnsupportedException(sprintf('Unsupported environment "%s".', $kernel->getEnvironment())),
+        };
+    }
 }

src/Utils/Version/Version.php

@@ -84,6 +84,18 @@
             "config/packages/nelmio_cors.yaml"
         ]
     },
+    "phpstan/phpstan": {
+        "version": "1.10",
+        "recipe": {
+            "repo": "github.com/symfony/recipes-contrib",
+            "branch": "main",
+            "version": "1.0",
+            "ref": "d74d4d719d5f53856c9c13544aa22d44144b1819"
+        },
+        "files": [
+            "phpstan.neon"
+        ]
+    },
     "phpunit/phpunit": {
         "version": "9.5",
         "recipe": {

symfony.lock

@@ -16,7 +16,7 @@
 use Ixnode\PhpApiVersionBundle\Command\Version\VersionCommand;
 use Ixnode\PhpApiVersionBundle\Constants\Command\CommandSchema;
 use Ixnode\PhpApiVersionBundle\Tests\Functional\Command\Base\BaseFunctionalCommandTest;
-use Ixnode\BashVersionManager\Version;
+use Ixnode\PhpApiVersionBundle\Utils\Version\Version;
 use Ixnode\PhpContainer\File;
 use Ixnode\PhpContainer\Json;
 use Ixnode\PhpException\File\FileNotFoundException;
@@ -42,11 +42,17 @@ class VersionCommandTest extends BaseFunctionalCommandTest
     public function doConfig(): void
     {
         $this
+            ->setConfigUseDb()
             ->setConfigUseParameterBag()
+            ->setConfigUseKernel()
             ->setConfigUseCommand(
                 VersionCommand::COMMAND_NAME,
                 VersionCommand::class,
-                fn () => [new Version($this->getProjectDir())]
+                fn () => [
+                    new Version($this->getProjectDir()),
+                    self::$kernel,
+                    $this->entity->getEntityManager()
+                ]
             );
     }