-
Notifications
You must be signed in to change notification settings - Fork 357
Add runComposeUiTest API snippets #789
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.
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
Changes from all commits
d398230
a7dd228
7ffc550
cce2907
a350c26
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,86 @@ | ||||||
| /* | ||||||
| * Copyright 2026 The Android Open Source Project | ||||||
| * | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| * you may not use this file except in compliance with the License. | ||||||
| * You may obtain a copy of the License at | ||||||
| * | ||||||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| * See the License for the specific language governing permissions and | ||||||
| * limitations under the License. | ||||||
| */ | ||||||
|
|
||||||
| package com.example.compose.snippets.test | ||||||
|
|
||||||
| import androidx.compose.material3.Text | ||||||
| import androidx.compose.runtime.LaunchedEffect | ||||||
| import androidx.compose.runtime.getValue | ||||||
| import androidx.compose.runtime.mutableStateOf | ||||||
| import androidx.compose.runtime.remember | ||||||
| import androidx.compose.runtime.setValue | ||||||
| import androidx.compose.ui.test.ExperimentalTestApi | ||||||
| import androidx.compose.ui.test.assertIsDisplayed | ||||||
| import androidx.compose.ui.test.junit4.v2.createComposeRule | ||||||
| import androidx.compose.ui.test.onNodeWithText | ||||||
| import androidx.compose.ui.test.v2.runComposeUiTest | ||||||
| import kotlinx.coroutines.delay | ||||||
| import kotlinx.coroutines.test.advanceTimeBy | ||||||
| import kotlinx.coroutines.test.runTest | ||||||
| import org.junit.Rule | ||||||
| import org.junit.Test | ||||||
|
|
||||||
| class RunComposeUiTest { | ||||||
|
|
||||||
| @OptIn(ExperimentalTestApi::class) | ||||||
| // [START android_compose_test_runComposeUiTest] | ||||||
| @Test | ||||||
| fun testWithCoroutines() = runComposeUiTest { | ||||||
| setContent { | ||||||
| var status by remember { mutableStateOf("Loading...") } | ||||||
| LaunchedEffect(Unit) { | ||||||
| delay(1000) | ||||||
| status = "Done!" | ||||||
| } | ||||||
| Text(text = status) | ||||||
| } | ||||||
|
|
||||||
| onNodeWithText("Loading...").assertIsDisplayed() | ||||||
| mainClock.advanceTimeBy(1000 + 16 /* Frame buffer */) | ||||||
| onNodeWithText("Done!").assertIsDisplayed() | ||||||
| } | ||||||
| } | ||||||
| // [END android_compose_test_runComposeUiTest] | ||||||
|
|
||||||
| class Test2 { | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The class name
Suggested change
|
||||||
| // [START android_compose_test_v2_apis] | ||||||
| @get:Rule | ||||||
| val composeTestRule = createComposeRule() | ||||||
|
|
||||||
| @Test | ||||||
| fun testWithCoroutines() { | ||||||
| composeTestRule.setContent { | ||||||
| var status by remember { mutableStateOf("Loading...") } | ||||||
| LaunchedEffect(Unit) { | ||||||
| delay(1000) | ||||||
| status = "Done!" | ||||||
| } | ||||||
| Text(text = status) | ||||||
| } | ||||||
|
|
||||||
| // NOT RECOMMENDED | ||||||
| // Fails: runTest creates a new, separate scheduler. | ||||||
| // Advancing time here does NOT advance the compose clock. | ||||||
| // To fix this without migrating, you would need to share the scheduler | ||||||
| // by passing 'composeTestRule.mainClock.scheduler' to runTest. | ||||||
| runTest { | ||||||
| composeTestRule.onNodeWithText("Loading...").assertIsDisplayed() | ||||||
| advanceTimeBy(1000) | ||||||
| composeTestRule.onNodeWithText("Done!").assertIsDisplayed() | ||||||
| } | ||||||
| } | ||||||
| // [END android_compose_test_v2_apis] | ||||||
| } | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve readability and avoid magic numbers, consider extracting
16into a named constant, for exampleFRAME_BUFFER_MS. While there is a comment, using a constant makes the code's intent clearer and is generally a better practice.