Assertions

While Expectations work great for cases where you don’t care about the order of requests to your client, you may find times where you want to verify either the order of requests in your client’s history, or you may want to make assertions about the entirety of its history. Guzzler provides several convenience assertions for exactly this scenario.

Assertions are also intended to be made after the call to your code under test while Expectations are laid out before.

Available Methods

assertNoHistory($message = null)

To assert that your code did not make any requests at all, you can use the assertNoHistory() method, and pass an optional message argument.

public function testSomething()
{
    // ...

    $this->guzzler->assertNoHistory();
}

assertHistoryCount(int $count, $message = null)

This method can assert that the client received exactly the specified number of requests, regardless of what the requests were.

public function testSomething()
{
    // ...

    $this->guzzler->assertHistoryCount(4);
}

assertFirst(Closure $expect, $message = null)

Assertions can be made specifically against the first item in the client history. The first argument should be a closure that receives an Expectation and an optional error message can be passed as the second argument.

$this->guzzler->assertFirst(function (Expectation $e) {
    return $e->post("/a-url")
        ->withProtocol(1.1)
        ->withHeader("XSRF", "some-string");
});

assertNotFirst(Closure $expect, $message = null)

Assert that the first request in history does not meet the expectation defined. The first argument should be a closure that receives an Expectation and an optional error message can be passed as the second argument.

$this->guzzler->assertNotFirst(function ($expect) {
    return $expect->options('/some-url');
});

assertLast(Closure $expect, $message = null)

Assertions can be made specifically against the last item in the client history. The first argument should be a closure that receives an Expectation and an optional error message can be passed as the second argument.

$this->guzzler->assertLast(function ($expect) {
    return $expect->get("/some-getter");
});

assertNotLast(Closure $expect, $message = null)

Assert that the last request in history does not meet the expectation passed. The first argument should be a closure that receives an Expectation and an optional error message can be passed as the second argument.

$this->guzzler->assertNotLast(function ($expect) {
    return $expect->post('/some-url');
});

assertIndexes(array $indexes, Closure $expect, $message = null)

Assertions can be made against any specific index or set of indexes in the client history. The first argument should be an array of integers that correspond to the indexes of history items. The second argument should be a closure that receives an Expectation and an optional error message can be passed as the third argument.

$this->guzzler->assertIndexes([2, 3, 6], function ($expect) {
    return $expect->withBody("some body string");
});

assertNotIndexes(array $indexes, Closure $expect, $message = null)

Assertions can be made in the negative against any specific index or set of indexes in the client history. The first argument should be an array of integers that correspond to the indexes of history items. The second argument should be a closure that receives an Expectation and an optional error message can be passed as the third argument.

$this->guzzler->assertNotIndexes([2, 3, 6], function ($expect) {
    return $expect->delete('/some-url')
        ->withJson(['id-to-delete' => 42]);
});

assertAll(Closure $expect, $message = null)

This method can be used to assert that every request in the client’s history meets the expectation. For example, you may want to ensure that every request uses a certain authentication header or API token. The first argument should be a closure that receives an Expectation and an optional error message as the second argument.

$this->guzzler->assertAll(function ($expect) use ($token) {
    return $expect->withHeader("Authorization", $token);

    // Or maybe

    return $expect->withQuery(['api-key' => $token]);
});

assertNone(Closure $expect, $message = null)

This method can be used to assert that no request, given that any have been made, meet the expectation.

$this->guzzler->assertNone(function ($expect) {
    return $expect->delete("/some-dangerous-thing-to-delete");
});

You may notice that assertNone() has the same effect as expects($this->never()). The only real difference is preference.

Last Updated: 5/29/2019, 4:10:16 AM