Add assertSectionEquals method

TimothyGillespie · Apr 2, 2021 · Mar 21, 2021 · Mar 31, 2021 · Mar 31, 2021 · Mar 31, 2021
commit ac7140ef85e6376b5e37fa7ba45f1ddd8f7871d8
diff --git a/src/test/java/org/javawebstack/orm/test/shared/verification/QueryVerification.java b/src/test/java/org/javawebstack/orm/test/shared/verification/QueryVerification.java
@@ -50,12 +50,7 @@ public void assertSectionContains(String topLevelKeyword, String containedSubstr
         try {
             sectionString = getSection(topLevelKeyword, sectionIndex);
         } catch (SectionIndexOutOfBoundException e) {
-            fail(String.format(
-                    "A top level section of type %s and index %d was tested but only %d sections of that type existed.",
-                    e.getTopLevelKeyword(),
-                    e.getAttemptedIndex(),
-                    e.getSectionCount()
-            ));
+            this.failDueToSectionIndexOutOfBounds(e);
         }
 
         assertTrue(
@@ -74,6 +69,39 @@ public void assertOrderByContains(String containedSubstring) {
         this.assertSectionContains("ORDER BY", containedSubstring);
     }
 
+    /**
+     * Asserts that the first occurring section of a given top level keyword is equal to the given string.
+     * This method uses the String.equals method internally and is therefore case sensitive.
+     *
+     * @param topLevelKeyword The top level keyword that prefaces the section.
+     * @param expectedString The substring which the first section of the given type should be equal to.
+     */
+    public void assertSectionEquals(String topLevelKeyword, String expectedString) {
+        this.assertSectionEquals(topLevelKeyword, expectedString, 0);
+    }
+
+    /**
+     * Asserts that the i-th occurring section of a given top level keyword equal to the given string.
+     * This method uses the String.equals method internally and is therefore case sensitive.
+     *
+     * @param topLevelKeyword The top level keyword that prefaces the section.
+     * @param expectedString The substring which the specified section of the given type should be equal to.
+     * @param sectionIndex The index of the section to be checked, thus 0 refers to the first occurrence etc.
+     */
+    public void assertSectionEquals(String topLevelKeyword, String expectedString, int sectionIndex) {
+        String sectionString = null;
+        try {
+            sectionString = getSection(topLevelKeyword, sectionIndex);
+        } catch (SectionIndexOutOfBoundException e) {
+            this.failDueToSectionIndexOutOfBounds(e);
+        }
+
+        assertTrue(
+                sectionString.equals(expectedString),
+                String.format("The occurrence of index %d of %s section of the query was not equal to the string %s but looked like this: %s. Note that the match is case-sensitive.", sectionIndex, topLevelKeyword, expectedString, sectionString)
+        );
+    }
+
     /**
      * Retrieves the inner part of a section by its keyword. With multiple occurrences it will only retrieve the first
      * one. It does not include the keyword and one whitespaces at start and end.
@@ -123,4 +151,13 @@ public List<String> getSectionList(String topLevelKeyword) {
                 .getTopLevelSectionsByKeyword(topLevelKeyword);
     }
 
+    private void failDueToSectionIndexOutOfBounds(SectionIndexOutOfBoundException exception) {
+        fail(String.format(
+                "A top level section of type %s and index %d was tested but only %d sections of that type existed.",
+                exception.getTopLevelKeyword(),
+                exception.getAttemptedIndex(),
+                exception.getSectionCount()
+        ));
+    }
+
 }