Laravel passport 1つのテスト間でのユーザー切り替えに関して

Question

laravel passportを利用してapi認証を実装したwebアプリケーションを作成しております。
テストの際にユーザーをログアウトさせる方法がわからず、お力添え頂きたく思います。

public function test()
    {
        $headerArray = testLoginGetApiHeader($this,2,"testPassword");
        $response = $this->get(route('test'),$headerArray);
        $response->assertStatus(200);
        $response->assertJson([
            "status" => "success",
            "data" => [
                "user_id" => "2",
                ]
        ]);

        Auth::logout();

        $headerArray = testLoginGetApiHeader($this,3,"testPassword");
        $response = $this->get(route('test'),$headerArray);
        $response->assertStatus(200);
        $response->assertJson([
            "status" => "success",
            "data" => [
                "user_id" => "3",
            ]
        ]);
    }

function testLoginGetApiHeader(\Tests\TestCase $testCase, $userId, $password)
    {
        $login = $testCase->post('/login', [
            "email" => User::find($userId)->email,
            "password" => $password,
        ]);

        $accessToken = User::find($userId)->access_token;
        $headerArray = ["Accept" => "application/json", "Authorization" => 'Bearer ' . $accessToken];

        return $headerArray;
    }

実際のコードから不要な部分は省略していますが、以上が問題のあるコードです。

因みに上記のテストを走らせた際のエラーは以下になります。

BadMethodCallException: Method logout does not exist.

実際にアプリケーションからのユーザー切り替えは問題なく行えます。

テスト内で、ユーザーをログインさせた上でapiにアクセスせずにログアウトさせる場合は、
問題なくユーザー切り替えが行えました。

同じような実装経験のある方、どのように実装すべきかご教授頂きたいです。

Answer 1

apiの認証はリクエスト毎に、クライアントから送られてくる認証トークンによって行われるのでログアウトはそもそもありません。従ってAuth::logout()を行う必要がないどころか、試したとおりエラーになります。

apiの認証:

• \Illuminate\Auth\TokenGuardクラスが行う
• リクエストのヘッダやパラメタで毎回送られてくる認証トークンで認証する
• 1回限り

webのセッションによる認証:

• \Illuminate\Auth\SessionGuardクラスが行う
• セッションに保存された認証情報に基づいて認証を行う
• セッションに認証情報が保存されている限り何度でも有効
• ログイン時に認証情報をセッションに保存する
• ログアウト時に認証情報をセッションから削除する ← これを行うのがAuth::logout()

今回の例だと2度目のリクエストについては新たに設定した認証ヘッダに基づいて認証されるのでユーザの切り替えという観点では特に他にすることはありません。

ただPHPだとリクエスト毎にプログラムが最初から綺麗な状態で開始するのですが、今回の例のようにphpunitで2つのリクエストを続けて動作させると最初のリクエストによって変更された環境を引き継いで2つめが実行されてしまうので、適切なテストにならないことがあります。そのような場合例えばサービスコンテナをいったん破棄して作り直す$this->refreshApplication()を使うなどする必要があります。