matchers: intro doc failure example update (#1593)

MykolaGolubyev · web-flow · commit c8f03207c56c · 2024-05-08T06:28:09.000-04:00
diff --git a/webtau-core/src/test/java/org/testingisdocumenting/webtau/MatchersTest.java b/webtau-core/src/test/java/org/testingisdocumenting/webtau/MatchersTest.java
@@ -346,19 +346,26 @@ private static TableData loadFromCsv(String fileName) {
 
     @Test
     public void listFailureExample() {
-        doc.console.capture("list-failure", () -> {
-            code(() -> {
-                List<?> values = Arrays.asList(
-                        1,
-                        "testing",
-                        map("key1", "hello", "key2", "world"));
-                // failed-list
-                actual(values).should(equal(Arrays.asList(
-                        1,
-                        "teasing",
-                        map("key1", "hello", "key2", "work"))));
-                // failed-list
-            }).should(throwException(AssertionError.class));
+        runExpectExceptionCaptureAndValidateOutput(AssertionError.class, "list-failure", """
+                X failed expecting [value] to equal [1, "teasing", {"key1": "hello", "key2": "work"}]:
+                    [value][1]:  actual: "testing" <java.lang.String>
+                               expected: "teasing" <java.lang.String>
+                                            ^
+                    [value][2].key2:  actual: "world" <java.lang.String>
+                                    expected: "work" <java.lang.String>
+                                                  ^ (Xms)
+                 \s
+                  [1, **"testing"**, {"key1": "hello", "key2": **"world"**}]""", () -> {
+            List<?> values = Arrays.asList(
+                    1,
+                    "testing",
+                    map("key1", "hello", "key2", "world"));
+            // failed-list
+            actual(values).should(equal(Arrays.asList(
+                    1,
+                    "teasing",
+                    map("key1", "hello", "key2", "work"))));
+            // failed-list
         });
     }
 
diff --git a/webtau-docs/pom.xml b/webtau-docs/pom.xml
@@ -59,7 +59,7 @@
             <plugin>
                 <groupId>org.testingisdocumenting.znai</groupId>
                 <artifactId>znai-maven-plugin</artifactId>
-                <version>1.66</version>
+                <version>1.69</version>
                 <executions>
                     <execution>
                         <id>guide</id>
diff --git a/webtau-docs/znai/browser/asynchronous-page.md b/webtau-docs/znai/browser/asynchronous-page.md
@@ -32,7 +32,7 @@ Note: any matcher that you can use with `should` and `shouldNot` can be used wit
 
 Use `change` matcher when you want to wait for any change of a value without knowing the specifics.
 
-:include-file: doc-artifacts/snippets/matchers/snapshotAndChange.groovy {title: "wait for change", noGap: true, noGapSeparator: true}
+:include-file: doc-artifacts/snippets/matchers/snapshotAndChange.groovy {title: "wait for change", noGap: true, noGapBorder: true}
 :include-cli-output: doc-artifacts/matchers.groovy-console-output.txt {startLine: "change matcher", endLine: "change matcher", excludeStartEnd: true}
 
 # Wait on url
diff --git a/webtau-docs/znai/browser/matchers.md b/webtau-docs/znai/browser/matchers.md
@@ -41,7 +41,7 @@ It is not required when you do an explicit comparison with the list on the right
 
 # Snapshot And Change
 
-:include-file: doc-artifacts/snippets/matchers/snapshotAndChange.groovy {title: "wait for change", noGap: true, noGapSeparator: true}
+:include-file: doc-artifacts/snippets/matchers/snapshotAndChange.groovy {title: "wait for change", noGap: true, noGapBorder: true}
 :include-cli-output: doc-artifacts/matchers.groovy-console-output.txt {startLine: "change matcher", endLine: "change matcher", excludeStartEnd: true}
 
 
diff --git a/webtau-docs/znai/matchers/any-value.md b/webtau-docs/znai/matchers/any-value.md
@@ -8,7 +8,7 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
   surroundedBy: "any-value-table-example",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/any-value-table-output.txt 
 
@@ -18,7 +18,7 @@ Java:
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
   surroundedBy: "any-value-table-example",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/any-value-table-output.txt 
 
diff --git a/webtau-docs/znai/matchers/introduction.md b/webtau-docs/znai/matchers/introduction.md
@@ -17,7 +17,7 @@ Groovy:
     surroundedBy: "string-string-example",
     commentsType: "remove",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-string-comparison-output.txt 
 
@@ -31,7 +31,7 @@ Java:
     surroundedBy: "string-string-example",
     commentsType: "remove",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/string-string-comparison-output.txt 
 
@@ -48,7 +48,7 @@ Groovy:
     surroundedBy: "string-number-example",
     commentsType: "remove",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-number-comparison-output.txt 
 
@@ -58,7 +58,7 @@ Java:
     surroundedBy: "string-number-example",
     commentsType: "remove",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/string-number-comparison-output.txt 
 ``` 
@@ -73,7 +73,7 @@ Groovy:
     title: "waitTo example",
     surroundedBy: "wait-consume-message",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/wait-message-output.txt 
 
@@ -82,7 +82,7 @@ Java:
     title: "waitTo example",
     surroundedBy: "wait-consume-message",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/wait-message-output.txt 
 ``` 
@@ -96,7 +96,7 @@ Groovy:
     title: "waitToBe example",
     surroundedBy: "wait-number-records",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/wait-tobe-output.txt 
 
@@ -105,7 +105,7 @@ Java:
     title: "waitToBe example",
     surroundedBy: "wait-number-records",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/wait-tobe-output.txt 
 ``` 
@@ -120,7 +120,7 @@ Groovy:
     title: "shouldNot example",
     surroundedBy: "string-string-negative-example",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-string-negative-comparison-output.txt 
 
@@ -129,7 +129,7 @@ Java:
     title: "shouldNot example",
     surroundedBy: "string-string-negative-example",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/string-string-negative-comparison-output.txt 
 ``` 
@@ -140,7 +140,7 @@ Groovy:
     title: "waitToNot example",
     surroundedBy: "wait-negative-consume-message",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/wait-negative-message-output.txt 
 
@@ -149,7 +149,7 @@ Java:
     title: "waitToNot example",
     surroundedBy: "wait-negative-consume-message",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/wait-negative-message-output.txt 
 ``` 
@@ -166,7 +166,7 @@ Groovy:
     title: "assertion",
     surroundedBy: "failed-list",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/list-failure.txt 
 
@@ -175,7 +175,7 @@ Java:
     title: "assertion",
     surroundedBy: "failed-list",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/list-failure.txt 
 ``` 
diff --git a/webtau-docs/znai/matchers/java-beans-and-records.md b/webtau-docs/znai/matchers/java-beans-and-records.md
@@ -81,7 +81,7 @@ Groovy:
     surroundedBy: "beans-table-contain-example",
     commentsType: "inline",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 }
 :include-cli-output: doc-artifacts/beans-table-contain-output.txt 
 
@@ -90,7 +90,7 @@ Java:
     surroundedBy: "beans-table-contain-example",
     commentsType: "inline",
     noGap: true,
-    noGapSeparator: true
+    noGapBorder: true
 } 
 :include-cli-output: doc-artifacts/beans-table-contain-output.txt 
 ``` 
diff --git a/webtau-docs/znai/matchers/maps.md b/webtau-docs/znai/matchers/maps.md
@@ -7,7 +7,7 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersGroovyExamplesTest.groovy {
   surroundedBy: "maps-equal-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/maps-equal-console-output.txt 
 :include-markdown: import-ref.md
@@ -16,7 +16,7 @@ Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersJavaExamplesTest.java {
   surroundedBy: "maps-equal-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/maps-equal-console-output.txt 
 :include-markdown: import-ref.md
@@ -32,15 +32,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersGroovyExamplesTest.groovy {
   surroundedBy: "maps-contain-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/maps-contain-console-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersJavaExamplesTest.java {
   surroundedBy: "maps-contain-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/maps-contain-console-output.txt 
 ```
diff --git a/webtau-docs/znai/matchers/strings.md b/webtau-docs/znai/matchers/strings.md
@@ -7,7 +7,7 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
   surroundedBy: "single-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/single-line-string-compare-output.txt 
 :include-markdown: import-ref.md
@@ -16,7 +16,7 @@ Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
   surroundedBy: "single-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/single-line-string-compare-output.txt 
 :include-markdown: import-ref.md
@@ -32,15 +32,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
   surroundedBy: "multi-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/multi-line-string-compare-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
   surroundedBy: "multi-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/multi-line-string-compare-output.txt 
 ```
@@ -62,15 +62,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
   surroundedBy: "extra-empty-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/extra-empty-line-string-compare-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
   surroundedBy: "extra-empty-line-compare",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/extra-empty-line-string-compare-output.txt 
 ```
@@ -84,15 +84,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
   surroundedBy: "multi-line-contains",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-contains-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
   surroundedBy: "multi-line-contains",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-contains-output.txt 
 ```
@@ -106,15 +106,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
   surroundedBy: "single-line-regexp",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-regexp-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
   surroundedBy: "single-line-regexp",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/string-regexp-output.txt 
 ```
diff --git a/webtau-docs/znai/matchers/tables.md b/webtau-docs/znai/matchers/tables.md
@@ -7,7 +7,7 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersGroovyExamplesTest.groovy {
   surroundedBy: "table-equal-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/table-equal-console-output.txt 
 :include-markdown: import-ref.md
@@ -16,7 +16,7 @@ Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersJavaExamplesTest.java {
   surroundedBy: "table-equal-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/table-equal-console-output.txt 
 :include-markdown: import-ref.md
@@ -31,15 +31,15 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersGroovyExamplesTest.groovy {
   surroundedBy: "table-contain-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/table-contain-console-output.txt 
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersJavaExamplesTest.java {
   surroundedBy: "table-contain-mismatch",
   noGap: true,
-  noGapSeparator: true
+  noGapBorder: true
 }
 :include-cli-output: doc-artifacts/table-contain-console-output.txt 
 ```
diff --git a/webtau-docs/znai/matchers/value-change.md b/webtau-docs/znai/matchers/value-change.md
diff --git a/webtau-docs/znai/reference/table-data.md b/webtau-docs/znai/reference/table-data.md
diff --git a/webtau-docs/znai/release-notes/2.4/doc-2024-05-07-matchers-intro-failure-output-fix.md b/webtau-docs/znai/release-notes/2.4/doc-2024-05-07-matchers-intro-failure-output-fix.md
