matchers: doc string contain and regexp (#1527)

Author: MykolaGolubyev

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

@@ -17,7 +17,8 @@
 package org.testingisdocumenting.webtau.expectation.equality.handlers
 
 import org.junit.Test
-import static org.testingisdocumenting.webtau.WebTauCore.*
+
+import static org.testingisdocumenting.webtau.Matchers.*
 
 class StringMatchersGroovyExamplesTest {
     @Test
@@ -31,7 +32,7 @@ class StringMatchersGroovyExamplesTest {
     }
 
     @Test
-    void multLine() {
+    void multiLine() {
         code {
             // multi-line-compare
             String output = buildOutput()
@@ -50,6 +51,24 @@ class StringMatchersGroovyExamplesTest {
         } should throwException(AssertionError)
     }
 
+    @Test
+    void regexp() {
+        // single-line-regexp
+        String output = 'final price: $8998'
+        output.should == ~/final price: \$\d+/
+        // single-line-regexp
+    }
+
+    @Test
+    void contains() {
+        code {
+            // multi-line-contains
+            String output = buildOutput()
+            output.should contain("four")
+            // multi-line-contains
+        } should throwException(AssertionError)
+    }
+
     private static String buildOutput() {
         return "line one\nline two\nline three"
     }

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

@@ -18,6 +18,8 @@
 
 import org.junit.Test;
 
+import java.util.regex.Pattern;
+
 import static org.testingisdocumenting.webtau.Matchers.*;
 import static org.testingisdocumenting.webtau.testutils.TestConsoleOutput.*;
 
@@ -59,6 +61,33 @@ public void extraEmptyLines() {
                 });
     }
 
+    @Test
+    public void regexp() {
+        runCaptureAndValidateOutput("string-regexp-output", ". [value] equals ~/final price: \\$\\d+/ (Xms)",  () -> {
+            // single-line-regexp
+            String output = "final price: $8998";
+            actual(output).should(equal(Pattern.compile("final price: \\$\\d+")));
+            // single-line-regexp
+        });
+    }
+
+    @Test
+    public void contains() {
+        runExpectExceptionCaptureAndValidateOutput(AssertionError.class, "string-contains-output", """
+                X failed expecting [value] to contain "four": no match found (Xms)
+                 \s
+                  **__________**
+                    line one
+                    line two
+                    line three
+                  **__________**""", () -> {
+            // multi-line-contains
+            String output = buildOutput();
+            actual(output).should(contain("four"));
+            // multi-line-contains
+        });
+    }
+
     private static String buildOutput() {
         return "line one\nline two\nline three";
     }

webtau-docs/znai/matchers/strings.md

@@ -66,3 +66,45 @@ Java:
   title: "console output"
 }
 
+# Contains
+
+Use `contains` matcher to check a presence of a substring:
+
+```tabs
+Groovy:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
+  surroundedBy: "multi-line-contains"
+}
+
+Java:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
+  surroundedBy: "multi-line-contains"
+}
+```
+
+:include-cli-output: doc-artifacts/string-contains-output.txt {
+  title: "console output"
+}
+
+# Regexp
+
+Use `equal` matcher to match against a regular expression:
+
+```tabs
+Groovy:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersGroovyExamplesTest.groovy {
+  surroundedBy: "single-line-regexp"
+}
+
+Java:
+:include-file: org/testingisdocumenting/webtau/expectation/equality/handlers/StringMatchersJavaExamplesTest.java {
+  surroundedBy: "single-line-regexp"
+}
+```
+
+:include-cli-output: doc-artifacts/string-regexp-output.txt {
+  title: "console output"
+}
+
+
+

webtau-docs/znai/release-notes/2.1/doc-2023-08-09-string-contain-and-regexp.md

@@ -0,0 +1,2 @@
+* Doc: [string contain](matchers/strings#contains)
+* Doc: [string regexp](matchers/strings#regexp)