cli: extract from output by regexp

Author: MykolaGolubyev

webtau-cli/src/main/java/org/testingisdocumenting/webtau/cli/CliForegroundCommand.java

@@ -60,7 +60,8 @@ private CliRunResult cliStep(String command, CliProcessConfig config, Consumer<C
 
         try {
             step.execute(StepReportOptions.REPORT_ALL);
-            return new CliRunResult(validationResult.getExitCode().get(),
+            return new CliRunResult(command,
+                    validationResult.getExitCode().get(),
                     validationResult.getOut().get(),
                     validationResult.getErr().get());
         } finally {

webtau-cli/src/main/java/org/testingisdocumenting/webtau/cli/CliRunResult.java

@@ -16,12 +16,22 @@
 
 package org.testingisdocumenting.webtau.cli;
 
+import org.testingisdocumenting.webtau.reporter.StepReportOptions;
+import org.testingisdocumenting.webtau.reporter.WebTauStep;
+import org.testingisdocumenting.webtau.utils.RegexpUtils;
+
+import static org.testingisdocumenting.webtau.reporter.IntegrationTestsMessageBuilder.*;
+import static org.testingisdocumenting.webtau.reporter.IntegrationTestsMessageBuilder.stringValue;
+import static org.testingisdocumenting.webtau.reporter.TokenizedMessage.tokenizedMessage;
+
 public class CliRunResult {
+    private final String command;
     private final int exitCode;
     private final String output;
     private final String error;
 
-    public CliRunResult(int exitCode, String output, String error) {
+    public CliRunResult(String command, int exitCode, String output, String error) {
+        this.command = command;
         this.exitCode = exitCode;
         this.output = output;
         this.error = error;
@@ -38,4 +48,33 @@ public String getOutput() {
     public String getError() {
         return error;
     }
+
+    public String extractFromOutputByRegexp(String regexp) {
+        return extractFromSourceByRegexp("stdout", output, regexp);
+    }
+
+    public String extractFromErrorByRegexp(String regexp) {
+        return extractFromSourceByRegexp("stderr", error, regexp);
+    }
+
+    private String extractFromSourceByRegexp(String sourceLabel, String source, String regexp) {
+        WebTauStep step = WebTauStep.createStep(null,
+                tokenizedMessage(action("extracting text"), classifier("by regexp"), stringValue(regexp),
+                        FROM, urlValue(command), classifier(sourceLabel)),
+                (r) -> tokenizedMessage(action("extracted text"), classifier("by regexp"), stringValue(regexp),
+                        FROM, urlValue(command), classifier(sourceLabel), COLON, stringValue(r)),
+                () -> extractByRegexpStepImpl(sourceLabel, source, regexp));
+
+        return step.execute(StepReportOptions.SKIP_START);
+    }
+
+    private String extractByRegexpStepImpl(String sourceLabel, String source, String regexp) {
+        String extracted = RegexpUtils.extractByRegexp(source, regexp);
+        if (extracted == null) {
+            throw new RuntimeException("can't find content to extract using regexp <" + regexp + "> from " +
+                    sourceLabel + " of " + command);
+        }
+
+        return extracted;
+    }
 }

webtau-docs/znai/cli/foreground-command.md

@@ -49,6 +49,20 @@ Use the result of `cli.run` if you need to process the output of the command.
 
 Warning: Perform validation inside validation block so webtau can track what was checked.
 
+:include-file: doc-artifacts/snippets/foreground-cli/runResultExtractOutput.groovy {
+  title: "extract from output by regexp",
+  startLine: "example",
+  endLine: "example",
+  excludeStartEnd: true
+}
+
+:include-file: doc-artifacts/snippets/foreground-cli/runResultExtractError.groovy {
+  title: "extract from error by regexp",
+  startLine: "example",
+  endLine: "example",
+  excludeStartEnd: true
+}
+
 # Working Dir
 
 Use `cli.workingDir` as a second parameter to `cli.run` to set a working dir:

webtau-feature-testing/examples/scenarios/cli/foregroundExamples.groovy

@@ -40,4 +40,22 @@ scenario("command run result") {
     if (result.exitCode == 1) {
         // ...
     }
+}
+
+scenario("run result extract by regexp from output") {
+    // example
+    def result = cli.run('scripts/generate-id')
+    def id = result.extractFromOutputByRegexp("id=(\\d+)")
+    // example
+
+    id.should == "4321254"
+}
+
+scenario("run result extract by regexp from error") {
+    // example
+    def result = cli.run('scripts/generate-id')
+    def id = result.extractFromErrorByRegexp("id=(\\d+)")
+    // example
+
+    id.should == "123457"
 }

webtau-feature-testing/scripts/generate-id

@@ -0,0 +1,4 @@
+#!/bin/bash
+echo generating id
+echo id=4321254
+>&2 echo can not create entity with id=123457

webtau-feature-testing/src/test/groovy/org/testingisdocumenting/webtau/featuretesting/WebTauCliFeaturesTest.groovy

@@ -50,7 +50,9 @@ class WebTauCliFeaturesTest {
                 'withErrorValidation.groovy': 'command with error validation',
                 'withExitCodeValidation.groovy': 'command with exit code validation',
                 'implicitExitCodeBehindScenes.groovy': 'command implicit exit code check explicitly',
-                'runResult.groovy': 'command run result'
+                'runResult.groovy': 'command run result',
+                'runResultExtractOutput.groovy': 'run result extract by regexp from output',
+                'runResultExtractError.groovy': 'run result extract by regexp from error'
         ])
     }
 

webtau-feature-testing/test-expectations/scenarios/cli/foregroundExamples/run-details.json

@@ -35,6 +35,18 @@
     "stepsSummary" : {
       "numberOfSuccessful" : 2
     }
+  }, {
+    "scenario" : "run result extract by regexp from output",
+    "shortContainerId" : "foregroundExamples.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 3
+    }
+  }, {
+    "scenario" : "run result extract by regexp from error",
+    "shortContainerId" : "foregroundExamples.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 3
+    }
   } ],
   "exitCode" : 0
 }

