[Spring] Deprecate context configuration by more than one class

cucumber · Oct 15, 2017 · 0d0baef · 0d0baef
1 parent 9a951ec
commit 0d0baef
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 4 deletions.
diff --git a/spring/src/main/java/cucumber/runtime/java/spring/SpringFactory.java b/spring/src/main/java/cucumber/runtime/java/spring/SpringFactory.java
@@ -62,6 +62,7 @@ public class SpringFactory implements ObjectFactory {
 
     private final Collection<Class<?>> stepClasses = new HashSet<Class<?>>();
     private Class<?> stepClassWithSpringContext = null;
+    private boolean deprecationWarningIssued = false;
 
     public SpringFactory() {
     }
@@ -119,6 +120,14 @@ private static boolean hasComponentStereoType(Annotation annotation) {
 
 
     private void checkAnnotationsEqual(Class<?> stepClassWithSpringContext, Class<?> stepClass) {
+	if (!deprecationWarningIssued) {
+	    deprecationWarningIssued = true;
+	    System.err.println(String.format("" +
+	            "WARNING: Having more than one glue class that configures " +
+		    "the spring context is deprecated. Found both %1$s and %2$s " +
+		    "that attempt to configure the spring context.",
+		    stepClass, stepClassWithSpringContext));
+	}
         Annotation[] annotations1 = stepClassWithSpringContext.getAnnotations();
         Annotation[] annotations2 = stepClass.getAnnotations();
         if (annotations1.length != annotations2.length) {

diff --git a/spring/src/test/java/cucumber/runtime/java/spring/SpringFactoryTest.java b/spring/src/test/java/cucumber/runtime/java/spring/SpringFactoryTest.java
@@ -16,6 +16,8 @@
 import cucumber.runtime.java.spring.contexthierarchyconfig.WithDifferentContextHierarchyAnnotation;
 import cucumber.runtime.java.spring.dirtiescontextconfig.DirtiesContextBellyStepDefs;
 import cucumber.runtime.java.spring.metaconfig.dirties.DirtiesContextBellyMetaStepDefs;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -244,17 +246,37 @@ public void shouldUseCucumberXmlIfNoClassWithSpringAnnotationIsFound() {
     @Test
     public void shouldAllowClassesWithSameSpringAnnotations() {
         final ObjectFactory factory = new SpringFactory();
-        factory.addClass(WithSpringAnnotations.class);
-        factory.addClass(BellyStepdefs.class);
+	PrintStream originalErr = System.err;
+	try {
+	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+	    System.setErr(new PrintStream(baos));
+	    factory.addClass(WithSpringAnnotations.class);
+	    factory.addClass(BellyStepdefs.class);
+	    assertEquals("WARNING: Having more than one glue class that configures " +
+                         "the spring context is deprecated. Found both class " +
+                         "cucumber.runtime.java.spring.contextconfig.BellyStepdefs and class " +
+                         "cucumber.runtime.java.spring.contextconfig.WithSpringAnnotations " +
+                         "that attempt to configure the spring context.\n",
+			 baos.toString());
+	} finally {
+	    System.setErr(originalErr);
+	}
     }
 
     @Test
     public void shouldFailIfClassesWithDifferentSpringAnnotationsAreFound() {
         expectedException.expect(CucumberException.class);
         expectedException.expectMessage("Annotations differs on glue classes found: cucumber.runtime.java.spring.contexthierarchyconfig.WithContextHierarchyAnnotation, cucumber.runtime.java.spring.contexthierarchyconfig.WithDifferentContextHierarchyAnnotation");
         final ObjectFactory factory = new SpringFactory();
-        factory.addClass(WithContextHierarchyAnnotation.class);
-        factory.addClass(WithDifferentContextHierarchyAnnotation.class);
+	PrintStream originalErr = System.err;
+	try {
+	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+	    System.setErr(new PrintStream(baos));
+            factory.addClass(WithContextHierarchyAnnotation.class);
+            factory.addClass(WithDifferentContextHierarchyAnnotation.class);
+	} finally {
+	    System.setErr(originalErr);
+	}
     }
 
     @Test