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,40 @@ class GeneratePreviewTestTest {
       checkHasImages()
     }
   }
+
+  @Test
+  fun whenDisablePreviewAndRecordRunImagesShouldNotBeRecorded() {
+    RoborazziGradleRootProject(testProjectDir).previewModule.apply {
+      buildGradle.enable = false
+
+      record()
+
+      checkNoImages()
+    }
+  }
+
+  @Test
+  fun whenCustomTesterAndRecordRunImagesShouldBeRecordedAndCanSeeJUnitLog() {
+    RoborazziGradleRootProject(testProjectDir).previewModule.apply {
+      buildGradle.useCustomTester = true
+
+      record {
+        itShouldHaveJUnitRuleLog()
+      }
+
+      checkHasImages()
+    }
+  }
+
+  @Test
+  fun whenIncludePrivatePreviewsAndRecordRunImagesShouldBeRecorded() {
+    RoborazziGradleRootProject(testProjectDir).previewModule.apply {
+      buildGradle.isIncludePrivatePreviews = true
+      record()
+
+      checkHasPrivatePreviewImages()
+    }
+  }
 }
 
 class PreviewModule(
@@ -35,6 +70,7 @@ class PreviewModule(
   companion object {
     val moduleName = "sample-generate-preview-tests"
   }
+
   val buildGradle = BuildGradle(testProjectDir)
 
   class BuildGradle(private val projectFolder: TemporaryFolder) {
@@ -44,14 +80,8 @@ class PreviewModule(
       val file =
         projectFolder.root.resolve(PATH)
       file.parentFile.mkdirs()
-      val roborazziExtension = """
-          roborazzi {
-            generateComposePreviewRobolectricTests {
-              enable = true
-              packages = listOf("com.github.takahirom.preview.tests")
-            }
-          }
-      """.trimIndent()
+
+      val roborazziExtension = createRoborazziExtension()
       val androidBlock = """
           android {
             namespace = "com.github.takahirom.preview.tests"
@@ -89,7 +119,7 @@ class PreviewModule(
           }
 
       """.trimIndent()
-      val buildGradleText = if(isKmp)
+      val buildGradleText = if (isKmp)
         """
           plugins {
               kotlin("multiplatform")
@@ -144,7 +174,7 @@ class PreviewModule(
               maven { url = uri("https://jitpack.io") }
           }
         """.trimIndent()
-        else """
+      else """
   plugins {
     id("com.android.application")
   //  id("com.android.library")
@@ -180,10 +210,44 @@ class PreviewModule(
         buildGradleText.trimIndent()
       )
     }
+
+    var enable = true
+    var isIncludePrivatePreviews = false
+    var useCustomTester = false
+
+    private fun createRoborazziExtension(): String {
+      val includePrivatePreviewsExpr = if (isIncludePrivatePreviews) {
+        """includePrivatePreviews = $isIncludePrivatePreviews"""
+      } else {
+        ""
+      }
+      val customTesterExpr = if (useCustomTester) {
+        """testerQualifiedClassName = "com.github.takahirom.sample.CustomPreviewTester""""
+      } else {
+        ""
+      }
+      val roborazziExtension = """
+              roborazzi {
+                generateComposePreviewRobolectricTests {
+                  enable = $enable
+                  packages = listOf("com.github.takahirom.preview.tests")
+                  $includePrivatePreviewsExpr
+                  $customTesterExpr
+                }
+              }
+          """.trimIndent()
+      return roborazziExtension
+    }
+  }
+
+  fun record(checks: BuildResult.() -> Unit = {}) {
+    val result = runTask("recordRoborazziDebug")
+    result.checks()
   }
 
-  fun record() {
-    runTask("recordRoborazziDebug")
+  fun BuildResult.itShouldHaveJUnitRuleLog() {
+    assert(output.contains("JUnit4TestLifecycleOptions starting"))
+    assert(output.contains("JUnit4TestLifecycleOptions finished"))
   }
 
   private fun runTask(
@@ -205,4 +269,24 @@ class PreviewModule(
     println("images:" + images?.toList())
     assert(images?.isNotEmpty() == true)
   }
+
+  fun checkNoImages() {
+    val images = testProjectDir.root.resolve("$moduleName/build/outputs/roborazzi/").listFiles()
+    println("images:" + images?.toList())
+    checkResultCount(
+      testProjectDir.root.resolve("$moduleName/build/test-results/roborazzi/results-summary.json")
+      // All zero
+    )
+
+    assert(images?.isEmpty() == 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/java/io/github/takahirom/roborazzi/RoborazziGradleProject.kt

@@ -337,19 +337,7 @@ dependencies {
   ) {
     val recordedFile =
       testProjectDir.root.resolve("app/$buildDirName/test-results/roborazzi/results-summary.json")
-    val results = CaptureResults.fromJsonFile(recordedFile.absolutePath)
-    assert(results.resultSummary.recorded == recorded) {
-      "Expected count: $recorded, actual count: ${results.resultSummary.recorded} summary:${results.resultSummary}"
-    }
-    assert(results.resultSummary.added == added) {
-      "Expected count: $added, actual count: ${results.resultSummary.added} summary:${results.resultSummary}"
-    }
-    assert(results.resultSummary.changed == changed) {
-      "Expected count: $changed, actual count: ${results.resultSummary.changed} summary:${results.resultSummary}"
-    }
-    assert(results.resultSummary.unchanged == unchanged) {
-      "Expected count: $unchanged, actual count: ${results.resultSummary.unchanged} summary:${results.resultSummary}"
-    }
+    checkResultCount(recordedFile, recorded, added, changed, unchanged)
   }
 
   fun checkRecordedFileExists(path: String) {
@@ -646,3 +634,25 @@ class RoborazziTest {
 
   val buildGradle = BuildGradle(testProjectDir)
 }
+
+fun checkResultCount(
+  recordedFile: File,
+  recorded: Int = 0,
+  added: Int = 0,
+  changed: Int = 0,
+  unchanged: Int = 0
+) {
+  val results = CaptureResults.fromJsonFile(recordedFile.absolutePath)
+  assert(results.resultSummary.recorded == recorded) {
+    "Expected count: $recorded, actual count: ${results.resultSummary.recorded} summary:${results.resultSummary}"
+  }
+  assert(results.resultSummary.added == added) {
+    "Expected count: $added, actual count: ${results.resultSummary.added} summary:${results.resultSummary}"
+  }
+  assert(results.resultSummary.changed == changed) {
+    "Expected count: $changed, actual count: ${results.resultSummary.changed} summary:${results.resultSummary}"
+  }
+  assert(results.resultSummary.unchanged == unchanged) {
+    "Expected count: $unchanged, actual count: ${results.resultSummary.unchanged} summary:${results.resultSummary}"
+  }
+}

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/integrationTest/projects/sample-generate-preview-tests/src/test/java/com/github/takahirom/sample/CustomPreviewTester.kt

@@ -0,0 +1,26 @@
+package com.github.takahirom.sample
+
+import org.junit.Assert.*
+import com.github.takahirom.roborazzi.*
+import org.junit.rules.TestWatcher
+import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
+
+class CustomPreviewTester : ComposePreviewTester<AndroidPreviewInfo> by AndroidComposePreviewTester() {
+  override fun options(): ComposePreviewTester.Options = super.options().copy(
+    testLifecycleOptions = ComposePreviewTester.Options.JUnit4TestLifecycleOptions(
+      testRuleFactory = {
+        object : TestWatcher() {
+          override fun starting(description: org.junit.runner.Description?) {
+            println("JUnit4TestLifecycleOptions starting")
+            super.starting(description)
+          }
+
+          override fun finished(description: org.junit.runner.Description?) {
+            println("JUnit4TestLifecycleOptions finished")
+            super.finished(description)
+          }
+        }
+      }
+    )
+  )
+}