Deprecated in favour of .

Author: aslakhellesoy

History.md

@@ -1,5 +1,7 @@
 ## [Git master](https://github.com/cucumber/cucumber-jvm/compare/v1.1.1...master)
 
+* [Core] Deprecated `cucumber.runtime.PendingException` in favour of `cucumber.api.PendingException`. (Aslak Hellesøy)
+* [Core] New `@cucumber.api.Pending` annotation for custom `Exception` classes that will cause a scenario to be `pending` instead of `failed`. ([#427](https://github.com/cucumber/cucumber-jvm/pull/427) agattiker)
 * [Core] `--name 'name with spaces in single quotes'` is working ([#379](https://github.com/cucumber/cucumber-jvm/issues/379), [#429](https://github.com/cucumber/cucumber-jvm/pull/429) William Powell)
 
 ## [1.1.1](https://github.com/cucumber/cucumber-jvm/compare/v1.0.14...1.1.1)

clojure/src/main/clj/cucumber/runtime/clj.clj

@@ -25,7 +25,7 @@
       (str
        "({0} #\"{1}\" [{3}]\n"
        "  (comment  {4}  )\n"
-       "  (throw (cucumber.runtime.PendingException.)))\n"))
+       "  (throw (cucumber.api.PendingException.)))\n"))
     (arguments [_ argumentTypes]
       (str/replace (SnippetGenerator/untypedArguments argumentTypes)
                    "," ""))

clojure/src/test/java/cucumber/runtime/clojure/ClojureSnippet.java

@@ -15,7 +15,7 @@ public class ClojureSnippet implements Snippet {
     public String template() {
         return "({0} #\"{1}\" [{3}]\n" +
                 "  (comment  {4}  )\n" +
-                "  (throw (cucumber.runtime.PendingException.)))\n";
+                "  (throw (cucumber.api.PendingException.)))\n";
     }
 
     @Override

clojure/src/test/java/cucumber/runtime/clojure/ClojureSnippetTest.java

@@ -22,7 +22,7 @@ public void generatesPlainSnippet() {
         String expected = "" +
                 "(Given #\"^I have (\\d+) cukes in my \\\"([^\\\"]*)\\\" belly$\" [arg1 arg2]\n" +
                 "  (comment  Express the Regexp above with the code you wish you had  )\n" +
-                "  (throw (cucumber.runtime.PendingException.)))\n";
+                "  (throw (cucumber.api.PendingException.)))\n";
         assertEquals(expected, snippet);
     }
 
@@ -34,7 +34,7 @@ public void generatesSnippetWithDataTable() {
         String expected = "" +
                 "(Given #\"^I have:$\" [arg1]\n" +
                 "  (comment  Express the Regexp above with the code you wish you had  )\n" +
-                "  (throw (cucumber.runtime.PendingException.)))\n";
+                "  (throw (cucumber.api.PendingException.)))\n";
         assertEquals(expected, snippet);
     }
 }

clojure/src/test/resources/cucumber/runtime/clojure/stepdefs.clj

@@ -26,7 +26,7 @@
 
 (Given #"^(\d+) unimplemented step$" [arg1]
   (comment  Express the Regexp above with the code you wish you had  )
-  (throw (cucumber.runtime.PendingException. "This is pending. Seeing a stacktrace here is normal.")))
+  (throw (cucumber.api.PendingException. "This is pending. Seeing a stacktrace here is normal.")))
 
 (def most-recent (atom nil))
 

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

@@ -0,0 +1,18 @@
+package cucumber.api;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Any exception class annotated with this annotation will be treated as a "pending" exception.
+ * That is - if the exception is thrown from a step definition or hook, the scenario's status will
+ * be pending instead of failed.
+ *
+ * @see PendingException
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Pending {
+}

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

@@ -0,0 +1,13 @@
+package cucumber.api;
+
+// We're deliberately not extending CucumberException (which is used to signal fatal errors)
+@Pending
+public class PendingException extends RuntimeException {
+    public PendingException() {
+        this("TODO: implement me");
+    }
+
+    public PendingException(String message) {
+        super(message);
+    }
+}

core/src/main/java/cucumber/runtime/Pending.java

@@ -1,6 +1,12 @@
 package cucumber.runtime;
 
