Merge branch 'main' into add-installation

Author: thijskh

.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

README.md

@@ -2,7 +2,7 @@
 
 [![Code_Checks](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml/badge.svg)](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml)
 
-A Symfony 5/6/7 bundle that adds a /health and /info endpoint to your application.
+A Symfony 5/6/7 bundle that adds an /internal/health and /internal/info endpoint to your application.
 
 The endpoints return JSON responses. The `/internal/info` endpoint tries to give as much information about the currently installed 
 version of the application as possible. This information is based on the build path of the installation. But also
@@ -55,11 +55,11 @@ When a health check failed the HTTP Response status code will be 503. And the JS
     security:
         firewalls:
             monitor:
-                pattern: ^/(info|health)$
+                pattern: ^/internal/(info|health)$
                 security: false
 
     ```
- * The /info and /health endpoints should now be available for everybody. Applying custom access restriction is up to
+ * The /internal/info and /internal/health endpoints should now be available for everybody. Applying custom access restriction is up to
     the implementer of this bundle. 
     
 ## Adding Health Checks

composer.json

@@ -15,7 +15,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",
@@ -38,11 +38,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"
     ]

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>

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

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

src/DependencyInjection/Compiler/HealthCheckPass.php

@@ -30,15 +30,15 @@ class HealthCheckPass implements CompilerPassInterface
     /**
      * @SuppressWarnings(PHPMD.UnusedLocalVariable) $tags is never used in the foreach
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has('openconext.monitor.health_check_chain')) {
             return;
         }
 
         $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) {

src/DependencyInjection/OpenConextMonitorExtension.php

@@ -34,7 +34,7 @@ class OpenConextMonitorExtension extends Extension
     /**
      * @throws \Exception
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');

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 }

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);
+    }
+}