アプリケーションイベントのユニットテスト

概要

JUnit 5 と Mockito を使用して Spring の ApplicationEvent パブリッシャーと @EventListener コンシューマーをテストするための実践的なパターンを提供します — 完全な Spring コンテキストをブートする必要はありません。

使用場面

• イベントパブリッシャーまたはリスナーのユニットテストを作成するとき
• イベントが正しいペイロードで公開されたことを検証するとき
• @EventListener メソッドの呼び出しと副作用をテストするとき
• 複数のリスナーを通じたイベント伝播をテストするとき
• 非同期イベント処理（@Async + @EventListener）を検証するとき
• サービステストで ApplicationEventPublisher をモックするとき

手順

1. テスト依存関係を追加: spring-boot-starter、JUnit 5、Mockito、AssertJ
2. ApplicationEventPublisher をモック: テスト対象のサービス内のパブリッシャーフィールドに @Mock を使用
3. ArgumentCaptor でイベントをキャプチャ: ArgumentCaptor.forClass(EventType.class) を使用して公開されたペイロードを検査
4. リスナーの副作用を検証: モックされた依存関係に対してリスナーを直接呼び出す
5. 非同期ハンドラーをテスト: Thread.sleep() または Awaitility を使用 — その後、非同期操作が呼び出されたことをアサート
6. 検証チェックポイントを追加:
   • イベントをキャプチャした後、フィールドをアサートする前に eventCaptor.getValue() が null でないことを確認
   • リスナーが呼び出されない場合、publishEvent() が正しいイベントタイプで呼び出されたことを確認
   • 非同期アサートが失敗する場合、待機時間を増やし、エグゼキュータープールが飽和していないか確認
7. エラーシナリオをカバー: リスナーが例外を適切に処理することをアサート

例

Maven

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter</artifactId>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-core</artifactId>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.assertj</groupId>
  <artifactId>assertj-core</artifactId>
  <scope>test</scope>
</dependency>

Gradle

dependencies {
  implementation("org.springframework.boot:spring-boot-starter")
  testImplementation("org.junit.jupiter:junit-jupiter")
  testImplementation("org.mockito:mockito-core")
  testImplementation("org.assertj:assertj-core")
}

カスタムイベントとパブリッシャーテスト

public class UserCreatedEvent extends ApplicationEvent {
  private final User user;

  public UserCreatedEvent(Object source, User user) {
    super(source);
    this.user = user;
  }

  public User getUser() { return user; }
}

@Service
public class UserService {
  private final ApplicationEventPublisher eventPublisher;
  private final UserRepository userRepository;

  public UserService(ApplicationEventPublisher eventPublisher, UserRepository userRepository) {
    this.eventPublisher = eventPublisher;
    this.userRepository = userRepository;
  }

  public User createUser(String name, String email) {
    User savedUser = userRepository.save(new User(name, email));
    eventPublisher.publishEvent(new UserCreatedEvent(this, savedUser));
    return savedUser;
  }
}

イベント公開のユニットテスト

@ExtendWith(MockitoExtension.class)
class UserServiceEventTest {

  @Mock
  private ApplicationEventPublisher eventPublisher;

  @Mock
  private UserRepository userRepository;

  @InjectMocks
  private UserService userService;

  @Test
  void shouldPublishUserCreatedEvent() {
    User newUser = new User(1L, "Alice", "alice@example.com");
    when(userRepository.save(any(User.class))).thenReturn(newUser);

    ArgumentCaptor<UserCreatedEvent> eventCaptor = ArgumentCaptor.forClass(UserCreatedEvent.class);

    userService.createUser("Alice", "alice@example.com");

    verify(eventPublisher).publishEvent(eventCaptor.capture());
    assertThat(eventCaptor.getValue().getUser()).isEqualTo(newUser);
  }
}

リスナー直接テスト

@Component
public class UserEventListener {
  private final EmailService emailService;

  public UserEventListener(EmailService emailService) { this.emailService = emailService; }

  @EventListener
  public void onUserCreated(UserCreatedEvent event) {
    emailService.sendWelcomeEmail(event.getUser().getEmail());
  }
}

class UserEventListenerTest {

  @Test
  void shouldSendWelcomeEmailOnUserCreated() {
    EmailService emailService = mock(EmailService.class);
    UserEventListener listener = new UserEventListener(emailService);

    User user = new User(1L, "Alice", "alice@example.com");
    listener.onUserCreated(new UserCreatedEvent(this, user));

    verify(emailService).sendWelcomeEmail("alice@example.com");
  }

  @Test
  void shouldNotThrowWhenEmailServiceFails() {
    EmailService emailService = mock(EmailService.class);
    doThrow(new RuntimeException("down")).when(emailService).sendWelcomeEmail(any());

    UserEventListener listener = new UserEventListener(emailService);
    User user = new User(1L, "Alice", "alice@example.com");

    assertThatCode(() -> listener.onUserCreated(new UserCreatedEvent(this, user)))
      .doesNotThrowAnyException();
  }
}

非同期リスナーテスト

@Component
public class AsyncEventListener {
  private final SlowService slowService;

  @EventListener
  @Async
  public void onUserCreatedAsync(UserCreatedEvent event) {
    slowService.processUser(event.getUser());
  }
}

class AsyncEventListenerTest {

  @Test
  void shouldProcessEventAsynchronously() throws Exception {
    SlowService slowService = mock(SlowService.class);
    AsyncEventListener listener = new AsyncEventListener(slowService);

    User user = new User(1L, "Alice", "alice@example.com");
    listener.onUserCreatedAsync(new UserCreatedEvent(this, user));

    Thread.sleep(200); // checkpoint: allow async executor to run
    verify(slowService).processUser(user);
  }
}

ベストプラクティス

• ApplicationEventPublisher をモック — ユニットテストではリアルコンテキストに投稿させない
• ArgumentCaptor でイベントをキャプチャしフィールドレベルの等価性をアサート（型だけでなく）
• リスナーを分離してテスト：モックされた依存関係で構築し、ハンドラーメソッドを直接呼び出す
• エラーパスをカバー：リスナーはパブリッシャーに例外を伝播させてはいけない
• 非同期リスナー：Thread.sleep() の代わりに Awaitility を優先し確定的な待機を実現
• イベントを不変でシリアライズ可能に保つ — JVM 境界を越える場合はその両方をテスト

制約と警告

• Spring 自体のイベントインフラストラクチャをテストしない — ビジネスロジックとイベントペイロードに焦点を当てる
• @Async は @EnableAsync が必要 — Thread.sleep() を使用するテストはテストで非同期プロキシが配線されていなくても合格する可能性がある；モック検証を代わりに使用
• Spring はリスナー順序を保証しない — @Order を追加する場合を除き、実行シーケンスに依存するテストを作成しない
• CI 環境で Thread.sleep() を避ける — 負荷下でテストが不安定になる；Awaitility の .atMost() ブロックで置き換える
• JVM 境界を越えるイベントはシリアライズテストが必要 — リモートリスナーの null フィールドは多くの場合、Serializable が欠落していることを意味する

参考資料

• Spring ApplicationEvent Javadoc
• ApplicationEventPublisher Javadoc
• @EventListener Javadoc