[Testing] Improve rule.waitUntil API to accept a matcher [226934294]

Fixed

Feature Request

Status Update

No update yet.

Description

ja...@google.com

created issue #1

Mar 25, 2022 05:42PM

Feature request for improved waitUntil APIs.

Currently, ComposeTestRule's waitUntil function takes a condition lambda that produces a boolean.

This can be used to very effectively and easily synchronize a test with a UI by adding statements such as:

composeTestRule.waitUntil {
    composeTestRule
        .onAllNodesWithText("Welcome")
        .fetchSemanticsNodes().size == 1
}

Making this functionality generic to accept any matcher and any count of nodes would be easy with:


fun ComposeContentTestRule.waitUntilNodeCount(
    matcher: SemanticsMatcher,
    count: Int,
    timeoutMillis: Long = 1_000L
) {
    this.waitUntil(timeoutMillis) {
        this.onAllNodes(matcher).fetchSemanticsNodes().size == count
    }
}

Plus some sugar:

fun ComposeContentTestRule.waitUntilExists(
    matcher: SemanticsMatcher,
    timeoutMillis: Long = 1_000L
) {
    return this.waitUntilNodeCount(matcher, 1, timeoutMillis)
}

fun ComposeContentTestRule.waitUntilDoesNotExist(
    matcher: SemanticsMatcher,
    timeoutMillis: Long = 1_000L
) {
    return this.waitUntilNodeCount(matcher, 0, timeoutMillis)
}

Usage:

composeTestRule.waitUntilExists(hasText("Continue"))

More details and options in (internal doc): go/compose-test-waituntil-proposal

Comments

iz...@google.com <iz...@google.com> Jun 27, 2022 08:54AM

Reassigned to iz...@google.com.

iz...@google.com <iz...@google.com> Jul 21, 2022 04:00PM

Accepted by iz...@google.com.

iz...@google.com <iz...@google.com> #2Aug 22, 2022 08:53AM

Assigned to je...@google.com.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

https://android-review.googlesource.com/1123258

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

ar...@gmail.com <ar...@gmail.com> #3Nov 5, 2022 04:54AM

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

ar...@gmail.com <ar...@gmail.com> #4Nov 6, 2022 05:06AM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

https://android-review.googlesource.com/1288456

ap...@google.com <ap...@google.com> #5Jan 26, 2023 02:20PM

Project: platform/frameworks/support
Branch: androidx-main

commit 2118900c6c4b44749cb6ac30bfb71d8b13fbc665
Author: Izer Onadim <izeronadim@google.com>
Date: Mon Jun 27 12:55:50 2022

Improve rule.waitUntil API to accept a matcher

Extend the `ComposeTestRule.waitUntil` API to accept a matcher and
any count of nodes by adding experimental `waitUntilNodeCount`. Add
some syntactic sugar with `waitUntilAtLeastOneExists`,
`waitUntilExactlyOneExists` and `waitUntilDoesNotExist`.

Bug: 226934294
Test: ./gradlew compose:ui:ui-test-junit4:test
&& ./gradlew compose:ui:ui-test-junit4:cC
Relnote: "Added `waitUntilNodeCount`, `waitUntilAtLeastOneExists`,
`waitUntilExactlyOneExists` and `waitUntilDoesNotExist` as
experimental API to `ComposeTestRule`, extending the `waitUntil` API
to accept any matcher and any count of nodes. See `ComposeTestRule`
for further documentation."

Change-Id: Ifa1b98cf869a78b79f082c4ed8df6c9abd302a87

M compose/ui/ui-test-junit4/api/public_plus_experimental_current.txt
A compose/ui/ui-test-junit4/src/androidAndroidTest/kotlin/androidx/compose/ui/test/junit4/ComposeTestRuleWaitUntilTest.kt
A compose/ui/ui-test-junit4/src/androidAndroidTest/kotlin/androidx/compose/ui/test/junit4/WaitUntilNodeCountTest.kt
M compose/ui/ui-test-junit4/src/androidMain/kotlin/androidx/compose/ui/test/junit4/AndroidComposeTestRule.android.kt
M compose/ui/ui-test-junit4/src/commonMain/kotlin/androidx/compose/ui/test/ComposeUiTest.kt
M compose/ui/ui-test-junit4/src/desktopMain/kotlin/androidx/compose/ui/test/junit4/DesktopComposeTestRule.desktop.kt
M compose/ui/ui-test-junit4/src/jvmMain/kotlin/androidx/compose/ui/test/junit4/ComposeTestRule.jvm.kt

https://android-review.googlesource.com/2136682

ja...@google.com <ja...@google.com> #6Mar 22, 2023 11:41AM

Marked as fixed.

Released with Compose 1.4.0.