Testing

Usage

The test directory is: tests/

The fixture directory is: tests/Fixture/

To start all tests, run:

composer test

To start all tests with code coverage, run:

composer test:coverage

The code coverage output directory is: build/coverage/

Unit Tests

Testing units in isolation of its dependencies.

Unit tests should test the behavior and not the implementation details of your classes. Make sure that unit tests are running in-memory only, because they have to be very fast.

HTTP Tests

The AppTestTrait provides methods for making HTTP requests to your Slim application and examining the output.

Creating a request

Creating a GET request:

$request = $this->createRequest('GET', '/users');

Creating a POST request:

$request = $this->createRequest('POST', '/users');

Creating a JSON application/json request with payload:

$request = $this->createJsonRequest('POST', '/users', ['name' => 'Sally']);

Creating a form application/x-www-form-urlencoded request with payload:

$request = $this->createFormRequest('POST', '/users', ['name' => 'Sally']);

Creating a query string

The withQueryParams method can generate URL-encoded query strings. Example:

$params = [
    'limit' => 10,
];

$request = $this->createRequest('GET', '/users');

// /users?limit=10
$request = $request->withQueryParams($params);

Add BasicAuth to the request

$credentials = base64_encode('username:password');
$request = $request->withHeader('Authorization', sprintf('Basic %s', $credentials));

Invoking a request

The Slim App handle() method traverses the application middleware stack + actions handler and returns the Response object.

$response = $this->app->handle($request);

Asserting the HTTP status code:

$this->assertSame(200, $response->getStatusCode());

Asserting a JSON response:

$this->assertJsonContentType($response);

Asserting JSON response data:

$expected = [
    'user_id' => 1,
    'username' => 'admin',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => 'john.doe@example.com',
];

$this->assertJsonData($expected, $response);

You can find more examples in: tests/TestCase/Action/

Read more