webtau-filesystem/src/main/java/org/testingisdocumenting/webtau/fs/FileTextContent.java

@@ -21,12 +21,14 @@
 import org.testingisdocumenting.webtau.expectation.ActualValueExpectations;
 import org.testingisdocumenting.webtau.expectation.ValueMatcher;
 import org.testingisdocumenting.webtau.expectation.timer.ExpectationTimer;
-import org.testingisdocumenting.webtau.reporter.*;
+import org.testingisdocumenting.webtau.reporter.IntegrationTestsMessageBuilder;
+import org.testingisdocumenting.webtau.reporter.StepReportOptions;
+import org.testingisdocumenting.webtau.reporter.ValueMatcherExpectationSteps;
+import org.testingisdocumenting.webtau.reporter.WebTauStep;
 import org.testingisdocumenting.webtau.utils.FileUtils;
+import org.testingisdocumenting.webtau.utils.RegexpUtils;
 
 import java.nio.file.Path;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import static org.testingisdocumenting.webtau.reporter.IntegrationTestsMessageBuilder.*;
 import static org.testingisdocumenting.webtau.reporter.TokenizedMessage.tokenizedMessage;
@@ -55,9 +57,9 @@ public ActualPath actualPath() {
 
     public String extractByRegexp(String regexp) {
         WebTauStep step = WebTauStep.createStep(null,
-                tokenizedMessage(action("extracting text"), classifier("by regexp"),
-                        FROM, urlValue(path), COLON, stringValue(regexp)),
-                (r) -> tokenizedMessage(action("extracted text"), classifier("by regexp"),
+                tokenizedMessage(action("extracting text"), classifier("by regexp"), stringValue(regexp),
+                        FROM, urlValue(path)),
+                (r) -> tokenizedMessage(action("extracted text"), classifier("by regexp"), stringValue(regexp),
                         FROM, urlValue(path), COLON, stringValue(r)),
                 () -> extractByRegexpStepImpl(regexp));
 
@@ -96,13 +98,11 @@ public String toString() {
     }
 
     private String extractByRegexpStepImpl(String regexp) {
-        Pattern pattern = Pattern.compile(regexp);
-        Matcher matcher = pattern.matcher(getData());
-        boolean found = matcher.find();
-        if (!found) {
+        String extracted = RegexpUtils.extractByRegexp(getData(), regexp);
+        if (extracted == null) {
             throw new RuntimeException("can't find content to extract using regexp <" + regexp + "> from: " + path);
         }
 
-        return matcher.group(1);
+        return extracted;
     }
 }

webtau-utils/src/main/java/org/testingisdocumenting/webtau/utils/RegexpUtils.java

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2021 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -36,4 +37,15 @@ public static String replaceAll(String source, Pattern regexp, Function<Matcher,
 
         return result.toString();
     }
+
+    public static String extractByRegexp(String source, String regexp) {
+        Pattern pattern = Pattern.compile(regexp);
+        Matcher matcher = pattern.matcher(source);
+        boolean found = matcher.find();
+        if (!found) {
+            return null;
+        }
+
+        return matcher.group(1);
+    }
 }

webtau-utils/src/test/groovy/org/testingisdocumenting/webtau/utils/RegexpUtilsTest.groovy

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2021 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,4 +26,13 @@ class RegexpUtilsTest {
         def replaced = RegexpUtils.replaceAll("hello 10 world of 42 numbers", ~/(\d)\d*/, { m -> '"' + m.group(1) + '"' })
         Assert.assertEquals('hello "1" world of "4" numbers', replaced)
     }
+
+    @Test
+    void "extract value by regexp"() {
+        Assert.assertEquals("123",
+                RegexpUtils.extractByRegexp("line 1\nline 2\nhello id=123 ere\n", "id=(\\d+)"))
+
+        Assert.assertEquals(null,
+                RegexpUtils.extractByRegexp("line 1\nline 2\nhello id=123 ere\n", "bid=(\\d+)"))
+    }
 }