#202 - Can not apply Spy to a bean in the test scope

Author: rbygrave

inject-test/src/test/java/org/example/custom2/OcsOne.java

@@ -3,4 +3,7 @@
 @OtherScope
 public class OcsOne implements OciPlant, OciRock {
 
+  public String one() {
+    return "realOne";
+  }
 }

inject-test/src/test/java/org/example/custom2/OcsTwo.java

@@ -1,5 +1,8 @@
 package org.example.custom2;
 
+import jakarta.inject.Named;
+
+@Named("two")
 @OciMarker
 @OtherScope
 public class OcsTwo implements OciRock {
@@ -9,4 +12,8 @@ public class OcsTwo implements OciRock {
   OcsTwo(OcsOne one) {
     this.one = one;
   }
+
+  public String twoPlusOne() {
+    return "two+" + one.one();
+  }
 }

inject-test/src/test/java/org/example/custom2/ParentScopeSpyTest.java

@@ -0,0 +1,107 @@
+package org.example.custom2;
+
+import io.avaje.inject.BeanScope;
+import io.avaje.inject.spi.Builder;
+import io.avaje.inject.spi.Module;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ParentScopeSpyTest {
+
+  @Test
+  void parent() {
+    try (var parent = BeanScope.builder()
+      .modules(new MyTestModule())
+      .build()) {
+
+      var parentOne = parent.get(OcsOne.class);
+      assertThat(parentOne.one()).isEqualTo("realOne");
+
+      try (var child = BeanScope.builder()
+        .parent(parent, false)
+        .modules(new OtherModule())
+        .build()) {
+
+        OcsThree three = child.get(OcsThree.class);
+        assertThat(three).isNotNull();
+        var childOne = child.get(OcsOne.class);
+        assertThat(childOne).isSameAs(parentOne);
+
+        OcsTwo two = child.get(OcsTwo.class);
+        assertThat(two.twoPlusOne()).isEqualTo("two+realOne");
+      }
+    }
+  }
+
+  @Test
+  void parent_withSpy() {
+    try (var parent = BeanScope.builder()
+      .modules(new MyTestModule())
+      .build()) {
+
+      var parentOne = parent.get(OcsOne.class);
+      assertThat(parentOne.one()).isEqualTo("realOne");
+
+      try (var child = BeanScope.builder()
+        .parent(parent, false)
+        .modules(new OtherModule())
+        .forTesting()
+        .spy(OcsOne.class) // apply Spy to parent supplied bean
+        .build()) {
+
+        assertThat(child.get(OcsThree.class)).isNotNull();
+        var childOne = child.get(OcsOne.class);
+        assertThat(childOne).isNotSameAs(parentOne);
+
+        OcsTwo two = child.get(OcsTwo.class);
+        assertThat(two.twoPlusOne()).isEqualTo("two+realOne");
+
+        // it's a spy
+        Mockito.verify(childOne).one();
+      }
+    }
+  }
+
+  static class MyTestModule implements Module.Custom {
+
+    private final Class<?>[] provides = new Class<?>[]{};
+    private final Class<?>[] requires = new Class<?>[]{};
+    private final Class<?>[] requiresPackages = new Class<?>[]{};
+    private Builder builder;
+
+    @Override
+    public Class<?>[] provides() {
+      return provides;
+    }
+
+    @Override
+    public Class<?>[] requires() {
+      return requires;
+    }
+
+    @Override
+    public Class<?>[] requiresPackages() {
+      return requiresPackages;
+    }
+
+    @Override
+    public Class<?>[] classes() {
+      return new Class<?>[]{
+        org.example.custom2.OcsOne.class,
+      };
+    }
+
+    @Override
+    public void build(Builder builder) {
+      this.builder = builder;
+      build_custom2_OcsOne();
+    }
+
+    protected void build_custom2_OcsOne() {
+      OcsOne$DI.build(builder);
+    }
+
+  }
+}

inject/src/main/java/io/avaje/inject/spi/DBeanMap.java

@@ -73,6 +73,17 @@ void register(int flag, Provider<?> provider) {
     }
   }
 
