Hello Coders!👨💻👩💻
It's been a while, so today we'll level up our skills by diving into the world of PHP unit testing, where we'll learn how to master the art of mocking using Pest.🚀🧩
If you're not familiar with it, Pest is a testing framework built on PHP with a focus on simplicity, boasting a very clean and elegant syntax. For detailed information, you can check out its official documentation here. But for now, let's focus on how we can use Pest in mocking unit tests.
Installation and Basic Test with Pest 📦💻
To start with, we need to install Pest via composer. Run the below command in your terminal:
composer require pestphp/pest --dev
After Proper installation, let's write a simple test to verify the working of Pest:
it('checks if true is truly true', function() {
assertTrue(true);
});
To run this test, execute the command.
./vendor/bin/pest
You should see a successful message if everything works fine.
Mocking with Pest 🎭💼
Mocking objects are a ubiquitous feature of PHPUnit, the backbone of Pest, and hence Pest inherits this ability. Let's illustrate mocking with a simple example.
Suppose we have a newsletter feature in our application which will interact with a third-party mailer. Instead of actually sending a mail during the test, we should ideally mock this behavior.
Here is an example of a class Newsletter that uses an external Mailer class:
class Newsletter
{
protected $mailer;
public function __construct(Mailer $mailer)
{
$this->mailer = $mailer;
}
public function send($subject, $message)
{
return $this->mailer->send($subject, $message);
}
}
While testing this class, we should mock the Mailer class to make sure our test is not dependent on its implementation. Here’s how we can do it with Pest:
test('newsletter sends a message when a message is provided', function() {
// Create a mocked instance of Mailer class
$mailer = \Mockery::mock(Mailer::class);
$mailer->expects('send')
->with('Subject', 'Message')
->andReturn(true);
$newsletter = new Newsletter($mailer);
$result = $newsletter->send('Subject', 'Message');
assertTrue($result);
});
Running this test won't actually send a mail but will check if the send method is being invoked as expected.
And that's it! You've just tested a class with a mocked dependency using Pest.😎🎉
Mocking might seem daunting at first, but with Pest, it's a breeze. The examples we've gone through are pretty simple. Mocking can get complex depend on your application logic. But I hope this gives you a good starting point.
Remember, code is like humor. When you have to explain it, it’s bad. – Your code should not just pass the tests, it should clearly show its intent. Happy Testing! 🚀✔️
For in-depth information on Mocking, you can refer to Mockery Documentation and to learn more about PHPUnit, you can check the PHPUnit official docs.
However, be aware that links might be outdated as technology evolves quickly.
Stay tuned for more such guides! Happy Coding! 🌐✨
References:
