Skip to content

Latest commit

 

History

History
1016 lines (729 loc) · 26.2 KB

expectations.md

File metadata and controls

1016 lines (729 loc) · 26.2 KB
Raw
title description
Expectations
By setting expectations for your tests using the Pest expectation API, you can easily identify bugs and other issues in your code. This is because the API allows you to specify the expected outcome of a test, making it easy to detect any deviations from the expected behavior.

Expectations

By setting expectations for your tests using the Pest expectation API, you can easily identify bugs and other issues in your code. This is because the API allows you to specify the expected outcome of a test, making it easy to detect any deviations from the expected behavior.

You can start the expectation by passing your value to the expect($value) function. The expect() function is used every time you want to test a value. You will rarely call expect() by itself. Instead, you will use expect() along with an "expectation" method to assert something about the value.

test('sum', function () {
    $value = sum(1, 2);

    expect($value)->toBe(3); // Assert that the value is 3...
});

As demonstrated, the expect function in Pest allows you to chain multiple expectations together for a given $value. This means that you can perform as many checks as necessary in a single test by simply continuing to chain additional expectations.

expect($value)
    ->toBeInt()
    ->toBe(3);

At any time, you may test the opposite of an expectation by prepending the not modifier to the expectation.

expect($value)
    ->toBeInt()
    ->toBe(3)
    ->not->toBeString() // Not to be string...
    ->not->toBe(4); // Not to be 4...

With the Pest expectation API, you have access to an extensive collection of individual expectations that are designed to test various aspects of your code. Below is a comprehensive list of the available expectations.

In addition to the individual expectations available in Pest, the expectation API also provides several modifiers that allow you to further customize your tests. These modifiers can be used to create more complex expectations and to test multiple values at once. Here are some examples of the modifiers available in Pest:

toBe()

This expectation ensures that both $value and $expected share the same type and value.

If used with objects, it ensures that both variables refer to the exact same object.

expect(1)->toBe(1);
expect('1')->not->toBe(1);
expect(new StdClass())->not->toBe(new StdClass());

toBeBetween()

This expectation ensures that $value is between 2 values. It works with int, float and DateTime.

expect(2)->toBeBetween(1, 3);
expect(1.5)->toBeBetween(1, 2);

$expectationDate = new DateTime('2023-09-22');
$oldestDate = new DateTime('2023-09-21');
$latestDate = new DateTime('2023-09-23');

expect($expectationDate)->toBeBetween($oldestDate, $latestDate);

toBeEmpty()

This expectation ensures that $value is empty.

expect('')->toBeEmpty();
expect([])->toBeEmpty();
expect(null)->toBeEmpty();

toBeTrue()

This expectation ensures that $value is true.

expect($isPublished)->toBeTrue();

toBeTruthy()

This expectation ensures that $value is truthy.

expect(1)->toBeTruthy();
expect('1')->toBeTruthy();

toBeFalse()

This expectation ensures that $value is false.

expect($isPublished)->toBeFalse();

toBeFalsy()

This expectation ensures that $value is falsy.

expect(0)->toBeFalsy();
expect('')->toBeFalsy();

toBeGreaterThan($expected)

This expectation ensures that $value is greater than $expected.

expect($count)->toBeGreaterThan(20);

toBeGreaterThanOrEqual($expected)

This expectation ensures that $value is greater than or equal to $expected.

expect($count)->toBeGreaterThanOrEqual(21);

toBeLessThan($expected)

This expectation ensures that $value is lesser than $expected.

expect($count)->toBeLessThan(3);

toBeLessThanOrEqual($expected)

This expectation ensures that $value is lesser than or equal to $expected.

expect($count)->toBeLessThanOrEqual(2);

toContain($needles)

This expectation ensures that all the given needles are elements of the $value.

expect('Hello World')->toContain('Hello');
expect('Pest: an elegant PHP Testing Framework')->toContain('Pest', 'PHP', 'Framework');
expect([1, 2, 3, 4])->toContain(2, 4);

toContainEqual($needles)

This expectation ensures that all the given needles are elements (in terms of equality) of the $value.

expect([1, 2, 3])->toContainEqual('1');
expect([1, 2, 3])->toContainEqual('1', '2');

toContainOnlyInstancesOf($class)

This expectation ensures that $value contains only instances of $class.

$dates = [new DateTime(), new DateTime()];

expect($dates)->toContainOnlyInstancesOf(DateTime::class);

toHaveCount(int $count)

This expectation ensures that the $count provided matches the number of elements in an iterable $value.

expect(['Nuno', 'Luke', 'Alex', 'Dan'])->toHaveCount(4);

toHaveProperty(string $name, $value = null)

This expectation ensures that $value has a property named $name.

