wait for cli output

Author: MykolaGolubyev

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

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2020 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +18,6 @@
 package org.testingisdocumenting.webtau.cli;
 
 import org.testingisdocumenting.webtau.cli.expectation.CliExitCode;
-import org.testingisdocumenting.webtau.cli.expectation.CliOutput;
 import org.testingisdocumenting.webtau.cli.expectation.CliValidationExitCodeOutputHandler;
 import org.testingisdocumenting.webtau.cli.expectation.CliValidationOutputOnlyHandler;
 import org.testingisdocumenting.webtau.expectation.ActualPath;
@@ -83,6 +83,17 @@ public void run(String command, ProcessEnv env, CliValidationExitCodeOutputHandl
 
     }
 
+    public CliBackgroundCommand runBackground(String command, ProcessEnv env) {
+        CliBackgroundCommand backgroundCommand = backgroundCommand(command, env);
+        backgroundCommand.start();
+
+        return backgroundCommand;
+    }
+
+    public CliBackgroundCommand runBackground(String command) {
+        return runBackground(command, ProcessEnv.EMPTY);
+    }
+
     public CliBackgroundCommand backgroundCommand(String command, ProcessEnv env) {
         return new CliBackgroundCommand(command, env);
     }
@@ -129,8 +140,8 @@ private void runAndValidate(CliValidationResult validationResult,
             }
 
             validationResult.setExitCode(exitCode(runResult.getExitCode()));
-            validationResult.setOut(cliOutput(runResult));
-            validationResult.setErr(cliError(runResult));
+            validationResult.setOut(runResult.getOutput());
+            validationResult.setErr(runResult.getError());
             validationResult.setStartTime(startTime);
             validationResult.setElapsedTime(endTime - startTime);
 
@@ -166,12 +177,4 @@ private static void validateExitCode(CliValidationResult validationResult) {
     private CliExitCode exitCode(int exitCode) {
         return new CliExitCode(exitCode);
     }
-
-    private static CliOutput cliOutput(ProcessRunResult runResult) {
-        return new CliOutput("process output", runResult.getOutput());
-    }
-
-    private static CliOutput cliError(ProcessRunResult runResult) {
-        return new CliOutput("process error output", runResult.getError());
-    }
 }

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

@@ -16,6 +16,8 @@
 
 package org.testingisdocumenting.webtau.cli;
 
+import org.testingisdocumenting.webtau.cli.expectation.CliOutput;
+
 import java.io.IOException;
 
 public class CliBackgroundCommand {
@@ -40,6 +42,14 @@ public void start() {
         }
     }
 
