Roborazzi Test for Markdown Playground

gradle/libs.versions.toml

@@ -37,13 +37,15 @@ nullawayGradle = "2.1.0"
 okhttp = "5.0.0-alpha.12"
 okio = "3.9.1"
 retrofit = "2.11.0"
+roborazzi = "1.6.0"
 slack-lint = "0.8.2"
 sortDependencies = "0.7"
 spotless = "7.0.0.BETA4"
 sqldelight = "2.0.2"
 versionsPlugin = "0.51.0"
 wire = "5.1.0"
 xmlutil = "0.90.2"
+junit = "4.13.1"
 
 [plugins]
 bestPracticesPlugin = { id = "com.autonomousapps.plugin-best-practices-plugin", version = "0.10" }
@@ -68,6 +70,7 @@ moshiGradlePlugin = { id = "dev.zacsweers.moshix", version.ref = "moshix" }
 moshix = { id = "dev.zacsweers.moshix", version.ref = "moshix" }
 pluginUploader = { id = "dev.bmac.intellij.plugin-uploader", version = "1.3.5" }
 retry = { id = "org.gradle.test-retry", version.ref = "gradle-retry" }
+roborazzi = { id = "io.github.takahirom.roborazzi", version.ref = "roborazzi" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 sortDependencies = { id = "com.squareup.sort-dependencies", version.ref = "sortDependencies" }
 versionsPlugin = { id = "com.github.ben-manes.versions", version.ref = "versionsPlugin" }
@@ -139,6 +142,7 @@ okio-fakefilesystem = { module = "com.squareup.okio:okio-fakefilesystem", versio
 oshi = "com.github.oshi:oshi-core:6.6.5"
 retrofit = { module = "com.squareup.retrofit2:retrofit", version.ref = "retrofit" }
 retrofit-converters-wire = { module = "com.squareup.retrofit2:converter-wire", version.ref = "retrofit" }
+roborazzi = { module = "io.github.takahirom.roborazzi:roborazzi-compose-desktop", version.ref = "roborazzi" }
 rxjava = "io.reactivex.rxjava3:rxjava:3.1.9"
 sarif4k = "io.github.detekt.sarif4k:sarif4k:0.6.0"
 slackLints-checks = { module = "com.slack.lint:slack-lint-checks", version.ref = "slack-lint" }
@@ -147,4 +151,5 @@ slf4jNop = "org.slf4j:slf4j-nop:2.0.16"
 tikxml-htmlEscape = { module = "com.tickaroo.tikxml:converter-htmlescape", version = "0.8.15" }
 truth = "com.google.truth:truth:1.4.4"
 xmlutil-core = { module = "io.github.pdvrieze.xmlutil:core", version.ref = "xmlutil" }
-xmlutil-serialization = { module = "io.github.pdvrieze.xmlutil:serialization", version.ref = "xmlutil" }
+xmlutil-serialization = { module = "io.github.pdvrieze.xmlutil:serialization", version.ref = "xmlutil" }
+junit-junit = { group = "junit", name = "junit", version.ref = "junit" }

platforms/intellij/compose/playground/build.gradle.kts

@@ -14,12 +14,14 @@
  * limitations under the License.
  */
 import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
   alias(libs.plugins.kotlin.multiplatform)
   alias(libs.plugins.compose)
   alias(libs.plugins.kotlin.plugin.compose)
   alias(libs.plugins.lint)
+  alias(libs.plugins.roborazzi)
 }
 
 kotlin {
@@ -47,6 +49,14 @@ kotlin {
         implementation(projects.platforms.intellij.compose)
       }
     }
+    jvmTest {
+      dependencies {
+        implementation(libs.junit)
+        implementation(libs.roborazzi)
+        implementation(compose.desktop.common)
+        implementation(compose.desktop.uiTestJUnit4)
+      }
+    }
   }
 }
 
@@ -56,3 +66,7 @@ configurations
   .configureEach { attributes { attribute(KotlinPlatformType.attribute, KotlinPlatformType.jvm) } }
 
 dependencies { lintChecks(libs.composeLints) }
+
+tasks.withType<KotlinCompile>().configureEach {
+  compilerOptions { freeCompilerArgs.add("-Xcontext-receivers") }
+}

platforms/intellij/compose/playground/src/jvmMain/kotlin/foundry/intellij/compose/playground/MarkdownPlayground.kt

@@ -18,11 +18,13 @@ package foundry.intellij.compose.playground
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.padding
+import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.window.singleWindowApplication
 import foundry.intellij.compose.markdown.ui.MarkdownContent
@@ -31,11 +33,20 @@ import org.jetbrains.jewel.intui.standalone.theme.IntUiTheme
 import org.jetbrains.jewel.ui.component.DefaultButton
 import org.jetbrains.jewel.ui.component.Text
 
-fun main() = singleWindowApplication {
+fun main() {
+  singleWindowApplication { AppContent() }
+}
+
+// created function for testing
+@Composable
+fun AppContent() {
   var isDark by remember { mutableStateOf(false) }
   IntUiTheme(isDark) {
     Column(Modifier.background(JewelTheme.globalColors.panelBackground)) {
-      DefaultButton(modifier = Modifier.padding(16.dp), onClick = { isDark = !isDark }) {
+      DefaultButton(
+        modifier = Modifier.padding(16.dp).testTag("dark-mode-toggle"),
+        onClick = { isDark = !isDark },
+      ) {
         Text("Toggle dark mode")
       }
       MarkdownContent { MARKDOWN }

platforms/intellij/compose/playground/src/jvmTest/kotlin/foundry/intellij/compose/playground/MarkdownPlaygroundKtTest.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2024 Slack Technologies, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package foundry.intellij.compose.playground
+
+import androidx.compose.ui.test.ExperimentalTestApi
+import androidx.compose.ui.test.onNodeWithTag
+import androidx.compose.ui.test.onRoot
+import androidx.compose.ui.test.performClick
+import androidx.compose.ui.test.runDesktopComposeUiTest
+import com.github.takahirom.roborazzi.RoborazziOptions
+import io.github.takahirom.roborazzi.captureRoboImage
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class MarkdownPlaygroundKtTest {
+  @OptIn(ExperimentalTestApi::class)
+  @Test
+  fun test() = runTest {
+    runDesktopComposeUiTest {
+      setContent { AppContent() }
+
+      val roborazziOptions =
+        RoborazziOptions(
+          recordOptions = RoborazziOptions.RecordOptions(resizeScale = 0.5),
+          compareOptions = RoborazziOptions.CompareOptions(changeThreshold = 0F),
+        )
+
+      onRoot().captureRoboImage(roborazziOptions = roborazziOptions)
+
+      onNodeWithTag("dark-mode-toggle").performClick()
+
+      onRoot().captureRoboImage(roborazziOptions = roborazziOptions)
+    }
+  }
+}