1313import org .springframework .context .ConfigurableApplicationContext ;
1414import org .springframework .context .support .ClassPathXmlApplicationContext ;
1515import org .springframework .context .support .GenericApplicationContext ;
16+ import org .springframework .stereotype .Component ;
1617import org .springframework .test .context .ContextConfiguration ;
1718import org .springframework .test .context .ContextHierarchy ;
1819import org .springframework .test .context .TestContextManager ;
1920
2021import java .lang .annotation .Annotation ;
2122import java .util .Collection ;
2223import java .util .HashSet ;
24+ import java .util .Set ;
25+ import java .util .Stack ;
2326
2427/**
2528 * Spring based implementation of ObjectFactory.
2629 * <p/>
2730 * <p>
2831 * <ul>
2932 * <li>It uses TestContextManager to manage the spring context.
30- * Configuration via: @ContextConfiguration or @ContextHierarcy
31- * At least on step definition class needs to have a @ContextConfiguration or
32- * @ContextHierarchy annotation. If more that one step definition class has such
33+ * Configuration via: @{@link ContextConfiguration} or @{@link ContextHierarchy}
34+ * At least one step definition class needs to have a @ContextConfiguration
35+ * or @ContextHierarchy annotation. If more that one step definition class has such
3336 * an annotation, the annotations must be equal on the different step definition
34- * classes. If no step definition class with @ContextConfiguration or
35- * @ContextHierarcy is found, it will try to load cucumber.xml from the classpath.
37+ * classes. If no step definition class with @ContextConfiguration or @ContextHierarchy
38+ * is found, it will try to load cucumber.xml from the classpath.
3639 * </li>
3740 * <li>The step definitions class with @ContextConfiguration or @ContextHierarchy
38- * annotation, may also have a @WebAppConfiguration or @DirtiesContext annotation.
41+ * annotation, may also have a @{@link org.springframework.test.context.web.WebAppConfiguration}
42+ * or @{@link org.springframework.test.annotation.DirtiesContext} annotation.
3943 * </li>
40- * <li>The step definitions added to the TestContextManagers context and
44+ * <li>The step definitions are added to the TestContextManagers context and
4145 * is reloaded for each scenario.</li>
46+ * <li>Step definitions should not be annotated with @{@link Component} or
47+ * other annotations that mark it as eligible for detection by classpath scanning.</li>
48+ * <li>When a step definition class is annotated by @Component or an annotation that has the @Component stereotype an
49+ * exception will be thrown</li>
50+ * </li>
4251 * </ul>
43- * </p>
4452 * <p/>
4553 * <p>
4654 * Application beans are accessible from the step definitions using autowiring
@@ -61,6 +69,7 @@ public SpringFactory() {
6169 @ Override
6270 public boolean addClass (final Class <?> stepClass ) {
6371 if (!stepClasses .contains (stepClass )) {
72+ checkNoComponentAnnotations (stepClass );
6473 if (dependsOnSpringContext (stepClass )) {
6574 if (stepClassWithSpringContext == null ) {
6675 stepClassWithSpringContext = stepClass ;
@@ -73,6 +82,42 @@ public boolean addClass(final Class<?> stepClass) {
7382 return true ;
7483 }
7584
85+ private static void checkNoComponentAnnotations (Class <?> type ) {
86+ for (Annotation annotation : type .getAnnotations ()) {
87+ if (hasComponentStereoType (annotation )) {
88+ throw new CucumberException (String .format ("" +
89+ "Glue class %1$s was annotated with @%2$s; marking it as a candidate for auto-detection by " +
90+ "Spring. Glue classes are detected and registered by Cucumber. Auto-detection of glue classes by " +
91+ "spring may lead to duplicate bean definitions. Please remove the @%2$s annotation" ,
92+ type .getName (),
93+ annotation .annotationType ().getSimpleName ()));
94+ }
95+ }
96+ }
97+
98+ private static boolean hasComponentStereoType (Annotation annotation ) {
99+ Set <Class <? extends Annotation >> seen = new HashSet <Class <? extends Annotation >>();
100+ Stack <Class <? extends Annotation >> toCheck = new Stack <Class <? extends Annotation >>();
101+ toCheck .add (annotation .annotationType ());
102+
103+ while (!toCheck .isEmpty ()) {
104+ Class <? extends Annotation > annotationType = toCheck .pop ();
105+ if (Component .class .equals (annotationType )) {
106+ return true ;
107+ }
108+
109+ seen .add (annotationType );
110+ for (Annotation annotationTypesAnnotations : annotationType .getAnnotations ()) {
111+ if (!seen .contains (annotationTypesAnnotations .annotationType ())) {
112+ toCheck .add (annotationTypesAnnotations .annotationType ());
113+ }
114+ }
115+
116+ }
117+ return false ;
118+ }
119+
120+
76121 private void checkAnnotationsEqual (Class <?> stepClassWithSpringContext , Class <?> stepClass ) {
77122 Annotation [] annotations1 = stepClassWithSpringContext .getAnnotations ();
78123 Annotation [] annotations2 = stepClass .getAnnotations ();
0 commit comments