core: indent step input and output in console reporter

Author: MykolaGolubyev

webtau-console/src/main/java/org/testingisdocumenting/webtau/console/IndentedConsoleOutput.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2021 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.console;
+
+import org.testingisdocumenting.webtau.utils.StringUtils;
+
+import java.util.Arrays;
+
+import java.util.stream.Stream;
+
+public class IndentedConsoleOutput implements ConsoleOutput {
+    private final ConsoleOutput original;
+    private final String indentation;
+
+    public IndentedConsoleOutput(ConsoleOutput original, Integer indentationSize) {
+        this.original = original;
+        this.indentation = StringUtils.createIndentation(indentationSize);
+    }
+
+    @Override
+    public void out(Object... styleOrValues) {
+        original.out(Stream.concat(Stream.of(indentation), Arrays.stream(styleOrValues)).toArray());
+    }
+
+    @Override
+    public void err(Object... styleOrValues) {
+        original.err(Stream.concat(Stream.of(indentation), Arrays.stream(styleOrValues)).toArray());
+    }
+}

webtau-console/src/test/groovy/org/testingisdocumenting/webtau/console/IndentedConsoleOutputTest.groovy

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2021 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.console
+
+import org.junit.Before
+import org.junit.Test
+
+class IndentedConsoleOutputTest {
+    TestConsoleOutput console
+
+    @Before
+    void init() {
+        console = new TestConsoleOutput()
+    }
+
+    @Test
+    void "should indent output"() {
+        def indented =new IndentedConsoleOutput(console, 4)
+        indented.out('hello', 200L, 'world')
+
+        assert console.out == [['    ', 'hello', 200L, 'world']]
+        assert console.err == []
+    }
+
+    @Test
+    void "should indent error"() {
+        def indented =new IndentedConsoleOutput(console, 4)
+        indented.err('hello', 200L, 'world')
+
+        assert console.err == [['    ', 'hello', 200L, 'world']]
+        assert console.out == []
+    }
+
+    private static class TestConsoleOutput implements ConsoleOutput {
+        private List<List<Object>> out = new ArrayList<>()
+        private List<List<Object>> err = new ArrayList<>()
+
+
+        @Override
+        void out(Object... styleOrValues) {
+            out.push(Arrays.asList(styleOrValues))
+        }
+
+        @Override
+        void err(Object... styleOrValues) {
+            err.push(Arrays.asList(styleOrValues))
+        }
+    }
+}

webtau-core/src/main/java/org/testingisdocumenting/webtau/reporter/ConsoleStepReporter.java

@@ -18,6 +18,7 @@
 package org.testingisdocumenting.webtau.reporter;
 
 import org.testingisdocumenting.webtau.console.ConsoleOutputs;
+import org.testingisdocumenting.webtau.console.IndentedConsoleOutput;
 import org.testingisdocumenting.webtau.console.ansi.Color;
 import org.testingisdocumenting.webtau.utils.StringUtils;
 
@@ -114,15 +115,20 @@ private void printStepInput(WebTauStep step) {
             return;
         }
 
-        step.getInput().prettyPrint(ConsoleOutputs.asCombinedConsoleOutput());
+        step.getInput().prettyPrint(createIndentedConsoleOutput(step));
     }
 
     private void printStepOutput(WebTauStep step) {
         if (skipRenderRequestResponse()) {
             return;
         }
 
-        step.getOutput().prettyPrint(ConsoleOutputs.asCombinedConsoleOutput());
+        step.getOutput().prettyPrint(createIndentedConsoleOutput(step));
+    }
+
+    private IndentedConsoleOutput createIndentedConsoleOutput(WebTauStep step) {
+        return new IndentedConsoleOutput(ConsoleOutputs.asCombinedConsoleOutput(),
+                numberOfSpacedForIndentLevel(step.getNumberOfParents()));
     }
 
     private boolean skipRenderRequestResponse() {
@@ -178,8 +184,12 @@ private boolean isLastTokenError(TokenizedMessage completionMessage) {
                 IntegrationTestsMessageBuilder.TokenTypes.ERROR.getType());
     }
 
-    private String createIndentation(int indentation) {
-        return StringUtils.createIndentation(indentation * 2);
+    private String createIndentation(int indentLevel) {
+        return StringUtils.createIndentation(numberOfSpacedForIndentLevel(indentLevel));
+    }
+
+    private int numberOfSpacedForIndentLevel(int indentLevel) {
+        return indentLevel * 2;
     }
 
     private void executeIfWithinVerboseLevel(WebTauStep step, Runnable code) {

webtau-core/src/test/groovy/org/testingisdocumenting/webtau/reporter/ConsoleStepReporterTest.groovy

@@ -142,6 +142,32 @@ class ConsoleStepReporterTest implements ConsoleOutput {
         }
     }
 
+    @Test
+    void "should indent step input pretty print"() {
+        def topLevelStep = WebTauStep.createStep(null, TokenizedMessage.tokenizedMessage(action("top level action")),
+                { -> TokenizedMessage.tokenizedMessage(action("top level action completed")) }) {
+
+            def secondLevelStepSuccess = WebTauStep.createStep(null, TokenizedMessage.tokenizedMessage(action("second level action")),
+                    { -> TokenizedMessage.tokenizedMessage(action("second level action completed")) }) {
+            }
+
+            secondLevelStepSuccess.setInput(new TestStepInput())
+            secondLevelStepSuccess.setOutput(new TestStepOutput())
+            secondLevelStepSuccess.execute(StepReportOptions.REPORT_ALL)
+        }
+
+        expectReport(Integer.MAX_VALUE, '> top level action\n' +
+                '  > second level action\n' +
+                '  hello input\n' +
+                '  world\n' +
+                '  hello output\n' +
+                '  world\n' +
+                '  . second level action completed (0ms)\n' +
+                '. top level action completed (0ms)') {
+            topLevelStep.execute(StepReportOptions.REPORT_ALL)
+        }
+    }
+
     @Test
     void "should not render step if a nest level is greater than provided max"() {
         expectReport(0, '') {
@@ -236,4 +262,30 @@ class ConsoleStepReporterTest implements ConsoleOutput {
     void err(Object... styleOrValues) {
         lines.add(new IgnoreAnsiString(styleOrValues).toString())
     }
+
+    private static class TestStepInput implements WebTauStepInput {
+        @Override
+        void prettyPrint(ConsoleOutput console) {
+            console.out("hello input")
+            console.out("world")
+        }
+
+        @Override
+        Map<String, ?> toMap() {
+            return Collections.emptyMap()
+        }
+    }
+
+    private static class TestStepOutput implements WebTauStepOutput {
+        @Override
+        void prettyPrint(ConsoleOutput console) {
+            console.out("hello output")
+            console.out("world")
+        }
+
+        @Override
+        Map<String, ?> toMap() {
+            return Collections.emptyMap()
+        }
+    }
 }