feat: Improve the error messages in PlSqlCheckVerifierTest assertions

This commit enhances the clarity of error messages described in assertions within PlSqlCheckVerifierTest. This adjustment includes the precise expected value and the actual output, allowing for clearer comprehension of any errors thrown during the test's execution.
felipebz · Feb 9, 2024 · 25f8dc4 · 25f8dc4
1 parent 4ca6ac6
commit 25f8dc4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/zpa-checks-testkit/src/main/kotlin/org/sonar/plsqlopen/checks/verifier/PlSqlCheckVerifier.kt b/zpa-checks-testkit/src/main/kotlin/org/sonar/plsqlopen/checks/verifier/PlSqlCheckVerifier.kt
@@ -135,14 +135,12 @@ class PlSqlCheckVerifier : PlSqlCheck() {
             assertEquals(expected.startColumn, actual.primaryLocation().startLineOffset() + 1, "Bad start column at line ${expected.line}")
             assertEquals(expected.endColumn, actual.primaryLocation().endLineOffset() + 1, "Bad end column at line ${expected.line}")
             assertEquals(expected.endLine, actual.primaryLocation().endLine(), "Bad end line at line ${expected.line}")
-            if (expected.secondaryLines != null && expected.secondaryLines != secondary(actual)) {
-                throw AssertionError("Bad secondary locations at line ${expected.line} ==> expected: ${expected.secondaryLines} but was: ${secondary(actual)}")
-            }
+            assertEquals(expected.secondaryLines, secondary(actual), "Bad secondary locations at line ${expected.line}")
         }
 
         private fun assertEquals(expected: Any?, actual: Any?, message: String) {
             if (expected != null && expected != actual) {
-                throw AssertionError(message)
+                throw AssertionError("$message ==> expected: \"${expected}\" but was: \"${actual}\"")
             }
         }
 

diff --git a/...cks-testkit/src/test/kotlin/org/sonar/plsqlopen/checks/verifier/PlSqlCheckVerifierTest.kt b/...cks-testkit/src/test/kotlin/org/sonar/plsqlopen/checks/verifier/PlSqlCheckVerifierTest.kt
@@ -119,7 +119,7 @@ class PlSqlCheckVerifierTest {
             PlSqlCheckVerifier.verify("src/test/resources/check_verifier_incorrect_secondary_location.sql", visitor)
             fail("Test should fail")
         } catch (e: AssertionError) {
-            assertThat(e).hasMessage("Bad secondary locations at line 8 ==> expected: [4] but was: [3, 4]")
+            assertThat(e).hasMessage("Bad secondary locations at line 8 ==> expected: \"[4]\" but was: \"[3, 4]\"")
         }
     }
 
@@ -130,7 +130,7 @@ class PlSqlCheckVerifierTest {
             PlSqlCheckVerifier.verify("src/test/resources/check_verifier_incorrect_secondary_location2.sql", visitor)
             fail("Test should fail")
         } catch (e: AssertionError) {
-            assertThat(e).hasMessage("Bad secondary locations at line 8 ==> expected: [3, 4, 5] but was: [3, 4]")
+            assertThat(e).hasMessage("Bad secondary locations at line 8 ==> expected: \"[3, 4, 5]\" but was: \"[3, 4]\"")
         }
     }