AndroidUiTestingUtils
A set of TestRules, ActivityScenarios and utils to facilitate UI testing/snapshot testing under certain configurations, independent of the framework you are using. It currently supports the following:
- FontSizes
- Locales
In the near future, there are plans to also support the following, among others:
- Orientation
- Display
- Dark mode
- Reduce snapshot testing flakiness
Integration
To integrate AndroidUiTestingUtils into your project:
Add jitpack to your root build.gradle file:
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
Add a dependency to build.gradle
dependencies {
androidTestImplementation 'com.github.sergio-sastre:AndroidUiTestingUtils:1.0.0-SNAPSHOT'
}
What to keep in mind
- For standard UI testing, use
TestRules. - For snapshot/screenshot testing any UI component that does not test the full Activity, prefer
ActivityScenarioConfiguratortoTestRules. That is because:- Some
TestRules, likeFontSizeTestRule, execute the corresponding adb shell commands to change the configuration, and that change might not happen immediately, slowing down your test execution. ActivityScenarioConfiguratorlaunches a default Activity with the given configuration. Therefore, such configuration changes apply to all UI elements that are inflated with the Activity context! Check the examples in Road-to-Effective-Snapshot-Testing to see how to snapshot test any view using the Activity context.
- Some
Known issue: As of AndroidUiTestingUtils:1.0.0-SNAPSHOT, pseudolocales (i.e. en_XA and ar_XB) do not work with LocaleTestRule. This will be fixed in the next version
Usage
- To use
ActivityScenarioConfiguratoryou need to add the following activities to yourdebug/manifest
<application
...
<activity android:name="sergio.sastre.uitesting.utils.activityscenario.ActivityScenarioConfigurator$SnapshotConfiguredActivity"/>
...
</application>
- To use
LocaleTestRule, add this permission in yourdebug.manifest:
<uses-permission android:name="android.permission.CHANGE_CONFIGURATION"
tools:ignore="ProtectedPermissions"/>
Code examples
Screenshot test examples with Shot from pedrovgs
- ActivityScenario
@Test
fun activityScenarioWithLocaleAndFontSize(){
val activityScenario =
ActivityScenarioConfigurator.Builder()
.setFontSize(fontScale)
.setLocale(locale)
.launchConfiguredActivity()
.waitForActivity()
val view =
waitForView {
val layout = activity.inflate(layoutId)
...
}
compareScreenshot(
view = view,
name = testName
)
}
- Jetpack Compose + ActivityScenario
In order to test Jetpack Compose views withActivityScenarioConfigurator, usecreateEmptyComposeRule(), for instance:
@get:Rule
val composeTestRule = createEmptyComposeRule()
@Test
fun composeWithFontSizeTest() {
val activityScenario =
ActivityScenarioConfigurator.Builder()
.setFontSize(fontScale)
.setLocale(locale)
.launchConfiguredActivity()
.onActivity {
it.setContent {
myComposeView()
}
}
compareScreenshot(composeTestRule, name = testName)
}
TestRule example
@get:Rule
val localeTestRule = LocaleTestRule(locale)
@get:Rule
val fontSizeTestRule = FontScaleRules.fontScaleTestRule(fontScale)
@Test
fun yourTest() {
// here your UI or snapshot Test
...
}
5 Dec 15, 2022
1.6k Jan 3, 2023
1 Apr 12, 2022
2.8k Dec 14, 2022
8.4k Jan 9, 2023
5.6k Jan 3, 2023
86 Jan 1, 2023
1.8k Jan 5, 2023
191 Dec 21, 2022
10 Dec 3, 2022
1 Feb 23, 2022
0 Nov 18, 2021
0 Dec 30, 2021
157 Nov 13, 2022
43 Dec 24, 2022
10 Dec 5, 2022
4 Jan 27, 2022