matchers: docs console output improvements (#1564)

Author: MykolaGolubyev

webtau-core/src/test/java/org/testingisdocumenting/webtau/MatchersTest.java

@@ -44,7 +44,7 @@ public void removeStepReporter() {
 
     @Test
     public void stringComparisonExample() {
-        doc.console.capture("string-string-comparison", () -> {
+        doc.console.capture("string-string-comparison-output", () -> {
             // string-string-example
             String errorMessage = generateErrorMessage();
             actual(errorMessage).should(equal("insufficient disk space")); // string and string equality comparison
@@ -54,7 +54,7 @@ public void stringComparisonExample() {
 
     @Test
     public void stringNegativeComparisonExample() {
-        doc.console.capture("string-string-negative-comparison", () -> {
+        doc.console.capture("string-string-negative-comparison-output", () -> {
             // string-string-negative-example
             String errorMessage = generateErrorMessage();
             actual(errorMessage).shouldNot(equal("completed"));
@@ -64,7 +64,7 @@ public void stringNegativeComparisonExample() {
 
     @Test
     public void stringWaitExample() {
-        doc.console.capture("wait-message", () -> {
+        doc.console.capture("wait-message-output", () -> {
             // wait-consume-message
             actual(liveValue(this::consumeMessage)).waitTo(equal("message we wait for"));
             // wait-consume-message
@@ -73,7 +73,7 @@ public void stringWaitExample() {
 
     @Test
     public void stringWaitNegativeExample() {
-        doc.console.capture("wait-negative-message", () -> {
+        doc.console.capture("wait-negative-message-output", () -> {
             // wait-negative-consume-message
             actual(liveValue(this::consumeMessage)).waitToNot(equal("duplicate"));
             // wait-negative-consume-message
@@ -82,9 +82,11 @@ public void stringWaitNegativeExample() {
 
     @Test
     public void numberWaitExample() {
-        // wait-number-records
-        actual(liveValue(this::countRecords)).waitToBe(greaterThanOrEqual(5));
-        // wait-number-records
+        doc.console.capture("wait-tobe-output", () -> {
+            // wait-number-records
+            actual(liveValue(this::countRecords)).waitToBe(greaterThanOrEqual(5));
+            // wait-number-records
+        });
     }
 
     private String consumeMessage() {
@@ -98,7 +100,7 @@ private int countRecords() {
 
     @Test
     public void numberComparisonExample() {
-        doc.console.capture("number-number-comparison", () -> {
+        doc.console.capture("number-number-comparison-output", () -> {
             // number-number-example
             double price = calculatePrice();
             actual(price, "price").shouldBe(greaterThan(10)); // explict name to use in reporting
@@ -108,10 +110,12 @@ public void numberComparisonExample() {
 
     @Test
     public void numberAndStringExample() {
-        // string-number-example
-        String numberAsText = "200";
-        actual(numberAsText).shouldBe(greaterThan(150)); // text and number relative comparison
-        // string-number-example
+        doc.console.capture("string-number-comparison-output", () -> {
+            // string-number-example
+            String numberAsText = "200";
+            actual(numberAsText).shouldBe(greaterThan(150)); // text and number relative comparison
+            // string-number-example
+        });
     }
 
     @Test

webtau-docs/znai/matchers/any-value.md

@@ -6,17 +6,21 @@ provide a value but your focus is on different data.
 ```tabs
 Groovy: 
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
-  surroundedBy: "any-value-table-example"
+  surroundedBy: "any-value-table-example",
+  noGap: true,
+  noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/any-value-table-output.txt 
+
 :include-markdown: import-ref.md
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
-  surroundedBy: "any-value-table-example"
+  surroundedBy: "any-value-table-example",
+  noGap: true,
+  noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/any-value-table-output.txt 
+
 :include-markdown: import-ref.md
 ```
-
-:include-cli-output: doc-artifacts/any-value-table-output.txt {
-  title: "console output"
-}

webtau-docs/znai/matchers/introduction.md

@@ -1,7 +1,9 @@
 WebTau provides two ways to assert values: `should` and `waitTo`. They work for business logic testing, HTTP, Browser, and other layers.
 Methods accept a matcher as a second parameter:
 
+```attention-note
 WebTau provides console output for all the matching it does, regardless of whether it fails or passes.
+```
 
 # Should 
 
@@ -13,8 +15,12 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "should example",
     surroundedBy: "string-string-example",
-    commentsType: "remove"
+    commentsType: "remove",
+    noGap: true,
+    noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/string-string-comparison-output.txt 
+
  Note: Groovy has a shortcut for `equal` matcher.
 
 :include-markdown: import-ref.md
@@ -23,12 +29,15 @@ Java:
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "should example",
     surroundedBy: "string-string-example",
-    commentsType: "remove"
+    commentsType: "remove",
+    noGap: true,
+    noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/string-string-comparison-output.txt 
+
 :include-markdown: import-ref.md
 ``` 
 
-:include-cli-output: doc-artifacts/string-string-comparison.txt {title: "should console output"}
 
 Use `shouldBe` alias to make a better flow with matchers like `greaterThan`:
 
@@ -37,15 +46,21 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "shouldBe example",
     surroundedBy: "string-number-example",
-    commentsType: "remove"
+    commentsType: "remove",
+    noGap: true,
+    noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/string-number-comparison-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "shouldBe example",
     surroundedBy: "string-number-example",
-    commentsType: "remove"
+    commentsType: "remove",
+    noGap: true,
+    noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/string-number-comparison-output.txt 
 ``` 
 
 # WaitTo
@@ -56,32 +71,43 @@ Use `waitTo` to wait for a value to eventually match a matcher.
 Groovy: 
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "waitTo example",
-    surroundedBy: "wait-consume-message"
+    surroundedBy: "wait-consume-message",
+    noGap: true,
+    noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/wait-message-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "waitTo example",
-    surroundedBy: "wait-consume-message"
+    surroundedBy: "wait-consume-message",
+    noGap: true,
+    noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/wait-message-output.txt 
 ``` 
 
-:include-cli-output: doc-artifacts/wait-message.txt {title: "wait console output"}
 
 Use `waitToBe` alias to make a better flow with matchers like `greaterThan`:
 
 ```tabs
 Groovy: 
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "waitToBe example",
-    surroundedBy: "wait-number-records"
+    surroundedBy: "wait-number-records",
+    noGap: true,
+    noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/wait-tobe-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "waitToBe example",
-    surroundedBy: "wait-number-records"
+    surroundedBy: "wait-number-records",
+    noGap: true,
+    noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/wait-tobe-output.txt 
 ``` 
 
 # Negative Matching
@@ -93,35 +119,39 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "shouldNot example",
     surroundedBy: "string-string-negative-example",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 }
-:include-cli-output: doc-artifacts/string-string-negative-comparison.txt 
+:include-cli-output: doc-artifacts/string-string-negative-comparison-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "shouldNot example",
     surroundedBy: "string-string-negative-example",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 } 
-:include-cli-output: doc-artifacts/string-string-negative-comparison.txt 
+:include-cli-output: doc-artifacts/string-string-negative-comparison-output.txt 
 ``` 
 
 ```tabs
 Groovy: 
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "waitToNot example",
     surroundedBy: "wait-negative-consume-message",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 }
-:include-cli-output: doc-artifacts/wait-negative-message.txt 
+:include-cli-output: doc-artifacts/wait-negative-message-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "waitToNot example",
     surroundedBy: "wait-negative-consume-message",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 } 
-:include-cli-output: doc-artifacts/wait-negative-message.txt 
+:include-cli-output: doc-artifacts/wait-negative-message-output.txt 
 ``` 
 
 # Failure Output
@@ -135,15 +165,17 @@ Groovy:
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     title: "assertion",
     surroundedBy: "failed-list",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 }
 :include-cli-output: doc-artifacts/list-failure.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     title: "assertion",
     surroundedBy: "failed-list",
-    noGap: true
+    noGap: true,
+    noGapSeparator: true
 } 
 :include-cli-output: doc-artifacts/list-failure.txt 
 ``` 

webtau-docs/znai/matchers/java-beans-and-records.md

@@ -79,18 +79,22 @@ Use `contain` with `TableData` to partially compare list of java beans.
 Groovy: 
 :include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
     surroundedBy: "beans-table-contain-example",
-    commentsType: "inline"
+    commentsType: "inline",
+    noGap: true,
+    noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/beans-table-contain-output.txt 
 
 Java: 
 :include-file: org/testingisdocumenting/webtau/MatchersTest.java {
     surroundedBy: "beans-table-contain-example",
-    commentsType: "inline"
+    commentsType: "inline",
+    noGap: true,
+    noGapSeparator: true
 } 
+:include-cli-output: doc-artifacts/beans-table-contain-output.txt 
 ``` 
 
-:include-cli-output: doc-artifacts/beans-table-contain-output.txt {title: "contain handler output"}
-
 # Java Records 
 
 WebTau compares Java Records with maps and tables in the same way as Java Beans.

webtau-docs/znai/matchers/maps.md

@@ -5,20 +5,23 @@ When two maps are not equal, WebTau generates all the required info to investiga
 ```tabs
 Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersGroovyExamplesTest.groovy {
-  surroundedBy: "maps-equal-mismatch"
+  surroundedBy: "maps-equal-mismatch",
+  noGap: true,
+  noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/maps-equal-console-output.txt 
 :include-markdown: import-ref.md
 
 Java:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersJavaExamplesTest.java {
-  surroundedBy: "maps-equal-mismatch"
+  surroundedBy: "maps-equal-mismatch",
+  noGap: true,
+  noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/maps-equal-console-output.txt 
 :include-markdown: import-ref.md
 ```
 
-:include-cli-output: doc-artifacts/maps-equal-console-output.txt {
-  title: "console output"
-}
 
 # Contain
 
@@ -27,14 +30,18 @@ Use `contain` matcher to check if one map is a subset of another:
 ```tabs
 Groovy:
 :include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/MapMatchersGroovyExamplesTest.groovy {
-  surroundedBy: "maps-contain-mismatch"
+  surroundedBy: "maps-contain-mismatch",
+  noGap: true,
+  noGapSeparator: 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"
+  surroundedBy: "maps-contain-mismatch",
+  noGap: true,
+  noGapSeparator: true
 }
+:include-cli-output: doc-artifacts/maps-contain-console-output.txt 
 ```
 
-:include-cli-output: doc-artifacts/maps-contain-console-output.txt {
-  title: "console output"
-}