Rename the UndefinedStepException class to MissingStepDefinitionExcep…

…tion This pull request fixes #2026 - When a step definition is missing cucumber fails with a undefined step exception. This seems kinda misleading because its the step definition that was missing, not the step that was undefined.
cucumber · Jun 21, 2020 · a52ec88 · a52ec88
1 parent 1fdf68f
commit a52ec88
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 18 deletions.
diff --git a/...atform/engine/UndefinedStepException.java → ...ngine/MissingStepDefinitionException.java b/...atform/engine/UndefinedStepException.java → ...ngine/MissingStepDefinitionException.java
@@ -7,11 +7,11 @@
 
 import static java.util.stream.Collectors.joining;
 
-final class UndefinedStepException extends IncompleteExecutionException {
+final class MissingStepDefinitionException extends IncompleteExecutionException {
 
     private static final long serialVersionUID = 1L;
 
-    UndefinedStepException(List<Suggestion> suggestions) {
+    MissingStepDefinitionException(List<Suggestion> suggestions) {
         super(createMessage(suggestions));
     }
 

diff --git a/...atform-engine/src/main/java/io/cucumber/junit/platform/engine/TestCaseResultObserver.java b/...atform-engine/src/main/java/io/cucumber/junit/platform/engine/TestCaseResultObserver.java
@@ -22,7 +22,7 @@ void assertTestCasePassed() {
         delegate.assertTestCasePassed(
             TestAbortedException::new,
             Function.identity(),
-            UndefinedStepException::new,
+            MissingStepDefinitionException::new,
             Function.identity());
     }
 

diff --git a/...rm-engine/src/test/java/io/cucumber/junit/platform/engine/TestCaseResultObserverTest.java b/...rm-engine/src/test/java/io/cucumber/junit/platform/engine/TestCaseResultObserverTest.java
@@ -223,7 +223,7 @@ void undefined() {
         bus.send(new TestStepFinished(Instant.now(), testCase, testStep, result));
         bus.send(new TestCaseFinished(Instant.now(), testCase, result));
         Exception exception = assertThrows(Exception.class, observer::assertTestCasePassed);
-        assertThat(exception.getCause(), instanceOf(UndefinedStepException.class));
+        assertThat(exception.getCause(), instanceOf(MissingStepDefinitionException.class));
 
         assertThat(exception.getCause().getMessage(), is("" +
                 "The step \"mocked\" is undefined. You can implement it using the snippet(s) below:\n" +

diff --git a/junit/src/main/java/io/cucumber/junit/JUnitReporter.java b/junit/src/main/java/io/cucumber/junit/JUnitReporter.java
@@ -125,11 +125,11 @@ private void handleStepResult(PickleStepTestStep testStep, Result result) {
             case UNDEFINED:
                 Collection<String> snippets = snippetsPerStep.remove(
                     new StepLocation(testStep.getUri(), testStep.getStepLine()));
-                stepErrors.add(new UndefinedStepException(
+                stepErrors.add(new MissingStepDefinitionException(
                     testStep.getStepText(),
                     snippets,
                     snippetsPerStep.values()));
-                stepNotifier.addFailure(error == null ? new UndefinedStepException(snippets) : error);
+                stepNotifier.addFailure(error == null ? new MissingStepDefinitionException(snippets) : error);
                 break;
             default:
                 throw new IllegalStateException("Unexpected result status: " + result.getStatus());

diff --git a/...ucumber/junit/UndefinedStepException.java → ...junit/MissingStepDefinitionException.java b/...ucumber/junit/UndefinedStepException.java → ...junit/MissingStepDefinitionException.java
@@ -5,11 +5,11 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
-final class UndefinedStepException extends RuntimeException {
+final class MissingStepDefinitionException extends RuntimeException {
 
     private static final long serialVersionUID = 1L;
 
-    UndefinedStepException(Collection<String> snippets) {
+    MissingStepDefinitionException(Collection<String> snippets) {
         super(createMessage(snippets), null, false, false);
     }
 
@@ -30,7 +30,7 @@ private static void appendSnippets(Collection<String> snippets, StringBuilder sb
         });
     }
 
-    UndefinedStepException(String stepText, Collection<String> snippets, Collection<Collection<String>> otherSnippets) {
+    MissingStepDefinitionException(String stepText, Collection<String> snippets, Collection<Collection<String>> otherSnippets) {
         super(createMessage(stepText, snippets, otherSnippets), null, false, false);
     }
 

diff --git a/...ber/junit/UndefinedStepExceptionTest.java → ...t/MissingStepDefinitionExceptionTest.java b/...ber/junit/UndefinedStepExceptionTest.java → ...t/MissingStepDefinitionExceptionTest.java
@@ -7,11 +7,11 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 
-class UndefinedStepExceptionTest {
+class MissingStepDefinitionExceptionTest {
 
     @Test
     void should_generate_a_message_for_a_single_snippet() {
-        UndefinedStepException exception = new UndefinedStepException(singletonList("snippet"));
+        MissingStepDefinitionException exception = new MissingStepDefinitionException(singletonList("snippet"));
         assertThat(exception.getMessage(), is("" +
                 "This step is undefined. You can implement it using the snippet(s) below:\n" +
                 "\n" +
@@ -20,7 +20,7 @@ void should_generate_a_message_for_a_single_snippet() {
 
     @Test
     void should_generate_a_message_for_step_without_additional_snippets() {
-        UndefinedStepException exception = new UndefinedStepException(
+        MissingStepDefinitionException exception = new MissingStepDefinitionException(
             "step text",
             singletonList("snippet"),
             emptyList());
@@ -32,7 +32,7 @@ void should_generate_a_message_for_step_without_additional_snippets() {
 
     @Test
     void should_generate_a_message_for_step_with_additional_snippets() {
-        UndefinedStepException exception = new UndefinedStepException(
+        MissingStepDefinitionException exception = new MissingStepDefinitionException(
             "step text",
             singletonList("snippet"),
             singletonList(singletonList("additional snippet")));
@@ -49,7 +49,7 @@ void should_generate_a_message_for_step_with_additional_snippets() {
 
     @Test
     void should_generate_a_message_for_step_with_additional_duplicated_snippets() {
-        UndefinedStepException exception = new UndefinedStepException(
+        MissingStepDefinitionException exception = new MissingStepDefinitionException(
             "step text",
             singletonList("snippet"),
             singletonList(singletonList("snippet")));

diff --git a/...cumber/testng/UndefinedStepException.java → ...estng/MissingStepDefinitionException.java b/...cumber/testng/UndefinedStepException.java → ...estng/MissingStepDefinitionException.java
@@ -7,11 +7,11 @@
 
 import static java.util.stream.Collectors.joining;
 
-final class UndefinedStepException extends SkipException {
+final class MissingStepDefinitionException extends SkipException {
 
     private static final long serialVersionUID = 1L;
 
-    UndefinedStepException(List<Suggestion> suggestions) {
+    MissingStepDefinitionException(List<Suggestion> suggestions) {
         super(createMessage(suggestions));
     }
 

diff --git a/testng/src/main/java/io/cucumber/testng/TestCaseResultObserver.java b/testng/src/main/java/io/cucumber/testng/TestCaseResultObserver.java
@@ -25,7 +25,7 @@ void assertTestCasePassed() {
             (exception) -> exception instanceof SkipException
                     ? exception
                     : new SkipException(exception.getMessage(), exception),
-            UndefinedStepException::new,
+            MissingStepDefinitionException::new,
             Function.identity());
     }
 

diff --git a/testng/src/test/java/io/cucumber/testng/TestNGCucumberRunnerTest.java b/testng/src/test/java/io/cucumber/testng/TestNGCucumberRunnerTest.java
@@ -41,7 +41,7 @@ public void runScenarioWithUndefinedStepsStrict() {
         PickleWrapper wrapper = (PickleWrapper) scenario[0];
 
         assertThrows(
-            UndefinedStepException.class,
+            MissingStepDefinitionException.class,
             () -> testNGCucumberRunner.runScenario(wrapper.getPickle()));
     }