Add roborazzi-compose-preview-scanner-support module to handle preview settings #427

takahirom · 2024-07-09T03:02:27Z

No description provided.

github-actions · 2024-07-09T03:08:25Z

Snapshot diff report

File name	Image
com.github.takahirom .preview.tests.Previ ewsKt.PreviewNormal_ compare.png
com.github.takahirom .preview.tests.Previ ewsKt.PreviewWithPro perties2.WITH_SYSTEM UI_WITH_BACKGROUND BG_COLOR_4278190335_ NIGHT_NEXUS_5_WALLPA PER_GREEN_DOMINATED_ compare.png
com.github.takahirom .preview.tests.Previ ewsKt.PreviewDarkMod e.NIGHT_compare.png
com.github.takahirom .preview.tests.Previ ewsKt.PreviewWithPro perties1.Preview_Nam e_Preview_Group_API_ LEVEL_30_W320dp_H640 dp_ja-rJP_FONT_1_5f_ compare.png

takahirom · 2024-07-09T03:14:51Z

roborazzi-compose-preview-scanner-support/build.gradle

+  compileOnly libs.androidx.compose.runtime
+  compileOnly libs.composable.preview.scanner
+  compileOnly libs.robolectric


It could be a point of discussion, but the current approach of depending on other libraries is using compileOnly in Roborazzi to prevent making breaking changes.

takahirom · 2024-07-09T03:25:51Z

...anner-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt

+  val robolectricCapturerClass =
+    System.getProperty("roborazzi.generateRobolectricPreview.capturer.classFQDN", null)
+  if (robolectricCapturerClass != null) {
+    val capturerClass = Class.forName(robolectricCapturerClass)
+    if (!RobolectricPreviewCapturer::class.java.isAssignableFrom(capturerClass)) {
+      throw IllegalArgumentException("The class $robolectricCapturerClass must implement RobolectricPreviewCapturer")
+    }
+    val capturer = capturerClass.getDeclaredConstructor().newInstance() as RobolectricPreviewCapturer
+    capturer.capture(preview)
+  } else {
+    DefaultRobolectricPreviewCapturer().capture(preview)
+  }


I've added the flexibility to customize using your own capturer to set up custom settings.

It might be good to have Gradle DSL option for this class setting.

sergio-sastre

