Dont register spy if one already exist and is primary - #7621

Author: lsiu

spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java

@@ -18,14 +18,7 @@
 
 import java.beans.PropertyDescriptor;
 import java.lang.reflect.Field;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedHashMap;
-import java.util.LinkedHashSet;
-import java.util.Map;
-import java.util.Set;
-import java.util.TreeSet;
+import java.util.*;
 
 import org.springframework.aop.scope.ScopedProxyUtils;
 import org.springframework.aop.support.AopUtils;
@@ -319,13 +312,30 @@ private void registerSpies(SpyDefinition definition, Field field,
 	}
 
 	private void registerSpy(SpyDefinition definition, Field field, String beanName) {
+		if (isAlreadyRegisteredAndIsPrimary(definition)) {
+			// don't register this new spy since we already registered one which is primary
+			return;
+		}
+
 		this.spies.put(beanName, definition);
 		this.beanNameRegistry.put(definition, beanName);
 		if (field != null) {
 			this.fieldRegistry.put(field, new RegisteredField(definition, beanName));
 		}
 	}
 
+	private boolean isAlreadyRegisteredAndIsPrimary(SpyDefinition definition) {
+		if (this.beanNameRegistry.keySet().contains(definition)) {
+			String existingBeanName = this.beanNameRegistry.get(definition);
+			BeanDefinition existingBeanDefinition = ((ConfigurableListableBeanFactory) this.beanFactory)
+					.getBeanDefinition(existingBeanName);
+			if (existingBeanDefinition.isPrimary()) {
+				return true;
+			}
+		}
+		return false;
+	}
+
 	protected Object createSpyIfNecessary(Object bean, String beanName)
 			throws BeansException {
 		SpyDefinition definition = this.spies.get(beanName);

spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnInterfaceWithTwoBeanWithFirstBeanMarkWithPrimaryTest.java

@@ -0,0 +1,70 @@
+package org.springframework.boot.test.mock.mockito;
+
+import org.hamcrest.Matchers;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+import org.springframework.stereotype.Component;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.mockito.Mockito.doReturn;
+
+/**
+ * Created by lsiu on 2016-12-14.
+ */
+@RunWith(SpringRunner.class)
+public class SpyBeanOnInterfaceWithTwoBeanWithFirstBeanMarkWithPrimaryTest {
+
+	@Autowired
+	private Config.InterfaceAConsumer consumer;
+
+	@SpyBean
+	private Config.TheInterface instance;
+
+	@Test
+	public void test() {
+		doReturn("fromSpyBean").when(instance).giveMeAString();
+		Assert.assertThat(consumer.getTheString(), Matchers.equalTo("fromSpyBean"));
+	}
+
+	@Configuration
+	static class Config {
+		public interface TheInterface {
+			String giveMeAString();
+		}
+
+		@Primary
+		@Component
+		public static class ClassOne implements TheInterface {
+			@Override
+			public String giveMeAString() {
+				return "fromClassOne";
+			}
+		}
+
+		@Component
+		public static class ClassTwo implements TheInterface {
+
+			@Override
+			public String giveMeAString() {
+				return "fromClassTwo";
+			}
+		}
+
+		@Component
+		public static class InterfaceAConsumer {
+			private final TheInterface theInterface;
+
+			public InterfaceAConsumer(TheInterface interfaceA) {
+				this.theInterface = interfaceA;
+			}
+
+			String getTheString() {
+				return theInterface.giveMeAString();
+			}
+		}
+	}
+}

spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnInterfaceWithTwoBeanWithSecondBeanMarkWithPrimaryTest.java

@@ -0,0 +1,70 @@
+package org.springframework.boot.test.mock.mockito;
+
+import org.hamcrest.Matchers;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+import org.springframework.stereotype.Component;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.mockito.Mockito.doReturn;
+
+/**
+ * Created by lsiu on 2016-12-14.
+ */
+@RunWith(SpringRunner.class)
+public class SpyBeanOnInterfaceWithTwoBeanWithSecondBeanMarkWithPrimaryTest {
+
+	@Autowired
+	private Config.InterfaceAConsumer consumer;
+
+	@SpyBean
+	private Config.TheInterface instance;
+
+	@Test
+	public void test() {
+		doReturn("fromSpyBean").when(instance).giveMeAString();
+		Assert.assertThat(consumer.getTheString(), Matchers.equalTo("fromSpyBean"));
+	}
+
+	@Configuration
+	static class Config {
+		public interface TheInterface {
+			String giveMeAString();
+		}
+
+		@Component
+		public static class ClassOne implements TheInterface {
+			@Override
+			public String giveMeAString() {
+				return "fromClassOne";
+			}
+		}
+
+		@Primary
+		@Component
+		public static class ClassTwo implements TheInterface {
+
+			@Override
+			public String giveMeAString() {
+				return "fromClassTwo";
+			}
+		}
+
+		@Component
+		public static class InterfaceAConsumer {
+			private final TheInterface theInterface;
+
+			public InterfaceAConsumer(TheInterface interfaceA) {
+				this.theInterface = interfaceA;
+			}
+
+			String getTheString() {
+				return theInterface.giveMeAString();
+			}
+		}
+	}
+}