In addition, you can verify the actual value of a property by providing a second argument.

expect($user)->toHaveProperty('name');
expect($user)->toHaveProperty('name', 'Nuno');
expect($user)->toHaveProperty('is_active', 'true');

toHaveProperties(iterable $name)

This expectation ensures that $value has property names matching all the names contained in $names.

expect($user)->toHaveProperties(['name', 'email']);

In addition, you can verify the name and value of multiple properties using an associative array.

expect($user)->toHaveProperties([
    'name' => 'Nuno', 
    'email' => '[email protected]'
]);

toMatchArray($array)

This expectation ensures that the $value array matches the given $array subset.

$user = [
    'id'    => 1,
    'name'  => 'Nuno',
    'email' => '[email protected]',
    'is_active' => true,
];

expect($user)->toMatchArray([
    'email' => '[email protected]',
    'name' => 'Nuno'
]);

toMatchObject($object)

This expectation ensures that the $value object matches a subset of the properties of a given $object.

$user = new stdClass();
$user->id = 1;
$user->email = '[email protected]';
$user->name = 'Nuno';

expect($user)->toMatchObject([
    'email' => '[email protected]',
    'name' => 'Nuno'
]);

toEqual($expected)

This expectation ensures that $value and $expected have the same value.

expect($title)->toEqual('Hello World');
expect('1')->toEqual(1);
expect(new StdClass())->toEqual(new StdClass());

toEqualCanonicalizing($expected)

This expectation ensures that $value and $expected have the same values, no matter what order the elements are given in.

$usersAsc = ['Dan', 'Fabio', 'Nuno'];
$usersDesc = ['Nuno', 'Fabio', 'Dan'];

expect($usersAsc)->toEqualCanonicalizing($usersDesc);
expect($usersAsc)->not->toEqual($usersDesc);

toEqualWithDelta($expected, float $delta)

This expectation ensures that the absolute difference between $value and $expected is lower than $delta.

expect($durationInMinutes)->toEqualWithDelta(10, 5); //duration of 10 minutes with 5 minutes tolerance

expect(14)->toEqualWithDelta(10, 5);    // Pass
expect(14)->toEqualWithDelta(10, 0.1); // Fail

toBeIn()

This expectation ensures that $value is one of the given values.

expect($newUser->status)->toBeIn(['pending', 'new', 'active']);

toBeInfinite()

This expectation ensures that $value is infinite.

expect(log(0))->toBeInfinite();

toBeInstanceOf($class)

This expectation ensures that $value is an instance of $class.

expect($user)->toBeInstanceOf(User::class);

toBeArray()

This expectation ensures that $value is an array.

expect(['Pest','PHP','Laravel'])->toBeArray();

toBeBool()

This expectation ensures that $value is of type bool.

expect($isActive)->toBeBool();

toBeCallable()

This expectation ensures that $value is of type callable.

$myFunction = function () {};

expect($myFunction)->toBeCallable();

toBeFile()

This expectation ensures that the string $value is an existing file.

expect('/tmp/some-file.tmp')->toBeFile();

toBeFloat()

This expectation ensures that $value is of type float.

expect($height)->toBeFloat();

toBeInt()

This expectation ensures that $value is of type integer.

expect($count)->toBeInt();

toBeIterable()

This expectation ensures that $value is of type iterable.

expect($array)->toBeIterable();

toBeNumeric()

This expectation ensures that $value is of type numeric.

expect($age)->toBeNumeric();
expect(10)->toBeNumeric();
expect('10')->toBeNumeric();

toBeDigits()

This expectation ensures that $value contains only digits.

expect($year)->toBeDigits();
expect(15)->toBeDigits();
expect('15')->toBeDigits();

toBeObject()

This expectation ensures that $value is of type object.

$object = new stdClass();

expect($object)->toBeObject();

toBeResource()

This expectation ensures that $value is of type resource.

$handle = fopen('php://memory', 'r+');

expect($handle)->toBeResource();

toBeScalar()

This expectation ensures that $value is of type scalar.

expect('1')->toBeScalar();
expect(1)->toBeScalar();
expect(1.0)->toBeScalar();
expect(true)->toBeScalar();
expect([1, '1'])->not->toBeScalar();

toBeString()

This expectation ensures that $value is of type string.

expect($string)->toBeString();

toBeJson()

This expectation ensures that $value is a JSON string.

expect('{"hello":"world"}')->toBeJson();

toBeNan()

This expectation ensures that $value is not a number (NaN).

expect(sqrt(-1))->toBeNan();

toBeNull()

This expectation ensures that $value is null.

expect(null)->toBeNull();

toHaveKey(string $key)

This expectation ensures that $value contains the provided $key.

