Golden tests for UI in Flutter - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a golden test in Flutter UI testing?

A golden test compares the current UI rendering of a widget to a saved reference image (called a golden file) to detect unintended visual changes.

beginner

Why are golden tests useful in mobile app development?

They help catch visual bugs early by ensuring UI looks exactly as expected after code changes, preventing accidental design breaks.

beginner

Which Flutter package is commonly used to write golden tests?

The flutter_test package includes support for golden tests using the matchesGoldenFile matcher.

intermediate

How do you update a golden file when the UI intentionally changes?

You run the test with the --update-goldens flag to regenerate the golden files with the new UI appearance.

intermediate

What is a common challenge when running golden tests on different devices or environments?

Differences in screen resolution, font rendering, or platform can cause false failures; tests should run in a consistent environment.

What does a golden test compare in Flutter?

A Current widget rendering vs saved image

B Widget code vs documentation

C App performance vs baseline

D User input vs expected output

Golden tests compare the widget's current rendered image to a saved golden file image.

Which command updates golden files in Flutter tests?

A flutter test --update-goldens

B flutter run --update

C flutter build --golden

D flutter clean --golden

The --update-goldens flag regenerates golden files with the current UI.

Golden tests help primarily to catch what kind of bugs?

A Network bugs

B Logic bugs

C Visual/UI bugs

D Database bugs

Golden tests focus on detecting visual or UI changes.

Which Flutter package provides golden test support?

A provider

B http

C flutter_localizations

D flutter_test

flutter_test includes matchers and utilities for golden testing.

What is a key requirement for reliable golden tests?

A User interaction simulation

B Consistent test environment

C Multiple device testing

D Fast internet connection

Golden tests need a consistent environment to avoid false positives.

Explain how golden tests work and why they are important in Flutter UI development.

Think about how you check if a picture looks the same after editing.

Describe the steps to create and update a golden test in Flutter.

Consider writing a test, saving the image, and updating it when UI changes.

Practice

1. What is the main purpose of a golden test in Flutter UI testing?

easy

A. To compare the current UI rendering with a saved image to detect visual changes

B. To test the performance speed of UI animations

C. To check if the UI code compiles without errors

D. To verify the network requests made by the UI

Solution

1. Step 1: Understand the purpose of golden tests

   Golden tests compare the UI's current look to a saved image to find visual differences.

2. Step 2: Eliminate unrelated options

   Performance, compilation, and network checks are not the focus of golden tests.

3. Final Answer:

   To compare the current UI rendering with a saved image to detect visual changes -> Option A

4. Quick Check:

   Golden test purpose = Visual comparison [OK]

Hint: Golden tests check UI images, not code or speed [OK]

Common Mistakes:

• Confusing golden tests with performance tests
• Thinking golden tests check code syntax
• Assuming golden tests verify network calls

2. Which Flutter test function is used to compare a widget's UI to a golden file?

easy

A. runApp(widget).toMatchGolden('golden.png')

B. expect(widget, equals('golden.png'))

C. testWidgets('golden test', () => expect(widget, isTrue))

D. expectLater(widget, matchesGoldenFile('golden.png'))

Solution

1. Step 1: Identify the correct golden test syntax

   The function expectLater with matchesGoldenFile is the standard way to compare UI to a golden image.

2. Step 2: Check other options for correctness

   Options B, C, and D use incorrect or non-existent syntax for golden tests.

3. Final Answer:

   expectLater(widget, matchesGoldenFile('golden.png')) -> Option D

4. Quick Check:

   Golden test syntax = expectLater + matchesGoldenFile [OK]

Hint: Use expectLater with matchesGoldenFile for golden tests [OK]

Common Mistakes:

• Using expect instead of expectLater
• Missing matchesGoldenFile matcher
• Trying to call golden test on runApp directly

3. Given this Flutter golden test snippet:

testWidgets('Button golden test', (tester) async {
  await tester.pumpWidget(MyButton());
  await expectLater(find.byType(MyButton), matchesGoldenFile('button.png'));
});

What will happen if the current button UI differs visually from 'button.png'?

medium

A. The test will throw a syntax error

B. The test will fail indicating a visual mismatch

C. The test will pass regardless of UI differences

D. The test will skip without running

Solution

1. Step 1: Understand golden test behavior on mismatch

   If the rendered UI does not match the saved golden image, the test fails to alert visual changes.

2. Step 2: Verify other options

   Passing despite differences, syntax errors, or skipping are not expected behaviors here.

3. Final Answer:

   The test will fail indicating a visual mismatch -> Option B

4. Quick Check:

   Golden test mismatch = test failure [OK]

Hint: Golden test fails if UI differs from saved image [OK]

Common Mistakes:

• Expecting test to pass despite UI changes
• Confusing runtime errors with test failures
• Thinking golden tests skip on mismatch

4. Identify the error in this golden test code snippet:

testWidgets('Screen golden test', (tester) async {
  await tester.pumpWidget(MyScreen());
  expect(find.byType(MyScreen), matchesGoldenFile('screen.png'));
});

medium

A. Using expect instead of expectLater for matchesGoldenFile

B. Missing await before tester.pumpWidget

C. Incorrect widget type passed to find.byType

D. Golden file name should be a full path

Solution

1. Step 1: Check the matcher usage

   Golden tests require expectLater with matchesGoldenFile to work asynchronously.

2. Step 2: Validate other parts

   Await is correctly used with pumpWidget, widget type is correct, and relative file names are allowed.

3. Final Answer:

   Using expect instead of expectLater for matchesGoldenFile -> Option A

4. Quick Check:

   Golden test needs expectLater, not expect [OK]

Hint: Use expectLater, not expect, with matchesGoldenFile [OK]

Common Mistakes:

• Using expect instead of expectLater
• Forgetting async/await on pumpWidget
• Assuming golden file needs full absolute path

5. You want to write a golden test for a button that changes color based on theme. Which approach ensures your golden test covers both light and dark themes correctly?

hard

A. Skip golden tests for theme changes and rely on manual testing

B. Write one golden test with default theme only, assuming dark theme looks similar

C. Write separate golden tests pumping the button with light and dark theme widgets and compare to separate golden files

D. Use a single golden file and toggle theme at runtime without repumping widget

Solution

1. Step 1: Understand theme impact on UI

   Light and dark themes can change colors significantly, so testing both separately is needed.

2. Step 2: Evaluate testing approaches

   Separate tests with repumping widgets under each theme and comparing to distinct golden files ensures accurate visual checks.

3. Final Answer:

   Write separate golden tests pumping the button with light and dark theme widgets and compare to separate golden files -> Option C

4. Quick Check:

   Test each theme separately with distinct golden files [OK]

Hint: Test light and dark themes separately with different golden files [OK]

Common Mistakes:

• Assuming one golden file covers all themes
• Not repumping widget after theme change
• Skipping golden tests for theme variations