Adds the ability to fake registered checks.

[lukeraymonddowning]

Hey all!

Motivation

If you're a bit of a testing nut, like myself, you want to ensure that your health checks are registered correctly and throw the correct error status when in use. Up to now, this was not possible, because checks cannot be faked and will actually run as they would in production.

Implementation

To support this feature, I went down a similar route to Event::fake in Laravel. That is to say, we swap out the underlying Health instance with a FakeHealth instance that is able to take fake responses and use them for given health checks.

Here is a basic example:

it('has an error if the database is not available', function () {
  Health::fake([
    DatabaseCheck::class => new Result(Status::failed())
  ]);

  $this->get('/health')->assertStatus(503);
});

Advanced usage

There are occasions where it is necessary to have more control over the check. For example, imagine we want to override the shouldRun functionality, which by default defers to the original check. To satisfy this requirement, you may use the FakeCheck::result method.

it('has an error if the database is not available', function () {
  Health::fake([
    PingCheck::class => FakeCheck::result(new Result(Status::ok()), true)
  ]);

  $this->get('/health')->assertOk();
});

In the above example, we might imagine that in the testing environment, the check would not run because ::shouldRun returns false. We can force it to run by passing true as the second parameter to FakeCheck::result.

Let's imagine another example, where we use multiple DatabaseCheck instances to check multiple connections. What if each connection should return a different result in the test? No problem, we can pass a Closure to Health::fake:

Health::fake([
    DatabaseCheck::class => fn (DatabaseCheck $check) => $check->getName() === 'MySQL'
          ? new Result(Status::crashed())
          : new Result(Status::warning());
]);

I hope you find this as valuable as I will. Thanks for all the hard work you continue to do for the Laravel community!

Kind Regards,
Luke

[freekmurze]

Thanks for this quality PR @lukeraymonddowning 👍

Could you take a look at the failing tests?

Could you also add some documentation on how to use the fake?

[lukeraymonddowning]

@freekmurze documentation added and tests fixed (I think at least, the workflow hasn't run again yet).

[freekmurze]

Quality PR, thanks Luke!