Add Cache Status

docs/available-checks/cache.md

@@ -0,0 +1,28 @@
+---
+title: Application Cache
+weight: 2
+---
+
+This check makes sure the application can connect to your cache system and read/write to the cache keys. By default, this check will make sure the `default` connection is working.
+
+## Usage
+
+Here's how you can register the check.
+
+```php
+use Spatie\Health\Facades\Health;
+use Spatie\Health\Checks\Checks\CacheCheck;
+
+Health::checks([
+    CacheCheck::new(),
+]);
+```
+
+
+### Specifying the cache driver
+
+To check another cache driver, call `driver()`.
+
+```php
+CacheCheck::new()->driver('another-cache-driver'),
+```

docs/available-checks/cpu-load.md

@@ -1,6 +1,6 @@
 ---
 title: CPU load
-weight: 2
+weight: 3
 ---
 
 This check makes sure that your CPU load isn't too high.
@@ -39,4 +39,3 @@ Health::checks([
         ->failWhenLoadIsHigherInTheLast15Minutes(1.5);
 ]);
 ```
-

docs/available-checks/db-connection.md

@@ -1,6 +1,6 @@
 ---
 title: DB connection
-weight: 2
+weight: 4
 ---
 
 This check makes sure your application can connect to a database. If the `default` database connection does not work, this check will fail.
@@ -26,4 +26,3 @@ To check another database connection, call `connectionName()`
 ```php
 DatabaseCheck::new()->connectionName('another-connection-name'),
 ```
-

docs/available-checks/debug-mode.md

@@ -1,6 +1,6 @@
 ---
 title: Debug mode
-weight: 3
+weight: 5
 ---
 
 This check will make sure that debug mode is set to `false`. It will fail when debug mode is `true`.

docs/available-checks/environment.md

@@ -1,6 +1,6 @@
 ---
 title: Environment
-weight: 4
+weight: 6
 ---
 
 This check will make sure your application is running used the right environment. By default, this check will fail when the environment is not equal to `production`.

docs/available-checks/flare-error-count.md

@@ -1,6 +1,6 @@
 ---
 title: Flare error count
-weight: 5
+weight: 7
 ---
 
 This check will monitor the amount of errors and exceptions your application throws. For this check you'll need to have an account on [Flare](https://flareapp.io).

docs/available-checks/horizon.md

@@ -1,6 +1,6 @@
 ---
 title: Horizon
-weight: 6
+weight: 8
 ---
 
 This check will make sure Horizon is running.  It will report a warning when Horizon is paused, and a failure when Horizon is not running.
@@ -17,4 +17,3 @@ Health::checks([
     HorizonCheck::new(),
 ]);
 ```
-

docs/available-checks/ping.md

@@ -1,6 +1,6 @@
 ---
 title: Ping
-weight: 7
+weight: 9
 ---
 
 This check will send a request to a given URL.  It will report a failure when that URL doesn't respond with a successfull response code within a second.

docs/available-checks/redis.md

@@ -1,6 +1,6 @@
 ---
 title: Redis
-weight: 8
+weight: 10
 ---
 
 This check will make sure Redis is running. By default, this check will make sure the `default` connection is working.

docs/available-checks/schedule.md

@@ -1,6 +1,6 @@
 ---
 title: Schedule
-weight: 9
+weight: 11
 ---
 
 This check will make sure the schedule is running. If the check detects that the schedule is not run every minute, it will fail.

docs/available-checks/used-disk-space.md

@@ -1,6 +1,6 @@
 ---
 title: Used disk space
-weight: 10
+weight: 12
 ---
 
 This check will monitor the percentage of available disk space.

src/Checks/Checks/CacheCheck.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Spatie\Health\Checks\Checks;
+
+use Exception;
+use function app;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Str;
+use Spatie\Health\Checks\Check;
+use Spatie\Health\Checks\Result;
+use Throwable;
+
+class CacheCheck extends Check
+{
+    protected ?string $driver = null;
+
+    public function driver(string $driver): self
+    {
+        $this->driver = $driver;
+
+        return $this;
+    }
+
+    public function run(): Result
+    {
+        $driver = $this->driver ?? $this->defaultDriver();
+
+        $result = Result::make()->meta([
+            'driver' => $driver,
+        ]);
+
+        try {
+            $response = $this->pingCache($driver);
+
+            return $response
+                ? $result->ok()
+                : $result->failed("Could not set or retrieve an application cache value.");
+        } catch (Exception $exception) {
+            return $result->failed("An exception occurred with the application cache: `{$exception->getMessage()}`");
+        }
+    }
+
+    protected function defaultDriver(): string
+    {
+        return config('cache.default', 'file');
+    }
+
+    protected function pingCache(string $driver): bool
+    {
+        $payload = Str::random(5);
+
+        Cache::driver($driver)->put('laravel-health:check', $payload, 10);
+
+        return (Cache::driver($driver)->get('laravel-health:check') === $payload);
+    }
+}

tests/Checks/CacheCheckTest.php

@@ -0,0 +1,32 @@
+<?php
+
+use Spatie\Health\Checks\Checks\CacheCheck;
+use Spatie\Health\Enums\Status;
+use Spatie\Health\Tests\TestClasses\FakeCacheCheck;
+
+it('will determine that a working cache is ok', function () {
+    $result = CacheCheck::new()->run();
+
+    expect($result->status)->toBe(Status::ok());
+});
+
+
+it('will determine that a non-existing cache is not ok', function () {
+    $result = CacheCheck::new()
+        ->driver('does-not-exist')
+        ->run();
+
+    expect($result)
+        ->status->toBe(Status::failed())
+        ->getNotificationMessage()->toBe('An exception occurred with the application cache: `Cache store [does-not-exist] is not defined.`');
+});
+
+it('will return an error when it cannot set or retrieve cache key', function () {
+    $result = FakeCacheCheck::new()
+        ->replyWith(fn () => false)
+        ->run();
+
+    expect($result)
+        ->status->toBe(Status::failed())
+        ->notificationMessage->toBe('Could not set or retrieve an application cache value.');
+});

tests/TestClasses/FakeCacheCheck.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Spatie\Health\Tests\TestClasses;
+
+use Closure;
+use Spatie\Health\Checks\Checks\CacheCheck;
+
+class FakeCacheCheck extends CacheCheck
+{
+    protected Closure $closure;
+
+    public function replyWith(Closure $closure): self
+    {
+        $this->closure = $closure;
+
+        return $this;
+    }
+
+    public function pingCache(string $driver): bool
+    {
+        return ($this->closure)();
+    }
+}