Merge 74abe33 into bec5e39

oat-sa · Mar 23, 2021 · dc60218 · dc60218
2 parents bec5e39 + 74abe33
commit dc60218
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+1.1.0
+-----
+
+* Added automatic logs on checkers execution
+* Updated documentation
+
 1.0.0
 -----
 

diff --git a/README.md b/README.md
@@ -81,6 +81,10 @@ foreach ($results as $result) {
 }
 ```
 
+**Notes**:
+- you can provide to the `HealthChecker` (as 2nd constructor parameter) a [LoggerInterface](https://www.php-fig.org/psr/psr-3/#3-psrlogloggerinterface) instance to customise its logging behaviour.
+- by default, the `NullLogger` will be used
+
 ## Tests
 
 To run tests:

diff --git a/composer.json b/composer.json
@@ -4,7 +4,8 @@
     "type": "library",
     "license": "GPL-2.0-only",
     "require": {
-        "php": ">=7.2.0"
+        "php": ">=7.2.0",
+        "psr/log": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "8.5.14",

diff --git a/src/HealthChecker.php b/src/HealthChecker.php
@@ -25,18 +25,25 @@
 use OAT\Library\HealthCheck\Checker\CheckerInterface;
 use OAT\Library\HealthCheck\Result\CheckerResult;
 use OAT\Library\HealthCheck\Result\CheckerResultCollection;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Throwable;
 
 class HealthChecker
 {
     /** @var CheckerInterface[] */
     private $checkers;
 
-    public function __construct(iterable $checkers = [])
+    /** @var LoggerInterface */
+    private $logger;
+
+    public function __construct(iterable $checkers = [], ?LoggerInterface $logger = null)
     {
         foreach ($checkers as $index => $checker) {
             $this->registerChecker($checker, is_string($index) ? $index : null);
         }
+
+        $this->logger = $logger ?? new NullLogger();
     }
 
     public function registerChecker(CheckerInterface $checker, string $identifier = null): self
@@ -53,7 +60,14 @@ public function performChecks(): CheckerResultCollection
         foreach ($this->checkers as $identifier => $checker) {
             try {
                 $result = $checker->check();
+
+                if ($result->isSuccess()) {
+                    $this->logger->info($result->getMessage());
+                } else {
+                    $this->logger->error($result->getMessage());
+                }
             } catch (Throwable $exception) {
+                $this->logger->error($exception->getMessage());
                 $result = new CheckerResult(false, $exception->getMessage());
             }
 

diff --git a/tests/Unit/HealthCheckerTest.php b/tests/Unit/HealthCheckerTest.php
@@ -27,11 +27,14 @@
 use OAT\Library\HealthCheck\HealthChecker;
 use OAT\Library\HealthCheck\Result\CheckerResult;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\Test\TestLogger;
 
 class HealthCheckerTest extends TestCase
 {
     public function testItCanBeConstructedWithPreRegisteredCheckers(): void
     {
+        $logger = new TestLogger();
+
         $subject = new HealthChecker(
             [
                 $this->buildChecker('successChecker', function () {
@@ -40,39 +43,49 @@ public function testItCanBeConstructedWithPreRegisteredCheckers(): void
                 $this->buildChecker('failureChecker', function () {
                     throw new Exception('failure message');
                 })
-            ]
+            ],
+            $logger
         );
 
         $results = $subject->performChecks();
 
         $this->assertCount(2, $results);
+        $this->assertTrue($logger->hasInfo('success message'));
+        $this->assertTrue($logger->hasError('failure message'));
     }
 
     public function testItCanBeConstructedWithTwiceTheSameCheckerUnderDifferentIdentifier(): void
     {
+        $logger = new TestLogger();
+
         $checker = $this->buildChecker('checker', function () {
-            return new CheckerResult();
+            return new CheckerResult(true, 'success message');
         });
 
         $subject = new HealthChecker(
             [
                 'checker1' => $checker,
                 'checker2' => $checker,
-            ]
+            ],
+            $logger
         );
 
         $results = $subject->performChecks();
 
         $this->assertCount(2, $results);
+
+        $this->assertTrue($logger->hasInfo('success message'));
     }
 
     public function testItCanRegisterTwiceTheSameCheckerUnderDifferentIdentifier(): void
     {
+        $logger = new TestLogger();
+
         $checker = $this->buildChecker('checker', function () {
-            return new CheckerResult();
+            return new CheckerResult(true, 'success message');
         });
 
-        $subject = new HealthChecker();
+        $subject = new HealthChecker([], $logger);
 
         $subject
             ->registerChecker($checker, 'checker1')
@@ -81,11 +94,15 @@ public function testItCanRegisterTwiceTheSameCheckerUnderDifferentIdentifier():
         $results = $subject->performChecks();
 
         $this->assertCount(2, $results);
+
+        $this->assertTrue($logger->hasInfo('success message'));
     }
 
     public function testItPerformChecksWithSingleSuccessfulChecker(): void
     {
-        $subject = new HealthChecker();
+        $logger = new TestLogger();
+
+        $subject = new HealthChecker([], $logger);
 
         $subject->registerChecker(
             $this->buildChecker('successChecker', function () {
@@ -109,11 +126,15 @@ public function testItPerformChecksWithSingleSuccessfulChecker(): void
             ],
             $results->jsonSerialize()
         );
+
+        $this->assertTrue($logger->hasInfo('success message'));
     }
 
     public function testItPerformChecksWithSingleExpectedFailingChecker(): void
     {
-        $subject = new HealthChecker();
+        $logger = new TestLogger();
+
+        $subject = new HealthChecker([], $logger);
 
         $subject->registerChecker(
             $this->buildChecker('failureChecker', function () {
@@ -137,11 +158,15 @@ public function testItPerformChecksWithSingleExpectedFailingChecker(): void
             ],
             $results->jsonSerialize()
         );
+
+        $this->assertTrue($logger->hasError('failure message'));
     }
 
     public function testItPerformChecksWithSingleUnexpectedFailingChecker(): void
     {
-        $subject = new HealthChecker();
+        $logger = new TestLogger();
+
+        $subject = new HealthChecker([], $logger);
 
         $subject->registerChecker(
             $this->buildChecker('failureChecker', function () {
@@ -165,11 +190,15 @@ public function testItPerformChecksWithSingleUnexpectedFailingChecker(): void
             ],
             $results->jsonSerialize()
         );
+
+        $this->assertTrue($logger->hasError('failure message'));
     }
 
     public function testItPerformChecksWithSeveralCheckers(): void
     {
-        $subject = new HealthChecker();
+        $logger = new TestLogger();
+
+        $subject = new HealthChecker([], $logger);
 
         $subject
             ->registerChecker(
@@ -203,6 +232,9 @@ public function testItPerformChecksWithSeveralCheckers(): void
             ],
             $results->jsonSerialize()
         );
+
+        $this->assertTrue($logger->hasInfo('success message'));
+        $this->assertTrue($logger->hasError('failure message'));
     }
 
     private function buildChecker(string $identifier, callable $checkerLogic): CheckerInterface