@takahirom
It looks already good.
I just have a concern regarding the default device PIXEL4 collapsing with the default config (I've seen you can set "sdk", but can you also set "qualifiers")?
Feel free to ignore the comments if you do not find them relevant enough

sergio-sastre · 2024-07-09T07:22:50Z

...anner-support/src/main/java/com/github/takahirom/roborazzi/RobolectricPreviewInfosApplier.kt

+  }
+  setUiMode(preview.previewInfo.uiMode)
+
+  fun setLocale(locale: String) {


Minor:
Just for readability, I'd just move all these methods up and then execute

val preview = this setUiMode(preview.previewInfo.uiMode) setLocale(preview.previewInfo.locale) setFontScale(preview.previewInfo.fontScale)

I just thought that when we change this, we might need to frequently change the caller side as well. That's why I put it here. If we have other places to apply this, I would like to separate it. I think you're right normally, but I would like to try this style.

sergio-sastre · 2024-07-09T07:36:55Z

...ugin/src/main/java/io/github/takahirom/roborazzi/GenerateRobolectricPreviewTestsExtension.kt

@@ -168,17 +186,32 @@ abstract class GeneratePreviewScreenshotTestsTask : DefaultTask() {
  @get:Input
  var scanPackageTrees: ListProperty<String> = project.objects.listProperty(String::class.java)

+  @get:Input
+  abstract val customTestClassFQDN: Property<String>


I've checked the code where this is used and I still do not understand what FQDN stands for

I meant to say 'fully qualified name.' It seems that it's not a commonly used term. I'll rename this to 'customTestQualifiedClassName.' Thank you.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/qualified-name.html

sergio-sastre · 2024-07-09T07:48:48Z

...ugin/src/main/java/io/github/takahirom/roborazzi/GenerateRobolectricPreviewTestsExtension.kt

+  val robolectricConfig = objects.mapProperty(String::class.java, String::class.java)
+    .convention(
+      mapOf(
+        "sdk" to "[33]"


I am missing in the README.md how this is configured. Is it via Strings? If yes, I believe that is a bit error prone since only "sdk" and "qualifiers" are allowed, and it looks like the user could easily configure sth wrong?

Thanks. I've added 'qualifiers' to robolectricConfig and KDoc to clarify.
robolectricConfig will be passed to Robolectric's @Config annotation in the generated test class.
If the user makes a mistake, it will result in a compilation error in the generated code.

@Config(sdk = [33], qualifiers = RobolectricDeviceQualifiers.Pixel4a)

It's just a string, so users can pass the manifest file path, application class name, and maxSdk if they want.
The reason I added this option is that Robolectric's @Config has many options, and I thought users might want to set up the package for the Application class or Manifest path, and so on. However, managing all these options would be challenging.

Very true. I've also realised the user could also pass the fontScale there (it is the only config that is not passed via the qualifier string). For instance:
@Config(fontScale = 1.3f)

I would say that is a Config option we could ignore for now, since I believe not so many people will use it, and add it later, unless you think that is sth trivial to handle. Would create an issue not to forget about it though.

Since there are many options, maybe also makes sense to state in the README.md what options are supported, and even throw an error for those not supported yet.

But up to you, this looks already pretty good
Your call :)

sergio-sastre · 2024-07-09T07:51:58Z

...anner-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt

+  }
+
+  override fun test(preview: ComposablePreview<AndroidPreviewInfo>) {
+    RuntimeEnvironment.setQualifiers(RobolectricDeviceQualifiers.Pixel4a)


Here you are using Pixel4a, but the user could set its own default "qualifiers" together with the "sdk", right?

Thanks!
61944ed#diff-40c74b98bba110446d989a28a052af78498ff1a46e8b98c509fe5a750e23fc5bR34

sergio-sastre · 2024-07-09T07:54:44Z

sample-generate-preview-tests/src/main/java/com/github/takahirom/preview/tests/Previews.kt

@@ -38,7 +65,7 @@ fun Preview2() {
  apiLevel = 30,
  widthDp = 320,
  heightDp = 640,
-  locale = "ja_JP",
+  locale = "ja",


I always have issues to understand how locale strings look like :P but I believe "ja-rJP" should work for @previews as stated here:
https://developer.android.com/guide/topics/resources/providing-resources

It seems working now. Thanks!

sergio-sastre · 2024-07-09T08:00:48Z

...anner-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt

+  }
+
+  override fun test(preview: ComposablePreview<AndroidPreviewInfo>) {
+    RuntimeEnvironment.setQualifiers(RobolectricDeviceQualifiers.Pixel4a)


And I also expected the applyToRobolectricConfiguration() to be called after setting the device...
Somehow it seems to work because in the screenshot tests the dark mode is applied.
Out of curiosity... where is that method called?

Oh, I forgot to mention. I've added a new captureRoboImage() function that takes a ComposablePreview<AndroidPreviewInfo> parameter.
I've implemented it as shown below.
Even if users don't want to use the generateRobolectricPreviewTests Extension, they can use this roborazzi-compose-preview-scanner-support module to take preview screenshot tests.

@ExperimentalRoborazziApi fun ComposablePreview<AndroidPreviewInfo>.captureRoboImage( filePath: String = DefaultFileNameGenerator.generateFilePath("png"), roborazziOptions: RoborazziOptions = RoborazziOptions(), ) { val composablePreview = this composablePreview.applyToRobolectricConfiguration() // ← here captureRoboImage(filePath = filePath, roborazziOptions = roborazziOptions) { composablePreview() } }

Cool! It is very handy indeed!

…y user

…cument

takahirom · 2024-07-09T11:49:44Z

I've added the README section.

sergio-sastre · 2024-07-10T05:36:08Z

Snapshot diff report

File name Image
PreviewNormal_compare.png
PreviewWithProperties.Preview_Name_Preview_Group_API_LEVEL_30_W320dp_H640dp_ja-rJP_FONT_1_5f_WITH_SYSTEM_UI_WITH_BACKGROUND_BG_COLOR_4278190335_NIGHT_NEXUS_5_WALLPAPER_GREEN_DOMINATED_compare.png
PreviewDarkMode.NIGHT_compare.png

@takahirom
Minor:
I wonder what would be the name of the screenshot files if:

A Preview with the same test name and preview parameters is placed in another folder... Would be overwritten?

sergio-sastre

@takahirom
It looks very good to me. I wrote a couple of comments, but feel free to ignore them or handle them in next versions.

Already accepted. Let's ship it!

takahirom · 2024-07-10T05:49:49Z

@sergio-sastre

A Preview with the same test name and preview parameters is placed in another folder... Would be overwritten?

Yes, currently it is. Recently, I found that the Compose Preview Screenshot Testing by Google has made a good approach to this( New format: pkg/class/method_suffix.png ). I think we can add it to roborazzi.record.filePathStrategy, but the issue is that we are creating a path for the preview in the DefaultRobolectricPreviewTest. To implement this, it seems we would need to obtain the package name and class name.
https://android.googlesource.com/platform/tools/base/+/565124e60ced74eb5ad4274377abc60a7283a34c

We might have to be able to use the filePathStrategy for the preview.

sergio-sastre · 2024-07-10T18:20:41Z

@sergio-sastre

A Preview with the same test name and preview parameters is placed in another folder... Would be overwritten?

Yes, currently it is. Recently, I found that the Compose Preview Screenshot Testing by Google has made a good approach to this( New format: pkg/class/method_suffix.png ). I think we can add it to roborazzi.record.filePathStrategy, but the issue is that we are creating a path for the preview in the DefaultRobolectricPreviewTest. To implement this, it seems we would need to obtain the package name and class name. https://android.googlesource.com/platform/tools/base/+/565124e60ced74eb5ad4274377abc60a7283a34c

We might have to be able to use the filePathStrategy for the preview.

All good. I suggest to document it is a known issue, and tackle it in one of the next releases

…reviewTests

takahirom · 2024-07-11T01:09:32Z

Now it is using roborazzi.record.namingStrategy for naming. So if we add a new strategy we can use it.
f088830
https://github.com/takahirom/roborazzi?tab=readme-ov-file#roborazzirecordnamingstrategy

takahirom · 2024-07-11T01:11:43Z

I also changed the naming of generateRobolectricPreviewTests to generateRobolectric**Compose**PreviewTests.
We have Test Preview in our IDE plugin, and it would be a bit confusing otherwise.

sergio-sastre · 2024-07-11T04:48:57Z

Now it is using roborazzi.record.namingStrategy for naming. So if we add a new strategy we can use it. f088830 https://github.com/takahirom/roborazzi?tab=readme-ov-file#roborazzirecordnamingstrategy

Looks good!
I assume record naming strategy is the same for verifying right?

Just as remark: if the package name is too long it can lead to file not found/long name errors

I believe it is worth mentioning, in that case the user should choose another naming strategy

In my opinion, the first version looks ready 👍

takahirom · 2024-07-11T10:15:13Z

I'll release this.
But I'll rename generateRobolectricComposePreviewTests to generateComposePreviewRobolectricTests before that.

…reviewTests

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [io.github.takahirom.roborazzi](https://github.com/takahirom/roborazzi) | `1.21.0` -> `1.22.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.takahirom.roborazzi/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.takahirom.roborazzi/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.takahirom.roborazzi/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.takahirom.roborazzi/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-junit-rule](https://github.com/takahirom/roborazzi) | `1.21.0` -> `1.22.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.takahirom.roborazzi:roborazzi-junit-rule/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.takahirom.roborazzi:roborazzi-junit-rule/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.takahirom.roborazzi:roborazzi-junit-rule/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.takahirom.roborazzi:roborazzi-junit-rule/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-compose-desktop](https://github.com/takahirom/roborazzi) | `1.21.0` -> `1.22.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.takahirom.roborazzi:roborazzi-compose-desktop/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.takahirom.roborazzi:roborazzi-compose-desktop/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.takahirom.roborazzi:roborazzi-compose-desktop/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.takahirom.roborazzi:roborazzi-compose-desktop/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-compose](https://github.com/takahirom/roborazzi) | `1.21.0` -> `1.22.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.takahirom.roborazzi:roborazzi-compose/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.takahirom.roborazzi:roborazzi-compose/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.takahirom.roborazzi:roborazzi-compose/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.takahirom.roborazzi:roborazzi-compose/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi](https://github.com/takahirom/roborazzi) | `1.21.0` -> `1.22.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.takahirom.roborazzi:roborazzi/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.takahirom.roborazzi:roborazzi/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.takahirom.roborazzi:roborazzi/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.takahirom.roborazzi:roborazzi/1.21.0/1.22.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>takahirom/roborazzi (io.github.takahirom.roborazzi)</summary> ### [`v1.22.1`](https://github.com/takahirom/roborazzi/releases/tag/1.22.1) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.22.0...1.22.1) ### Bug fixes We've released Experimental Compose Preview Support in [1.22.0](https://github.com/takahirom/roborazzi/releases/tag/1.22.0). In this release, we are going to include a bug fix for it. The strategy of `generateComposePreviewRobolectricTests{}` is not to modify settings automatically, but to verify that the user settings are correct. This allows our settings to be the single source of truth. However, the assertion had some bugs, so I fixed them. #### What's Changed - \[Roborazzi Idea Plugin] Generate Roborazzi images via its IntelliJ Plugin by [@eyedol](https://github.com/eyedol) in [takahirom/roborazzi#429 (We will address this topic in a future release) - \[Bug fixes] Fix assertions in Automated Test Generation for Experimental Compose Preview Support by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#432 **Full Changelog**: takahirom/roborazzi@1.22.0...1.22.1 ### [`v1.22.0`](https://github.com/takahirom/roborazzi/releases/tag/1.22.0) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.21.0...1.22.0) ### Experimental Compose Preview Support 🚀 We're excited to announce the experimental release of [Compose Preview Support for Roborazzi](https://takahirom.github.io/roborazzi/preview-support.html), a powerful new feature that streamlines the process of generating screenshot tests for Jetpack Compose Previews. #### Key Features - **Automated Test Generation**: Automatically generate screenshot tests for Composable Previews using the [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) library - **Manual Integration Support**: For those who prefer more control, we've added helper functions to manually integrate Compose Preview screenshot tests. #### How to Use To enable Compose Preview screenshot test generation, add the following to your `build.gradle.kts`: ```kotlin roborazzi { generateComposePreviewRobolectricTests { enable = true } } ``` After configuration, run the `recordRoborazziDebug` task to generate screenshots using the newly created tests. #### Customization Options Customize your setup with options like: - Specifying package names to scan - Defining a custom test class - Configuring Robolectric settings #### Manual Integration For manual integration, add the following dependency: ```kotlin testImplementation("io.github.takahirom.roborazzi:roborazzi-compose-preview-scanner-support:[version]") ``` Then use the `ComposablePreview<AndroidPreviewInfo>.captureRoboImage()` function in your tests. Note that `ComposablePreview` is a class provided by the [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) library, which Roborazzi utilizes for this feature. This approach allows for more fine-grained control over the screenshot capture process for Compose Previews. #### Acknowledgements Special thanks to [@yschimke](https://github.com/yschimke) for the initial proposal, and to [@sergio-sastre](https://github.com/sergio-sastre) and [@yschimke](https://github.com/yschimke) for their valuable design and code reviews. For more detailed information on setup and usage, please visit our [documentation](https://takahirom.github.io/roborazzi/preview-support.html). ### Enhanced Accessibility Text Capture Thanks to [@lukas-mercari](https://github.com/lukas-mercari) 's contribution, we've improved accessibility text dumping for merged Compose elements. Both content descriptions and text are now captured, providing more comprehensive accessibility information in tests. ![image](https://github.com/user-attachments/assets/9b01a6b7-616b-46f8-bed8-cb2424eb9d17) #### What's Changed - \[roborazzi-idea-plugin] Fix: Icons are not shown in the new UI by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#421 - \[CI]Wait for main to succeed for compare ci by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#422 - \[CI] Remove main push trigger from compare ci by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#423 - \[CI] Add unit test for WebAssets class by [@eyedol](https://github.com/eyedol) in [takahirom/roborazzi#412 - \[Sample]Update dependency androidx.compose.foundation:foundation to v1.6.8 by [@renovate](https://github.com/renovate) in [takahirom/roborazzi#340 - \[Bug fixes] Dump both content description as well as text for the case when two elements are merged by [@lukas-mercari](https://github.com/lukas-mercari) in [takahirom/roborazzi#430 - \[Improvement] Add roborazzi-compose-preview-scanner-support module to handle preview settings by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#427 - \[Feature] Implement generateRobolectricPreviewTests prototype by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#416 **Full Changelog**: takahirom/roborazzi@1.21.0...1.22.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/chrisbanes/haze).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io.github.takahirom.roborazzi](https://github.com/takahirom/roborazzi) | plugin | minor | `1.21.0` -> `1.22.2` | | [io.github.takahirom.roborazzi:roborazzi-junit-rule](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.21.0` -> `1.22.2` | | [io.github.takahirom.roborazzi:roborazzi-compose](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.21.0` -> `1.22.2` | | [io.github.takahirom.roborazzi:roborazzi](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.21.0` -> `1.22.2` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>takahirom/roborazzi (io.github.takahirom.roborazzi)</summary> ### [`v1.22.2`](https://github.com/takahirom/roborazzi/releases/tag/1.22.2) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.22.1...1.22.2) ##### Notice [RobolectricPreviewTest and roborazzi.generateComposePreviewRobolectricTests.customTestQualifiedClassName](https://takahirom.github.io/roborazzi/preview-support.html#customizing-the-preview-screenshot-test) are used for customizing [Experimental Compose Preview Support](https://takahirom.github.io/roborazzi/preview-support.html). However, the name and class signature of RobolectricPreviewTest will be changed in a future release(not in 1.22.2) to support the Compose Multiplatform Preview Annotation. ##### Bug fixes We didn't have integration tests for [Experimental Compose Preview Support](https://takahirom.github.io/roborazzi/preview-support.html), so we added them. In KMP projects, we used to check only `testImplementation` (androidUnitTest.dependencies.implementation is used for KMP Android Unit tests), and the verification for generateComposePreviewRobolectricTests{} was failing. Therefore, we have added integration tests and fixed the behavior for KMP projects. ##### What's Changed - Refactor Roborazzi integration tests to support multiple modules by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#434 - Fix warning of RoborazziPreviewParameterizedTests by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#436 - Fix GenerateRobolectricComposePreviewTests to support KMP by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#435 **Full Changelog**: takahirom/roborazzi@1.22.1...1.22.2 ### [`v1.22.1`](https://github.com/takahirom/roborazzi/releases/tag/1.22.1) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.22.0...1.22.1) ##### Bug fixes We've released Experimental Compose Preview Support in [1.22.0](https://github.com/takahirom/roborazzi/releases/tag/1.22.0). In this release, we are going to include a bug fix for it. The strategy of `generateComposePreviewRobolectricTests{}` is not to modify settings automatically, but to verify that the user settings are correct. This allows our settings to be the single source of truth. However, the assertion had some bugs, so I fixed them. ##### What's Changed - \[Roborazzi Idea Plugin] Generate Roborazzi images via its IntelliJ Plugin by [@eyedol](https://github.com/eyedol) in [takahirom/roborazzi#429 (We will address this topic in a future release) - \[Bug fixes] Fix assertions in Automated Test Generation for Experimental Compose Preview Support by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#432 **Full Changelog**: takahirom/roborazzi@1.22.0...1.22.1 ### [`v1.22.0`](https://github.com/takahirom/roborazzi/releases/tag/1.22.0) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.21.0...1.22.0) ##### Experimental Compose Preview Support 🚀 We're excited to announce the experimental release of [Compose Preview Support for Roborazzi](https://takahirom.github.io/roborazzi/preview-support.html), a powerful new feature that streamlines the process of generating screenshot tests for Jetpack Compose Previews. ##### Key Features - **Automated Test Generation**: Automatically generate screenshot tests for Composable Previews using the [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) library - **Manual Integration Support**: For those who prefer more control, we've added helper functions to manually integrate Compose Preview screenshot tests. ##### How to Use To enable Compose Preview screenshot test generation, add the following to your `build.gradle.kts`: ```kotlin roborazzi { generateComposePreviewRobolectricTests { enable = true } } ``` After configuration, run the `recordRoborazziDebug` task to generate screenshots using the newly created tests. ##### Customization Options Customize your setup with options like: - Specifying package names to scan - Defining a custom test class - Configuring Robolectric settings ##### Manual Integration For manual integration, add the following dependency: ```kotlin testImplementation("io.github.takahirom.roborazzi:roborazzi-compose-preview-scanner-support:[version]") ``` Then use the `ComposablePreview<AndroidPreviewInfo>.captureRoboImage()` function in your tests. Note that `ComposablePreview` is a class provided by the [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner) library, which Roborazzi utilizes for this feature. This approach allows for more fine-grained control over the screenshot capture process for Compose Previews. ##### Acknowledgements Special thanks to [@yschimke](https://github.com/yschimke) for the initial proposal, and to [@sergio-sastre](https://github.com/sergio-sastre) and [@yschimke](https://github.com/yschimke) for their valuable design and code reviews. For more detailed information on setup and usage, please visit our [documentation](https://takahirom.github.io/roborazzi/preview-support.html). ##### Enhanced Accessibility Text Capture Thanks to [@lukas-mercari](https://github.com/lukas-mercari) 's contribution, we've improved accessibility text dumping for merged Compose elements. Both content descriptions and text are now captured, providing more comprehensive accessibility information in tests. ![image](https://github.com/user-attachments/assets/9b01a6b7-616b-46f8-bed8-cb2424eb9d17) ##### What's Changed - \[roborazzi-idea-plugin] Fix: Icons are not shown in the new UI by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#421 - \[CI]Wait for main to succeed for compare ci by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#422 - \[CI] Remove main push trigger from compare ci by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#423 - \[CI] Add unit test for WebAssets class by [@eyedol](https://github.com/eyedol) in [takahirom/roborazzi#412 - \[Sample]Update dependency androidx.compose.foundation:foundation to v1.6.8 by [@renovate](https://github.com/renovate) in [takahirom/roborazzi#340 - \[Bug fixes] Dump both content description as well as text for the case when two elements are merged by [@lukas-mercari](https://github.com/lukas-mercari) in [takahirom/roborazzi#430 - \[Improvement] Add roborazzi-compose-preview-scanner-support module to handle preview settings by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#427 - \[Feature] Implement generateRobolectricPreviewTests prototype by [@takahirom](https://github.com/takahirom) in [takahirom/roborazzi#416 **Full Changelog**: takahirom/roborazzi@1.21.0...1.22.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Add roborazzi-compose-preview-scanner-support module to handle previews

b4b980c

takahirom changed the title ~~Add roborazzi-compose-preview-scanner-support module to handle previews~~ Add roborazzi-compose-preview-scanner-support module to handle preview settings Jul 9, 2024

Remove confusing option of generatedClassFQDN

8e13b33

takahirom commented Jul 9, 2024

View reviewed changes

takahirom added 7 commits July 9, 2024 12:27

Add comment

6cd6181

Fix integration tests

2209e29

Add PreviewDarkMode preview

71669eb

Make it more customizable

ddb5173

Fix space

8abca87

Fix indent of generated code

f1f8c6c

Remove height of preview

31a28ce

sergio-sastre reviewed Jul 9, 2024

View reviewed changes

takahirom added 5 commits July 9, 2024 17:57

Use Config(qualifiers) instead of setQualifiers to be able to setup b…

61944ed

…y user

Rename customTestClassFQDN to customTestQualifiedClassName and add do…

305532a

…cument

Add comments

2dff108

Try ja-rJP

abba0f7

Add README section of Compose Preview Support

ad68387

sergio-sastre approved these changes Jul 10, 2024

View reviewed changes

takahirom added 5 commits July 10, 2024 15:27

Use roborazziDefaultNamingStrategy() for Preview

f088830

Fix naming of parameterized tests

7890958

Divide the preview into two preview to fix too long file name

6ce2d2a

Revert unneeded change

e6fbf6e

Add The supported @Preview annotation options section

2931d00

sergio-sastre approved these changes Jul 10, 2024

View reviewed changes

Change generateRobolectricPreviewTests to generateRobolectricComposeP…

2f18f28

…reviewTests

takahirom added 2 commits July 11, 2024 19:47

Rename generateRobolectricPreviewTests to generateRobolectricComposeP…

b261991

…reviewTests

Fix some warning and errors

1edaf3e

takahirom merged commit 6622443 into takahirom/add-autoPreviewScreenshots/2024-06-26 Jul 12, 2024
6 checks passed

takahirom deleted the takahirom/add-roborazzi-compose-preview-scanner-support/2024-07-09 branch July 12, 2024 10:31

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add roborazzi-compose-preview-scanner-support module to handle preview settings #427

Add roborazzi-compose-preview-scanner-support module to handle preview settings #427

takahirom commented Jul 9, 2024

github-actions bot commented Jul 9, 2024 •

edited

Loading

takahirom Jul 9, 2024

takahirom Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre left a comment

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024 •

edited

Loading

sergio-sastre Jul 10, 2024

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre Jul 9, 2024

takahirom Jul 9, 2024

sergio-sastre Jul 10, 2024

takahirom commented Jul 9, 2024 •

edited

Loading

sergio-sastre commented Jul 10, 2024 •

edited

Loading

sergio-sastre left a comment •

edited

Loading

takahirom commented Jul 10, 2024 •

edited

Loading

sergio-sastre commented Jul 10, 2024

takahirom commented Jul 11, 2024

takahirom commented Jul 11, 2024

sergio-sastre commented Jul 11, 2024 •

edited

Loading

takahirom commented Jul 11, 2024 •

edited

Loading

Add roborazzi-compose-preview-scanner-support module to handle preview settings #427

Add roborazzi-compose-preview-scanner-support module to handle preview settings #427

Conversation

takahirom commented Jul 9, 2024

github-actions bot commented Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergio-sastre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom commented Jul 9, 2024 • edited Loading

sergio-sastre commented Jul 10, 2024 • edited Loading

sergio-sastre left a comment • edited Loading

Choose a reason for hiding this comment

takahirom commented Jul 10, 2024 • edited Loading

sergio-sastre commented Jul 10, 2024

takahirom commented Jul 11, 2024

takahirom commented Jul 11, 2024

sergio-sastre commented Jul 11, 2024 • edited Loading

takahirom commented Jul 11, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

takahirom Jul 9, 2024 •

edited

Loading

takahirom commented Jul 9, 2024 •

edited

Loading

sergio-sastre commented Jul 10, 2024 •

edited

Loading

sergio-sastre left a comment •

edited

Loading

takahirom commented Jul 10, 2024 •

edited

Loading

sergio-sastre commented Jul 11, 2024 •

edited

Loading

takahirom commented Jul 11, 2024 •

edited

Loading