expect(['name' => 'Nuno', 'surname' => 'Maduro'])->toHaveKey('name');
expect(['name' => 'Nuno', 'surname' => 'Maduro'])->toHaveKey('name', 'Nuno');
expect(['user' => ['name' => 'Nuno', 'surname' => 'Maduro']])->toHaveKey('user.name');
expect(['user' => ['name' => 'Nuno', 'surname' => 'Maduro']])->toHaveKey('user.name', 'Nuno');

toHaveKeys(array $keys)

This expectation ensures that $value contains the provided $keys.

expect(['id' => 1, 'name' => 'Nuno'])->toHaveKeys(['id', 'name']);
expect(['message' => ['from' => 'Nuno', 'to' => 'Luke'] ])->toHaveKeys(['message.from', 'message.to']);

toHaveLength(int $number)

This expectation ensures that the provided $number matches the length of a string $value or the number of elements in an iterable $value.

expect('Pest')->toHaveLength(4);
expect(['Nuno', 'Maduro'])->toHaveLength(2);

toBeDirectory()

This expectation ensures that the string $value is a directory.

expect('/tmp')->toBeDirectory();

toBeReadableDirectory()

This expectation ensures that the string $value is a directory and that it is readable.

expect('/tmp')->toBeReadableDirectory();

toBeReadableFile()

This expectation ensures that the string $value is a file and that it is readable.

expect('/tmp/some-file.tmp')->toBeReadableFile();

toBeWritableDirectory()

This expectation ensures that the string $value is a directory and that it is writable.

expect('/tmp')->toBeWritableDirectory();

toBeWritableFile()

This expectation ensures that the string $value is a file and that it is writable.

expect('/tmp/some-file.tmp')->toBeWritableFile();

toStartWith(string $expected)

This expectation ensures that $value starts with the provided string.

expect('Hello World')->toStartWith('Hello');

toThrow()

This expectation ensures that a closure throws a specific exception class, exception message, or both.

expect(fn() => throw new Exception('Something happened.'))->toThrow(Exception::class);
expect(fn() => throw new Exception('Something happened.'))->toThrow('Something happened.');
expect(fn() => throw new Exception('Something happened.'))->toThrow(Exception::class, 'Something happened.');
expect(fn() => throw new Exception('Something happened.'))->toThrow(new Exception('Something happened.'));

toMatch(string $expression)

This expectation ensures that $value matches a regular expression.

expect('Hello World')->toMatch('/^hello wo.*$/i');

toEndWith(string $expected)

This expectation ensures that $value ends with the provided string.

expect('Hello World')->toEndWith('World');

toMatchConstraint(Constraint $constraint)

This expectation ensures that $value matches a specified PHPUnit constraint.

use PHPUnit\Framework\Constraint\IsTrue;

expect(true)->toMatchConstraint(new IsTrue());

toBeUppercase(string $expected)

This expectation ensures that $value is uppercase.

expect('PESTPHP')->toBeUppercase();

toBeLowercase(string $expected)

This expectation ensures that $value is lowercase.

expect('pestphp')->toBeLowercase();

toBeAlpha(string $expected)

This expectation ensures that $value only contains alpha characters.

expect('pestphp')->toBeAlpha();

toBeAlphaNumeric(string $expected)

This expectation ensures that $value only contains alphanumeric characters.

expect('pestPHP123')->toBeAlphaNumeric();

toBeSnakeCase()

This expectation ensures that $value only contains string in snake_case format.

expect('snake_case')->toBeSnakeCase();

toBeKebabCase()

This expectation ensures that $value only contains string in kebab-case format.

expect('kebab-case')->toBeKebabCase();

toBeCamelCase()

This expectation ensures that $value only contains string in camelCase format.

expect('camelCase')->toBeCamelCase();

toBeStudlyCase()

This expectation ensures that $value only contains string in StudlyCase format.

expect('StudlyCase')->toBeStudlyCase();

toHaveSnakeCaseKeys()

This expectation ensures that $value only contains an array with keys in snake_case format.

expect(['snake_case' => 'abc123'])->toHaveSnakeCaseKeys();

toHaveKebabCaseKeys()

This expectation ensures that $value only contains an array with keys in kebab-case format.

expect(['kebab-case' => 'abc123'])->toHaveKebabCaseKeys();

toHaveCamelCaseKeys()

This expectation ensures that $value only contains an array with keys in camelCase format.

expect(['camelCase' => 'abc123'])->toHaveCamelCaseKeys();

toHaveStudlyCaseKeys()

This expectation ensures that $value only contains an array with keys in StudlyCase format.

expect(['StudlyCase' => 'abc123'])->toHaveStudlyCaseKeys();

toHaveSameSize()

This expectation ensures that the size of $value and the provided iterable are the same.

