Golden tests for UI in Flutter - Build, Publish & Deploy

Build & Publish - Golden tests for UI

Performance Impact

Golden tests do not run in the live app, so they do not affect frame rate or battery during normal use. However, they require rendering UI snapshots during testing, which can consume CPU and memory temporarily. This is fine since tests run off the main user experience. Using golden tests helps catch UI bugs early, preventing costly performance issues in production.

Optimization Tips

To keep golden tests efficient and reliable, limit the number of snapshots and test only key UI states. Use device pixel ratio and consistent fonts to avoid false failures. Run tests on CI with caching to speed up repeated runs. Avoid testing large widget trees in one snapshot; break them into smaller parts. This keeps tests fast and stable, supporting smooth 60fps UI in the app.

App Size and Startup Time

Golden tests do not affect the app bundle size or startup time because they are part of the test suite, not the shipped app. However, storing many large golden image files in your repo can increase project size. Keep golden images optimized and remove outdated snapshots to manage repo size. This keeps your development environment clean without impacting app download size or launch speed.

iOS vs Android Differences

Golden tests in Flutter behave the same on iOS and Android since Flutter renders UI consistently across platforms. However, slight differences in font rendering or system themes can cause snapshot mismatches. Use platform-agnostic fonts and themes in tests or maintain separate golden images per platform if needed. This ensures tests pass reliably on both iOS and Android CI environments.

Store Review Guidelines

Golden tests are a development tool and do not affect app store submissions directly. However, ensuring your UI matches design specs through golden tests helps meet Apple's Human Interface Guidelines and Google's Material Design standards. This reduces the chance of store rejections due to UI inconsistencies or accessibility issues. Keep your UI polished and compliant by integrating golden tests in your workflow.

Self-Check Question

Your app takes 5 seconds to load this screen. What's likely wrong?

• You might have unoptimized widget builds causing slow rendering.
• Heavy images or animations not cached or deferred.
• Golden tests are unrelated to runtime speed but ensure UI correctness early.
• Check for expensive operations in build methods or large widget trees.

Key Result

Golden tests help catch UI bugs early without affecting app performance or size, ensuring consistent design across iOS and Android and smoother app store approval.

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