Merge pull request #535 from takahirom/takahirom/fix-naming-of-assert…

…Prompt-to-assertionPrompt/2024-11-03 Fix the naming of `assertPrompt` to `assertionPrompt`
takahirom · Nov 3, 2024 · 7d1b417 · 7d1b417
2 parents 094b6b4 + bd582a4
commit 7d1b417
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -1105,11 +1105,11 @@ fun captureWithAi() {
     .captureRoboImage(
       roborazziOptions = provideRoborazziContext().options.addedAiAssertions(
         AiAssertionOptions.AiAssertion(
-          assertPrompt = "it should have PREVIOUS button",
+          assertionPrompt = "it should have PREVIOUS button",
           requiredFulfillmentPercent = 90,
         ),
         AiAssertionOptions.AiAssertion(
-          assertPrompt = "it should show First Fragment",
+          assertionPrompt = "it should show First Fragment",
           requiredFulfillmentPercent = 90,
         )
       )
@@ -1151,7 +1151,7 @@ compareOptions = RoborazziOptions.CompareOptions(
         return AiAssertionResults(
           aiAssertionResults = aiAssertionOptions.aiAssertions.map { assertion ->
             AiAssertionResult(
-              assertPrompt = assertion.assertPrompt,
+              assertionPrompt = assertion.assertionPrompt,
               fulfillmentPercent = fulfillmentPercent,
               requiredFulfillmentPercent = assertion.requiredFulfillmentPercent,
               failIfNotFulfilled = assertion.failIfNotFulfilled,
@@ -1163,7 +1163,7 @@ compareOptions = RoborazziOptions.CompareOptions(
     },
     aiAssertions = listOf(
       AiAssertionOptions.AiAssertion(
-        assertPrompt = "it should have PREVIOUS button",
+        assertionPrompt = "it should have PREVIOUS button",
         requiredFulfillmentPercent = 90,
       ),
     ),

diff --git a/docs/topics/ai_powered_image_assertion.md b/docs/topics/ai_powered_image_assertion.md
@@ -34,11 +34,11 @@ fun captureWithAi() {
     .captureRoboImage(
       roborazziOptions = provideRoborazziContext().options.addedAiAssertions(
         AiAssertionOptions.AiAssertion(
-          assertPrompt = "it should have PREVIOUS button",
+          assertionPrompt = "it should have PREVIOUS button",
           requiredFulfillmentPercent = 90,
         ),
         AiAssertionOptions.AiAssertion(
-          assertPrompt = "it should show First Fragment",
+          assertionPrompt = "it should show First Fragment",
           requiredFulfillmentPercent = 90,
         )
       )
@@ -80,7 +80,7 @@ compareOptions = RoborazziOptions.CompareOptions(
         return AiAssertionResults(
           aiAssertionResults = aiAssertionOptions.aiAssertions.map { assertion ->
             AiAssertionResult(
-              assertPrompt = assertion.assertPrompt,
+              assertionPrompt = assertion.assertionPrompt,
               fulfillmentPercent = fulfillmentPercent,
               requiredFulfillmentPercent = assertion.requiredFulfillmentPercent,
               failIfNotFulfilled = assertion.failIfNotFulfilled,
@@ -92,7 +92,7 @@ compareOptions = RoborazziOptions.CompareOptions(
     },
     aiAssertions = listOf(
       AiAssertionOptions.AiAssertion(
-        assertPrompt = "it should have PREVIOUS button",
+        assertionPrompt = "it should have PREVIOUS button",
         requiredFulfillmentPercent = 90,
       ),
     ),

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
@@ -178,7 +178,8 @@ data class RoborazziOptions(
           if (conditionResult.fulfillmentPercent < conditionResult.requiredFulfillmentPercent!!) {
             throw AssertionError(
               "The generated image did not meet the required prompt fulfillment percentage.\n" +
-                "prompt:${conditionResult.assertPrompt}\n" +
+                "assertionPrompt:${conditionResult.assertionPrompt}\n" +
+                "failIfNotFulfilled:${conditionResult.failIfNotFulfilled}\n" +
                 "aiAssertion.fulfillmentPercent:${conditionResult.fulfillmentPercent}\n" +
                 "requiredFulfillmentPercent:${conditionResult.requiredFulfillmentPercent}\n" +
                 "explanation:${conditionResult.explanation}"
@@ -247,12 +248,12 @@ data class RoborazziOptions(
 
   @ExperimentalRoborazziApi
   fun addedAiAssertion(
-    assert: String,
+    assertionPrompt: String,
     requiredFulfillmentPercent: Int
   ): RoborazziOptions {
     return addedAiAssertions(
       AiAssertionOptions.AiAssertion(
-        assertPrompt = assert,
+        assertionPrompt = assertionPrompt,
         requiredFulfillmentPercent = requiredFulfillmentPercent
       )
     )

diff --git a/...roborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/AiAssertionOptions.kt b/...roborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/AiAssertionOptions.kt
@@ -20,7 +20,7 @@ INPUT_PROMPT
   val inputPrompt: (AiAssertionOptions) -> String = { aiOptions ->
     buildString {
       aiOptions.aiAssertions.forEachIndexed { index, aiAssertion ->
-        appendLine("Assertion ${index + 1}: ${aiAssertion.assertPrompt}\n")
+        appendLine("Assertion ${index + 1}: ${aiAssertion.assertionPrompt}\n")
       }
     }
   },
@@ -40,7 +40,7 @@ INPUT_PROMPT
   }
 
   data class AiAssertion(
-    val assertPrompt: String,
+    val assertionPrompt: String,
     val failIfNotFulfilled: Boolean = true,
     /**
      * If null, the AI result is not validated. But the fulfillment_percent are still included in the report.

diff --git a/...uild/roborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/CaptureResult.kt b/...uild/roborazzi-core/src/commonMain/kotlin/com/github/takahirom/roborazzi/CaptureResult.kt
@@ -145,7 +145,7 @@ data class AiAssertionResults(
 @Serializable
 data class AiAssertionResult(
   @SerialName("assert_prompt")
-  val assertPrompt: String,
+  val assertionPrompt: String,
   @SerialName("required_fulfillment_percent")
   val requiredFulfillmentPercent: Int?,
   @SerialName("fail_if_not_fulfilled")

diff --git a/...razzi-ai-gemini/src/commonMain/kotlin/com/github/takahirom/roborazzi/GeminiRoborazziAi.kt b/...razzi-ai-gemini/src/commonMain/kotlin/com/github/takahirom/roborazzi/GeminiRoborazziAi.kt
@@ -94,7 +94,7 @@ class GeminiAiAssertionModel(
           explanation = "AI model did not return a result for this assertion"
         )
         AiAssertionResult(
-          assertPrompt = condition.assertPrompt,
+          assertionPrompt = condition.assertionPrompt,
           requiredFulfillmentPercent = condition.requiredFulfillmentPercent,
           failIfNotFulfilled = condition.failIfNotFulfilled,
           fulfillmentPercent = assertResult.fulfillmentPercent,

diff --git a/...razzi-ai-openai/src/commonMain/kotlin/com/github/takahirom/roborazzi/OpenAiRoborazziAi.kt b/...razzi-ai-openai/src/commonMain/kotlin/com/github/takahirom/roborazzi/OpenAiRoborazziAi.kt
@@ -195,7 +195,7 @@ private fun parseOpenAiResponse(
     val fulfillmentPercent = result?.fulfillmentPercent ?: 0
     val explanation = result?.explanation ?: "AI model did not return a result for this assertion"
     AiAssertionResult(
-      assertPrompt = condition.assertPrompt,
+      assertionPrompt = condition.assertionPrompt,
       requiredFulfillmentPercent = condition.requiredFulfillmentPercent,
       failIfNotFulfilled = condition.failIfNotFulfilled,
       fulfillmentPercent = fulfillmentPercent,

diff --git a/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/GeminiAiAiTest.kt b/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/GeminiAiAiTest.kt
@@ -60,11 +60,11 @@ class GeminiAiAiTest {
       .captureRoboImage(
         roborazziOptions = provideRoborazziContext().options.addedAiAssertions(
           AiAssertionOptions.AiAssertion(
-            assertPrompt = "it should have PREVIOUS button",
+            assertionPrompt = "it should have PREVIOUS button",
             requiredFulfillmentPercent = 90,
           ),
           AiAssertionOptions.AiAssertion(
-            assertPrompt = "it should show First Fragment",
+            assertionPrompt = "it should show First Fragment",
             requiredFulfillmentPercent = 90,
           )
         )

diff --git a/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/OpenAiTest.kt b/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/OpenAiTest.kt
@@ -61,11 +61,11 @@ class OpenAiTest {
       .captureRoboImage(
         roborazziOptions = provideRoborazziContext().options.addedAiAssertions(
           AiAssertionOptions.AiAssertion(
-            assertPrompt = "it should have PREVIOUS button",
+            assertionPrompt = "it should have PREVIOUS button",
             requiredFulfillmentPercent = 90,
           ),
           AiAssertionOptions.AiAssertion(
-            assertPrompt = "it should show First Fragment",
+            assertionPrompt = "it should show First Fragment",
             requiredFulfillmentPercent = 90,
           )
         )

diff --git a/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/boxed/AiManualTest.kt b/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/boxed/AiManualTest.kt
@@ -75,7 +75,7 @@ class AiManualTest {
             return AiAssertionResults(
               aiAssertionResults = aiAssertionOptions.aiAssertions.map { assertion ->
                 AiAssertionResult(
-                  assertPrompt = assertion.assertPrompt,
+                  assertionPrompt = assertion.assertionPrompt,
                   fulfillmentPercent = fulfillmentPercent,
                   requiredFulfillmentPercent = assertion.requiredFulfillmentPercent,
                   failIfNotFulfilled = assertion.failIfNotFulfilled,
@@ -87,7 +87,7 @@ class AiManualTest {
         },
         aiAssertions = listOf(
           AiAssertionOptions.AiAssertion(
-            assertPrompt = "it should have PREVIOUS button",
+            assertionPrompt = "it should have PREVIOUS button",
             requiredFulfillmentPercent = 90,
           ),
         ),