+    public CliOutput getOutput() {
+        return backgroundRunResult.getOutput();
+    }
+
+    public CliOutput getError() {
+        return backgroundRunResult.getError();
+    }
+
     public void stop() {
         backgroundRunResult.destroy();
         backgroundRunResult = null;

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

@@ -16,6 +16,8 @@
 
 package org.testingisdocumenting.webtau.cli;
 
+import org.testingisdocumenting.webtau.cli.expectation.CliOutput;
+
 import java.io.IOException;
 import java.lang.reflect.Field;
 
@@ -29,6 +31,9 @@ public class ProcessBackgroundRunResult {
     private final Thread consumeErrorThread;
     private final Thread consumeOutThread;
 
+    private final CliOutput output;
+    private final CliOutput error;
+
     public ProcessBackgroundRunResult(Process process,
                                       StreamGobbler outputGobbler,
                                       StreamGobbler errorGobbler,
@@ -40,6 +45,8 @@ public ProcessBackgroundRunResult(Process process,
         this.errorGobbler = errorGobbler;
         this.consumeErrorThread = consumeErrorThread;
         this.consumeOutThread = consumeOutThread;
+        this.output = new CliOutput("process output", outputGobbler);
+        this.error = new CliOutput("process error output", errorGobbler);
     }
 
     public Process getProcess() {
@@ -58,12 +65,12 @@ public void destroy() {
         }
     }
 
-    public StreamGobbler getOutputGobbler() {
-        return outputGobbler;
+    public CliOutput getOutput() {
+        return output;
     }
 
-    public StreamGobbler getErrorGobbler() {
-        return errorGobbler;
+    public CliOutput getError() {
+        return error;
     }
 
     public Thread getConsumeErrorThread() {
@@ -75,11 +82,7 @@ public Thread getConsumeOutThread() {
     }
 
     public ProcessRunResult createRunResult() {
-        return new ProcessRunResult(process.exitValue(),
-                outputGobbler.getLines(),
-                errorGobbler.getLines(),
-                outputGobbler.getException(),
-                errorGobbler.getException());
+        return new ProcessRunResult(process.exitValue(), output, error);
     }
 
     /**

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
+ * Copyright 2020 webtau maintainers
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,46 +16,39 @@
 
 package org.testingisdocumenting.webtau.cli;
 
+import org.testingisdocumenting.webtau.cli.expectation.CliOutput;
+
 import java.io.IOException;
 import java.util.List;
 
 public class ProcessRunResult {
-    private int exitCode;
-    private List<String> output;
-    private List<String> error;
-
-    private IOException outputReadingException;
-    private IOException errorReadingException;
-
-    public ProcessRunResult(int exitCode,
-                            List<String> output,
-                            List<String> error,
-                            IOException outputReadingException,
-                            IOException errorReadingException) {
+    private final int exitCode;
+    private final CliOutput output;
+    private final CliOutput error;
+
+    public ProcessRunResult(int exitCode, CliOutput output, CliOutput error) {
         this.exitCode = exitCode;
         this.output = output;
         this.error = error;
-        this.outputReadingException = outputReadingException;
-        this.errorReadingException = errorReadingException;
     }
 
     public IOException getOutputReadingException() {
-        return outputReadingException;
+        return output.getException();
     }
 
     public IOException getErrorReadingException() {
-        return errorReadingException;
+        return error.getException();
     }
 
     public int getExitCode() {
         return exitCode;
     }
 
-    public List<String> getOutput() {
+    public CliOutput getOutput() {
         return output;
     }
 
-    public List<String> getError() {
+    public CliOutput getError() {
         return error;
     }
 }

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

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2020 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,27 +25,35 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 import static org.testingisdocumenting.webtau.cfg.WebTauConfig.getCfg;
 
 public class StreamGobbler implements Runnable {
     private final InputStream stream;
+
+    private final StringBuffer full;
     private final List<String> lines;
     private final boolean renderOutput;
 
     private IOException exception;
 
     public StreamGobbler(InputStream stream) {
         this.stream = stream;
-        this.lines = new ArrayList<>();
+        this.lines = Collections.synchronizedList(new ArrayList<>());
+        this.full = new StringBuffer();
         this.renderOutput = shouldRenderOutput();
     }
 
     public List<String> getLines() {
         return lines;
     }
 
+    public String getFull() {
+        return full.toString();
+    }
+
     public IOException getException() {
         return exception;
     }
@@ -81,6 +90,7 @@ private void consume(BufferedReader bufferedReader) throws IOException {
             }
 
             lines.add(line);
+            full.append(line).append('\n');
         }
     }
 

webtau-cli/src/main/java/org/testingisdocumenting/webtau/cli/expectation/CliOutput.java

@@ -16,27 +16,26 @@
 
 package org.testingisdocumenting.webtau.cli.expectation;
 
+import org.testingisdocumenting.webtau.cli.StreamGobbler;
 import org.testingisdocumenting.webtau.expectation.ActualPath;
 
-import java.util.ArrayList;
+import java.io.IOException;
 import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 import java.util.stream.Collectors;
 
 public class CliOutput implements CliResultExpectations {
     private final String id;
-    private final List<String> lines;
+    private final StreamGobbler streamGobbler;
 
     private final Set<Integer> matchedLinesIdx;
 
-    private final String full;
-
-    public CliOutput(String id, List<String> lines) {
+    public CliOutput(String id, StreamGobbler streamGobbler) {
         this.id = id;
-        this.lines = lines;
+        this.streamGobbler = streamGobbler;
+
         this.matchedLinesIdx = new TreeSet<>();
-        this.full = String.join("\n", lines);
     }
 
     @Override
@@ -45,23 +44,28 @@ public ActualPath actualPath() {
     }
 
     public String get() {
-        return full;
+        return streamGobbler.getFull();
     }
 
     public List<String> getLines() {
-        return lines;
+        return streamGobbler.getLines();
+    }
+
+    public IOException getException() {
+        return streamGobbler.getException();
     }
 
     public void registerMatchedLine(Integer idx) {
         matchedLinesIdx.add(idx);
     }
 
     public List<String> extractMatchedLines() {
+        List<String> lines = getLines();
         return matchedLinesIdx.stream().map(lines::get).collect(Collectors.toList());
     }
 
     @Override
     public String toString() {
-        return full;
+        return streamGobbler.getFull();
     }
 }

webtau-cli/src/main/java/org/testingisdocumenting/webtau/cli/expectation/CliResultExpectations.java

@@ -41,11 +41,15 @@ default void shouldNot(ValueMatcher valueMatcher) {
 
     @Override
     default void waitTo(ValueMatcher valueMatcher, ExpectationTimer expectationTimer, long tickMillis, long timeOutMillis) {
-        throw new UnsupportedOperationException();
+        ValueMatcherExpectationSteps.waitStep(null, this, StepReportOptions.REPORT_ALL,
+                tokenizedMessage(IntegrationTestsMessageBuilder.id(actualPath().getPath())), valueMatcher,
+                expectationTimer, tickMillis, timeOutMillis);
     }
 
     @Override
     default void waitToNot(ValueMatcher valueMatcher, ExpectationTimer expectationTimer, long tickMillis, long timeOutMillis) {
-        throw new UnsupportedOperationException();
+        ValueMatcherExpectationSteps.waitNotStep(null, this, StepReportOptions.REPORT_ALL,
+                tokenizedMessage(IntegrationTestsMessageBuilder.id(actualPath().getPath())), valueMatcher,
+                expectationTimer, tickMillis, timeOutMillis);
     }
 }

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

@@ -0,0 +1,10 @@
+package scenarios.cli
+
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+scenario("wait for output") {
+    def command = cli.runBackground("scripts/sleeps")
+    command.output.waitTo contain("line two")
+
+    command.output.should contain("line one")
+}

webtau-feature-testing/scripts/sleeps

@@ -0,0 +1,6 @@
+#!/bin/bash
+echo "welcome sleeping script"
+sleep 1
+echo "line one"
+sleep 1
+echo "line two"

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

@@ -57,6 +57,13 @@ class WebTauCliFeaturesTest {
         }
     }
 
+    @Test
+    void "wait for output"() {
+        supportedPlatformOnly {
+            runCli('outputWait.groovy', 'webtau.cfg')
+        }
+    }
+
     private static void runCli(String restTestName, String configFileName, String... additionalArgs) {
         testRunner.runCli("scenarios/cli/$restTestName",
                 "scenarios/cli/$configFileName", additionalArgs)