Introduce envvar support for info

MKodde · MKodde · commit e0231adc22d7 · 2024-01-25T11:06:27.000+01:00
diff --git a/.github/workflows/code_coverage.yaml b/.github/workflows/code_coverage.yaml
@@ -13,6 +13,8 @@ jobs:
           php-version: 8.2
           coverage: pcov
 
+      # Implicitly runs `composer tests` in post update cmd. So PHPCS, MD and other static analysis is executed at
+      # this point.
       - run: composer install --no-progress
 
       - run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
   },
   "require-dev": {
     "php-parallel-lint/php-parallel-lint": "^1.3",
-    "phpmd/phpmd": "^2.6",
+    "phpmd/phpmd": "^2.13",
     "matthiasnoback/symfony-config-test": "^4.3",
     "phpdocumentor/reflection-docblock": "^5.2",
     "phpunit/php-token-stream": "^3.1.3|^4.0.4",
@@ -37,11 +37,11 @@
   "scripts": {
     "tests": {
       "docheader": "vendor/bin/docheader check src/",
-      "phpcmd": "vendor/bin/phpmd src text phpmd.xml",
       "phpcs": "vendor/bin/phpcs src --report=full --standard=phpcs.xml --extensions=php --warning-severity=0",
       "phpcpd": "vendor/bin/phpcpd src --exclude=src/Tests/*",
-      "phpunit": "vendor/bin/phpunit --coverage-text"
-      },
+      "phpunit": "vendor/bin/phpunit --coverage-text",
+      "phpmd": "vendor/bin/phpmd src text phpmd.xml --exclude 'src/Tests/*'"
+    },
       "post-update-cmd": [
         "@tests"
     ]
diff --git a/phpmd.xml b/phpmd.xml
@@ -30,6 +30,8 @@
     <rule ref="rulesets/naming.xml">
         <exclude name="ShortVariable" />
         <exclude name="LongVariable" />
+        <exclude name="LongClassName" />
+        <exclude name="ShortClassName" />
     </rule>
 
 </ruleset>
diff --git a/src/Controller/HealthController.php b/src/Controller/HealthController.php
@@ -30,14 +30,9 @@
  */
 class HealthController extends AbstractController
 {
-    /**
-     * @var HealthCheckChain
-     */
-    private $healthChecker;
-
-    public function __construct(HealthCheckChain $healthChecker)
-    {
-        $this->healthChecker = $healthChecker;
+    public function __construct(
+        private readonly HealthCheckChain $healthChecker
+    ) {
     }
 
     public function __invoke(): JsonResponse
diff --git a/src/Controller/InfoController.php b/src/Controller/InfoController.php
@@ -18,6 +18,7 @@
 
 namespace OpenConext\MonitorBundle\Controller;
 
+use OpenConext\MonitorBundle\Value\BuildInformationFactory;
 use OpenConext\MonitorBundle\Value\BuildPathFactory;
 use OpenConext\MonitorBundle\Value\Information;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -41,34 +42,16 @@
  */
 class InfoController extends AbstractController
 {
-    /**
-     * @var string
-     */
-    private $buildPath;
-
-    /**
-     * @var string
-     */
-    private $environment;
-
-    /**
-     * @var bool
-     */
-    private $debuggerEnabled;
-
-    /**
-     * @var array
-     */
-    private $systemInfo = [];
+    private array $systemInfo = [];
 
     public function __construct(
-        $buildPath,
-        $environment,
-        $debuggerEnabled
+        private readonly string $buildPath,
+        private readonly string $environment,
+        private readonly bool $debuggerEnabled,
+        private readonly ?string $version,
+        private readonly ?string $revision,
+        private readonly ?string $commitDate,
     ) {
-        $this->buildPath = $buildPath;
-        $this->environment = $environment;
-        $this->debuggerEnabled = $debuggerEnabled;
 
         if (function_exists('opcache_get_status')) {
             $this->systemInfo['opcache'] = opcache_get_status(false);
@@ -77,8 +60,14 @@ public function __construct(
 
     public function __invoke(): JsonResponse
     {
+        $buildInformation = BuildInformationFactory::build(
+            $this->version,
+            $this->revision,
+            $this->commitDate,
+            $this->buildPath
+        );
         $info = Information::buildFrom(
-            BuildPathFactory::buildFrom($this->buildPath),
+            $buildInformation,
             $this->environment,
             $this->debuggerEnabled,
             $this->systemInfo
diff --git a/src/DependencyInjection/Compiler/HealthCheckPass.php b/src/DependencyInjection/Compiler/HealthCheckPass.php
@@ -38,7 +38,7 @@ public function process(ContainerBuilder $container)
 
         $definition = $container->findDefinition('openconext.monitor.health_check_chain');
 
-        // find all service IDs with the app.mail_transport tag
+        // find all service IDs with the openconext.monitor.health_check tag
         $taggedServices = $container->findTaggedServiceIds('openconext.monitor.health_check');
 
         foreach ($taggedServices as $id => $tags) {
diff --git a/src/Resources/config/services.yml b/src/Resources/config/services.yml
@@ -5,15 +5,17 @@ services:
             - '~'
             - '%kernel.environment%'
             - '%kernel.debug%'
-        public: true
+            - '%env(default::string:OPENCONEXT_APP_VERSION)%'
+            - '%env(default::string:OPENCONEXT_GIT_SHA)%'
+            - '%env(default::string:OPENCONEXT_COMMIT_DATE)%'
+
         autowire: true
         tags: ['controller.service_arguments', 'container.service_subscriber']
 
     openconext.monitor.controller.health:
         class: OpenConext\MonitorBundle\Controller\HealthController
         arguments:
             - '@openconext.monitor.health_check_chain'
-        public: true
         autowire: true
         tags: ['controller.service_arguments', 'container.service_subscriber']
 
@@ -30,4 +32,4 @@ services:
         calls:
             - [ setEntityManager, ['@?doctrine.orm.entity_manager']]
         tags:
-            - { name: openconext.monitor.health_check }
+            - { name: openconext.monitor.health_check }
diff --git a/src/Tests/Value/BuildInformationFactoryTest.php b/src/Tests/Value/BuildInformationFactoryTest.php
@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Tests\Value;
+
+use OpenConext\MonitorBundle\Value\BuildEnvVars;
+use OpenConext\MonitorBundle\Value\BuildInformationFactory;
+use OpenConext\MonitorBundle\Value\BuildPath;
+use PHPUnit\Framework\TestCase;
+
+class BuildInformationFactoryTest extends TestCase
+{
+    public function test_builds_based_on_env_vars()
+    {
+        $buildInformation = BuildInformationFactory::build(
+            '1.0.0',
+            'e97bbfc39653cb5541d453e704c64a7fab4f5b1',
+            '1900-01-01',
+            'My-Application-da39a3ee5e6b4b0d3255bfef95601890afd80709'
+        );
+        $this->assertInstanceOf(BuildEnvVars::class, $buildInformation);
+    }
+    public function test_builds_based_on_env_vars_commit_date_optional()
+    {
+        $buildInformation = BuildInformationFactory::build(
+            '1.0.0',
+            'e97bbfc39653cb5541d453e704c64a7fab4f5b1',
+            null,
+            'My-Application-da39a3ee5e6b4b0d3255bfef95601890afd80709'
+        );
+        $this->assertInstanceOf(BuildEnvVars::class, $buildInformation);
+    }
+    public function test_builds_on_path()
+    {
+        $buildInformation = BuildInformationFactory::build(
+            null,
+            null,
+            null,
+            'My-Application-da39a3ee5e6b4b0d3255bfef95601890afd80709'
+        );
+        $this->assertInstanceOf(BuildPath::class, $buildInformation);
+    }
+}
diff --git a/src/Tests/Value/EnvVarFactoryTest.php b/src/Tests/Value/EnvVarFactoryTest.php
@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Tests\Value;
+
+use OpenConext\MonitorBundle\Value\BuildEnvVars;
+use OpenConext\MonitorBundle\Value\BuildEnvVarsFactory;
+use OpenConext\MonitorBundle\Value\BuildInformation;
+use PHPUnit\Framework\TestCase;
+
+class EnvVarFactoryTest extends TestCase
+{
+    public function test_happy_flow()
+    {
+        $expectedSemverVersion = '1.1.0';
+        $expectedRevision = 'e3f5a1f0';
+        $expectedDate = '2024-01-01';
+        $envVarVO = BuildEnvVarsFactory::buildFrom($expectedSemverVersion, $expectedRevision, $expectedDate);
+        $this->assertInstanceOf(BuildInformation::class, $envVarVO);
+        $this->assertInstanceOf(BuildEnvVars::class, $envVarVO);
+        $this->assertTrue($envVarVO->hasRevision() && $envVarVO->hasVersion() && $envVarVO->hasCommitDate());
+        $this->assertEquals($expectedSemverVersion, $envVarVO->getVersion());
+        $this->assertEquals($expectedRevision, $envVarVO->getRevision());
+        $this->assertEquals($expectedDate, $envVarVO->getCommitDate());
+    }
+
+    /**
+     * @dataProvider buildValidVariants
+     */
+    public function test_happy_flow_variants(
+        string $expectedSemverVersion,
+        string $expectedRevision,
+        ?string $expectedDate = null,
+    ) {
+        $envVarVO = BuildEnvVarsFactory::buildFrom($expectedSemverVersion, $expectedRevision, $expectedDate);
+        $this->assertInstanceOf(BuildInformation::class, $envVarVO);
+        $this->assertInstanceOf(BuildEnvVars::class, $envVarVO);
+        $this->assertEquals($expectedSemverVersion, $envVarVO->getVersion());
+        $this->assertEquals($expectedRevision, $envVarVO->getRevision());
+        $this->assertEquals($expectedDate, $envVarVO->getCommitDate());
+    }
+
+    public function buildValidVariants()
+    {
+        return [
+            'all set' => ['1.1.0', 'e97bbfc3', '2000-01-01'],
+            'all set, long date' => ['1.1.0', 'e97bbfc3', '2000-01-01 00:00:00'],
+            'no date' => ['1.1.0', 'e97bbfc3'],
+            'full commit hash' => ['1.1.0', 'e97bbfc39653cb5541d453e704c64a7fab4f5b1'],
+            'non-semver hash' => ['beta-1', 'e97bbfc39653cb5541d453e704c64a7fab4f5b1'],
+        ];
+    }
+
+}
diff --git a/src/Value/BuildEnvVars.php b/src/Value/BuildEnvVars.php
@@ -0,0 +1,93 @@
+<?php
+
+/**
+ * Copyright 2024 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenConext\MonitorBundle\Value;
+
+/**
+ * Representation of the env vars that describe the build details
+ *
+ * By default, the following env vars are evaluated:
+ *
+ * OPENCONEXT_APP_VERSION | maps to $version    | required
+ * OPENCONEXT_GIT_SHA     | maps to $revision   | required
+ * OPENCONEXT_COMMIT_DATE | maps to $commitDate | optional
+ *
+ * This VO is created by its factory who actually reads the env-vars
+ */
+class BuildEnvVars implements BuildInformation
+{
+    public function __construct(
+        private readonly string $version,
+        private readonly string $revision,
+        private readonly ?string $commitDate,
+    ) {
+    }
+
+    public function getVersion(): string
+    {
+        return $this->version;
+    }
+
+    public function getRevision(): string
+    {
+        return $this->revision;
+    }
+
+    public function getCommitDate(): ?string
+    {
+        return $this->commitDate;
+    }
+
+    public function hasRevision(): bool
+    {
+        return true;
+    }
+
+    public function getPath(): string
+    {
+        return '';
+    }
+
+    public function hasVersion(): bool
+    {
+        return true;
+    }
+
+    public function hasPath(): bool
+    {
+        return false;
+    }
+
+    public function hasCommitDate(): bool
+    {
+        return !is_null($this->commitDate);
+    }
+
+    public function jsonSerialize(): mixed
+    {
+        $data = [
+            'version' => $this->version,
+            'revision' => $this->revision,
+        ];
+        if ($this->hasCommitDate()) {
+            $data['commitDate'] = $this->commitDate;
+        }
+
+        return $data;
+    }
+}
diff --git a/src/Value/BuildEnvVarsFactory.php b/src/Value/BuildEnvVarsFactory.php
diff --git a/src/Value/BuildInformation.php b/src/Value/BuildInformation.php
diff --git a/src/Value/BuildInformationFactory.php b/src/Value/BuildInformationFactory.php
diff --git a/src/Value/BuildPath.php b/src/Value/BuildPath.php
diff --git a/src/Value/Information.php b/src/Value/Information.php
