Use Laravel's Built-in SetUp Hooks for Application Test Traits

Last updated on by

Use Laravel's Built-in SetUp Hooks for Application Test Traits image

The Laravel framework provides a bunch of helpful test traits that make our lives easier, such as migrating databases, setting up Faker, removing middleware, and more. When writing feature tests in Laravel, the base TestCase class inherits the framework's TestCase class. In this class, is the base setUp template is called in PHPUnit:

protected function setUp(): void
{
$this->setUpTheTestEnvironment();
}

The setUpTheTestEnvironment() method—found in the TestCase's InteractsWithTestCaseLifecycle trait—does a few things:

  • Clear resolved Facade instances
  • Refreshes the application
  • Boots testing helper traits
  • Sets the Model class event dispatcher instance
  • Marks that the setup has run

The part that I want to focus on is the setUpTraits() method, which recursively returns traits on the instance. This method includes some internal framework trait checks and calls methods on those traits if they're used:

if (isset($uses[RefreshDatabase::class])) {
$this->refreshDatabase();
}
 
if (isset($uses[DatabaseMigrations::class])) {
$this->runDatabaseMigrations();
}
 
// ... etc

At the end of the method, it loops through all the traits and checks for the existence of a setup/teardown method that matches the trait name:

foreach ($uses as $trait) {
if (method_exists($this, $method = 'setUp'.class_basename($trait))) {
$this->{$method}();
}
 
if (method_exists($this, $method = 'tearDown'.class_basename($trait))) {
$this->beforeApplicationDestroyed(fn () => $this->{$method}());
}
}

If you had a MyUsefulHelper trait on a test class, the method_exists check would look for these methods:

public function setUpMyUsefulHelper();
public function tearDownMyUsefulHelper();

What's neat about the trait setup methods is that you can avoid boilerplate code anywhere you want to use this trait in a test:

class MyTestCase
{
use MyUsefulHelper;
 
// This method is not needed if a `setUpMyUsefulHelper` method is defined.
- public function setUp: void
- {
- parent::setUp();
-
- $this->initMyUsefulHelper();
- }
}

If your application has useful helpers, setup code, etc., using these hooks can clean up your code, and you don't have to remember to manually initialize the trait's setup. For example, perhaps you have factory code in multiple tests that sets up users, permissions, and roles. Your setup code could be moved into a reusable trait that automatically sets everything up before each test.

Recently, I created a trait to interact with a Wiremock server that required some setup and teardown logic, such as defining custom mocked request/response pairs (and cleaning them up afterwards). I created an InteractsWithWiremock trait that automatically takes care of set up and reset automatically using Laravel's automatic setUp hook.

I love finding small nuggets like this in the Laravel framework code!

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Laravel Idea for PhpStorm logo

Laravel Idea for PhpStorm

Ultimate PhpStorm plugin for Laravel developers, delivering lightning-fast code completion, intelligent navigation, and powerful generation tools to supercharge productivity.

Laravel Idea for PhpStorm
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Enum-Powered Route Permissions in Laravel image

Enum-Powered Route Permissions in Laravel

Read article
NativePHP for iOS image

NativePHP for iOS

Read article
Using Relative Date Helpers in Laravel's Query Builder image

Using Relative Date Helpers in Laravel's Query Builder

Read article
Fine-tuning Pagination Links in Laravel image

Fine-tuning Pagination Links in Laravel

Read article
Relative Date Helpers in Laravel 11.42 image

Relative Date Helpers in Laravel 11.42

Read article
Smart Route Detection in Laravel image

Smart Route Detection in Laravel

Read article