[Core] Add Before and AfterStep hooks (#1323)

Adds hooks that are invoked before and after a step.

The hooks have 'invoke around' semantics. Meaning that if a before step hook is executed the after step hooks will also be executed regardless of the result of the step. If a step did not pass, the following step and its hooks will be skipped.

To support the invoke around semantics the TestStep event has been replaced with an interface. And it's concrete implementation split into HookTestStep and PickleStepTestStep. All subclass specific methods in TestStep have been deprecated.

When doing a dry run all hooks will be reported. In prior implementations the before and after scenario hooks were unskippable and simply not included. These have been made skippable but will only be skipped on a dry run.

Author: Aniket

android/src/main/java/cucumber/runtime/formatter/AndroidLogcatReporter.java

@@ -1,6 +1,7 @@
 package cucumber.runtime.formatter;
 
 import android.util.Log;
+import cucumber.api.PickleStepTestStep;
 import cucumber.api.event.EventHandler;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseStarted;
@@ -40,8 +41,9 @@ public void receive(TestCaseStarted event) {
     private final EventHandler<TestStepStarted> testStepStartedHandler = new EventHandler<TestStepStarted>() {
         @Override
         public void receive(TestStepStarted event) {
-            if (!event.testStep.isHook()) {
-                Log.d(logTag, String.format("%s", event.testStep.getStepText()));
+            if (event.testStep instanceof PickleStepTestStep) {
+                PickleStepTestStep testStep = (PickleStepTestStep) event.testStep;
+                Log.d(logTag, String.format("%s", testStep.getStepText()));
             }
         }
     };

core/pom.xml

@@ -13,7 +13,7 @@
 
     <dependencies>
         <dependency>
-            <groupId>info.cukes</groupId>
+            <groupId>io.cucumber</groupId>
             <artifactId>cucumber-html</artifactId>
         </dependency>
         <dependency>

core/src/main/java/cucumber/api/Argument.java

@@ -0,0 +1,7 @@
+package cucumber.api;
+
+public interface Argument {
+    Integer getOffset();
+
+    String getVal();
+}

core/src/main/java/cucumber/api/HookTestStep.java

@@ -0,0 +1,19 @@
+package cucumber.api;
+
+/**
+ * Hooks are invoked before and after each scenario and before and
+ * after each gherkin step in a scenario.
+ *
+ * @see cucumber.api.event.TestCaseStarted
+ * @see cucumber.api.event.TestCaseFinished
+ */
+public interface HookTestStep extends TestStep {
+
+    /**
+     * Returns the hook hook type.
+     *
+     * @return the hook type.
+     */
+    HookType getHookType();
+
+}

core/src/main/java/cucumber/api/HookType.java

@@ -1,7 +1,7 @@
 package cucumber.api;
 
 public enum HookType {
-    Before, After;
+    Before, After, BeforeStep, AfterStep;
 
     @Override
     public String toString() {

core/src/main/java/cucumber/api/PickleStepTestStep.java

@@ -0,0 +1,65 @@
+package cucumber.api;
+
+import java.util.List;
+
+/**
+ * A pickle test step matches a line in a Gherkin scenario or background.
+ */
+public interface PickleStepTestStep extends TestStep {
+
+    /**
+     * The pattern or expression used to match the glue code to the Gherkin step.
+     *
+     * @return a pattern or expression
+     */
+    String getPattern();
+
+    /**
+     * The matched Gherkin step as a compiled Pickle
+     *
+     * @return the matched step
+     */
+    gherkin.pickles.PickleStep getPickleStep();
+
+
+    /**
+     * Returns the arguments provided to the step definition.
+     *
+     * For example the step definition <code>Given (.*) pickles</code>
+     * when matched with <code>Given 15 pickles</code> will receive
+     * as argument <code>"15"</code>
+     *
+     * @return argument provided to the step definition
+     */
+    List<cucumber.api.Argument> getDefinitionArgument();
+
+    /**
+     * Returns arguments provided to the Gherkin step. E.g:
+     * a data table or doc string.
+     *
+     * @return arguments provided to the gherkin step.
+     */
+
+    List<gherkin.pickles.Argument> getStepArgument();
+
+    /**
+     * The line in the feature file defining this step.
+     *
+     * @return a line number
+     */
+    int getStepLine();
+
+    /**
+     * A uri to to the feature and line of this step.
+     *
+     * @return a uri
+     */
+    String getStepLocation();
+
+    /**
+     * The full text of the Gherkin step.
+     *
+     * @return the step text
+     */
+    String getStepText();
+}

core/src/main/java/cucumber/api/Result.java

@@ -2,11 +2,21 @@
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.util.Comparator;
 
 public class Result {
+
+    public final static Comparator<Result> SEVERITY = new Comparator<Result>() {
+
+        @Override
+        public int compare(Result a, Result b) {
+            return a.status == b.status ? 0 : a.status.ordinal() > b.status.ordinal() ? 1 : -1;
+        }
+    };
+
     private static final long serialVersionUID = 1L;
 
-    private final Result.Type status;
+    private final Type status;
     private final Long duration;
     private final Throwable error;
     public static final Result SKIPPED = new Result(Result.Type.SKIPPED, null, null);
@@ -85,4 +95,13 @@ private String getErrorMessage(Throwable error) {
         error.printStackTrace(printWriter);
         return stringWriter.getBuffer().toString();
     }
+
+    @Override
+    public String toString() {
+        return "Result{" +
+            "status=" + status +
+            ", duration=" + duration +
+            ", error=" + error +
+            '}';
+    }
 }

core/src/main/java/cucumber/api/TestCase.java

@@ -1,95 +1,19 @@
 package cucumber.api;
 
-import cucumber.api.event.TestCaseFinished;
-import cucumber.api.event.TestCaseStarted;
-import cucumber.runner.EventBus;
-import cucumber.runtime.ScenarioImpl;
-import gherkin.events.PickleEvent;
-import gherkin.pickles.PickleLocation;
 import gherkin.pickles.PickleTag;
 
 import java.util.List;
 
-public class TestCase {
-    private final PickleEvent pickleEvent;
-    private final List<TestStep> testSteps;
-    private final boolean dryRun;
+public interface TestCase {
+    int getLine();
 
-    /**
-     * Creates a new instance of a test case.
-     *
-     * @param testSteps   of the test case
-     * @param pickleEvent the pickle executed by this test case
-     * @deprecated not part of the public api
-     */
-    @Deprecated
-    public TestCase(List<TestStep> testSteps, PickleEvent pickleEvent) {
-        this(testSteps, pickleEvent, false);
-    }
+    String getName();
 
-    /**
-     * Creates a new instance of a test case.
-     *
-     * @param testSteps   of the test case
-     * @param pickleEvent the pickle executed by this test case
-     * @param dryRun      skip execution of the test steps
-     * @deprecated not part of the public api
-     */
-    @Deprecated
-    public TestCase(List<TestStep> testSteps, PickleEvent pickleEvent, boolean dryRun) {
-        this.testSteps = testSteps;
-        this.pickleEvent = pickleEvent;
-        this.dryRun = dryRun;
-    }
+    String getScenarioDesignation();
 
-    /**
-     * Executes the test case.
-     *
-     * @param bus to which events should be broadcast
-     * @deprecated not part of the public api
-     */
-    @Deprecated
-    public void run(EventBus bus) {
-        boolean skipNextStep = this.dryRun;
-        Long startTime = bus.getTime();
-        bus.send(new TestCaseStarted(startTime, this));
-        ScenarioImpl scenarioResult = new ScenarioImpl(bus, pickleEvent);
-        for (TestStep step : testSteps) {
-            Result stepResult = step.run(bus, pickleEvent.pickle.getLanguage(), scenarioResult, skipNextStep);
-            if (!stepResult.is(Result.Type.PASSED)) {
-                skipNextStep = true;
-            }
-            scenarioResult.add(stepResult);
-        }
-        Long stopTime = bus.getTime();
-        bus.send(new TestCaseFinished(stopTime, this, new Result(scenarioResult.getStatus(), stopTime - startTime, scenarioResult.getError())));
-    }
+    List<PickleTag> getTags();
 
-    public List<TestStep> getTestSteps() {
-        return testSteps;
-    }
+    List<TestStep> getTestSteps();
 
-    public String getName() {
-        return pickleEvent.pickle.getName();
-    }
-
-    public String getScenarioDesignation() {
-        return fileColonLine(pickleEvent.pickle.getLocations().get(0)) + " # " + getName();
-    }
-
-    public String getUri() {
-        return pickleEvent.uri;
-    }
-
-    public int getLine() {
-        return pickleEvent.pickle.getLocations().get(0).getLine();
-    }
-
-    private String fileColonLine(PickleLocation location) {
-        return pickleEvent.uri + ":" + location.getLine();
-    }
-
-    public List<PickleTag> getTags() {
-        return pickleEvent.pickle.getTags();
-    }
+    String getUri();
 }