[Spring] Throw exception when step definitions are annotated with component

When step definitions are annotated with @component or other related
annotations they can be picked up by springs class path scanning. This
conflicts with cucumbers class path scanning and may result in
multiple bean definitions for the same class.

This problem is hard to understand and hard to trace. By making the
problem explicit and providing a clear instruction on how to resolve
this we can hopefully avoid future confusion.

The current implementation only checks the a subset of all annotations.
This will hopefully be sufficient.

Closes #1225

Author: mpkorstanje

spring/src/main/java/cucumber/runtime/java/spring/SpringFactory.java

@@ -1,5 +1,6 @@
 package cucumber.runtime.java.spring;
 
+import static java.util.Arrays.asList;
 import static org.springframework.test.context.FixBootstrapUtils.createBootstrapContext;
 import static org.springframework.test.context.FixBootstrapUtils.resolveTestContextBootstrapper;
 
@@ -13,34 +14,44 @@
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.support.ClassPathXmlApplicationContext;
 import org.springframework.context.support.GenericApplicationContext;
+import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Controller;
+import org.springframework.stereotype.Repository;
+import org.springframework.stereotype.Service;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.ContextHierarchy;
 import org.springframework.test.context.TestContextManager;
 
 import java.lang.annotation.Annotation;
 import java.util.Collection;
 import java.util.HashSet;
