
# キャプチャーしたログ

`captureLogs` は、各テストの間に `SpringLog` を通してログに出されたものを記録します。そのため、テストはコードが例外を投げる代わりに警告やエラーをログに出すことを確認できます。テストクラスでは、`@CapturedOutput()` フィールドが同じことを行います。

## 使う理由

ログでしか見えない動作もあります。遅い決済についての警告や、投げられる代わりに処理されてログに出されるエラーなどです。それを確認しておけば、そうしたコードが黙って変わるのを防げます。

## 例

```dart
void main() {
  final logs = captureLogs(level: SpringLogLevel.debug); // テストの外で一度だけ
  final app = springBootTest(springApplication);

  test('warns about slow payments', () {
    app.getBean<Checkout>().pay(slowOrder);
    expect(logs.messages, contains('slow payment'));
    expect(logs.atLevel(SpringLogLevel.warning), hasLength(1));
    expect(logs.ofLogger('neon.checkout'), isNotEmpty); // その子ロガーも
  });
}
```

```dart
@SpringBootTest()
class CheckoutLogTest {
  @CapturedOutput()
  late CapturedLogs logs;                      // 各テストの前に空になる

  @Autowired()
  late Checkout checkout;

  @Test()
  void payingIsLogged() {
    checkout.pay(3);
    expect(logs.messages, contains('paid 3.0'));
  }
}
```

## CapturedLogs

| メンバー | 得られるもの |
|---|---|
| `records` | レベル、ロガー、メッセージ、フィールド、エラーを持つ `SpringLogRecord` |
| `messages` | メッセージ |
| `text` | レコードごとに一行の `LEVEL [logger] message` |
| `atLevel(level)` | ちょうどそのレベルのレコード (警告にエラーは含まれない) |
| `ofLogger(name)` | そのロガーと、その下のロガーのレコード |

- どのテストも空のキャプチャーから始まります。
- レコードは、ロガー自身のレベルでフィルターされた後にキャプチャーされます。
- `level` は各テストの間 `SpringLog.level` を設定し、その後で古いレベルに戻します。
- `captureLogs` は、`main` または `group` の中で、テストの外で一度だけ呼んでください。

## app.output

`app.output` は別のものです。アプリケーションが出力した行で、起動しなかったコンテキストの失敗レポートや、有効な場合のバナーなどです。各行はテストが失敗したときにも表示されます。起動時の情報は出力されるのではなくログに出されるため、`output` ではなく、キャプチャーしたログに含まれます。

## Spring (Java) との対応

Spring Boot の `OutputCaptureExtension` は、プロセスが出力するすべてをキャプチャーします。`captureLogs` は `SpringLog` のレコードだけを、そのレベルとロガーとともにキャプチャーするため、アサーションでテキストを解析する必要はありません。

## 関連項目

- [springBootTest](spring-boot-test.md)
- [spring_boot_starter_logging](../spring-boot-starter-logging/index.md)
- [SpringLog](../spring-core-dart/logging/spring-log.md)