-// We're deliberately not extending CucumberException (which is used to signal fatal errors)
+import cucumber.api.Pending;
+
+/**
+ * @see cucumber.api.PendingException
+ * @deprecated Use cucumber.api.PendingException
+ */
+@Deprecated
 @Pending
 public class PendingException extends RuntimeException {
     public PendingException() {

core/src/main/java/cucumber/runtime/PendingException.java

@@ -1,5 +1,6 @@
 package cucumber.runtime;
 
+import cucumber.api.Pending;
 import cucumber.runtime.io.ClasspathResourceLoader;
 import cucumber.runtime.io.ResourceLoader;
 import cucumber.runtime.model.CucumberFeature;
@@ -208,7 +209,6 @@ private void runHookIfTagsMatch(HookDefinition hook, Reporter reporter, Set<Tag>
         }
     }
 
-
     //TODO: Maybe this should go into the cucumber step execution model and it should return the result of that execution!
     @Override
     public void runUnreportedStep(String uri, I18n i18n, String stepKeyword, String stepName, int line, List<DataTableRow> dataTableRows, DocString docString) throws Throwable {
@@ -279,10 +279,7 @@ public void runStep(String uri, Step step, Reporter reporter, I18n i18n) {
     }
 
     private static boolean isPending(Throwable t) {
-    	if (t.getClass().isAnnotationPresent(Pending.class)) {
-    		return true;
-    	}
-        return Arrays.binarySearch(PENDING_EXCEPTIONS, t.getClass().getName()) >= 0;
+        return t.getClass().isAnnotationPresent(Pending.class) || Arrays.binarySearch(PENDING_EXCEPTIONS, t.getClass().getName()) >= 0;
     }
 
     public void writeStepdefsJson() throws IOException {

core/src/main/java/cucumber/runtime/Runtime.java

@@ -1,5 +1,6 @@
 package cucumber.runtime;
 
+import cucumber.api.PendingException;
 import cucumber.runtime.io.ClasspathResourceLoader;
 import cucumber.runtime.io.ResourceLoader;
 import cucumber.runtime.model.CucumberFeature;

core/src/test/java/cucumber/runtime/RuntimeTest.java

@@ -123,7 +123,7 @@ def write_pending_mapping(step_name)
 public class Mappings<%= @@mappings_counter %> {
     @Given("<%= step_name -%>")
     public void <%= step_name.gsub(/[\s:]/, '_') -%>() {
-        throw new cucumber.runtime.PendingException();
+        throw new cucumber.api.PendingException();
     }
 }
 

java/src/test/resources/cucumber-tck/cucumber_java_mappings.rb

@@ -5,7 +5,7 @@
 import cucumber.runtime.Backend;
 import cucumber.runtime.CucumberException;
 import cucumber.runtime.Glue;
-import cucumber.runtime.PendingException;
+import cucumber.api.PendingException;
 import cucumber.runtime.UnreportedStepExecutor;
 import cucumber.runtime.io.Resource;
 import cucumber.runtime.io.ResourceLoader;

jruby/src/main/java/cucumber/runtime/jruby/JRubyBackend.java

@@ -1,6 +1,6 @@
 package cucumber.runtime.junit;
 
-import cucumber.runtime.PendingException;
+import cucumber.api.PendingException;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Reporter;
 import gherkin.formatter.model.Background;

junit/src/main/java/cucumber/runtime/junit/JUnitReporter.java

@@ -1,6 +1,6 @@
 package cucumber.runtime.junit;
 
-import cucumber.runtime.PendingException;
+import cucumber.api.PendingException;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Reporter;
 import gherkin.formatter.model.Result;

junit/src/test/java/cucumber/runtime/junit/JUnitReporterTest.java

@@ -1,11 +1,11 @@
 package cucumber.runtime.java.picocontainer;
 
+import cucumber.api.PendingException;
 import cucumber.api.Scenario;
 import cucumber.api.java.After;
 import cucumber.api.java.Before;
 import cucumber.api.java.en.Given;
 import cucumber.api.java.en.Then;
-import cucumber.runtime.PendingException;
 
 import java.util.List;
 

picocontainer/src/test/java/cucumber/runtime/java/picocontainer/StepDefs.java

@@ -11,7 +11,7 @@ public class JavaScriptSnippet implements Snippet {
     public String template() {
         return "{0}(/{1}/, function({3}) '{'\n" +
                 "  // {4}\n" +
-                "  throw new Packages.cucumber.runtime.PendingException();\n" +
+                "  throw new Packages.cucumber.api.PendingException();\n" +
                 "'}');\n";
     }
 

rhino/src/main/java/cucumber/runtime/rhino/JavaScriptSnippet.java

@@ -16,7 +16,7 @@ public void generatesPlainSnippet() {
         String expected = "" +
                 "Given(/^I have (\\d+) cukes in my \"([^\"]*)\" belly$/, function(arg1, arg2) {\n" +
                 "  // Express the Regexp above with the code you wish you had\n" +
-                "  throw new Packages.cucumber.runtime.PendingException();\n" +
+                "  throw new Packages.cucumber.api.PendingException();\n" +
                 "});\n";
         assertEquals(expected, snippetFor("I have 4 cukes in my \"big\" belly"));
     }