matchers: limit report details output (#1538)

Author: MykolaGolubyev

webtau-core/src/main/java/org/testingisdocumenting/webtau/cfg/WebTauConfig.java

@@ -59,6 +59,8 @@ public class WebTauConfig implements PrettyPrintable {
 
     private final ConfigValue tableVerticalSeparator = declare("tableVerticalSeparator", "string to use as a vertical separator when print TableData", () -> " \u2502 ");
 
+    private final ConfigValue matchersReportEntriesLimit = declare("matchersReportEntriesLimit",
+            "max number of entries for <mismatches>/<missing> to display when matcher fails", () -> 10);
     private final ConfigValue consolePayloadOutputLimit = declare("consolePayloadOutputLimit",
             "max number of lines to display in console for outputs (e.g. http response)", () -> 500);
 
@@ -163,6 +165,10 @@ public boolean getFullStackTrace() {
         return fullStackTrace.getAsBoolean();
     }
 
+    public int getMatchersReportEntriesLimit() {
+        return matchersReportEntriesLimit.getAsInt();
+    }
+
     public int getConsolePayloadOutputLimit() {
         return consolePayloadOutputLimit.getAsInt();
     }

webtau-core/src/main/java/org/testingisdocumenting/webtau/expectation/TokenizedReportUtils.java

@@ -16,6 +16,7 @@
 
 package org.testingisdocumenting.webtau.expectation;
 
+import org.testingisdocumenting.webtau.cfg.WebTauConfig;
 import org.testingisdocumenting.webtau.data.ValuePath;
 import org.testingisdocumenting.webtau.expectation.equality.ValuePathMessage;
 import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
@@ -61,7 +62,14 @@ public static TokenizedMessage combineReportParts(TokenizedMessage... parts) {
         return result;
     }
 
-    public static TokenizedMessage generateReportPartWithoutLabel(ValuePath topLevelActualPath, Stream<List<ValuePathMessage>> messagesGroupsStream) {
+    public static TokenizedMessage generateReportPartWithoutLabel(ValuePath topLevelActualPath,
+                                                                  Stream<List<ValuePathMessage>> messagesGroupsStream) {
+        return generateReportPartWithoutLabel(topLevelActualPath, messagesGroupsStream, WebTauConfig.getCfg().getMatchersReportEntriesLimit());
+    }
+
+    public static TokenizedMessage generateReportPartWithoutLabel(ValuePath topLevelActualPath,
+                                                                  Stream<List<ValuePathMessage>> messagesGroupsStream,
+                                                                  int maxNumberOfEntries) {
         List<List<ValuePathMessage>> messagesGroups = messagesGroupsStream.filter(group -> !group.isEmpty()).toList();
         if (messagesGroups.isEmpty()) {
             return tokenizedMessage();
@@ -70,7 +78,7 @@ public static TokenizedMessage generateReportPartWithoutLabel(ValuePath topLevel
         TokenizedMessage result = tokenizedMessage();
         int groupIdx = 0;
         for (List<ValuePathMessage> group : messagesGroups) {
-            TokenizedReportUtils.appendToReport(result, topLevelActualPath, group);
+            TokenizedReportUtils.appendToReport(result, topLevelActualPath, group, maxNumberOfEntries);
 
             boolean isLastGroup = groupIdx == messagesGroups.size() - 1;
             if (!isLastGroup) {
@@ -83,9 +91,19 @@ public static TokenizedMessage generateReportPartWithoutLabel(ValuePath topLevel
         return result;
     }
 
-    public static TokenizedMessage appendToReport(TokenizedMessage report, ValuePath topLevelActualPath, List<ValuePathMessage> messages) {
+    private static void appendToReport(TokenizedMessage report,
+                                       ValuePath topLevelActualPath,
+                                       List<ValuePathMessage> messages,
+                                       int maxNumberOfEntries) {
+        boolean needToLimit = messages.size() > maxNumberOfEntries;
         int messageIdx = 0;
         for (ValuePathMessage message : messages) {
+            boolean reachedLimit = needToLimit && messageIdx == maxNumberOfEntries;
+            if (reachedLimit) {
+                report.delimiter("...");
+                return;
+            }
+
             boolean useFullMessage = !message.getActualPath().equals(topLevelActualPath);
             report.add(useFullMessage ? message.getFullMessage() : message.getMessage());
 
@@ -95,7 +113,5 @@ public static TokenizedMessage appendToReport(TokenizedMessage report, ValuePath
             }
             messageIdx++;
         }
-
-        return report;
     }
 }

webtau-core/src/test/groovy/org/testingisdocumenting/webtau/expectation/TokenizedReportUtilsTest.groovy

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.expectation
+
+import org.junit.Test
+import org.testingisdocumenting.webtau.data.ValuePath
+import org.testingisdocumenting.webtau.expectation.equality.ValuePathMessage
+
+import java.util.stream.Stream
+
+import static org.testingisdocumenting.webtau.WebTauCore.*
+
+class TokenizedReportUtilsTest {
+    @Test
+    void "should limit number of details when specified"() {
+        def messages = [
+                new ValuePathMessage(new ValuePath("p1"), tokenizedMessage().error("message 1")),
+                new ValuePathMessage(new ValuePath("p2"), tokenizedMessage().error("message 2")),
+                new ValuePathMessage(new ValuePath("p3"), tokenizedMessage().error("message 3")),
+        ]
+
+        def report = TokenizedReportUtils.generateReportPartWithoutLabel(new ValuePath("root"), Stream.of(messages), 2)
+        actual(report.toString()).should equal("p1: message 1\n" +
+                "p2: message 2\n" +
+                "...")
+    }
+
+    @Test
+    void "should not limit number of details when exact match in count"() {
+        def messages = [
+                new ValuePathMessage(new ValuePath("p1"), tokenizedMessage().error("message 1")),
+                new ValuePathMessage(new ValuePath("p2"), tokenizedMessage().error("message 2")),
+                new ValuePathMessage(new ValuePath("p3"), tokenizedMessage().error("message 3")),
+        ]
+
+        def report = TokenizedReportUtils.generateReportPartWithoutLabel(new ValuePath("root"), Stream.of(messages), 3)
+        actual(report.toString()).should equal("p1: message 1\n" +
+                "p2: message 2\n" +
+                "p3: message 3")
+    }
+}

webtau-core/src/test/java/org/example/domain/CustomComplexDataTest.java

@@ -67,15 +67,16 @@ public void complexDataEqualsEachOtherUsingWebTau() {
         expected.addRow(3, 5);
 
         runExpectExceptionCaptureAndValidateOutput(AssertionError.class, "custom-complex-data-webtau-fail-output",
-                "X failed expecting [value] to equal cA │ cB\n" +
-                        "                                     1 │  2\n" +
-                        "                                     3 │  5:\n" +
-                        "    [value][1].cB:  actual: 4 <java.lang.Integer>\n" +
-                        "                  expected: 5 <java.lang.Integer> (Xms)\n" +
-                        "  \n" +
-                        "  cA │ cB   \n" +
-                        "   1 │     2\n" +
-                        "   3 │ **4**", () -> {
+                """
+                        X failed expecting [value] to equal cA │ cB
+                                                             1 │  2
+                                                             3 │  5:
+                            [value][1].cB:  actual: 4 <java.lang.Integer>
+                                          expected: 5 <java.lang.Integer> (Xms)
+                         \s
+                          cA │ cB  \s
+                           1 │     2
+                           3 │ **4**""", () -> {
                     // webtau-assertion
                     actual(calculated).should(equal(expected));
                     // webtau-assertion

webtau-docs/znai/release-notes/2.2/add-2023-09-01-limit-matcher-details-output.md

@@ -0,0 +1 @@
+* Add: Limit [Matchers](matchers/introduction) number of mismatch details printed by default via config `matchersReportEntriesLimit `