Adds retryable compose test rule

[dabrosch]

Proposed Changes

• This solves the "Only a single call to runTest can be performed during one test." error when you are trying to retry a test that has uses a ComposeRule.
• Achieved by creating a RetryableComposeRule class.
• This is needed because the environment that gets created from a ComposeRule is not supposed to be reused in any other test runs per discussion here: Retrying of test not fully supported with AndroidComposeTestRule Kotlin/kotlinx.coroutines#3718 (comment) so this new rule creates a new environment after each test has ran.
• This should help keep people from following the incorrect workaround such as here: https://issuetracker.google.com/issues/235383900 where they re-use the ComposeRule for subsequent retries by ordering their rules specifically to do so.
• This rule should be ordered after any retry rule.

Testing

Test: I setup an intentionally failing compose jUnit test with a retry rule outside of my RetryableComposeRule and observed that upon the retry there was NO error of "Only a single call to runTest can be performed during one test."

Issues Fixed

Fixes: https://issuetracker.google.com/issues/235383900 and Kotlin/kotlinx.coroutines#3718 (comment)

[AShunevych]

Can you explain how exactly your rule should be implemented ? For example, we have rule chain :

//
val basicRule = createAndroidComposeRule<MyActivity>()  //  basic rule 
val retryRule = RetryableComposeTestRule  { basicRule } // retry rule as you propose 
val flakyRule = FlakytestRule().allowFlakyAttemptsByDefault(2) // simple test rule from Barista lib 

// So we have flaky rule as outerRule and all rules goes around
@get:Rule
val rulechain:RuleChain = run {
 RuleChain.outerRule(flakyRule).around(basicRule).around(retryRule) 
}

Test will restart, but again IllegalStateException("Only a single call to runTest can be performed during one test.") will be thrown exception will be thrown.
Thank you.

[dabrosch]

Can you explain how exactly your rule should be implemented ? For example, we have rule chain :

//
val basicRule = createAndroidComposeRule<MyActivity>()  //  basic rule 
val retryRule = RetryableComposeTestRule  { basicRule } // retry rule as you propose 
val flakyRule = FlakytestRule().allowFlakyAttemptsByDefault(2) // simple test rule from Barista lib 

// So we have flaky rule as outerRule and all rules goes around
@get:Rule
val rulechain:RuleChain = run {
 RuleChain.outerRule(flakyRule).around(basicRule).around(retryRule) 
}

Test will restart, but again IllegalStateException("Only a single call to runTest can be performed during one test.") will be thrown exception will be thrown. Thank you.

The problem is that you have two composeRules in the RuleChain, you have the basicRule AND the retryRule, you should only have the retryRule.

So I suggest removing the entire val basicRule line and instead change the next to this:

val retryRule = RetryableComposeTestRule  { createAndroidComposeRule<MyActivity>() } // retry rule as you propose 

[dabrosch]

Sorry for my late reply as well, hah! Well, since you see that I am overriding all of the regular ComposeTestRule public elements, you would have to change the output to be AndroidComposeTestRule and override all of the additional public elements to expose what you are looking for. What I would probably do is inherit from RetryableComposeRule and implement a new class RetryableAndroidComposeRule. But your other option is to just be in control of your own launching of activities (by using the createEmptyComposeRule), and therefore you should already have a reference to the activity to interact with.

…

--Daniel

On Tue, Aug 1, 2023 at 3:52 AM Anton Shunevych ***@***.***> wrote: So I suggest removing the entire val basicRule line and instead change the next to this: val retryRule = RetryableComposeTestRule { createAndroidComposeRule<MyActivity>() } // retry rule as you propose Sorry for not responding that long. Thanks!. I wonder: retryRule will inherit from ComposeTestRule, not from AndroidComposeTestRule is there any way to make it use AndroidComposeTestRule <https://developer.android.com/reference/kotlin/androidx/compose/ui/test/junit4/AndroidComposeTestRule>instead ? I am asking about this because, end-to-end tests may often require interaction with activity. — Reply to this email directly, view it on GitHub <#574 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMIGFGIL37I7ZZTDUCYX5TXTDNXNANCNFSM6AAAAAAZR7JJIE> . You are receiving this because you authored the thread.Message ID: ***@***.***>