How to test authentication via API with Laravel Passport?
Laravel Passport actually ships with some testing helpers which you can use to test your authenticated API endpoints.
Passport::actingAs(
factory(User::class)->create(),
);
This is how you can implement this, to make it actually work.
First of all, you should properly implement db:seeds and Passport installation.
Second one, you don't need, to create your own route to verify, if that works (basic Passport responses are fine enough, for that).
So here is a description, on how it worked in my installation (Laravel 5.5)...
In my case, I need only one Passport client, that's why, I created another route, for api authorization (api/v1/login
), to only supply username and password. You can read more about it here.
Fortunately this example covers basic Passport authorization test also.
So to successfully run your tests, the basic idea is:
- Create passport keys on test setup.
- Seed db with users, roles and other resources which might be needed.
- Create
.env
entry withPASSPORT_CLIENT_ID
(optional - Passport always createpassword grant token
with id = 2 on empty db). - Use this id to fetch proper client_secret from db.
- And then run your tests...
Code examples...
ApiLoginTest.php
/**
* @group apilogintests
*/
public function testApiLogin() {
$body = [
'username' => '[email protected]',
'password' => 'admin'
];
$this->json('POST','/api/v1/login',$body,['Accept' => 'application/json'])
->assertStatus(200)
->assertJsonStructure(['token_type','expires_in','access_token','refresh_token']);
}
/**
* @group apilogintests
*/
public function testOauthLogin() {
$oauth_client_id = env('PASSPORT_CLIENT_ID');
$oauth_client = OauthClients::findOrFail($oauth_client_id);
$body = [
'username' => '[email protected]',
'password' => 'admin',
'client_id' => $oauth_client_id,
'client_secret' => $oauth_client->secret,
'grant_type' => 'password',
'scope' => '*'
];
$this->json('POST','/oauth/token',$body,['Accept' => 'application/json'])
->assertStatus(200)
->assertJsonStructure(['token_type','expires_in','access_token','refresh_token']);
}
Notes:
Credentials need to be modified of course.
PASSPORT_CLIENT_ID needs to be 2, as explained before.
JsonStructure verification is redundant, since we get 200 response, only if authorization succeeds. However, if you wanted additional verification, this also passes...
TestCase.php
public function setUp() {
parent::setUp();
\Artisan::call('migrate',['-vvv' => true]);
\Artisan::call('passport:install',['-vvv' => true]);
\Artisan::call('db:seed',['-vvv' => true]);
}
Notes:
Here we are creating relevant entries to db, which are needed in our tests. So remember, to have users with roles etc. seeded here.
Final notes...
This should be enough, to get your code working. On my system, all this passes green and also works on my gitlab CI runner.
Finally, please check your middlewares on routes also. Especially, if you were experimenting with dingo (or jwt by thymon) package.
The only middleware, you may consider, applying to Passport authorization route, is throttle
to have some protection from brute force attack.
Side note...
Passport and dingo have totally different jwt implementations.
In my tests, only Passport behaves the right way and I assume, that this is the reason, why dingo is not maintained anymore.
Hope it will solve your problem...