+  /**
+   * Get with a strict match on name for the single entry case.
+   */
+  Object getStrict(Type type, String name) {
+    DContextEntry entry = beans.get(type.getTypeName());
+    if (entry == null) {
+      return null;
+    }
+    return entry.getStrict(KeyUtil.lower(name));
+  }
+
   @SuppressWarnings("unchecked")
   <T> T get(Type type, String name) {
     DContextEntry entry = beans.get(type.getTypeName());

inject/src/main/java/io/avaje/inject/spi/DBeanScope.java

@@ -85,6 +85,26 @@ private  <T> T getByType(Type type, @Nullable String name) {
     return parent.get(type, name);
   }
 
+  /**
+   * Get with a strict match on name for the single entry case.
+   */
+  @Nullable
+  Object getStrict(String name, Type[] types) {
+    for (Type type : types) {
+      if (!isAnnotationType(type)) {
+        Object match = beans.getStrict(type, name);
+        if (match != null) {
+          return match;
+        }
+      }
+    }
+    return null;
+  }
+
+  private boolean isAnnotationType(Type type) {
+    return type instanceof Class && ((Class<?>) type).isAnnotation();
+  }
+
   @Override
   public <T> Optional<T> getOptional(Class<T> type) {
     return getMaybe(type, null);

inject/src/main/java/io/avaje/inject/spi/DBuilder.java

@@ -28,8 +28,13 @@ class DBuilder implements Builder {
    */
   protected final DBeanMap beanMap = new DBeanMap();
 
-  private final BeanScope parent;
-  private final boolean parentOverride;
+  protected final BeanScope parent;
+  protected final boolean parentOverride;
+
+  /**
+   * Bean provided by the parent scope that we are not overriding.
+   */
+  protected Object parentMatch;
 
   /**
    * Debug of the current bean being wired - used in injection errors.
@@ -53,17 +58,16 @@ public boolean isAddBeanFor(Type... types) {
 
   @Override
   public boolean isAddBeanFor(String name, Type... types) {
+    parentMatch = null;
     next(name, types);
     if (parentOverride || parent == null) {
       return true;
     }
-    for (Type type : types) {
-      try {
-        parent.get(type, name);
-        return false;
-      } catch (NoSuchElementException e) {
-        // ignore
-      }
+    if (parent instanceof DBeanScope) {
+      // effectively looking for a match in the test scope
+      DBeanScope dParent = (DBeanScope) parent;
+      parentMatch = dParent.getStrict(name, types);
+      return parentMatch == null;
     }
     return true;
   }

inject/src/main/java/io/avaje/inject/spi/DBuilderExtn.java

@@ -1,5 +1,6 @@
 package io.avaje.inject.spi;
 
+import io.avaje.inject.BeanEntry;
 import io.avaje.inject.BeanScope;
 
 import java.lang.reflect.Type;
@@ -34,6 +35,7 @@ class DBuilderExtn extends DBuilder {
   @Override
   public boolean isAddBeanFor(String qualifierName, Type... types) {
     if (!super.isAddBeanFor(qualifierName, types)) {
+      enrichParentMatch();
       return false;
     }
     if (hasSuppliedBeans) {
@@ -42,6 +44,19 @@ public boolean isAddBeanFor(String qualifierName, Type... types) {
     return true;
   }
 
+  /**
+   * If we have a parentMatch (e.g. test scope bean) but we want to enrich it (Mockito Spy),
+   * then enrich the parentMatch bean and register that into this scope.
+   */
+  private void enrichParentMatch() {
+    if (parentMatch != null && !enrichMap.isEmpty()) {
+      Object enrichedBean = enrich(parentMatch, beanMap.next());
+      if (enrichedBean != parentMatch) {
+        beanMap.register(BeanEntry.SUPPLIED, enrichedBean);
+      }
+    }
+  }
+
   /**
    * Potentially enrich the bean prior to registering with context.
    */

inject/src/main/java/io/avaje/inject/spi/DContextEntry.java

@@ -34,6 +34,16 @@ Provider<?> provider(String name) {
     return new EntryMatcher(name).provider(entries);
   }
 
+  /**
+   * Get with strict name match for the single entry case.
+   */
+  Object getStrict(String name) {
+    if (entries.size() == 1) {
+      return entries.get(0).beanIfNameMatch(name);
+    }
+    return new EntryMatcher(name).match(entries);
+  }
+
   Object get(String name) {
     if (entries.size() == 1) {
       return entries.get(0).bean();

inject/src/main/java/io/avaje/inject/spi/DContextEntryBean.java

@@ -66,6 +66,13 @@ final boolean isNameEqual(String qualifierName) {
     return Objects.equals(qualifierName, name);
   }
 
+  /**
+   * Return the bean if name matches and otherwise null.
+   */
+  Object beanIfNameMatch(String name) {
+    return isNameMatch(name) ? bean() : null;
+  }
+
   Object bean() {
     return source;
   }