matchers: add table data section (#1526)

Author: MykolaGolubyev

webtau-core-groovy/src/test/groovy/org/testingisdocumenting/webtau/data/table/TableDataGroovyTest.groovy

@@ -98,16 +98,6 @@ class TableDataGroovyTest {
                              48  | null }
     }
 
-//    @Test
-//    void "matching a single value inside"() {
-//        def table = ["col A" | "col B" | "col C"] {
-//                    _____________________________
-//                        10   | "hello" | "world"
-//                        20   |  "next" | "event" }
-//
-//        table.should contain("hello")
-//    }
-
     @Test
     void "should generate multiple rows from multi-values"() {
         def tableData = createTableDataWithPermute()

webtau-core-groovy/src/test/groovy/org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersGroovyExamplesTest.groovy

@@ -0,0 +1,56 @@
+/*
+ * 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.equality.handlers
+
+import org.junit.Test
+import org.testingisdocumenting.webtau.data.table.TableData
+
+import static org.testingisdocumenting.webtau.Matchers.*
+import static org.testingisdocumenting.webtau.WebTauCore.*
+
+class TableDataMatchersGroovyExamplesTest {
+    @Test
+    void equalityMismatch() {
+        code {
+            // table-equal-mismatch
+            def summary = loadFromCsv("summary.csv")
+            def expected = [  "ColumnA" | "ColumnB" ] {
+                           ____________________________
+                                10      | greaterThan(15)
+                          anyOf(20, 22) | 40 }
+            summary.should == expected
+            // table-equal-mismatch
+        } should throwException(AssertionError)
+    }
+
+    @Test
+    void containsMismatch() {
+        code {
+            // table-contain-mismatch
+            def summary = loadFromCsv("summary.csv")
+            summary.should contain(["ColumnA": 20, "ColumnB": greaterThan(15)])
+            // table-contain-mismatch
+        } should throwException(AssertionError)
+    }
+
+    private static TableData loadFromCsv(String fileName) {
+        return ["ColumnA" | "ColumnB" ] {
+               _________________________
+                        10| 20
+                        30| 40 }
+    }
+}

webtau-core/src/test/java/org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersJavaExamplesTest.java

@@ -0,0 +1,74 @@
+/*
+ * 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.equality.handlers;
+
+import org.junit.Test;
+import org.testingisdocumenting.webtau.data.table.TableData;
+
+import static org.testingisdocumenting.webtau.Matchers.*;
+import static org.testingisdocumenting.webtau.WebTauCore.*;
+import static org.testingisdocumenting.webtau.testutils.TestConsoleOutput.*;
+
+public class TableDataMatchersJavaExamplesTest {
+    @Test
+    public void equalityMismatch() {
+        runExpectExceptionCaptureAndValidateOutput(AssertionError.class, "table-equal-console-output", """
+                X failed expecting [value] to equal ColumnA           │ ColumnB         \s
+                                                                   10 │ <greater than 15>
+                                                    <any of [20, 22]> │                40:
+                    [value][1].ColumnA:  actual: 30 <java.lang.Integer>
+                                       expected: 20 <java.lang.Integer>
+                                         actual: 30 <java.lang.Integer>
+                                       expected: 22 <java.lang.Integer> (Xms)
+                 \s
+                  ColumnA │ ColumnB
+                       10 │      20
+                   **30** │      40""", () -> {
+            // table-equal-mismatch
+            var summary = loadFromCsv("summary.csv");
+            TableData expected = table("ColumnA", "ColumnB",
+                                      _________________________,
+                                              10, greaterThan(15),
+                                   anyOf(20, 22), 40);
+
+            actual(summary).should(equal(expected));
+            // table-equal-mismatch
+        });
+    }
+
+    @Test
+    public void containsMismatch() {
+        runExpectExceptionCaptureAndValidateOutput(AssertionError.class, "table-contain-console-output", """
+                X failed expecting [value] to contain {"ColumnA": 20, "ColumnB": <greater than 15>}: no match found (Xms)
+                 \s
+                  ColumnA │ ColumnB
+                       10 │      20
+                       30 │      40""", () -> {
+            // table-contain-mismatch
+            var summary = loadFromCsv("summary.csv");
+            actual(summary).should(contain(map("ColumnA", 20, "ColumnB", greaterThan(15))));
+            // table-contain-mismatch
+        });
+    }
+
+    private static TableData loadFromCsv(String fileName) {
+        return table("ColumnA", "ColumnB",
+                     ___________________,
+                            10, 20,
+                            30, 40);
+    }
+}

webtau-docs/znai/browser/tables.md

@@ -21,6 +21,8 @@ Java:
 }
 ```
 
+More details in [Matchers](matchers/tables)
+
 # Extracting Table Data
 
 Use `:identifier: extractTableData` to extract `TableData` for further processing, e.g. saving to a disk:

webtau-docs/znai/matchers/tables.md

@@ -0,0 +1,37 @@
+# Equality Comparison
+
+When two tables are not equal, WebTau generates all the required info to investigate:
+
+```tabs
+Groovy:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersGroovyExamplesTest.groovy {
+  surroundedBy: "table-equal-mismatch"
+}
+Java:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersJavaExamplesTest.java {
+  surroundedBy: "table-equal-mismatch"
+}
+```
+
+:include-cli-output: doc-artifacts/table-equal-console-output.txt {
+  title: "console output"
+}
+
+# Contain
+
+Use `contain` matcher to check if one map is a subset of another:
+
+```tabs
+Groovy:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersGroovyExamplesTest.groovy {
+  surroundedBy: "table-contain-mismatch"
+}
+Java:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/TableDataMatchersJavaExamplesTest.java {
+  surroundedBy: "table-contain-mismatch"
+}
+```
+
+:include-cli-output: doc-artifacts/table-contain-console-output.txt {
+  title: "console output"
+}

webtau-docs/znai/release-notes/2.1/doc-2023-08-08-table-data-matchers-section.md

@@ -0,0 +1 @@
+* Doc: [TableData Matcher](matchers/tables)

webtau-docs/znai/toc

@@ -97,6 +97,7 @@ matchers
     java-beans-and-records
     strings
     maps
+    tables
     any-of
     custom-compare-to-handler
 groovy-standalone-runner