#260 - ENH: Enhance @InjectTest with support for @setup methods & when @Inject, @mock provide values use them

Author: rbygrave

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_setupMethodStatic_Test.java

@@ -0,0 +1,39 @@
+package org.example.myapp;
+
+import io.avaje.inject.BeanScopeBuilder;
+import io.avaje.inject.test.InjectExtension;
+import io.avaje.inject.test.Setup;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_setupMethodStatic_Test {
+
+  static @Inject HelloService helloService;
+
+  static HelloData myTestDouble;
+
+  @Setup
+  static void setup(BeanScopeBuilder builder) {
+    myTestDouble = mock(HelloData.class);
+    when(myTestDouble.helloData()).thenReturn("MockedViaSetupMethod");
+    builder.bean(HelloData.class, myTestDouble);
+  }
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+MockedViaSetupMethod", helloService.hello());
+  }
+
+  @Test
+  void hello_2() {
+    when(myTestDouble.helloData()).thenReturn("LocalMock_2");
+    assertEquals("hello+LocalMock_2", helloService.hello());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_setupMethod_Test.java

@@ -0,0 +1,43 @@
+package org.example.myapp;
+
+import io.avaje.inject.BeanScopeBuilder;
+import io.avaje.inject.test.InjectExtension;
+import io.avaje.inject.test.Setup;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_setupMethod_Test {
+
+  @Inject
+  HelloService helloService;
+
+  HelloData myTestDouble;
+
+  @Setup
+  void setup(BeanScopeBuilder builder) {
+    myTestDouble = mock(HelloData.class);
+    when(myTestDouble.helloData()).thenReturn("MockedViaSetupMethod");
+    builder.bean(HelloData.class, myTestDouble);
+  }
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+MockedViaSetupMethod", helloService.hello());
+  }
+
+  @Test
+  void hello_2() {
+    when(myTestDouble.helloData()).thenReturn("LocalMock_2");
+    assertEquals("hello+LocalMock_2", helloService.hello());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_testDoubleViaInjectStatic_Test.java

@@ -0,0 +1,22 @@
+package org.example.myapp;
+
+import io.avaje.inject.test.InjectTest;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@InjectTest
+class InjectExtension_testDoubleViaInjectStatic_Test {
+
+  static @Inject HelloService helloService;
+
+  static @Inject HelloData myTestDouble = () -> "ImActuallyATestDouble";
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+ImActuallyATestDouble", helloService.hello());
+    assertEquals("ImActuallyATestDouble", myTestDouble.helloData());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_testDoubleViaInject_Test.java

@@ -0,0 +1,23 @@
+package org.example.myapp;
+
+import io.avaje.inject.test.InjectExtension;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_testDoubleViaInject_Test {
+
+  @Inject HelloService helloService;
+
+  @Inject HelloData myTestDouble = () -> "ImActuallyATestDouble";
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+ImActuallyATestDouble", helloService.hello());
+    assertEquals("ImActuallyATestDouble", myTestDouble.helloData());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_testDoubleViaMock2_Test.java

@@ -0,0 +1,37 @@
+package org.example.myapp;
+
+import io.avaje.inject.test.InjectExtension;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_testDoubleViaMock2_Test {
+
+  @Inject HelloService helloService;
+
+  @Mock HelloData mockData = initMe();
+
+  private HelloData initMe() {
+    HelloData helloData = Mockito.mock(HelloData.class);
+    when(helloData.helloData()).thenReturn("CreatedByInitMe");
+    return helloData;
+  }
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+CreatedByInitMe", helloService.hello());
+  }
+
+  @Test
+  void hello_2() {
+    when(mockData.helloData()).thenReturn("LocalMock_2");
+    assertEquals("hello+LocalMock_2", helloService.hello());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_testDoubleViaMockStatic_Test.java

@@ -0,0 +1,37 @@
+package org.example.myapp;
+
+import io.avaje.inject.test.InjectExtension;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_testDoubleViaMockStatic_Test {
+
+  static @Inject HelloService helloService;
+
+  static @Mock HelloData mockData = initMe();
+
+  private static HelloData initMe() {
+    HelloData helloData = Mockito.mock(HelloData.class);
+    when(helloData.helloData()).thenReturn("CreatedByInitMe");
+    return helloData;
+  }
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+CreatedByInitMe", helloService.hello());
+  }
+
+  @Test
+  void hello_2() {
+    when(mockData.helloData()).thenReturn("LocalMock_2");
+    assertEquals("hello+LocalMock_2", helloService.hello());
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/InjectExtension_testDoubleViaMock_Test.java

@@ -0,0 +1,25 @@
+package org.example.myapp;
+
+import io.avaje.inject.test.InjectExtension;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ExtendWith(InjectExtension.class)
+class InjectExtension_testDoubleViaMock_Test {
+
+  @Inject HelloService helloService;
+
+  @Mock HelloData mockData = () -> "ImAConcreteTestDouble";
+
+  @Test
+  void hello_1() {
+    assertEquals("hello+ImAConcreteTestDouble", helloService.hello());
+    assertEquals("ImAConcreteTestDouble", mockData.helloData());
+  }
+
+}

inject-test/src/main/java/io/avaje/inject/test/GlobalTestScope.java

@@ -0,0 +1,60 @@
+package io.avaje.inject.test;
+
+import io.avaje.applog.AppLog;
+import io.avaje.inject.BeanScope;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import java.util.concurrent.locks.ReentrantLock;
+
+import static java.lang.System.Logger.Level.DEBUG;
+import static java.lang.System.Logger.Level.TRACE;
+
+/**
+ * Holds the global BeanScope used for all tests.
+ */
+final class GlobalTestScope implements  ExtensionContext.Store.CloseableResource {
+
+  private static final System.Logger log = AppLog.getLogger("io.avaje.inject");
+
+  private final ReentrantLock lock = new ReentrantLock();
+  private boolean started;
+  private BeanScope globalBeanScope;
+
+  BeanScope obtain(ExtensionContext context) {
+    lock.lock();
+    try {
+      if (!started) {
+        initialise(context);
+        started = true;
+      }
+      return globalBeanScope;
+    } finally {
+      lock.unlock();
+    }
+  }
+
+  private void initialise(ExtensionContext context) {
+    globalBeanScope = TestBeanScope.init(false);
+    if (globalBeanScope != null) {
+      log.log(TRACE, "register global test BeanScope with beans {0}", globalBeanScope);
+      context.getRoot().getStore(ExtensionContext.Namespace.GLOBAL).put(InjectExtension.class.getCanonicalName(), this);
+    }
+  }
+
+  /**
+   * Global shutdown of JUnit.
+   */
+  @Override
+  public void close() {
+    lock.lock();
+    try {
+      if (globalBeanScope != null) {
+        log.log(DEBUG, "Closing global test BeanScope");
+        globalBeanScope.close();
+      }
+    } finally {
+      lock.unlock();
+    }
+  }
+
+}

inject-test/src/main/java/io/avaje/inject/test/InjectExtension.java

@@ -7,65 +7,30 @@
 
 import java.lang.System.Logger.Level;
 import java.lang.reflect.Method;
-import java.util.concurrent.locks.ReentrantLock;
 
 /**
  * Junit 5 extension for avaje inject.
  * <p>
  * Supports injection for fields annotated with <code>@Mock, @Spy, @Captor, @Inject</code>.
  */
-public class InjectExtension implements BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback, ExtensionContext.Store.CloseableResource {
+public final class InjectExtension implements BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback {
 
   private static final System.Logger log = AppLog.getLogger("io.avaje.inject");
   private static final Namespace INJECT_NS = Namespace.create("io.avaje.inject.InjectTest");
   private static final String BEAN_SCOPE = "BEAN_SCOPE";
   private static final String META = "META";
-  private static final ReentrantLock lock = new ReentrantLock();
-  private static boolean started;
-  private static BeanScope globalTestScope;
+  private static final GlobalTestScope GLOBAL = new GlobalTestScope();
 
-  /**
-   * Global shutdown of JUnit.
-   */
-  @Override
-  public void close() {
-    lock.lock();
-    try {
-      if (globalTestScope != null) {
-        log.log(Level.DEBUG, "Closing global test BeanScope");
-        globalTestScope.close();
-      }
-    } finally {
-      lock.unlock();
-    }
-  }
-
-  private void initialiseGlobalTestScope(ExtensionContext context) {
-    globalTestScope = TestBeanScope.init(false);
-    if (globalTestScope != null) {
-      log.log(Level.TRACE, "register global test BeanScope with beans {0}", globalTestScope);
-      context.getRoot().getStore(Namespace.GLOBAL).put(InjectExtension.class.getCanonicalName(), this);
-    }
-  }
+  private BeanScope globalBeanScope;
 
   @Override
   public void beforeAll(ExtensionContext context) {
-    lock.lock();
-    try {
-      if (!started) {
-        initialiseGlobalTestScope(context);
-        started = true;
-      }
-
-      final MetaInfo metaInfo = createMetaInfo(context);
-      putMetaInfo(context, metaInfo);
+    globalBeanScope = GLOBAL.obtain(context);
 
-      if (metaInfo.hasStaticInjection()) {
-        MetaInfo.Scope testClassBeanScope = metaInfo.buildForClass(globalTestScope);
-        putClassScope(context, testClassBeanScope);
-      }
-    } finally {
-      lock.unlock();
+    final MetaInfo metaInfo = createMetaInfo(context);
+    putMetaInfo(context, metaInfo);
+    if (metaInfo.hasStaticInjection()) {
+      putClassScope(context, metaInfo.buildForClass(globalBeanScope));
     }
   }
 
@@ -96,10 +61,10 @@ private BeanScope getClassScope(ExtensionContext context) {
   @Override
   public void beforeEach(final ExtensionContext context) {
     final MetaInfo metaInfo = getMetaInfo(context);
-    if (metaInfo.hasNormalInjection()) {
+    if (metaInfo.hasInstanceInjection()) {
 
       // if (static fields) then (class scope) else (globalTestScope)
-      final BeanScope parent = metaInfo.hasStaticInjection() ? getClassScope(context) : globalTestScope;
+      final BeanScope parent = metaInfo.hasStaticInjection() ? getClassScope(context) : globalBeanScope;
 
       AutoCloseable beanScope = metaInfo.buildForInstance(parent, context.getRequiredTestInstance());
 

inject-test/src/main/java/io/avaje/inject/test/MetaInfo.java

@@ -6,7 +6,7 @@
 /**
  * Wraps the underlying metadata (fields with annotations @Mock, @Spy, @Inject, @Captor).
  */
-class MetaInfo {
+final class MetaInfo {
 
   private final MetaReader reader;
 
@@ -18,7 +18,7 @@ boolean hasStaticInjection() {
     return reader.hasClassInjection();
   }
 
-  boolean hasNormalInjection() {
+  boolean hasInstanceInjection() {
     return reader.hasInstanceInjection();
   }