Skip to content

Commit

Permalink
Make it a breaking change to allow for user migration
Browse files Browse the repository at this point in the history
  • Loading branch information
@takahirom
takahirom committed Feb 16, 2025
1 parent 387731f commit 2056650
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 35 deletions.
32 changes: 25 additions & 7 deletions ...ain/java/io/github/takahirom/roborazzi/GenerateComposePreviewRobolectricTestsExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,11 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
File(directory, "$className.kt").writeText(
"""
package $packageName
import androidx.activity.ComponentActivity
import androidx.compose.ui.test.junit4.AndroidComposeTestRule
import androidx.compose.ui.test.junit4.ComposeContentTestRule
import androidx.compose.ui.test.junit4.createComposeRule
import androidx.test.ext.junit.rules.ActivityScenarioRule
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
Expand All @@ -166,11 +171,8 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
import org.robolectric.ParameterizedRobolectricTestRunner
import org.robolectric.annotation.Config
import org.robolectric.annotation.GraphicsMode
import com.github.takahirom.roborazzi.*
import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
import sergio.sastre.composable.preview.scanner.android.AndroidComposablePreviewScanner
import sergio.sastre.composable.preview.scanner.android.screenshotid.AndroidPreviewScreenshotIdBuilder
import com.github.takahirom.roborazzi.*
@RunWith(ParameterizedRobolectricTestRunner::class)
Expand All @@ -181,10 +183,18 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
) {
private val tester = getComposePreviewTester("$testerQualifiedClassNameString")
private val testLifecycleOptions = tester.options().testLifecycleOptions
val composeTestRule: ComposeContentTestRule by lazy {
if (testLifecycleOptions is ComposePreviewTester.Options.JUnit4TestLifecycleOptions) {
testLifecycleOptions.composeRuleFactory()
} else {
createComposeRule()
}
}
@Suppress("UNCHECKED_CAST")
@get:Rule
val rule = RuleChain.outerRule(
if(testLifecycleOptions is ComposePreviewTester.Options.JUnit4TestLifecycleOptions) {
testLifecycleOptions.testRuleFactory()
if (testLifecycleOptions is ComposePreviewTester.Options.JUnit4TestLifecycleOptions) {
testLifecycleOptions.testRuleFactory(composeTestRule as AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>)
} else {
object : TestWatcher() {}
}
Expand All @@ -194,7 +204,15 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
$robolectricConfigString
@Test
fun test() {
tester.test(preview)
tester.test(
testParameter = if (testLifecycleOptions is ComposePreviewTester.Options.JUnit4TestLifecycleOptions) {
@Suppress("UNCHECKED_CAST")
ComposePreviewTester.TestParameter.JUnit4TestParameter(composeTestRule as AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>)
} else {
ComposePreviewTester.TestParameter.DefaultTestParameter(composeTestRule)
},
preview = preview
)
}
companion object {
Expand Down
64 changes: 36 additions & 28 deletions ...er-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,29 @@ interface ComposePreviewTester<T : Any> {
val scanOptions: ScanOptions = ScanOptions(emptyList()),
) {
interface TestLifecycleOptions
@Suppress("UNCHECKED_CAST")
data class JUnit4TestLifecycleOptions(
val composeRuleFactory: () -> AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *> = { createAndroidComposeRule<RoborazziActivity>() as AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *> },
/**
* The TestRule factory to be used for the generated tests.
* You can use this to add custom behavior to the generated tests.
*/
// Used from generated tests
@Suppress("unused") val testRuleFactory: () -> TestRule = { object : TestWatcher() {} },
@Suppress("unused") val testRuleFactory: (AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>) -> TestRule = object :
(AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>) -> TestRule {
override fun invoke(composeTestRule: AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>): TestRule {
return RuleChain.outerRule(
RuleChain
.outerRule(object : TestWatcher() {
override fun starting(description: org.junit.runner.Description?) {
super.starting(description)
registerActivityToRobolectricIfNeeded()
}
})
.around(composeTestRule)
)
}
}
) : TestLifecycleOptions

data class ScanOptions(
Expand Down Expand Up @@ -180,13 +196,24 @@ interface ComposePreviewTester<T : Any> {
*/
fun previews(): List<ComposablePreview<T>>

sealed class TestParameter {
internal val composeRule: ComposeTestRule
get() = when (this) {
is JUnit4TestParameter -> composeTestRule
is DefaultTestParameter -> composeTestRule
}
data class JUnit4TestParameter(val composeTestRule: AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>) :
TestParameter()
data class DefaultTestParameter(val composeTestRule: ComposeTestRule) : TestParameter()
}

/**
* Performs a test on a single composable preview.
* Note: This method will not be called as the same instance of previews() method.
*
* @param preview The ComposablePreview object to be tested.
*/
fun test(preview: ComposablePreview<T>)
fun test(testParameter: TestParameter, preview: ComposablePreview<T>)

companion object {
// Should be replaced with the actual default options from the plugin.
Expand All @@ -197,18 +224,6 @@ interface ComposePreviewTester<T : Any> {

@ExperimentalRoborazziApi
class AndroidComposePreviewTester : ComposePreviewTester<AndroidPreviewInfo> {
private val composeTestRule by lazy { createAndroidComposeRule<RoborazziActivity>() }
private val defaultRule: TestRule by lazy {
RuleChain
.outerRule(object : TestWatcher() {
override fun starting(description: org.junit.runner.Description?) {
super.starting(description)
registerActivityToRobolectricIfNeeded()
}
})
.around(composeTestRule)
}

override fun previews(): List<ComposablePreview<AndroidPreviewInfo>> {
val options = options()
return AndroidComposablePreviewScanner().scanPackageTrees(*options.scanOptions.packages.toTypedArray())
Expand All @@ -221,7 +236,7 @@ class AndroidComposePreviewTester : ComposePreviewTester<AndroidPreviewInfo> {
}.getPreviews()
}

override fun test(preview: ComposablePreview<AndroidPreviewInfo>) {
override fun test(testParameter: ComposePreviewTester.TestParameter, preview: ComposablePreview<AndroidPreviewInfo>) {
val pathPrefix =
if (roborazziRecordFilePathStrategy() == RoborazziRecordFilePathStrategy.RelativePathFromCurrentDirectory) {
roborazziSystemPropertyOutputDirectory() + java.io.File.separator
Expand All @@ -239,32 +254,25 @@ class AndroidComposePreviewTester : ComposePreviewTester<AndroidPreviewInfo> {
// (preview.getAnnotation<RoboComposePreviewOptions>() ?: RoboComposePreviewOptions())
val options = Class.forName(preview.declaringClass).declaredMethods
.firstOrNull { it.name == preview.methodName }
?.getAnnotation<RoboComposePreviewOptions>(RoboComposePreviewOptions::class.java) ?: RoboComposePreviewOptions()
?.getAnnotation<RoboComposePreviewOptions>(RoboComposePreviewOptions::class.java)
?: RoboComposePreviewOptions()
options.variations()
.forEach { optionVariation: RoboComposePreviewOptionVariation ->
val filePath = "$pathPrefix$name${optionVariation.nameWithPrefix()}.${provideRoborazziContext().imageExtension}"
val filePath =
"$pathPrefix$name${optionVariation.nameWithPrefix()}.${provideRoborazziContext().imageExtension}"
preview.captureRoboImage(
filePath = filePath,
roborazziComposeOptions = preview.toRoborazziComposeOptions().builder()
.apply {
@Suppress("UNCHECKED_CAST")
composeTestRule(composeTestRule as AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>)
manualAdvance(composeTestRule, optionVariation.manualClockOptions.advanceTimeMillis)
composeTestRule(testParameter.composeRule as AndroidComposeTestRule<ActivityScenarioRule<out ComponentActivity>, *>)
manualAdvance(testParameter.composeRule, optionVariation.manualClockOptions.advanceTimeMillis)
}
.build()
)
}
}

override fun options(): ComposePreviewTester.Options {
// TODO -> Add composeTestRule only if necessary to avoid extra execution time?
val testLifecycleOptions = ComposePreviewTester.Options.JUnit4TestLifecycleOptions(
testRuleFactory = { defaultRule })
return super.options().copy(
testLifecycleOptions = testLifecycleOptions
)
}

private fun createScreenshotIdFor(preview: ComposablePreview<AndroidPreviewInfo>) =
AndroidPreviewScreenshotIdBuilder(preview).ignoreClassName().build()
}
Expand Down

0 comments on commit 2056650

Please sign in to comment.