[Core] Added extraGlue option to @CucumberOptions (cucumber#1439)

This option works similarly to glue, specifing packages in which to
search for steps and hooks, but the default search path (the
current package) is included in the list of glue packages, whereas
glue includes only the explicitly listed packages.

Closes cucumber#1438.

Author: ekalin

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

@@ -31,6 +31,11 @@
      */
     String[] glue() default {};
 
+    /**
+     * @return where to look for glue code (stepdefs and hooks), in addition to default search path
+     */
+    String[] extraGlue() default {};
+
     /**
      * @return what tags in the features should be executed
      */

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

@@ -1,7 +1,6 @@
 package cucumber.runtime;
 
 import cucumber.api.CucumberOptions;
-import cucumber.runtime.formatter.PluginFactory;
 import cucumber.runtime.io.MultiLoader;
 
 import java.util.ArrayList;
@@ -13,7 +12,7 @@
 public class RuntimeOptionsFactory {
     private final Class clazz;
     private boolean featuresSpecified = false;
-    private boolean glueSpecified = false;
+    private boolean overridingGlueSpecified = false;
 
     public RuntimeOptionsFactory(Class clazz) {
         this.clazz = clazz;
@@ -43,7 +42,7 @@ private List<String> buildArgsFromOptions() {
             }
         }
         addDefaultFeaturePathIfNoFeaturePathIsSpecified(args, clazz);
-        addDefaultGlueIfNoGlueIsSpecified(args, clazz);
+        addDefaultGlueIfNoOverridingGlueIsSpecified(args, clazz);
         return args;
     }
 
@@ -101,15 +100,30 @@ private void addDefaultFeaturePathIfNoFeaturePathIsSpecified(List<String> args,
     }
 
     private void addGlue(CucumberOptions options, List<String> args) {
-        for (String glue : options.glue()) {
+        boolean hasExtraGlue = options.extraGlue().length > 0;
+        boolean hasGlue = options.glue().length > 0;
+
+        if (hasExtraGlue && hasGlue) {
+            throw new CucumberException("glue and extraGlue cannot be specified at the same time");
+        }
+
+        String[] gluePaths = {};
+        if (hasExtraGlue) {
+            gluePaths = options.extraGlue();
+        }
+        if (hasGlue) {
+            gluePaths = options.glue();
+            overridingGlueSpecified = true;
+        }
+
+        for (String glue : gluePaths) {
             args.add("--glue");
             args.add(glue);
-            glueSpecified = true;
         }
     }
 
-    private void addDefaultGlueIfNoGlueIsSpecified(List<String> args, Class clazz) {
-        if (!glueSpecified) {
+    private void addDefaultGlueIfNoOverridingGlueIsSpecified(List<String> args, Class clazz) {
+        if (!overridingGlueSpecified) {
             args.add("--glue");
             args.add(MultiLoader.CLASSPATH_SCHEME + packagePath(clazz));
         }

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

@@ -150,6 +150,44 @@ private void assertPluginExists(List<Plugin> plugins, String pluginName) {
         assertTrue(pluginName + " not found among the plugins", found);
     }
 
+    @Test
+    public void create_with_glue() {
+        RuntimeOptionsFactory runtimeOptionsFactory = new RuntimeOptionsFactory(ClassWithGlue.class);
+        RuntimeOptions runtimeOptions = runtimeOptionsFactory.create();
+
+        assertEquals(asList("app.features.user.registration", "app.features.hooks"), runtimeOptions.getGlue());
+    }
+
+    @Test
+    public void create_with_extra_glue() {
+        RuntimeOptionsFactory runtimeOptionsFactory = new RuntimeOptionsFactory(ClassWithExtraGlue.class);
+        RuntimeOptions runtimeOptions = runtimeOptionsFactory.create();
+
+        assertEquals(asList("app.features.hooks", "classpath:cucumber/runtime"), runtimeOptions.getGlue());
+    }
+
+    @Test
+    public void create_with_extra_glue_in_subclass_of_extra_glue() {
+        RuntimeOptionsFactory runtimeOptionsFactory = new RuntimeOptionsFactory(SubClassWithExtraGlueOfExtraGlue.class);
+        RuntimeOptions runtimeOptions = runtimeOptionsFactory.create();
+
+        assertEquals(asList("app.features.user.hooks", "app.features.hooks", "classpath:cucumber/runtime"), runtimeOptions.getGlue());
+    }
+
+    @Test
+    public void create_with_extra_glue_in_subclass_of_glue() {
+        RuntimeOptionsFactory runtimeOptionsFactory = new RuntimeOptionsFactory(SubClassWithExtraGlueOfGlue.class);
+        RuntimeOptions runtimeOptions = runtimeOptionsFactory.create();
+
+        assertEquals(asList("app.features.user.hooks", "app.features.user.registration", "app.features.hooks"), runtimeOptions.getGlue());
+    }
+
+    @Test(expected = CucumberException.class)
+    public void cannot_create_with_glue_and_extra_glue() {
+        RuntimeOptionsFactory runtimeOptionsFactory = new RuntimeOptionsFactory(ClassWithGlueAndExtraGlue.class);
+        runtimeOptionsFactory.create();
+    }
+
 
     @CucumberOptions(snippets = SnippetType.CAMELCASE)
     private static class Snippets {
@@ -218,4 +256,29 @@ private static class ClassWithJunitOption {
         // empty
     }
 
+    @CucumberOptions(glue = {"app.features.user.registration", "app.features.hooks"})
+    private static class ClassWithGlue {
+        // empty
+    }
+
+    @CucumberOptions(extraGlue = {"app.features.hooks"})
+    private static class ClassWithExtraGlue {
+        // empty
+    }
+
+    @CucumberOptions(extraGlue = {"app.features.user.hooks"})
+    private static class SubClassWithExtraGlueOfExtraGlue extends ClassWithExtraGlue {
+        // empty
+    }
+
+    @CucumberOptions(extraGlue = {"app.features.user.hooks"})
+    private static class SubClassWithExtraGlueOfGlue extends ClassWithGlue {
+        // empty
+    }
+
+    @CucumberOptions(extraGlue = {"app.features.hooks"}, glue = {"app.features.user.registration"})
+    private static class ClassWithGlueAndExtraGlue {
+        // empty
+    }
+
 }