Laravel模型Trait的单元测试最佳实践咨询

我编写了WatchCardListChange Trait，用于给使用该Trait的Laravel模型自动添加闭包模型事件，具体代码如下。尝试了两种PHPUnit测试方法（partialMock和getMockForTrait）但都没生效，想请教测试该Trait的最佳实践。

Trait代码 #

trait WatchCardListChange
{
  public static function booted()
  {
    static::watchCardListChange();
  }

  protected static function watchCardListChange()
  {
    $modelClass = get_called_class();
    $classParts = explode('\\', $modelClass);
    $className = end($classParts);
    $method = 'addEventsTo' . $className . 'Model';
    forward_static_call([$modelClass, $method]);
  }

  private static function addEventsToAcCardModel()
  {
    static::created(function ($model) {
      CardListChanged::dispatch($model);
    });
    static::updated(function ($model) {
      CardListChanged::dispatch($model);
    });
    static::deleted(function ($model) {
      CardListChanged::dispatch($model);
    });
  }
}

尝试过的测试代码 #

public function test_trait()
{
  // First approach
  $mock = $this->partialMock(AcCard::class, function (MockInterface $mock) {
    $mock->shouldAllowMockingProtectedMethods()->shouldReceive('booted')->once();
  });
  app()->instance(AcCard::class, $mock);
  $model = new AcCard();

  // Second approach
  $trait = $this->getMockForTrait(WatchCardListChange::class, [], '', true, true, true, ['watchCardListChange']);
  $trait->expects(self::exactly(1))->method('watchCardListChange');

  // Test
  $model = AcCard::factory()->create();
}

你的测试思路偏了——应该测试Trait实际触发的业务行为（也就是CardListChanged事件是否被正确分发），而不是去mock Trait内部的方法调用。Laravel的模型事件机制和Trait的执行逻辑，需要结合框架的测试工具来验证，以下是两种可靠的测试方案：

方案1：直接验证事件分发 #

利用Laravel的Event facade监听事件，验证模型创建/更新/删除时，CardListChanged是否被正确触发：

use Illuminate\Support\Facades\Event;
use App\Models\AcCard;
use App\Events\CardListChanged;

public function test_card_list_change_events_are_dispatched()
{
    // 监听目标事件
    Event::fake();

    // 测试创建事件
    $card = AcCard::factory()->create();
    Event::assertDispatched(CardListChanged::class, function ($event) use ($card) {
        return $event->model->id === $card->id;
    });

    // 测试更新事件
    $card->update(['some_column' => 'new_value']);
    Event::assertDispatched(CardListChanged::class, 2); // 累计触发2次

    // 测试删除事件
    $card->delete();
    Event::assertDispatched(CardListChanged::class, 3); // 累计触发3次
}

方案2：针对Trait逻辑的单元测试 #

如果想单独测试Trait的逻辑（比如watchCardListChange是否正确调用了对应的事件注册方法），可以创建一个测试专用模型类，避免影响实际业务模型：

use Illuminate\Database\Eloquent\Model;

// 测试用模型，仅用于Trait测试
class TestCard extends Model
{
    use WatchCardListChange;

    // 暴露私有方法，方便测试（仅测试环境使用）
    public static function callAddEventsToTestCardModel()
    {
        static::addEventsToTestCardModel();
    }

    // 对应Trait的命名规则，实现事件注册方法
    private static function addEventsToTestCardModel()
    {
        static::created(function ($model) {
            CardListChanged::dispatch($model);
        });
    }
}

然后编写测试：

use Illuminate\Support\Facades\Event;
use App\Events\CardListChanged;

public function test_trait_registers_events_correctly()
{
    Event::fake();

    // 测试Trait的booted逻辑是否触发事件注册
    TestCard::booted();

    // 创建模型，验证事件是否被分发
    $testCard = TestCard::factory()->create();
    Event::assertDispatched(CardListChanged::class, function ($event) use ($testCard) {
        return $event->model instanceof TestCard && $event->model->id === $testCard->id;
    });
}

原测试无效的原因 #

• 第一种partialMock方法：Laravel模型实例化不会直接使用容器中的实例，new AcCard()和factory()->create()都会创建新实例，你mock的对象根本没被用到。
• 第二种getMockForTrait方法：创建的是Trait的模拟对象，但它不是实际的Laravel模型，无法触发booted生命周期方法，也没有模型事件的上下文，因此测试无效。

内容的提问来源于stack exchange，提问作者simpsons3