writing-tests.md

title	description
Writing Tests	Writing Tests

Writing Tests

• Overview
• API Reference

Overview

Pest makes it easy to write tests. This section illustrates how to write a simple test suite with Pest, and what are the conventions you should use.

The setup is very simple, and usually looks like this:

tests
    - Unit/ComponentTest.php <--
    - Feature/HomeTest.php <--
phpunit.xml

To write a test, create a file in the Unit or Feature directory, and make sure its filename ends with the ...Test.php suffix. Then, all you need inside this file is a function that runs your test:

<?php
test('has home', function () {
    // ..
});

// or
it('has home', function () {
    // ..
});

Note: Pest will only run a test file if its name ends with the suffix set in your phpunit.xml.

API Reference

Now, on to the API reference. Pest offers you two functions to write your tests: test() & it(). Use the one that best fits your test naming convention, or both. They share the same behavior & syntax:

test()

The test function adds the given closure as test. The first argument is the test description; the second argument is a closure that contains the test expectations:

test('asserts true is true', function () {
    $this->assertTrue(true);

    expect(true)->toBeTrue();
});

Here is what this example test will return:

✓ asserts true is true

it()

The it function adds the given closure as test. The first argument is the test description; the second argument is a closure that contains the test expectations:

it('asserts true is true', function () {
    $this->assertTrue(true);

    expect(true)->toBeTrue();
});

Here is what this example test will return:

✓ it asserts true is true

Note: Notice how, when using the it function, your test name gets prepended with 'it' in the returned description.

---

Next section: Underlying Test Case →