Pest PHP Integration

Introduction

LaraDumps provides a Pest Helper to integrate its debugging tool into your testing experience.

Enable LaraDumps in Test

To use LaraDumps while testing, you must enable the "Enabled in testing" option inside your project settings in the desktop app.

Alternatively, you may edit the option observers > enabled_in_testing in your project's laradumps.yaml file.

#laradumps.yaml

observers:
  enabled_in_testing: true

Pest PHP Expectation

To inspect the value of Pest Expectation, just chain a ds() method inside the expectation.

test('some test', function() {
    expect(Something::execute())
        ->ds() //dumps the expectation value
        ->toBe('some result');
});

Test Response

LaraDumps also allows you to inspect the test response by chaining ds() method in a Livewire test.

test('some test', function() {
    livewire(SomeComponent::class)
        ->call('doSomething', 'some-value')
        ->ds()
        ->assertSeeInOrder([
            'result 1',
            'result 2',
            'result 3',
        ]);
});

Architecture Test

Production code should not contain any debug functions.

This example uses Pest's Architecture testing to check your code for the usage of any of this debug functions.

arch('does not use debug functions')
    ->expect(['ds', 'ds1' 'ds2', 'ds3', 'ds4', 'ds5', 'dsd', 'dsq', 'dd', 'ddd', 'dump', 'ray', 'die', 'var_dump', 'sleep', 'exit'])
    ->not->toBeUsed();