README.md

Android UI testing utils

A set of TestRules, ActivityScenarios and utils to facilitate UI & screenshot testing under certain configurations, independent of the UI testing libraries you are using.


For screenshot testing, it supports:

• Jetpack Compose
• android Views (e.g. custom Views, ViewHolders, etc.)
• Activities
• Fragments
• Robolectric
• Cross-library & Shared screenshot testing i.e. same test running either on device or on JVM.

This library enables you to easily change the following configurations in your UI tests:

1. Locale (also Pseudolocales en_XA & ar_XB)
   1. App Locale (i.e. per-app language preference)
   2. System Locale
2. Font size
3. Orientation
4. Custom themes
5. Dark mode / Day-Night mode
6. Display size

Wondering why verifying our design under these configurations is important? I've got you covered:

🎨 Design a pixel perfect Android app

Documentation

Check out this library's documentation page to see how to use it, including code and ready-to-run examples

Sponsors

Thanks to Screenshotbot for their support!

By using Screenshotbot instead of the in-build record/verify modes provided by most screenshot libraries, you'll give your colleages a better developer experience, since they will not be required to manually record screenshots after every run, instead getting notifications on their Pull Requests.

Android UI testing utils logo modified from one by Freepik - Flaticon