BeanOverride と @TestBean

テストで使えないもの (決済プロバイダー、実時間の時計、メールサーバー) と通信する Bean は、テストのオブジェクトに置き換えます。元の定義はどの Bean も生成される前に取り除かれるため、本物のオブジェクトも、それが接続するはずだったものも、決して作られません。それを注入するすべての Bean が置き換えを受け取ります。

Spring の @TestBean と @MockitoBean に当たりますが、生成されるモックではなく、出来上がったオブジェクトを使います。

使う理由

本物のカードに課金したり、本物のメールを送ったりするテストは、遅く、不安定で、危険です。一つの Bean を置き換えればアプリケーションの残りは本物のままなので、テストは結び付け、プロパティ、コントローラーを引き続き確認できます。

例

関数として:

final gateway = FakeGateway();
final clock = FixedClock(DateTime(2026, 1, 1));

final app = springBootTest(
  springApplication,
  overrides: [
    BeanOverride<PaymentGateway>(gateway),                  // その型の唯一の Bean
    BeanOverride<Clock>(clock),
    BeanOverride<PaymentGateway>(MockGateway(), name: 'sandbox'), // 複数の中の一つを名前で
  ],
);

クラスとして:

@SpringBootTest()
class PaymentTest {
  @TestBean(name: 'sandbox')            // sandbox という名前の Bean を置き換える
  final gateway = FakeGateway();

  @TestBean()                           // 唯一の Clock を置き換える
  final Clock clock = FixedClock(DateTime(2026, 1, 1));

  @TestBean()                           // Mailer の Bean がない: 追加する
  final Mailer mailer = RecordingMailer();

  @Autowired()
  late Checkout checkout;

  @Test()
  void paysThroughTheFake() {
    checkout.pay(12.5);
    expect(gateway.charged, [12.5]);
  }
}

どの Bean が置き換えられるか

指定 置き換えるもの
name: その名前の Bean、またはその名前を別名とする Bean
名前なし T の唯一の Bean。複数ある場合は、ただ一つの @Primary のもの。複数あって単一のプライマリーがなければ、それらを列挙する StateError で起動が失敗する
T の Bean がない 何も置き換えない: インスタンスは、型にちなんだ名前 (PaymentGateway なら paymentGateway) の新しい Bean として追加される

置き換えは、元のものの名前、別名、修飾子、順序、@Primary / @Fallback のフラグを保つため、@Qualifier の注入ポイントも引き続きそれを見つけます。複数のオーバーライドが同じ Bean を置き換える場合は、最後のものが優先されます。

どの型のもとで

知っておくべきこと

Spring (Java) との対応

@MockitoBean PaymentGateway gateway;              // 生成される Mockito のモック
@TestBean(name = "sandbox") PaymentGateway sandbox;
static PaymentGateway sandbox() { return new FakeGateway(); }

違い: 生成されるモックやスパイではなく出来上がったオブジェクトを使う、@MockitoBean(reset) はない、そして既存の Bean がないオーバーライドは、失敗する代わりにインスタンスを追加します。

関連項目