Share
Embed
flutter_kaigi_2021.pdf
Kyohei Ito
November 30, 2021
Transcript
72 slides
-
• Unit Testing • UI Testing • Snapshot Testing •
E2E Testing ςετͱ -
Golden Testing void main() { testWidgets('Snapshot for MyApp', (tester) async
{ const app = MyApp(); // ΩϟϓνϟαΠζΛઃఆ await tester.binding.setSurfaceSize(const Size(414, 896)); await tester.pumpWidget(app); // Ϛελʔεφοϓγϣοτͱͷࠩൺֱ await expectLater( find.byWidget(app), matchesGoldenFile('MyApp.png'), ); }); } -
Golden Testing mainAxisAlignment: MainAxisAlignment.center, children: <Widget>[ const Text( 'You have
pushed the button this many times:', ), Text( '$_counter', style: Theme.of(context).textTheme.headline4, ), ], ※ϓϩδΣΫτ࡞࣌ʹ࡞ΒΕΔίʔυ͔Βൈਮ -
Golden Testing mainAxisAlignment: MainAxisAlignment.start, children: <Widget>[ const Text( 'You have
pushed the button this many times:', ), Text( '$_counter', style: Theme.of(context).textTheme.headline4, ), ], ※ϓϩδΣΫτ࡞࣌ʹ࡞ΒΕΔίʔυ͔Βൈਮ DFOUFSΛTUBSUʹมߋͯ͠ςετͯ͠ΈΔ -
Golden Testing $ flutter test 00:04 +0: Snapshot for MyApp
00:04 +0 -1: Snapshot for MyApp [E] Test failed. See exception logs above. The test description was: Snapshot for MyApp The test description was: Snapshot for MyApp 00:04 +0 -1: Some tests failed. -
Visual Regression Testing • ը૾ճؼςετ • ը૾ͷࠩΛݕग़͢Δεφοϓγϣοτςετͷ ͻͱͭ • UI
͕༧ظͤͣมߋ͞Ε͍ͯͳ͍͔Λ͔֬ΊΔͷ ʹඇৗʹ༗༻ -
reg-suit $ yarn add reg-suit $ yarn reg-suit init --use-yarn
? Plugin(s) to install (bold: recommended) (Press <space> to select, <a> to toggle all, <i> to invert selection) ? Working directory of reg-suit. .reg ? Append ".reg" entry to your .gitignore file. Yes ? Directory contains actual images. catalog_app/test/screenshots ? Threshold, ranges from 0 to 1. Smaller value makes the comparison more sensitive. 0 ? notify-github plugin requires a client ID of reg-suit GitHub app. Open installation window in your browser Yes ? This repositoriy's client ID of reg-suit GitHub app ? Create a new GCS bucket No ? Existing bucket name ? Update configuration file Yes ? Copy sample images to working dir No -
• playbook-ui (playbook- fl utter) • ݩʑฐࣾͷ OSS ͱͯ͠ଘࡏ͍ͯ͠Δ iOS
൛ͷͷΛ Flutter Խ UI ΧλϩάΞϓϦ -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } Playbook ΠϯελϯεΛड͚औΓΧλϩάΞϓϦશମΛߏங͢Δ -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } ड͚औͬͨ Story ͷϦετ͕ PlaybookGallery ʹදࣔ͞ΕΔ -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } ड͚औͬͨ Scenario ͷϦετ͕ Story ͷ Row ʹදࣔ͞ΕΔ -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } ड͚औͬͨ Widget ͷදࣔʹؔ͢ΔใΛઃఆͰ͖Δ -
playbook-ui (playbook- fl utter) @override Widget build(BuildContext context) { return
MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]), ]), ), ); } ಠࣗʹ࣮ͨ͠ Widget ͳͲΛ͢͜ͱͰදࣔ͞ΕΔ -
playbook-ui (playbook- fl utter) name: simple_catalog_app dependencies: flutter: sdk: flutter
simple_app: path: ../simple_app playbook_ui: playbook: UI ΧλϩάΞϓϦߏྫ ϓϩμΫτͷΞϓϦΛґଘʹՃ -
playbook-ui (playbook- fl utter) name: component dependencies: flutter: sdk: flutter
UI ίϯϙʔωϯτύοέʔδԽྫ දࣔʹඞཁͳॲཧ͚ͩͷύοέʔδΛ࡞ -
playbook-ui (playbook- fl utter) name: simple_app dependencies: flutter: sdk: flutter
component: path: '../component' σόΠεઐ༻ͷґଘͳͲΞϓϦଆʹهड़͠ඞཁʹԠͯ͡ίϯϙʔωϯτʹ DI ࡞ͨ͠6*ίϯϙʔωϯτΛՃ -
playbook-ui (playbook- fl utter) name: simple_catalog_app dependencies: flutter: sdk: flutter
component: path: '../component' playbook_ui: playbook: ಉ͘͡6*ίϯϙʔωϯτΛՃ දࣔʹඞཁͳίϯϙʔωϯτ͚ͩΛ import ͢Δ͜ͱͰϏϧυ͕࣌ؒॖ -
playbook-ui (playbook- fl utter) void main() { runApp(MyApp()); } class
MyApp extends StatelessWidget { @override Widget build(BuildContext context) { return MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child: ..., ), ]) ]), ), ); } } UI ΧλϩάΞϓϦ͕ -
• fl utter_test matchesGoldenFile function • golden_toolkit (ebay) • playbook-snapshot
(playbook- fl utter) ը໘Ωϟϓνϟ -
Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child:
Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); playbook-snapshot (playbook- fl utter) -
Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child:
Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); playbook-snapshot (playbook- fl utter) 1MBZCPPLʹSVOϝιου͕Ճ͞ΕΔ -
Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child:
Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); playbook-snapshot (playbook- fl utter) 4DFOBSJP͕͍࣋ͬͯΔXJEHFU͕͞ΕΔ ΩϟϓνϟΛࡱΓ͍ͨ8JEHFU -
Playbook(stories: [ Story('Sample Widget', scenarios: [ Scenario( 'Sample Scenario', child:
Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); playbook-snapshot (playbook- fl utter) Snapshot ઃఆྫ -
Future<void> main() async { await Playbook(stories: [ Story('Sample Widget', scenarios:
[ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); } playbook-snapshot (playbook- fl utter) -
Future<void> main() async { await Playbook(stories: [ Story('Sample Widget', scenarios:
[ Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]).run( Snapshot( directoryPath: 'screenshots', devices: [SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); } playbook-snapshot (playbook- fl utter) ͜ͷ෦ΞϓϦςετڞ௨ -
Playbook playbook() { return Playbook(stories: [ Story('Sample Widget', scenarios: [
Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]); } playbook-snapshot (playbook- fl utter) -
void main() { runApp(MyApp()); } class MyApp extends StatelessWidget {
@override Widget build(BuildContext context) { return MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: playbook(), ), ); } } playbook-snapshot (playbook- fl utter) -
Future<void> main() async { await playbook().run( Snapshot( directoryPath: 'screenshots', devices:
[SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); } playbook-snapshot (playbook- fl utter) -
• தͰ fl utter_test ͷ matchesGoldenFile Λ࣮ߦ͍ͯ͠Δ • ϑΥϯτΞΠίϯ͕ಡΈࠐΊͳ͍ͷαϙʔτ playbook-snapshot
(playbook- fl utter) ৄ͘͠ https://speakerdeck.com/tomokitakahashi/shi-jian- fl utter-visual-regression-testing -
name: simple_catalog_app flutter: fonts: - family: Roboto fonts: - asset:
fonts/Roboto-Regular.ttf playbook-snapshot (playbook- fl utter) Ωϟϓνϟ࣌ͷϑΥϯτΛՃ͢Δ -
Future<void> main() async { await playbook().run( Snapshot( directoryPath: 'screenshots', devices:
[SnapshotDevice.iPhone8], ), (widget) { return ProviderScope( overrides: [], MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ), ); }, ); } DI ͜ͷ͋ͨΓͰ%*Մೳ -
• Story ࡞ͷ؆ུԽ • Scenario ࡞༻ͷΞϊςʔγϣϯ • Playbook ͷΠϯελϯεࣗಈੜ •
build_runner Ͱ࣮ߦՄೳ playbook-generator (playbook- fl utter) -
Playbook playbook() { return Playbook(stories: [ Story('Sample Widget', scenarios: [
Scenario( 'Sample Scenario', child: Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ), ), ]) ]); } playbook-generator (playbook- fl utter) Before -
const storyTitle = 'Sample Widget'; @GenerateScenario(title: 'Sample Scenario') Widget sampleScenario()
=> Center( child: Container( width: 200, height: 250, color: Colors.amber, alignment: Alignment.center, child: const Text('Hello World'), ), ); playbook-generator (playbook- fl utter) After -
void main() { runApp(MyApp()); } class MyApp extends StatelessWidget {
@override Widget build(BuildContext context) { return MaterialApp( title: 'Playbook Demo', theme: ThemeData.light(), home: PlaybookGallery( title: 'Sample App', playbook: playbook, ), ); } } playbook-generator (playbook- fl utter) ม HFUUFS ͕ࣗಈੜ͞Ε͍ͯΔ -
Future<void> main() async { await playbook.run( Snapshot( directoryPath: 'screenshots', devices:
[SnapshotDevice.iPhone8], ), (widget) { return MaterialApp( debugShowCheckedModeBanner: false, home: Material(child: widget), ); }, ); } playbook-generator (playbook- fl utter) ม HFUUFS ͕ࣗಈੜ͞Ε͍ͯΔ -
• PR ࣌ʹ VRT ͕࣮ߦ͞ΕΔΑ͏ʹ CI Ͱઃఆ͢Δ • ௨ܥͷϓϥάΠϯΛ͑ςετ݁ՌΛ௨ͯ͘͠ΕΔ •
ϨϏϡʔޙʹ Approve ͢Δ·ͰϚʔδͰ͖ͳͨ͘͠ΓͰ͖Δ ςετ -
{ "dependencies": { "reg-suit": "^0.11.1" }, "devDependencies": { "reg-keygen-git-hash-plugin": "^0.11.1",
"reg-notify-github-plugin": "^0.11.1", "reg-publish-gcs-plugin": "^0.11.1" }, "scripts": { "regression": "reg-suit run" } } CI SFHTVJUΛ࣮ߦ͢ΔͨΊͷઃఆΛՃ -
version: 2.1 orbs: android: circleci/[email protected] flutter: circleci/[email protected] node: circleci/[email protected] jobs:
vrt: executor: android/android steps: - checkout - node/install: install-yarn: true - flutter/install_sdk: - run: name: Install melos command: | dart pub global activate melos melos run pub:get - run: name: Run Golden Testing command: melos run test:snapshot - run: name: Install dependencies command: yarn - run: name: Run VRT command: yarn regression workflows: vrt: jobs: - vrt CI -
@override Widget build(BuildContext context) { return Container( color: Colors.amberAccent, child:
Row( mainAxisAlignment: MainAxisAlignment.center, crossAxisAlignment: CrossAxisAlignment.center, children: [ Icon(Icons.star), SizedBox(width: 16), Text(text, style: Theme.of(context).textTheme.headline5) ], ), ); } ςετ -
@override Widget build(BuildContext context) { return Container( color: Colors.amberAccent, child:
Row( mainAxisAlignment: MainAxisAlignment.start, crossAxisAlignment: CrossAxisAlignment.center, children: [ Icon(Icons.star), SizedBox(width: 16), Text(text, style: Theme.of(context).textTheme.headline5) ], ), ); } ςετ ෆ۩߹͔அͮ͠Β͍ -
• https://github.com/playbook-ui/playbook- fl utter • https://github.com/Dropsource/monarch • https://github.com/widgetbook/widgetbook • https://github.com/ookami-kb/storybook_
fl utter • https://github.com/eBay/ fl utter_glove_box/tree/master/packages/ golden_toolkit ࢀߟ URL