laravel PHPUnit 型エラー

Question

前提・実現したいこと

User::factory()->create()で作ったテストユーザーを使い、認証済み時のテストを行いたい。

発生している問題・エラーメッセージ

User::factory()->create();で作成した$userを使用し、actingAsでログインのユーザを指定しているが、下記の型エラーが発生している。
コードは、laravel8のドキュメントを参考に書きました。

Laravel 8.x HTTPテスト

ページ検索でactingAsで検索すると、私が見た箇所がピックアップされるはずです。

Expected type 'Illuminate\Contracts\Auth\Authenticatable'. Found 'Illuminate\Database\Eloquent\Collection|Illuminate\Database\Eloquent\Model'

該当のソースコード

<?php

namespace Tests\Feature;

use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;

class FavoriteTest extends TestCase
{
    public function test_favorite_screen_can_be_rendered()
    {
        $user = User::factory()->create();
        $response = $this->actingAs($user)->get('/');

        $response->assertSee('ユーザー');
        $response->assertSee('タイトル');
        $response->assertSee('カテゴリ');

        $response->assertStatus(200);
    }
}

Laravel8ドキュメントから引用

<?php

namespace Tests\Feature;

use App\Models\User;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_an_action_that_requires_authentication()
    {
        $user = User::factory()->create();

        $response = $this->actingAs($user)
                         ->withSession(['banned' => false])
                         ->get('/');
    }
}

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;

    protected $fillable = [
        'name',
        'email',
        'profile',
        'password',
    ];

    protected $hidden = [
        'password',
        'remember_token',
    ];

    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

###試したこと
まっさらなlaravelに、laravel/breezeを導入したデフォルトで用意されているテストコードでも同様の型エラーが起きていました。
これは、laravel側の欠陥なんでしょうか？

Answer 1

factoryでcreateおよびmakeするとIlluminate\Database\Eloquent\Collection|Illuminate\Database\Eloquent\ModelになってAuthenticableを継承できてないのが原因そう。

一度User::find()でモデルインスタンス化するとAuthenticableを継承してるのでエラーが出なくなるはずです。

User::findOrFail(User::factory()->create()->id)

でエラーメッセージは消えると思います。

とはいえ、factory使うのはLaravelのドキュメントにも書いてある方法だし、Laravel側の問題だと思います。
そもそも動くし。

大分昔の質問に回答失礼しました。

Answer 2

環境つくって実行してみた

create database laravel default character set utf8;
composer create-project laravel/laravel sample "8.*"
  - Installing laravel/framework (v8.62.0): Loading from cache
  - Installing laravel/sail (v1.10.2): Loading from cache
  - Installing laravel/sanctum (v2.11.2): Loading from cache
  - Installing laravel/serializable-closure (v1.0.2): Loading from cache
  - Installing laravel/tinker (v2.6.2): Loading from cache
  - Installing phpunit/php-code-coverage (9.2.7): Loading from cache
  - Installing phpunit/php-file-iterator (3.0.5): Loading from cache
  - Installing phpunit/php-invoker (3.1.1): Loading from cache
  - Installing phpunit/php-text-template (2.0.4): Loading from cache
  - Installing phpunit/php-timer (5.0.3): Loading from cache
  - Installing phpunit/phpunit (9.5.10): Loading from cache

php artisan key:generate
php artisan migrate:refresh

tests/ExampleTest.php

<?php
namespace Tests\Feature;

use App\Models\User;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_an_action_that_requires_authentication()
    {
        $user = User::factory()->create();
        $response = $this->actingAs($user)
                         ->withSession(['banned' => false])
                         ->get('/');
        $this->assertTrue(true);
    }
}

vi app/Models/User.php

<?php
namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var string[]
     */
    protected $fillable = [
        'name',
        'email',
        'password',
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

phpunit tests/ExampleTest.php

PHPUnit 9.5.10 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 00:00.219, Memory: 10.00 MB

普通に動いた

Comments

[Patao_program]

そのとおりです。普通に動きます。

Answer 3

class User
{
    use Authenticatable, HasApiTokens, HasFactory, Notifiable;

これではどうです？

Comments

[Patao_program]

これでも、だめでした。同じ型エラーが起きてしまいます！
特にUserモデルをいじったわけではないんですが...

Expected type 'Illuminate\Contracts\Auth\Authenticatable'. Found 'Illuminate\Database\Eloquent\Collection|Illuminate\Database\Eloquent\Model'.

>まっさらなlaravelに、laravel/breezeを導入したデフォルトで用意されているテストコードでも同様の型エラーが起きていました。

同じ環境が簡単に作れると思います。

Answer 4

Userモデルはどのように作りました？
↓こんな感じ？

use Reliese\Database\Eloquent\Model as Eloquent;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Eloquent implements Authenticable;
{
--your implementation--
}

Comments

[Patao_program]

use Illuminate\Foundation\Auth\User as Authenticatable;を継承した形になってます。UserModelのソースコードを追記しました。