Add roborazzi.compare.output.dir gradle.properties

takahirom · Dec 6, 2024 · 9ed4b4e · 9ed4b4e
1 parent 10c66ac
commit 9ed4b4e
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 3 deletions.
diff --git a/...oborazzi-core/src/commonJvmMain/kotlin/com/github/takahirom/roborazzi/RoborazziOptions.kt b/...oborazzi-core/src/commonJvmMain/kotlin/com/github/takahirom/roborazzi/RoborazziOptions.kt
@@ -116,7 +116,7 @@ data class RoborazziOptions(
   }
 
   data class CompareOptions(
-    val outputDirectoryPath: String = roborazziSystemPropertyOutputDirectory(),
+    val outputDirectoryPath: String = roborazziSystemPropertyCompareOutputDirectory(),
     val imageComparator: ImageComparator = DefaultImageComparator,
     val comparisonStyle: ComparisonStyle = ComparisonStyle.Grid(),
     val aiAssertionOptions: AiAssertionOptions? = null,
@@ -127,7 +127,7 @@ data class RoborazziOptions(
       imageComparator: ImageComparator = DefaultImageComparator,
       resultValidator: (result: ImageComparator.ComparisonResult) -> Boolean = DefaultResultValidator,
     ): this(
-      outputDirectoryPath = roborazziSystemPropertyOutputDirectory(),
+      outputDirectoryPath = roborazziSystemPropertyCompareOutputDirectory(),
       imageComparator = imageComparator,
       resultValidator = resultValidator,
     )
@@ -145,7 +145,7 @@ data class RoborazziOptions(
     }
 
     constructor(
-      outputDirectoryPath: String = roborazziSystemPropertyOutputDirectory(),
+      outputDirectoryPath: String = roborazziSystemPropertyCompareOutputDirectory(),
       /**
        * This value determines the threshold of pixel change at which the diff image is output or not.
        * The value should be between 0 and 1

diff --git a/...oborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/RoborazziProperties.kt b/...oborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/RoborazziProperties.kt
@@ -8,6 +8,11 @@ fun roborazziSystemPropertyOutputDirectory(): String {
   return getSystemProperty("roborazzi.output.dir", DEFAULT_ROBORAZZI_OUTPUT_DIR_PATH)
 }
 
+@ExperimentalRoborazziApi
+fun roborazziSystemPropertyCompareOutputDirectory(): String {
+  return getSystemProperty("roborazzi.compare.output.dir", roborazziSystemPropertyOutputDirectory())
+}
+
 @ExperimentalRoborazziApi
 fun roborazziSystemPropertyImageExtension(): String {
   return getSystemProperty("roborazzi.record.image.extension", "png")

diff --git a/...e-plugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProject.kt b/...e-plugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProject.kt
@@ -468,6 +468,11 @@ class MainActivity : ComponentActivity() {
     file.appendText("\nroborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory")
   }
 
+  fun addCompareOutputDirPathGradleProperty() {
+    val file = testProjectDir.root.resolve("gradle.properties")
+    file.appendText("\nroborazzi.compare.output.dir=build/outputs/custom_compare_outputDirectoryPath")
+  }
+
   fun addRuleTest() {
     val file =
       testProjectDir.root.resolve("app/src/test/java/com/github/takahirom/integration_test_project/RoborazziTest.kt")

diff --git a/...ugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProjectTest.kt b/...ugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProjectTest.kt
@@ -494,6 +494,22 @@ class RoborazziGradleProjectTest {
     }
   }
 
+  @Test
+  fun compareWithGradlePropertyPath() {
+    RoborazziGradleRootProject(testProjectDir).appModule.apply {
+      addCompareOutputDirPathGradleProperty()
+      record()
+      changeScreen()
+      compare()
+
+      checkResultsSummaryFileExists()
+
+      checkRecordedFileExists("$screenshotAndName.testCapture.png")
+      checkRecordedFileExists("app/build/outputs/custom_compare_outputDirectoryPath/$className.testCapture_compare.png")
+      checkRecordedFileNotExists("$screenshotAndName.testCapture_compare.png")
+    }
+  }
+
   @Test
   fun secondImagesIsSkippedIfFirstVerificationFails() {
     RoborazziGradleRootProject(testProjectDir).appModule.apply {