flutter pub add golden_toolkit

dependencies:
  golden_toolkit: ^0.15.0

**/failures/*.png

tags:
  golden:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Golden",
      "request": "launch",
      "type": "dart",
      "codeLens": {
        "for": ["run-test", "run-test-file"]
      },
      "args": ["--update-goldens"]
    }
  ]
}

await loadAppFonts();

import 'dart:async';

import 'package:golden_toolkit/golden_toolkit.dart';

Future<void> testExecutable(FutureOr<void> Function() testMain) async {
  await loadAppFonts();
  return testMain();
}

void main() {
  // ゴールデンテストを定義するための関数
  testGoldens(
    'Weather Screen Test',
    (tester) async {
      // 異なるデバイスサイズでWidgetをテストするために使用
      final builder = DeviceBuilder()
        // デバイスの種類を指定。指定した種類分スクリーンショットが作成されます。
        ..overrideDevicesForAllScenarios(devices: [
          Device.phone,
          Device.iphone11,
        ])
	// テストするシナリオを追加。今回はWeatherScreen全体をテスト。
        ..addScenario(
          widget: testableWidget(
	    child: const WeatherScreen(),
	  )
        );
      // addScenarioで指定したWidgetをレンダリング
      await tester.pumpDeviceBuilder(
        builder,
      );
      
      // レンダリングされたWidgetのスクリーンショットを作成し、第二引数で指定したファイルと比較します。
      await screenMatchesGolden(tester, 'weather_screen_test');
    },
  );
}

Widget testableWidget({required Widget child}) {
  return MaterialApp(
    theme: ThemeData(
      colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
      useMaterial3: true,
      fontFamily: 'Murecho',
    ),
    debugShowCheckedModeBanner: false,
    home: child,
  );
}

flutter test --update-goldens

import 'dart:async';
import 'dart:io';

import 'package:golden_toolkit/golden_toolkit.dart';

Future<void> testExecutable(FutureOr<void> Function() testMain) async {
  return GoldenToolkit.runWithConfiguration(
    () async {
      // フォントの読み込み
      await loadAppFonts();
      await testMain();
    },
    config: GoldenToolkitConfiguration(
      // 出力するデバイスを指定
      defaultDevices: const [
        Device.phone,
        Device.iphone11,
      ],
      skipGoldenAssertion: () => !Platform.isMacOS,
    ),
  );
}

  testGoldens(
    'Weather Screen Item Test',
    (tester) async {
      final builder = GoldenBuilder.grid(
        // 横に配置するコンポーネントの数
        columns: 2,
	// カラム数と幅と高さの比率
        widthToHeightRatio: 1,
      )
        // 各Enumの値でシナリオを作成
        ..addScenario(
          'Sunny',
          const WeatherScreenItem(weather: Weather.sunny),
        )
        ..addScenario(
          'Cloudy',
          const WeatherScreenItem(weather: Weather.cloudy),
        )
        ..addScenario(
          'Raining',
          const WeatherScreenItem(weather: Weather.rain),
        )
        ..addScenario(
          'Snow',
          const WeatherScreenItem(weather: Weather.snow),
        );

      await tester.pumpWidgetBuilder(
        builder.build(),
        wrapper: (child) => TestUtils.buildTestMaterialApp(child),
      );
      
      await screenMatchesGolden(
        tester,
        'weather_types_grid',
        autoHeight: true,
      );
    },
  );

    Future<void> testExecutable(FutureOr<void> Function() testMain) async {
  return GoldenToolkit.runWithConfiguration(
    () async {
      // 省略
    },
    config: GoldenToolkitConfiguration(
      fileNameFactory: (name) {
        return 'goldens/$name.png'; ← Golden Imageの保存先を変更
      },
      // 省略
    ),
  );
}

Future<void> testExecutable(FutureOr<void> Function() testMain) async {
  return GoldenToolkit.runWithConfiguration(
    () async {
      // 省略
    },
    config: GoldenToolkitConfiguration(
      enableRealShadows: true,　← 追加
      // 省略
    ),
  );
}

══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
The following LateError was thrown building WeatherScreenItem(dirty):
LateInitializationError: Field '_data@32084504' has not been initialized.

The relevant error-causing widget was:
  WeatherScreenItem
  WeatherScreenItem:file://zenn.dev/Users/t-z/workspace/flutter/advent_calendar_2023/test/ui/weather_screen_test.dart:46:17

class _Wrapper extends StatelessWidget {
  final Widget child;
  const _Wrapper(this.child);
  @override
  Widget build(BuildContext context) {
    ScreenUtil.init(
      context,
      designSize: const Size(430.0, 932.0),
    );
    return child;
  }
}

Widget testableWidget({required Widget child}) {
  return _Wrapper(MaterialApp(
    theme: ThemeData(
      colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
      useMaterial3: true,
      fontFamily: 'Murecho',
    ),
    debugShowCheckedModeBanner: false,
    home: child,
  ));
}

Widget testableWidget({required Widget child}) {
  return MediaQuery(
    data: const MediaQueryData(),
    child: _Wrapper(MaterialApp(
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
        fontFamily: 'Murecho',
      ),
      debugShowCheckedModeBanner: false,
      home: child,
    )),
  );
}

あなた
Golden TestのGoldenとはどういう意味で使用されていますか？？

ChatGPT
「ゴールデンテスト」または「ゴールデンファイルテスト」という用語は、ソフトウェアテストの分野で使われる言葉です。この用語の「ゴールデン」という部分は、テストの基準となる出力や結果が「金のように価値がある」、つまり非常に信頼性が高く、正確であることを意味しています。ゴールデンファイルは、テストの正確な基準点として機能し、新しいテスト結果がこの基準とどのように異なるかを評価するために使用されます。

この用語の由来は、一般的に「ゴールデンスタンダード」または「黄金基準」という表現に由来しています。これは、何かが最高水準または最も信頼性の高い例として認識されることを意味します。ソフトウェアテストの文脈では、ゴールデンファイルはそのような最高水準の例と見なされ、テストの信頼性と正確性を保証するための基準点として機能します。