Skip to content

docs: document Roborazzi screenshot tests in README #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kanyandula merged 2 commits into from
Jul 25, 2026
Merged

docs: document Roborazzi screenshot tests in README #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2444e1
docs: document Roborazzi screenshot tests in README
Jul 25, 2026
7595bfa
ci: surface screenshot verification in the job name
Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- uses: gradle/actions/wrapper-validation@v4

build-and-test:
name: Build, unit tests, detekt, lint
name: Build, unit tests, screenshots, detekt, lint
runs-on: ubuntu-latest
needs: validation
steps:
Expand Down
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,25 @@ appears automatically after the first publish.

## Testing

- **JVM unit tests** — `app/src/test/` (~21 files): notification mapping
- **JVM unit tests** — `app/src/test/` (~28 files): notification mapping
(`MessagingStyle`, body priority chain), dedup/debounce, outbox
enqueue/drain/prune, discovery payload, app-lock idle timeout, settings
parsing, plus ViewModel tests for Broker / Apps / Onboarding.
- **Screenshot tests** — `app/src/test/java/.../screenshot/` (7 test classes,
20 goldens in `app/src/test/screenshots/`): Roborazzi on Robolectric,
pinned to Pixel 5 / SDK 34 with fixed locale and timezone. Covers Status,
Apps, Broker, Locked, Permissions, Onboarding, and Language settings,
including French-locale and large-font variants. Record new goldens with
`./gradlew :app:recordRoborazziDebug`; verify with `verifyRoborazziDebug`.
Rationale and the Paparazzi comparison are in
[`docs/screenshot-testing-strategy.md`](docs/screenshot-testing-strategy.md).
- **Instrumented tests** — `app/src/androidTest/` (~6 files): Room DAO tests
(`OutboxDaoTest`), `BiometricAuthenticatorTest`, Hilt graph smoke test,
locked-screen UI test. Runner: `HiltTestRunner`.
- The instrumented suite **does not** exercise the live forwarding path
(FGS / BootReceiver removed from debug APK); that's covered by the device
checklist below.
- **CI:** [![CI](https://github.com/Kanyandula/NotifyBridge/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Kanyandula/NotifyBridge/actions/workflows/ci.yml) [![Instrumented](https://github.com/Kanyandula/NotifyBridge/actions/workflows/instrumented.yml/badge.svg?branch=main)](https://github.com/Kanyandula/NotifyBridge/actions/workflows/instrumented.yml) — fast lane (build, unit tests, detekt, lint, release assemble) and emulator lane (API 28 google_apis) on every push and PR.
- **CI:** [![CI](https://github.com/Kanyandula/NotifyBridge/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Kanyandula/NotifyBridge/actions/workflows/ci.yml) [![Instrumented](https://github.com/Kanyandula/NotifyBridge/actions/workflows/instrumented.yml/badge.svg?branch=main)](https://github.com/Kanyandula/NotifyBridge/actions/workflows/instrumented.yml) — fast lane (build, unit tests, screenshot verification, detekt, lint, release assemble) and emulator lane (API 28 google_apis) on every push and PR.

## Device manual verification checklist

Expand Down
Loading