+import java.util.List;
 
 /**
  * Spring based implementation of ObjectFactory.
  * <p/>
  * <p>
  * <ul>
  * <li>It uses TestContextManager to manage the spring context.
- * Configuration via: @ContextConfiguration or @ContextHierarcy
- * At least on step definition class needs to have a @ContextConfiguration or
- * @ContextHierarchy annotation. If more that one step definition class has such
+ * Configuration via: @{@link ContextConfiguration} or @{@link ContextHierarchy}
+ * At least one step definition class needs to have a @ContextConfiguration
+ * or @ContextHierarchy annotation. If more that one step definition class has such
  * an annotation, the annotations must be equal on the different step definition
- * classes. If no step definition class with @ContextConfiguration or
- * @ContextHierarcy is found, it will try to load cucumber.xml from the classpath.
+ * classes. If no step definition class with @ContextConfiguration or @ContextHierarchy
+ * is found, it will try to load cucumber.xml from the classpath.
  * </li>
  * <li>The step definitions class with @ContextConfiguration or @ContextHierarchy
- * annotation, may also have a @WebAppConfiguration or @DirtiesContext annotation.
+ * annotation, may also have a @{@link org.springframework.test.context.web.WebAppConfiguration}
+ * or @{@link org.springframework.test.annotation.DirtiesContext} annotation.
  * </li>
  * <li>The step definitions added to the TestContextManagers context and
  * is reloaded for each scenario.</li>
+ * <li>Step definition classes should not be annotated with @{@link Component} or
+ * other annotations that  marks it as eligible for detection by classpath scanning.</li>
+ * <li>When a step definition class is annotated with @Component, @{@link Controller}, @{@link Repository}
+ * or @{@link Service} an exception will be thrown.</li>
+ * </li>
  * </ul>
- * </p>
  * <p/>
  * <p>
  * Application beans are accessible from the step definitions using autowiring
@@ -49,6 +60,8 @@
  */
 public class SpringFactory implements ObjectFactory {
 
+    private static final List<Class<? extends Annotation>> componentStereoTypes = asList(Component.class, Controller.class, Repository.class, Service.class);
+
     private ConfigurableListableBeanFactory beanFactory;
     private CucumberTestContextManager testContextManager;
 
@@ -61,6 +74,7 @@ public SpringFactory() {
     @Override
     public boolean addClass(final Class<?> stepClass) {
         if (!stepClasses.contains(stepClass)) {
+            checkNoComponentAnnotations(stepClass);
             if (dependsOnSpringContext(stepClass)) {
                 if (stepClassWithSpringContext == null) {
                     stepClassWithSpringContext = stepClass;
@@ -73,6 +87,20 @@ public boolean addClass(final Class<?> stepClass) {
         return true;
     }
 
+    private void checkNoComponentAnnotations(Class<?> type) {
+        for (Class<? extends Annotation> stereoType : componentStereoTypes) {
+            if (type.isAnnotationPresent(stereoType)) {
+                throw new CucumberException(String.format("" +
+                        "Glue class %1$s was annotated with @%2$s; marking it as a candidate for auto-detection by " +
+                        "Spring. Glue classes are detected and registered by Cucumber. Auto-detection of glue classes by " +
+                        "spring may lead to duplicate bean definitions. Please remove the @%2$s annotation",
+                    type.getName(),
+                    stereoType.getSimpleName()));
+            }
+        }
+    }
+
+
     private void checkAnnotationsEqual(Class<?> stepClassWithSpringContext, Class<?> stepClass) {
         Annotation[] annotations1 = stepClassWithSpringContext.getAnnotations();
         Annotation[] annotations2 = stepClass.getAnnotations();

spring/src/test/java/cucumber/runtime/java/spring/SpringFactoryTest.java

@@ -7,6 +7,8 @@
 import cucumber.runtime.java.spring.commonglue.AutowiresThirdStepDef;
 import cucumber.runtime.java.spring.commonglue.OneStepDef;
 import cucumber.runtime.java.spring.commonglue.ThirdStepDef;
+import cucumber.runtime.java.spring.componentannotation.WithComponentAnnotation;
+import cucumber.runtime.java.spring.componentannotation.WithControllerAnnotation;
 import cucumber.runtime.java.spring.metaconfig.general.BellyMetaStepdefs;
 import cucumber.runtime.java.spring.contextconfig.BellyStepdefs;
 import cucumber.runtime.java.spring.contextconfig.WithSpringAnnotations;
@@ -247,4 +249,18 @@ public void shouldFailIfClassesWithDifferentSpringAnnotationsAreFound() {
         factory.addClass(WithContextHierarchyAnnotation.class);
         factory.addClass(WithDifferentContextHierarchyAnnotation.class);
     }
+
+    @Test(expected=CucumberException.class)
+    public void shouldFailIfClassWithSpringComponentAnnotationsIsFound() {
+        final ObjectFactory factory = new SpringFactory();
+        factory.addClass(WithComponentAnnotation.class);
+
+    }
+
+    @Test(expected=CucumberException.class)
+    public void shouldFailIfClassWithAnnotationAnnotatedWithSpringComponentAnnotationsIsFound() {
+        final ObjectFactory factory = new SpringFactory();
+        factory.addClass(WithControllerAnnotation.class);
+
+    }
 }

spring/src/test/java/cucumber/runtime/java/spring/componentannotation/WithComponentAnnotation.java

@@ -0,0 +1,23 @@
+package cucumber.runtime.java.spring.componentannotation;
+
+import cucumber.runtime.java.spring.beans.DummyComponent;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.ContextHierarchy;
+
+@Component
+public class WithComponentAnnotation {
+
+    private boolean autowired;
+
+    @Autowired
+    public void setAutowiredCollaborator(DummyComponent collaborator) {
+        autowired = true;
+    }
+
+    public boolean isAutowired() {
+        return autowired;
+    }
+
+}

spring/src/test/java/cucumber/runtime/java/spring/componentannotation/WithControllerAnnotation.java

@@ -0,0 +1,22 @@
+package cucumber.runtime.java.spring.componentannotation;
+
+import cucumber.runtime.java.spring.beans.DummyComponent;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Controller;
+import org.springframework.stereotype.Repository;
+
+@Controller
+public class WithControllerAnnotation {
+
+    private boolean autowired;
+
+    @Autowired
+    public void setAutowiredCollaborator(DummyComponent collaborator) {
+        autowired = true;
+    }
+
+    public boolean isAutowired() {
+        return autowired;
+    }
+
+}

spring/src/test/java/cucumber/runtime/java/spring/componentannotation/WithRepositoryAnnotation.java

@@ -0,0 +1,22 @@
+package cucumber.runtime.java.spring.componentannotation;
+
+import cucumber.runtime.java.spring.beans.DummyComponent;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Repository;
+import org.springframework.stereotype.Service;
+
+@Repository
+public class WithRepositoryAnnotation {
+
+    private boolean autowired;
+
+    @Autowired
+    public void setAutowiredCollaborator(DummyComponent collaborator) {
+        autowired = true;
+    }
+
+    public boolean isAutowired() {
+        return autowired;
+    }
+
+}

spring/src/test/java/cucumber/runtime/java/spring/componentannotation/WithServiceAnnotation.java

@@ -0,0 +1,22 @@
+package cucumber.runtime.java.spring.componentannotation;
+
+import cucumber.runtime.java.spring.beans.DummyComponent;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Service;
+
+@Service
+public class WithServiceAnnotation {
+
+    private boolean autowired;
+
+    @Autowired
+    public void setAutowiredCollaborator(DummyComponent collaborator) {
+        autowired = true;
+    }
+
+    public boolean isAutowired() {
+        return autowired;
+    }
+
+}