matchers: any value matcher (#1528)

Author: MykolaGolubyev

webtau-core-groovy/src/test/groovy/org/testingisdocumenting/webtau/MatchersGroovyTest.groovy

@@ -107,6 +107,17 @@ class MatchersGroovyTest {
         }
     }
 
+    @Test
+    void "any value table matcher example"() {
+        // any-value-table-example
+        TableData summaryTable = loadFromCsv("summary.csv")
+        summaryTable.should == ["ColumnA" | "ColumnB" ] {
+                                _________________________
+                                        10| anyValue
+                                        30| 40 }
+        // any-value-table-example
+    }
+
     @Test
     void "java records and table data equality"() {
         def wishListItem1 = new WishLitItem("id1", "tea set", true, [])
@@ -204,6 +215,13 @@ class MatchersGroovyTest {
         return 10.5
     }
 
+    private static TableData loadFromCsv(String fileName) {
+        return ["ColumnA" | "ColumnB" ] {
+              _________________________
+                        10| 20
+                        30| 40 }
+    }
+
     private int countRecords() {
         numberOfRecords += 1
         return numberOfRecords

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

@@ -0,0 +1,38 @@
+/*
+ * 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
+
+import org.junit.Test
+
+import static org.testingisdocumenting.webtau.Matchers.*
+
+class AnyValueMatcherTest {
+    @Test
+    void "positive"() {
+        def value = 100
+        value.shouldBe anyValue
+    }
+
+    @Test
+    void "negative"() {
+        def value = 100
+
+        code {
+            value.shouldNotBe anyValue
+        } should throwException("anyValue matches every value")
+    }
+}

webtau-core/src/main/java/org/testingisdocumenting/webtau/Matchers.java

@@ -35,6 +35,11 @@
  * Convenient place to discover all the available matchers
  */
 public class Matchers {
+    /**
+     * any value matcher. use it in places like table or complex structures where you want to ignore a value
+     */
+    public static final ValueMatcher anyValue = new AnyValueMatcher();
+
     /**
      * visible matcher to check if UI element is visible
      * @see #hidden

webtau-core/src/main/java/org/testingisdocumenting/webtau/expectation/equality/AnyValueMatcher.java

@@ -0,0 +1,79 @@
+/*
+ * 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;
+
+import org.testingisdocumenting.webtau.data.ValuePath;
+import org.testingisdocumenting.webtau.data.render.PrettyPrintable;
+import org.testingisdocumenting.webtau.data.render.PrettyPrinter;
+import org.testingisdocumenting.webtau.expectation.ValueMatcher;
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
+
+import static org.testingisdocumenting.webtau.WebTauCore.*;
+
+public class AnyValueMatcher implements ValueMatcher, PrettyPrintable {
+    @Override
+    public TokenizedMessage matchingTokenizedMessage(ValuePath actualPath, Object actual) {
+        return tokenizedMessage().matcher("to match any value");
+    }
+
+    @Override
+    public TokenizedMessage matchedTokenizedMessage(ValuePath actualPath, Object actual) {
+        return tokenizedMessage().matcher("matches every value");
+    }
+
+    @Override
+    public TokenizedMessage mismatchedTokenizedMessage(ValuePath actualPath, Object actual) {
+        throw new IllegalStateException();
+    }
+
+    @Override
+    public boolean matches(ValuePath actualPath, Object actual) {
+        return true;
+    }
+
+    @Override
+    public TokenizedMessage negativeMatchingTokenizedMessage(ValuePath actualPath, Object actual) {
+        return tokenizedMessage().matcher("to mismatch any value");
+    }
+
+    @Override
+    public TokenizedMessage negativeMatchedTokenizedMessage(ValuePath actualPath, Object actual) {
+        throw new IllegalStateException();
+    }
+
+    @Override
+    public TokenizedMessage negativeMismatchedTokenizedMessage(ValuePath actualPath, Object actual) {
+        return tokenizedMessage().id("anyValue").matcher("matches every value");
+    }
+
+    @Override
+    public boolean negativeMatches(ValuePath actualPath, Object actual) {
+        return false;
+    }
+
+    @Override
+    public void prettyPrint(PrettyPrinter printer) {
+        printer.printDelimiter("<");
+        printer.print(PrettyPrinter.CLASSIFIER_COLOR, "any value");
+        printer.printDelimiter(">");
+    }
+
+    @Override
+    public String toString() {
+        return PrettyPrinter.renderAsTextWithoutColors(this);
+    }
+}

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

@@ -291,6 +291,29 @@ public void anyOfMatcherWithOtherMatcherExample() {
         actual(message).shouldNotBe(anyOf("hello", contain("super")));
     }
 
+    @Test
+    public void anyValueTableMatcherExample() {
+        runCaptureAndValidateOutput("any-value-table-output", """
+                . [value] equals ColumnA │ ColumnB   \s
+                                      10 │ <any value>
+                                      30 │          40 (Xms)""", () -> {
+            // any-value-table-example
+            TableData summaryTable = loadFromCsv("summary.csv");
+            actual(summaryTable).should(equal(table("ColumnA", "ColumnB",
+                                                   ____________________,
+                                                           10, anyValue,
+                                                           30, 40)));
+            // any-value-table-example
+        });
+    }
+
+    private static TableData loadFromCsv(String fileName) {
+        return table("ColumnA", "ColumnB",
+                     ____________________,
+                            10, 20,
+                            30, 40);
+    }
+
     @Test
     public void listFailureExample() {
         doc.console.capture("list-failure", () -> {

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

@@ -0,0 +1,22 @@
+# Match Every Value
+
+Use `anyValue` matcher to match every expected value. Use it in places of complex data expectations where you need to 
+provide a value but your focus is on different data. 
+
+```tabs
+Groovy: 
+:include-file: org/testingisdocumenting/webtau/MatchersGroovyTest.groovy {
+  surroundedBy: "any-value-table-example"
+} 
+
+Java: 
+:include-file: org/testingisdocumenting/webtau/MatchersTest.java {
+  surroundedBy: "any-value-table-example"
+} 
+```
+
+:include-cli-output: doc-artifacts/any-value-table-output.txt {
+  title: "console output"
+}
+
+:include-markdown: static-import.md

webtau-docs/znai/release-notes/2.1/add-2023-08-14-any-value-matcher.md

@@ -0,0 +1 @@
+* Add: [any value matcher](matchers/any-value)

webtau-docs/znai/toc

@@ -99,6 +99,7 @@ matchers
     maps
     tables
     any-of
+    any-value
     custom-compare-to-handler
 groovy-standalone-runner
     introduction