Skip test step execution if --dry-run is specified (#1219)

Author: Adrian Baker

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

@@ -19,8 +19,8 @@ public TestCase(List<TestStep> testSteps, PickleEvent pickleEvent) {
         this.pickleEvent = pickleEvent;
     }
 
-    public void run(EventBus bus) {
-        boolean skipNextStep = false;
+    public void run(EventBus bus, boolean dryRun) {
+        boolean skipNextStep = dryRun;
         Long startTime = bus.getTime();
         bus.send(new TestCaseStarted(startTime, this));
         ScenarioImpl scenarioResult = new ScenarioImpl(bus, pickleEvent);

core/src/main/java/cucumber/runner/Runner.java

@@ -77,7 +77,7 @@ public void runUnreportedStep(String featurePath, String language, String stepNa
     public void runPickle(PickleEvent pickle) {
         buildBackendWorlds(); // Java8 step definitions will be added to the glue here
         TestCase testCase = createTestCaseForPickle(pickle);
-        testCase.run(bus);
+        testCase.run(bus, runtimeOptions.isDryRun());
         disposeBackendWorlds();
     }
 

core/src/test/java/cucumber/api/TestCaseTest.java

@@ -33,7 +33,7 @@ public void run_wraps_execute_in_test_case_started_and_finished_events() throws
         when(testStep.run(eq(bus), eq(language), isA(Scenario.class), anyBoolean())).thenReturn(resultWithStatus(Result.Type.UNDEFINED));
 
         TestCase testCase = new TestCase(Arrays.asList(testStep), pickleEvent());
-        testCase.run(bus);
+        testCase.run(bus, false);
 
         InOrder order = inOrder(bus, testStep);
         order.verify(bus).send(isA(TestCaseStarted.class));
@@ -51,7 +51,7 @@ public void run_all_steps() throws Throwable {
         when(testStep2.run(eq(bus), eq(language), isA(Scenario.class), anyBoolean())).thenReturn(resultWithStatus(Result.Type.PASSED));
 
         TestCase testCase = new TestCase(Arrays.asList(testStep1, testStep2), pickleEvent());
-        testCase.run(bus);
+        testCase.run(bus, false);
 
         InOrder order = inOrder(testStep1, testStep2);
         order.verify(testStep1).run(eq(bus), eq(language), isA(Scenario.class), eq(false));
@@ -68,7 +68,7 @@ public void skip_steps_after_the_first_non_passed_result() throws Throwable {
         when(testStep2.run(eq(bus), eq(language), isA(Scenario.class), anyBoolean())).thenReturn(resultWithStatus(Result.Type.SKIPPED));
 
         TestCase testCase = new TestCase(Arrays.asList(testStep1, testStep2), pickleEvent());
-        testCase.run(bus);
+        testCase.run(bus, false);
 
         InOrder order = inOrder(testStep1, testStep2);
         order.verify(testStep1).run(eq(bus), eq(language), isA(Scenario.class), eq(false));

core/src/test/java/cucumber/runner/RunnerTest.java

@@ -40,7 +40,7 @@ public class RunnerTest {
     private final Backend backend = mock(Backend.class);
     private final Runtime runtime = createRuntime(backend);
     private final Runner runner = runtime.getRunner();
-
+    
     @Test
     public void hooks_execute_when_world_exist() throws Throwable {
         HookDefinition beforeHook = addBeforeHook(runtime);
@@ -61,7 +61,7 @@ public void steps_are_skipped_after_failure() throws Throwable {
         doThrow(RuntimeException.class).when(failingBeforeHook).execute(Matchers.<Scenario>any());
         StepDefinition stepDefinition = mock(StepDefinition.class);
 
-        runner.runPickle(createPickleEventMatchingStepDefinitions(asList(stepDefinition)));
+        runner.runPickle(createPickleEventMatchingStepDefinitions(asList(stepDefinition), runtime));
 
         InOrder inOrder = inOrder(failingBeforeHook, stepDefinition);
         inOrder.verify(failingBeforeHook).execute(Matchers.<Scenario>any());
@@ -83,6 +83,25 @@ public void hooks_execute_also_after_failure() throws Throwable {
         inOrder.verify(afterHook).execute(Matchers.<Scenario>any());
     }
 
+    @Test
+    public void steps_are_not_executed_on_dry_run() throws Throwable {
+        // Step without dry-run flag should be executed once
+        {
+            StepDefinition stepDefinition = mock(StepDefinition.class);
+            Runtime runtime = createRuntime(backend);
+            runtime.getRunner().runPickle(createPickleEventMatchingStepDefinitions(asList(stepDefinition), runtime));
+            verify(stepDefinition).execute(Matchers.anyString(), Matchers.<Object[]>any());
+        }
+        
+        // Same step with dry-run flag should not be executred
+        {
+            StepDefinition stepDefinition = mock(StepDefinition.class);
+            Runtime dryRuntime = createRuntime(backend, "--dry-run");
+            dryRuntime.getRunner().runPickle(createPickleEventMatchingStepDefinitions(asList(stepDefinition), dryRuntime));
+            verify(stepDefinition, never()).execute(Matchers.anyString(), Matchers.<Object[]>any());
+        }
+    } 
+    
     @Test
     public void hooks_not_executed_in_dry_run_mode() throws Throwable {
         Runtime runtime = createRuntime(backend, "--dry-run");
@@ -141,7 +160,7 @@ private PickleEvent createEmptyPickleEvent() {
         return new PickleEvent("uri", new Pickle(NAME, ENGLISH, NO_STEPS, NO_TAGS, MOCK_LOCATIONS));
     }
 
-    private PickleEvent createPickleEventMatchingStepDefinitions(List<StepDefinition> stepDefinitions) {
+    private PickleEvent createPickleEventMatchingStepDefinitions(List<StepDefinition> stepDefinitions, Runtime runtime) {
         List<PickleStep> steps = new ArrayList<PickleStep>(stepDefinitions.size());
         int i = 0;
         for (StepDefinition stepDefinition : stepDefinitions) {