The test directory is:
The fixture directory is:
To start all tests, run:
To start all tests with code coverage, run:
The code coverage output directory is:
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.
AppTestTrait provides methods for making HTTP requests to your Slim application and examining the output.
Creating a request
$request = $this->createRequest('GET', '/users');
$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:
Asserting a JSON response:
Asserting JSON response data:
$this->assertJsonData([ 'user_id' => 1, 'username' => 'admin', 'first_name' => 'John', 'last_name' => 'Doe', 'email' => 'email@example.com', ], $response);
You can find more examples in:
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
Insert multiple fixtures at once:
use App\Test\Fixture\CustomerFixture; $this->insertFixtures([CustomerFixture::class]);
Insert manual fixtures:
Assert a number of rows in a given table:
Assert the given row exists:
Assert that the given row does not exist:
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'];
Testing with Date and Time
To change the date and time for testing purposes, invoke the
Chronos::setTestNow method within a test as follows:
use Cake\Chronos\Chronos; Chronos::setTestNow('2022-02-01 00:00:00');
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.
Note: Mocking is not a good testing method, because you may not test the code you actually deploy, and furthermore, if you change the code, you will have to change the test as well. The meaningfulness and maintainability of tests with a mock is thus significantly lower compared to a test that tests the entire code.
AppTestTrait provides methods for mocking objects into the container.
For better IDE support you may better use the
$this->mockMethod([UserReaderRepository::class, 'getUserById']) ->willReturn(['example' => 'data']);
- Slim 4 - Testing with PHPUnit (eBook)