jwt-auth を使った認証テスト

[Sakamoto0525]

課題

jwt-authを使う場合、公式がセッション・認証のペルパーとして提供しているactiongAsが使えない。（Laravel v6の場合 ←
公式ドキュメント

// actingAsの第二引数にはguardを指定。guardのデフォルト設定で良い時はなくても良い。
$this->actingAs($user, 'api')->get('/');

[Sakamoto0525]

jwt-auth の 公式ドキュメントを参考にする

これ

login() あたりが使えそう
説明には「ユーザーをログインさせ、そのユーザーのjwtを返す」と書かれている

// Get some user from somewhere
$user = User::first();

// Get the token
$token = auth()->login($user);

[Sakamoto0525]

LoginやRegisterの処理では、メールアドレスとパスワードを attempt() に配列として渡すことでjwt_tokenを生成しつつ、レスポンスで返している。

login() はテストでのみ。扱う方が良さげ？

[Sakamoto0525]

他に使えそうな関数をまとめる

user()

現在、認証済みのユーザーを取得する

$user = auth()->user();

userOrFail()

現在、認証済みのユーザーを取得する。認証済みユーザーが存在しない場合は例外を投げる

try {
    $user = auth()->userOrFail();
} catch (\Tymon\JWTAuth\Exceptions\UserNotDefinedException $e) {
    // do something
}

logout()

ユーザーをログアウトさせる。また、現在のトークンを無効化する。

auth()->logout();

// トークンを永久にブラックリストに登録する場合はtrueを指定する
auth()->logout(true);

refresh()

トークンをリフレッシュし、現在のトークンを無効化する

$newToken = auth()->refresh();

// トークンを永久にブラックリストに登録する場合は第一引数に true を指定する
// 新しいトークンを発行する場合は第二引数に true を指定する
$newToken = auth()->refresh(true, true);

setToken()

トークンを明示的に指定する

$user = auth()->setToken('eyJhb...')->user();

[Sakamoto0525]

基本的には継承元である tests/TestCase.php に対してログイン、ログアウト処理をラップさせ子はそれらを呼び出す形にするのがよさそう

[Sakamoto0525]

書いてみた

余計な部分は省いてます

TestCase.php

abstract class TestCase extends BaseTestCase
{
    public function login(User $user): void
    {
        if (!$token = auth('api')->login($user)) {
            throw new Exception('faild to login', 500);
        }
        $this->withHeaders(['Authorization' => 'Bearer ' . $token]);
    }
}

UsersControllerTest.php

  /** @test */
  public function ログインしていない時、４０１レスポンスが返ること(): void
  {
      $id = factory(User::class)->create()->id;

      $res = $this->json('GET', "/api/users/$id");
      $res->assertStatus(401);
  }

  /** @test */
  public function ログインしている時、２００レスポンスが返ること(): void
  {
      $user = factory(User::class)->create();
      $this->login($user);

      $res = $this->json('GET', "/api/users/$user->id");
      $res->assertStatus(200);
  }

[Sakamoto0525]

参考資料

正直v6なのであんまり役に立たなさそう

• jwt-auth 公式
• Laravel 6.x 公式 HTTPテスト
• Laravelで認証付きAPIの実装をUnitテスト
  • 参考というか１テストごとにログインAPIを叩くサンプルが書いてある。毎回APIを叩くのはどうかと思うが、一つの参考になればいいかも。