expect(['foo', 'bar'])->toHaveSameSize(['baz', 'bazz']);

toBeUrl()

This expectation ensures that $value is a URL.

expect('https://pestphp.com/')->toBeUrl();

toBeUuid()

This expectation ensures that $value is an UUID.

expect('ca0a8228-cdf6-41db-b34b-c2f31485796c')->toBeUuid();

and($value)

The and() modifier allows you to pass a new $value, enabling you to chain multiple expectations in a single test.

expect($id)->toBe(14)
    ->and($name)->toBe('Nuno');

dd()

The dd() modifier

Use the dd() modifier allows you to dump the current expectation $value and stop the code execution. This can be useful for debugging by allowing you to inspect the current state of the $value at a particular point in your test.

expect(14)->dd(); // 14
expect([1, 2])->sequence(
    fn ($number) => $number->toBe(1),
    fn ($number) => $number->dd(), // 2
);

ddWhen($condition)

Use the ddWhen() modifier allows you to dump the current expectation $value and stop the code execution when the given $condition is truthy.

expect([1, 2])->each(
    fn ($number) => $number->ddWhen(fn (int $number) => $number === 2) // 2
);

ddUnless($condition)

Use the ddUnless() modifier allows you to dump the current expectation $value and stop the code execution when the given $condition is falsy.

expect([1, 2])->each(
    fn ($number) => $number->ddUnless(fn (int $number) => $number === 1) // 2
);

each()

The each() modifier allows you to create an expectation on each item of the given iterable. It works by iterating over the iterable and applying the expectation to each item.

expect([1, 2, 3])->each->toBeInt();
expect([1, 2, 3])->each->not->toBeString();
expect([1, 2, 3])->each(fn ($number) => $number->toBeLessThan(4));

json()

The json() modifier decodes the current expectation $value from JSON to an array.

expect('{"name":"Nuno","credit":1000.00}')
    ->json()
    ->toHaveCount(2)
    ->name->toBe('Nuno')
    ->credit->toBeFloat();

expect('not-a-json')->json(); //Fails

match()

The match() modifier executes the closure associated with the first array key that matches the value of the first argument given to the method.

expect($user->miles)
    ->match($user->status, [
        'new'  => fn ($userMiles) => $userMiles->ToBe(0),
        'gold'  => fn ($userMiles) => $userMiles->toBeGreaterThan(500),
        'platinum' => fn ($userMiles) => $userMiles->toBeGreaterThan(1000),
    ]);

To check if the expected value is equal to the value associated with the matching key, you can directly pass the expected value as the array value instead of using a closure.

expect($user->default_language)
    ->match($user->country, [
        'PT' => 'Português',
        'US' => 'English',
        'TR' => 'Türkçe',
    ]);

not

The not modifier allows to invert the subsequent expectation.

expect(10)->not->toBeGreaterThan(100);
expect(true)->not->toBeFalse();

ray()

The ray() modifier allows you to debug the current $value with myray.app.

expect(14)->ray(); // 14
expect([1, 2])->sequence(
    fn ($number) => $number->toBe(1),
    fn ($number) => $number->ray(), // 2
);

sequence()

The sequence() modifier allows you to specify a sequential set of expectations for a single iterable.

expect([1, 2, 3])->sequence(
    fn ($number) => $number->toBe(1),
    fn ($number) => $number->toBe(2),
    fn ($number) => $number->toBe(3),
);

The sequence() modifier can also be used with associative iterables. Each closure in the sequence will receive two arguments: the first argument being the expectation for the value and the second argument being the expectation for the key.

expect(['hello' => 'world', 'foo' => 'bar', 'john' => 'doe'])->sequence(
    fn ($value, $key) => $value->toEqual('world'),
    fn ($value, $key) => $key->toEqual('foo'),
    fn ($value, $key) => $value->toBeString(),
);

The sequence() modifier can also be used to check if each value in the iterable matches a set of expected values. In this case, you can pass the expected values directly to the sequence() method instead of using closures.

expect(['foo', 'bar', 'baz'])->sequence('foo', 'bar', 'baz');

when()

The when() modifier runs the provided callback when the first argument passed to the method evaluates to true.

expect($user)
    ->when($user->is_verified === true, fn ($user) => $user->daily_limit->toBeGreaterThan(10))
    ->email->not->toBeEmpty();

unless()

The unless() modifier runs the provided callback when the first argument passed to the method evaluates to false.

expect($user)
    ->unless($user->is_verified === true, fn ($user) => $user->daily_limit->toBe(10))
    ->email->not->toBeEmpty();

After learning how to write expectations, the next section in the documentation, "Hooks" covers useful functions like "beforeEach" and "afterEach" that can be used to set up preconditions and cleanup actions for your tests: Hooks →