Support includePrivatePreviews of ComposablePreviewScanner

README.md

@@ -951,7 +951,7 @@ If you are having trouble debugging your test, try Dump mode as follows.
 # Experimental Compose Preview Support
 
 Roborazzi provides support for generating screenshot tests and easy setup for Jetpack Compose Preview.
-This support uses [ComposePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) to scan the Composable Previews in your project.
+This support uses [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) to scan the Composable Previews in your project.
 
 ## Generate Compose Preview screenshot tests
 
@@ -994,13 +994,13 @@ roborazzi {
 
 ## Manually adding Compose Preview screenshot tests
 
-Roborazzi provides a helper function for ComposePreviewScanner.
+Roborazzi provides a helper function for ComposablePreviewScanner.
 You can add the following dependency to your project to use the helper function:
 
 `testImplementation("io.github.takahirom.roborazzi:roborazzi-compose-preview-scanner-support:[version]")`
 
 Then you can use the `ComposablePreview<AndroidPreviewInfo>.captureRoboImage()` function to capture the Composable Preview using the settings in Preview annotations.
-To obtain the `ComposablePreview` object, please refer to [ComposePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner).
+To obtain the `ComposablePreview` object, please refer to [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner).
 
 ```kotlin
 fun ComposablePreview<AndroidPreviewInfo>.captureRoboImage(

docs/topics/preview_support.md

@@ -1,7 +1,7 @@
 # Experimental Compose Preview Support
 
 Roborazzi provides support for generating screenshot tests and easy setup for Jetpack Compose Preview.
-This support uses [ComposePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) to scan the Composable Previews in your project.
+This support uses [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) to scan the Composable Previews in your project.
 
 ## Generate Compose Preview screenshot tests
 
@@ -44,13 +44,13 @@ roborazzi {
 
 ## Manually adding Compose Preview screenshot tests
 
-Roborazzi provides a helper function for ComposePreviewScanner.
+Roborazzi provides a helper function for ComposablePreviewScanner.
 You can add the following dependency to your project to use the helper function:
 
 `testImplementation("io.github.takahirom.roborazzi:roborazzi-compose-preview-scanner-support:[version]")`
 
 Then you can use the `ComposablePreview<AndroidPreviewInfo>.captureRoboImage()` function to capture the Composable Preview using the settings in Preview annotations.
-To obtain the `ComposablePreview` object, please refer to [ComposePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner).
+To obtain the `ComposablePreview` object, please refer to [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner).
 
 ```kotlin
 fun ComposablePreview<AndroidPreviewInfo>.captureRoboImage(

gradle/libs.versions.toml

@@ -43,7 +43,7 @@ webjar-material-design-icons = "4.0.0"
 webjar-materialize = "1.0.0"
 webjars-locator-lite = "0.0.4"
 
-composable-preview-scanner = "0.1.2"
+composable-preview-scanner = "0.1.3"
 
 [libraries]
 roborazzi = { module = "io.github.takahirom.roborazzi:roborazzi", version.ref = "roborazzi-for-replacing-by-include-build" }

include-build/roborazzi-gradle-plugin/src/integrationTest/java/io/github/takahirom/roborazzi/PreviewGenerateTest.kt

@@ -17,6 +17,7 @@ class GeneratePreviewTestTest {
       checkHasImages()
     }
   }
+
   @Test
   fun whenKmpModuleAndRecordRunImagesShouldBeRecorded() {
     RoborazziGradleRootProject(testProjectDir).previewModule.apply {
@@ -26,6 +27,16 @@ class GeneratePreviewTestTest {
       checkHasImages()
     }
   }
+
+  @Test
+  fun whenIncludePrivatePreviewsAndRecordRunImagesShouldBeRecorded() {
+    RoborazziGradleRootProject(testProjectDir).previewModule.apply {
+      buildGradle.isIncludePrivatePreviews = true
+      record()
+
+      checkHasPrivatePreviewImages()
+    }
+  }
 }
 
 class PreviewModule(
@@ -35,20 +46,28 @@ class PreviewModule(
   companion object {
     val moduleName = "sample-generate-preview-tests"
   }
+
   val buildGradle = BuildGradle(testProjectDir)
 
   class BuildGradle(private val projectFolder: TemporaryFolder) {
     private val PATH = moduleName + "/build.gradle.kts"
     var isKmp = false
+    var isIncludePrivatePreviews = false
     fun write() {
       val file =
         projectFolder.root.resolve(PATH)
       file.parentFile.mkdirs()
+      val includePrivatePreviewsExpr = if (isIncludePrivatePreviews) {
+        """includePrivatePreviews = $isIncludePrivatePreviews"""
+      } else {
+        ""
+      }
       val roborazziExtension = """
           roborazzi {
             generateComposePreviewRobolectricTests {
               enable = true
               packages = listOf("com.github.takahirom.preview.tests")
+              $includePrivatePreviewsExpr
             }
           }
       """.trimIndent()
@@ -89,7 +108,7 @@ class PreviewModule(
           }
 
       """.trimIndent()
-      val buildGradleText = if(isKmp)
+      val buildGradleText = if (isKmp)
         """
           plugins {
               kotlin("multiplatform")
@@ -144,7 +163,7 @@ class PreviewModule(
               maven { url = uri("https://jitpack.io") }
           }
         """.trimIndent()
-        else """
+      else """
   plugins {
     id("com.android.application")
   //  id("com.android.library")
@@ -205,4 +224,13 @@ class PreviewModule(
     println("images:" + images?.toList())
     assert(images?.isNotEmpty() == true)
   }
+
+  fun checkHasPrivatePreviewImages() {
+    val privateImages =
+      testProjectDir.root.resolve("$moduleName/build/outputs/roborazzi/").listFiles()
+        .orEmpty()
+        .filter { it.name.contains("PreviewWithPrivate") }
+    println("images:" + privateImages.toList())
+    assert(privateImages.isNotEmpty() == true)
+  }
 }

include-build/roborazzi-gradle-plugin/src/integrationTest/projects/sample-generate-preview-tests/src/main/java/com/github/takahirom/preview/tests/Previews.kt

@@ -53,6 +53,23 @@ fun PreviewDarkMode() {
   }
 }
 
+@Preview
+@Composable
+private fun PreviewWithPrivate() {
+  val isSystemInDarkTheme = isSystemInDarkTheme()
+  MaterialTheme {
+    Card(
+      Modifier
+        .width(180.dp)
+    ) {
+      Text(
+        modifier = Modifier.padding(8.dp),
+        text = "This is private preview"
+      )
+    }
+  }
+}
+
 @Preview(
   name = "Preview Name",
   // These properties are not supported by Roborazzi yet.

include-build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/GenerateComposePreviewRobolectricTestsExtension.kt

@@ -19,6 +19,7 @@ import org.gradle.api.tasks.testing.Test
 import org.gradle.invocation.DefaultGradle
 import java.io.File
 import java.net.URLEncoder
+import java.util.Locale
 import javax.inject.Inject
 
 open class GenerateComposePreviewRobolectricTestsExtension @Inject constructor(objects: ObjectFactory) {
@@ -31,10 +32,10 @@ open class GenerateComposePreviewRobolectricTestsExtension @Inject constructor(o
   val packages: ListProperty<String> = objects.listProperty(String::class.java)
 
   /**
-   * The fully qualified class name of the custom test class that implements [com.github.takahirom.roborazzi.ComposePreviewTester].
+   * If true, the private previews will be included in the test.
    */
-  val testerQualifiedClassName: Property<String> = objects.property(String::class.java)
-    .convention("com.github.takahirom.roborazzi.AndroidComposePreviewTester")
+  val includePrivatePreviews: Property<Boolean> = objects.property(Boolean::class.java)
+    .convention(false)
 
   /**
    * [robolectricConfig] will be passed to the Robolectric's @Config annotation in the generated test class.
@@ -48,6 +49,14 @@ open class GenerateComposePreviewRobolectricTestsExtension @Inject constructor(o
           "qualifiers" to "RobolectricDeviceQualifiers.Pixel4a",
         )
       )
+
+  /**
+   * The fully qualified class name of the custom test class that implements [com.github.takahirom.roborazzi.ComposePreviewTester].
+   * This is advanced usage. You can implement your own test class that implements [com.github.takahirom.roborazzi.ComposePreviewTester].
+   */
+  val testerQualifiedClassName: Property<String> = objects.property(String::class.java)
+    .convention("com.github.takahirom.roborazzi.AndroidComposePreviewTester")
+
 }
 
 fun generateComposePreviewRobolectricTestsIfNeeded(
@@ -63,7 +72,7 @@ fun generateComposePreviewRobolectricTestsIfNeeded(
   setupGenerateComposePreviewRobolectricTestsTask(
     project = project,
     variant = variant,
-    scanPackages = extension.packages,
+    extension = extension,
     testerQualifiedClassName = extension.testerQualifiedClassName,
     robolectricConfig = extension.robolectricConfig
   )
@@ -79,23 +88,24 @@ fun generateComposePreviewRobolectricTestsIfNeeded(
 private fun setupGenerateComposePreviewRobolectricTestsTask(
   project: Project,
   variant: Variant,
-  scanPackages: ListProperty<String>,
+  extension: GenerateComposePreviewRobolectricTestsExtension,
   testerQualifiedClassName: Property<String>,
   robolectricConfig: MapProperty<String, String>,
 ) {
-  check(scanPackages.get().orEmpty().isNotEmpty()) {
+  check(extension.packages.get().orEmpty().isNotEmpty()) {
     "Please set roborazzi.generateRobolectricPreviewTests.packages in the generatePreviewTests extension or set roborazzi.generateRobolectricPreviewTests.enable = false." +
       "See https://github.com/sergio-sastre/ComposablePreviewScanner?tab=readme-ov-file#how-to-use for more information."
   }
 
   val generateTestsTask = project.tasks.register(
-    "generate${variant.name.capitalize()}ComposePreviewRobolectricTests",
+    "generate${variant.name.capitalize(Locale.ROOT)}ComposePreviewRobolectricTests",
     GenerateComposePreviewRobolectricTestsTask::class.java
   ) {
     // It seems that this directory path is overridden by addGeneratedSourceDirectory.
     // The generated tests will be located in build/JAVA/generate[VariantName]ComposePreviewRobolectricTests.
     it.outputDir.set(project.layout.buildDirectory.dir("generated/roborazzi/preview-screenshot"))
-    it.scanPackageTrees.set(scanPackages)
+    it.scanPackageTrees.set(extension.packages)
+    it.includePrivatePreviews.set(extension.includePrivatePreviews)
     it.testerQualifiedClassName.set(testerQualifiedClassName)
     it.robolectricConfig.set(robolectricConfig)
   }
@@ -114,6 +124,9 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
   @get:Input
   var scanPackageTrees: ListProperty<String> = project.objects.listProperty(String::class.java)
 
+  @get:Input
+  abstract val includePrivatePreviews: Property<Boolean>
+
   @get:Input
   abstract val testerQualifiedClassName: Property<String>
 
@@ -126,6 +139,7 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
     testDir.mkdirs()
 
     val packagesExpr = scanPackageTrees.get().joinToString(", ") { "\"$it\"" }
+    val includePrivatePreviewsExpr = includePrivatePreviews.get()
 
     val generatedClassFQDN = "com.github.takahirom.roborazzi.RoborazziPreviewParameterizedTests"
     val packageName = generatedClassFQDN.substringBeforeLast(".")
@@ -140,8 +154,11 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
     File(directory, "$className.kt").writeText(
       """
             package $packageName
+            import org.junit.Rule
             import org.junit.Test
             import org.junit.runner.RunWith
+            import org.junit.rules.TestWatcher
+            import org.junit.rules.RuleChain
             import org.robolectric.ParameterizedRobolectricTestRunner
             import org.robolectric.annotation.Config
             import org.robolectric.annotation.GraphicsMode
@@ -158,26 +175,42 @@ abstract class GenerateComposePreviewRobolectricTestsTask : DefaultTask() {
             class $className(
                 private val preview: ComposablePreview<Any>,
             ) {
-
+                private val testLifecycleOptions = tester.options().testLifecycleOptions
+                @get:Rule
+                val rule = RuleChain.outerRule(
+                  if(testLifecycleOptions is ComposePreviewTester.Options.JUnit4TestLifecycleOptions) {
+                    (testLifecycleOptions as ComposePreviewTester.Options.JUnit4TestLifecycleOptions).testRule
+                  } else {
+                    object : TestWatcher() {}
+                  }
+                )
                 companion object {
+                    val tester = getComposePreviewTester("$testerQualifiedClassNameString")
                     // lazy for performance
                     val previews: List<ComposablePreview<Any>> by lazy {
-                        getComposePreviewTester("$testerQualifiedClassNameString").previews(
-                            $packagesExpr
-                        )
+                        setupDefaultOptions()
+                        tester.previews()
                     }
                     @JvmStatic
                     @ParameterizedRobolectricTestRunner.Parameters(name = "{0}")
-                    fun values(): List<ComposablePreview<Any>> =
-                        previews
+                    fun values(): List<ComposablePreview<Any>> = previews 
+
+                    fun setupDefaultOptions() {
+                        ComposePreviewTester.defaultOptionsFromPlugin = ComposePreviewTester.Options(
+                            scanOptions = ComposePreviewTester.Options.ScanOptions(
+                              packages = listOf($packagesExpr),
+                              includePrivatePreviews = $includePrivatePreviewsExpr, 
+                            )
+                        )
+                    }
                 }
 
 
                 @GraphicsMode(GraphicsMode.Mode.NATIVE)
                 $robolectricConfigString
                 @Test
                 fun test() {
-                    getComposePreviewTester("$testerQualifiedClassNameString").test(preview)
+                    tester.test(preview)
                 }
 
             }
@@ -289,7 +322,8 @@ private fun verifyLibraryDependencies(
     val dependencies = this
     val libNameArray = libraryName.split(":")
     if (!dependencies.contains(libNameArray[0] to libNameArray[1])) {
-      val configurationNames = "'testImplementation'(For Android Project) or 'kotlin.sourceSets.androidUnitTest.dependencies.implementation'(For KMP)"
+      val configurationNames =
+        "'testImplementation'(For Android Project) or 'kotlin.sourceSets.androidUnitTest.dependencies.implementation'(For KMP)"
       error(
         "Roborazzi: Please add the following $configurationNames dependency to the 'dependencies' block in the 'build.gradle' file: '$libraryName' for the $configurationNames configuration.\n" +
           "For your convenience, visit https://www.google.com/search?q=" + URLEncoder.encode(