BAP-14878: Application health check endpoint (#18297)

- added LiipMonitorBundle dependency
- added checks for main application`s third party services
- added FileDriver for maintenance mode with custom logic of ttl option
- added dev documentation
- updated composer files in application to enable healthcheck package by default

Author: vdrizheruk

Check/DoctrineDBALCheck.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use Liip\MonitorBundle\Check\DoctrineDbal;
+
+class DoctrineDBALCheck extends DoctrineDbal
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel()
+    {
+        return 'Check if Doctrine DBAL is available';
+    }
+}

Check/ElasticsearchCheck.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use Elasticsearch\Connections\Connection;
+use Oro\Bundle\ElasticSearchBundle\Client\ClientFactory;
+use Oro\Bundle\ElasticSearchBundle\Engine\ElasticSearch as ElasticsearchEngine;
+use ZendDiagnostics\Check\CheckInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\Skip;
+
+/**
+ * Class for check Elasticsearch availability
+ */
+class ElasticsearchCheck implements CheckInterface
+{
+    /** @var ClientFactory */
+    protected $clientFactory;
+
+    /** @var string */
+    protected $engineName;
+
+    /** @var array */
+    protected $engineParameters;
+    
+    /**
+     * @param ClientFactory $clientFactory
+     * @param string $engineName
+     * @param array $engineParameters
+     */
+    public function __construct(ClientFactory $clientFactory, string $engineName, array $engineParameters)
+    {
+        $this->clientFactory = $clientFactory;
+        $this->engineName = $engineName;
+        $this->engineParameters = $engineParameters;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function check(): ResultInterface
+    {
+        if ($this->isConfigured()) {
+            $client = $this->clientFactory->create($this->engineParameters['client']);
+
+            $connection = $client->transport->getConnection();
+            if (!$connection instanceof Connection) {
+                return new Skip('Elasticsearch connection does not support ping. Check Skipped.');
+            }
+
+            return $connection->ping() && $connection->isAlive() ? new Success() : new Failure();
+        }
+
+        return new Skip('Elasticsearch connection is not configured. Check Skipped.');
+    }
+    
+    /**
+     * @return bool
+     */
+    protected function isConfigured(): bool
+    {
+        return ElasticsearchEngine::ENGINE_NAME === $this->engineName;
+    }
+    
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel(): string
+    {
+        return 'Check if Elasticsearch is available in case it is configured';
+    }
+}

Check/FileStorageCheckCollection.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use ZendDiagnostics\Check\DirWritable;
+use ZendDiagnostics\Check\CheckCollectionInterface;
+
+/**
+ * Class for check write permissions on folders
+ */
+class FileStorageCheckCollection implements CheckCollectionInterface
+{
+    /** @var string */
+    protected $rootDir;
+
+    /** @var array */
+    protected $checkDirs;
+
+    /**
+     * @param string $rootDir
+     * @param array $checkDirs
+     */
+    public function __construct(string $rootDir, array $checkDirs)
+    {
+        $this->rootDir = $rootDir;
+        $this->checkDirs = $checkDirs;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getChecks(): array
+    {
+        $checks = [];
+
+        foreach ($this->checkDirs as $checkDir) {
+            $check = new DirWritable($checkDir);
+            $check->setLabel(sprintf('Check if "%s" is writable', $checkDir));
+
+            $checks[$this->getCheckShortName($checkDir)] = $check;
+        }
+
+        return $checks;
+    }
+
+    /**
+     * @param string $checkDir
+     * @return string
+     */
+    private function getCheckShortName(string $checkDir): string
+    {
+        if (strpos($checkDir, $this->rootDir) === 0) {
+            $checkDir = ltrim(str_replace($this->rootDir, '', $checkDir), '/');
+        }
+
+        $checkDir = preg_replace('/[^[:alpha:]]/', '_', $checkDir);
+
+        return preg_replace('/_{2,}/', '_', sprintf('fs_%s', $checkDir));
+    }
+}

Check/MailTransportCheck.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use ZendDiagnostics\Check\CheckInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\Failure;
+
+/**
+ * Class for check mail transport configuration
+ */
+class MailTransportCheck implements CheckInterface
+{
+    /** @var \Swift_Mailer */
+    protected $mailer;
+
+    /**
+     * @param \Swift_Mailer $mailer
+     */
+    public function __construct(\Swift_Mailer $mailer)
+    {
+        $this->mailer = $mailer;
+    }
+
+    /**
+     * @return Failure|Success
+     */
+    public function check(): ResultInterface
+    {
+        $this->mailer->getTransport()->start();
+
+        return new Success();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel(): string
+    {
+        return 'Check if Mail Transport is available';
+    }
+}

Check/MaintenanceModeCheck.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use Lexik\Bundle\MaintenanceBundle\Drivers\DriverFactory;
+use Oro\Bundle\HealthCheckBundle\Drivers\FileDriver;
+use ZendDiagnostics\Check\CheckInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\Failure;
+
+/**
+ * Class for check Maintenance Mode
+ */
+class MaintenanceModeCheck implements CheckInterface
+{
+    /** @var DriverFactory */
+    protected $driverFactory;
+
+    /**
+     * @param DriverFactory $factory
+     */
+    public function __construct(DriverFactory $factory)
+    {
+        $this->driverFactory = $factory;
+    }
+
+    /**
+     * @return Failure|Success
+     */
+    public function check(): ResultInterface
+    {
+        $driver = $this->driverFactory->getDriver();
+
+        if (!$driver->decide()) {
+            return new Success('Off');
+        }
+
+        return $driver instanceof FileDriver && $driver->isExpired() ? new Failure('Expired') : new Success('On');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel(): string
+    {
+        return 'Check if Maintenance Mode is running and not expired';
+    }
+}

Check/RabbitMQCheck.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use Oro\Component\AmqpMessageQueue\Transport\Amqp\AmqpConnection;
+use ZendDiagnostics\Check\CheckInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\Skip;
+
+/**
+ * Class for check RabbitMQ availability
+ */
+class RabbitMQCheck implements CheckInterface
+{
+    /** @var array|null */
+    protected $config;
+
+    /**
+     * @param array|null $config
+     */
+    public function __construct(array $config = null)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function check(): ResultInterface
+    {
+        if ($this->isConfigured()) {
+            $connection = AmqpConnection::createFromConfig([
+                'host' => $this->config['host'],
+                'port' => $this->config['port'],
+                'user' => $this->config['user'],
+                'password' => $this->config['password'],
+                'vhost' => $this->config['vhost'],
+            ]);
+            $connection->createSession()->createProducer();
+
+            return new Success();
+        }
+
+        return new Skip('RabbitMQ connection is not configured. Check Skipped.');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel(): string
+    {
+        return 'Check if RabbitMQ is available in case it is configured';
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isConfigured(): bool
+    {
+        return is_array($this->config) &&
+            isset(
+                $this->config['host'],
+                $this->config['port'],
+                $this->config['user'],
+                $this->config['password'],
+                $this->config['vhost']
+            );
+    }
+}

Check/RedisCheck.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Oro\Bundle\HealthCheckBundle\Check;
+
+use Predis\Client as PredisClient;
+use ZendDiagnostics\Check\CheckInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+
+/**
+ * Validate that a Redis service is running
+ */
+class RedisCheck implements CheckInterface
+{
+    /** @var PredisClient */
+    protected $client;
+
+    /** @var string */
+    protected $type;
+
+    /**
+     * @param PredisClient $client
+     * @param string $type
+     */
+    public function __construct(PredisClient $client, string $type)
+    {
+        $this->client = $client;
+        $this->type = $type;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function check(): ResultInterface
+    {
+        $this->client->ping();
+        
+        return new Success();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLabel()
+    {
+        return sprintf('Check if %s is available', $this->type);
+    }
+}