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.
Mocking
When testing Slim applications, you may wish to “mock” certain aspects of your application, so they are not actually executed during a test. For example, when testing a service that needs a repository, you may wish to mock the repository so that it’s not actually executed queries during the test.
The AppTestTrait
provides methods for mocking objects into the container.
Mocking methods:
$this->mock(UserCreator::class)->method('createUser')->willReturn(1);
For better IDE support you may better use the mockMethod
helper:
$this->mockMethod([UserReaderRepository::class, 'getUserById'])
->willReturn(['example' => 'data']);
Mocking Date and Time
use Cake\Chronos\Chronos;
Chronos::setTestNow('2021-02-01 00:00:00');
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 http_build_query can generate URL-encoded query strings. Example:
$params = [
'limit' => 10,
];
$url = sprintf('/users?%s', http_build_query($params));
// $url is now: /users?limit=10
$request = $this->createRequest('GET', $url);
Add BasicAuth to the request
$request = $this->withHttpBasicAuth($request);
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:
$this->assertJsonData([
'user_id' => 1,
'username' => 'admin',
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john.doe@example.com',
], $response);
You can find more examples in: tests/TestCase/Action/
Database Testing
The DatabaseTestTrait
provides methods for all these stages of a database test:
- Import the database schema (table structure)
- Insert the fixtures (rows) required for the test.
- Execute the test
- Verify the state of the tables
- Cleanup the tables for each new test
Test fixtures
Insert multiple fixtures at once:
use App\Test\Fixture\CustomerFixture;
$this->insertFixtures([CustomerFixture::class]);
Insert manual fixtures:
$this->insertFixture('tablename', $row);
Database asserts
Assert a number of rows in a given table:
$this->assertTableRowCount(1, 'users');
Assert the given row exists:
$this->assertTableRowExists('users', 1);
Assert that the given row does not exist:
$this->assertTableRowNotExists('users', 1);
Assert row values:
$this->assertTableRow($expected, 'users', 1);
Assert a specific set of row values:
$this->assertTableRow($expected, 'users', 1, ['email', 'url']);
$this->assertTableRow($expected, 'users', 1, array_keys($expected));
Assert a specific value in a given table, row and field:
$this->assertTableRowValue('1', 'users', 1, 'id');
Read single value from table by id:
$password = $this->getTableRowById('users', 1)['password'];
Performance Testing
Debugging Tests
To debug tests in PhpStorm, you have to mark the tests/
directory as test sources root.
- Open the project in PhpStorm
- Right click the directory
tests
- Select:
Mark directory as
- Click
Test Sources Root
- Set a breakpoint within a test method
- Right click
test
- Click
Debug (tests) PHPUnit