repl: support for test selection using negative index

Author: MykolaGolubyev

webtau-cli-testing/src/test/groovy/scenarios/replTestSelection.groovy

@@ -64,6 +64,14 @@ scenario('run scenario by index') {
     cli.doc.capture('repl-test-scenario-ran-by-idx')
 }
 
+scenario('run scenario by negative index') {
+    repl.clearOutput()
+    repl << "r -1\n"
+    repl.output.waitTo contain("validating...")
+
+    cli.doc.capture('repl-test-scenario-ran-by-negative-idx')
+}
+
 scenario('run scenario by text') {
     repl.clearOutput()
     repl << "r 'clean'\n"

webtau-docs/znai/REPL/test-runs.md

@@ -36,7 +36,11 @@ Selected test file has three scenarios
 
 To run scenario by index
 
-:include-cli-output: cli-tests/repl-test-scenario-ran-by-idx/out.txt {title: "run test scenario by index"}
+:include-cli-output: cli-tests/repl-test-scenario-ran-by-idx/out.txt {title: "run test scenario by an index"}
+
+Use negative index to select from the bottom, i.e. -1 will select the last scenario, -2 will select second from the end
+
+:include-cli-output: cli-tests/repl-test-scenario-ran-by-negative-idx/out.txt {title: "run test scenario by a negative index"}
 
 To run scenario by partial name match
 

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/WebTauCliApp.groovy

@@ -103,7 +103,6 @@ class WebTauCliApp implements TestListener, ReportGenerator {
 
     void startRepl() {
         prepareTestsAndRun(WebDriverBehavior.AutoCloseWebDrivers) {
-            runner.setIsReplMode(true)
             def repl = new Repl(runner)
             repl.run()
         }

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/repl/IndexSelection.groovy

@@ -0,0 +1,35 @@
+/*
+ * 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.cli.repl
+
+import groovy.transform.PackageScope
+
+@PackageScope
+class IndexSelection {
+    @PackageScope
+    static int convertNegativeIdxToAbsolute(int size, int idx) {
+        //  0  1  2  3  4  5  6
+        // -7 -6 -5 -4 -3 -2 -1
+        // size = 7
+
+        if (idx >= 0) {
+            return idx
+        }
+
+        return size + idx
+    }
+}

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/repl/Repl.groovy

@@ -17,6 +17,7 @@
 
 package org.testingisdocumenting.webtau.cli.repl
 
+import groovy.transform.PackageScope
 import org.apache.groovy.groovysh.Groovysh
 import org.codehaus.groovy.tools.shell.IO
 import org.codehaus.groovy.tools.shell.util.Preferences
@@ -33,10 +34,15 @@ class Repl {
     private final Groovysh groovysh
     private final StandaloneTestRunner runner
     private final InteractiveTests interactiveTests
-    private final ReplResultRenderer resultRenderer
+
+    @PackageScope
+    final ReplResultRenderer resultRenderer
 
     Repl(StandaloneTestRunner runner) {
+        runner.setIsReplMode(true)
+
         this.runner = runner
+
         interactiveTests = new InteractiveTests(runner)
         ReplCommands.interactiveTests = interactiveTests
 

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/repl/ReplCommands.groovy

@@ -19,6 +19,7 @@ package org.testingisdocumenting.webtau.cli.repl
 import groovy.transform.PackageScope
 import org.testingisdocumenting.webtau.cfg.WebTauConfig
 import org.testingisdocumenting.webtau.console.ansi.Color
+import org.testingisdocumenting.webtau.data.render.PrettyPrintable
 import org.testingisdocumenting.webtau.documentation.DocumentationArtifacts
 import org.testingisdocumenting.webtau.reporter.stacktrace.StackTraceUtils
 import org.testingisdocumenting.webtau.runner.standalone.StandaloneTest
@@ -36,8 +37,11 @@ class ReplCommands {
     @PackageScope
     static InteractiveTests interactiveTests
 
-    private static TestsSelection testsSelection = new TestsSelection()
-    private static List<StandaloneTest> availableScenarios = []
+    @PackageScope
+    static TestsSelection testsSelection = new TestsSelection()
+
+    @PackageScope
+    static List<StandaloneTest> availableScenarios = []
 
     static WebTauConfig getReloadConfig() {
         return reloadConfig()
@@ -51,12 +55,12 @@ class ReplCommands {
         return WebTauConfig.cfg
     }
 
-    static boolean getTestSelected() {
+    static boolean getTestFileSelected() {
         return testsSelection.testFilePath != null
     }
 
     static void select(Object... selectors) {
-        if (testSelected) {
+        if (testFileSelected) {
             selectScenariosAndValidate(selectors)
             displaySelectedScenarios()
         } else {
@@ -65,32 +69,32 @@ class ReplCommands {
                 return
             }
 
-            selectTest(selectors[0])
+            selectTestFile(selectors[0])
         }
     }
 
     static void s(Object... selectors) {
         select(selectors)
     }
 
-    static void getRun() {
-        runSelected()
+    static Object getRun() {
+        return new ProxyToHandleNegativeIndexAndRunScenarios()
     }
 
-    static void getR() {
-        runSelected()
+    static Object getR() {
+        return getRun()
     }
 
-    static void getSelect() {
-        displaySelectedScenarios()
+    static Object getSelect() {
+        return new ProxyToHandleNegativeIndexAndDisplayScenarios()
     }
 
-    static void getS() {
-        getSelect()
+    static Object getS() {
+        return getSelect()
     }
 
     static void run(Object... selectors) {
-        if (testSelected) {
+        if (testFileSelected) {
             selectScenariosAndValidate(selectors)
 
             if (testsSelection.scenarios) {
@@ -102,7 +106,7 @@ class ReplCommands {
                 return
             }
 
-            selectTest(selectors[0])
+            selectTestFile(selectors[0])
 
             if (testsSelection.testFilePath) {
                 runSelected()
@@ -177,44 +181,46 @@ class ReplCommands {
     }
 
     private static void listTestFilesOrScenarios() {
-        if (!testSelected) {
+        if (!testFileSelected) {
             displayTestFiles()
         } else {
             displayScenarios(testsSelection.testFilePath)
         }
     }
 
-    private static void selectTest(Object selector) {
+    private static void selectTestFile(Object selector) {
         if (selector instanceof String) {
-            selectTestByRegexp(selector)
+            selectTestFileByRegexp(selector)
             return
         }
 
         if (selector instanceof Integer) {
-            selectTestByIndex(selector)
+            selectTestFileByIndex(selector)
             return
         }
 
-        out(Color.RED, "can't select test using: " + selector)
+        out(Color.RED, "can't select test file using: " + selector)
         testsSelection.testFilePath = ''
         testsSelection.scenarios = []
     }
 
-    private static void selectTestByIndex(Integer idx) {
-        if (idx < 0 || idx >= interactiveTests.testFilePaths.size()) {
-            out(Color.RED, 'enter a test index between 0 and ' + interactiveTests.testFilePaths.size())
+    private static void selectTestFileByIndex(Integer idx) {
+        def size = interactiveTests.testFilePaths.size()
+        idx = IndexSelection.convertNegativeIdxToAbsolute(size, idx)
+        if (idx < 0 || idx >= size) {
+            out(Color.RED, 'enter a test file index between 0 and ' + (size - 1))
             return
         }
 
         testsSelection.testFilePath = interactiveTests.testFilePathByIdx(idx)
         displayScenarios(testsSelection.testFilePath)
     }
 
-    private static void selectTestByRegexp(String regexp) {
+    private static void selectTestFileByRegexp(String regexp) {
         def pattern = Pattern.compile(regexp, Pattern.CASE_INSENSITIVE)
         def found = interactiveTests.firstTestFilePathByRegexp(pattern)
         if (!found) {
-            out(Color.RED, "didn't find a test matching regexp: " + regexp)
+            out(Color.RED, "didn't find a test file matching regexp: " + regexp)
             return
         }
 
@@ -230,7 +236,7 @@ class ReplCommands {
             testsSelection.scenarios = []
 
             withIssues.each {
-                out(Color.RED, "didn't find a test matching: " + it.input)
+                out(Color.RED, "didn't find a scenario matching: " + it.input)
             }
         } else {
             testsSelection.scenarios = selector.inputAndResults.scenario
@@ -277,4 +283,31 @@ class ReplCommands {
                 Color.PURPLE, testsSelection.testFilePath, ' ',
                 Color.YELLOW, scenario)
     }
+
+    // <s 1> is treated as method "s" call with parameter <1>
+    // <s -1> is treated as "getS() - 1" so we need to handle this in a way to make it feel like <s 1>
+    // <s> still needs to display selected scenarios, so when <s> without minus index is called we need to render
+    private static class ProxyToHandleNegativeIndexAndDisplayScenarios implements PrettyPrintable {
+        Object minus(Integer indexToMakeNegative) {
+            select(indexToMakeNegative * -1)
+            return null
+        }
+
+        @Override
+        void prettyPrint() {
+            displaySelectedScenarios()
+        }
+    }
+
+    private static class ProxyToHandleNegativeIndexAndRunScenarios implements PrettyPrintable {
+        Object minus(Integer indexToMakeNegative) {
+            run(indexToMakeNegative * -1)
+            return null
+        }
+
+        @Override
+        void prettyPrint() {
+            runSelected()
+        }
+    }
 }

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/repl/ReplScenariosSelector.groovy

@@ -59,6 +59,7 @@ class ReplScenariosSelector {
     }
 
     private SelectInputAndResult selectSingleScenarioByIdx(int idx) {
+        idx = IndexSelection.convertNegativeIdxToAbsolute(availableScenarios.size(), idx)
         def isInRange = idx >= 0 && idx < availableScenarios.size()
         def found = isInRange ? availableScenarios[idx] : null