Fixed issues with @nested tests and @Managed browsers

- Factory declaration on class level was not available in @nested classes
- Class level Browsers were created multiple times
- @nested instance Browsers were never created

Author: slu-it

webtester-support-junit5/src/main/java/info/novatec/testit/webtester/junit5/extensions/BaseExtension.java

@@ -5,7 +5,6 @@
 import java.util.function.Consumer;
 
 import org.junit.jupiter.api.extension.ExtensionContext;
-import org.junit.jupiter.api.extension.ExtensionContext.Store;
 
 import lombok.AccessLevel;
 import lombok.Getter;
@@ -26,7 +25,6 @@
 public class BaseExtension {
 
     protected static final ExtensionContext.Namespace NAMESPACE = ExtensionContext.Namespace.create("testit-webtester");
-    protected static final String EXTENSION_MODEL_KEY = "extension-model";
 
     private final ReflectionUtils reflectionUtils;
     private final TestClassModelFactory testClassModelFactory;
@@ -57,14 +55,8 @@ protected <T extends ExtensionContext> void executeHandlingUndeclaredThrowables(
     }
 
     protected final TestClassModel getModel(ExtensionContext context) {
-        Store store = context.getStore(NAMESPACE);
-        TestClassModel model = store.get(EXTENSION_MODEL_KEY, TestClassModel.class);
-        if (model == null) {
-            Class<?> testClass = getTestClassFrom(context);
-            model = testClassModelFactory.create(testClass);
-            store.put(EXTENSION_MODEL_KEY, model);
-        }
-        return model;
+        Class<?> testClass = getTestClassFrom(context);
+        return testClassModelFactory.create(testClass);
     }
 
     private Class<?> getTestClassFrom(ExtensionContext context) {

webtester-support-junit5/src/main/java/info/novatec/testit/webtester/junit5/extensions/browsers/ManagedBrowserExtension.java

@@ -11,6 +11,7 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.extension.AfterAllCallback;
 import org.junit.jupiter.api.extension.AfterEachCallback;
 import org.junit.jupiter.api.extension.BeforeAllCallback;
@@ -25,7 +26,6 @@
 import info.novatec.testit.webtester.browser.Browser;
 import info.novatec.testit.webtester.browser.BrowserFactory;
 import info.novatec.testit.webtester.browser.proxy.ProxyConfiguration;
-import info.novatec.testit.webtester.junit5.extensions.NoTestClassException;
 import info.novatec.testit.webtester.junit5.extensions.BaseExtension;
 
 
@@ -84,7 +84,9 @@ public class ManagedBrowserExtension extends BaseExtension
 
     @Override
     public void beforeAll(ContainerExtensionContext context) throws Exception {
-        executeHandlingUndeclaredThrowables(context, this::initializeAndInjectStaticBrowsers);
+        if (isRootContext(context)) {
+            executeHandlingUndeclaredThrowables(context, this::initializeAndInjectStaticBrowsers);
+        }
     }
 
     @Override
@@ -99,7 +101,13 @@ public void afterEach(TestExtensionContext context) {
 
     @Override
     public void afterAll(ContainerExtensionContext context) {
-        getManagedStaticBrowsers(context).forEach(this::closeAndLogErrors);
+        if (isRootContext(context)) {
+            getManagedStaticBrowsers(context).forEach(this::closeAndLogErrors);
+        }
+    }
+
+    private boolean isRootContext(ContainerExtensionContext context) {
+        return !context.getParent().isPresent();
     }
 
     private void closeAndLogErrors(Browser browser) {
@@ -112,10 +120,9 @@ private void closeAndLogErrors(Browser browser) {
     }
 
     private void initializeAndInjectStaticBrowsers(ContainerExtensionContext context) {
-        Class<?> testClass = context.getTestClass().orElseThrow(NoTestClassException::new);
         List<Browser> managedBrowsers = getManagedStaticBrowsers(context);
         getModel(context).getBrowserFields().stream().filter(isStaticField).forEach(field -> {
-            Browser browser = createBrowserFor(field, testClass);
+            Browser browser = createBrowserFor(field);
             managedBrowsers.add(browser);
             setValue(field, null, browser);
         });
@@ -125,36 +132,57 @@ private void initializeAndInjectInstanceBrowsers(TestExtensionContext context) {
         Object testInstance = context.getTestInstance();
         List<Browser> managedBrowsers = getManagedInstanceBrowsers(context);
         getModel(context).getBrowserFields().stream().filter(isInstanceField).forEach(field -> {
-            Browser browser = createBrowserFor(field, testInstance.getClass());
+            Browser browser = createBrowserFor(field);
             managedBrowsers.add(browser);
             setValue(field, testInstance, browser);
         });
     }
 
-    private Browser createBrowserFor(Field field, Class<?> testClass) {
-
-        Class<? extends ProxyConfiguration> proxyConfigurationClass;
-        Class<? extends BrowserFactory> factoryClass;
-
-        if (field.isAnnotationPresent(CreateUsing.class)) {
-            CreateUsing annotation = field.getAnnotation(CreateUsing.class);
-            proxyConfigurationClass = annotation.proxy();
-            factoryClass = annotation.value();
-        } else if (testClass.isAnnotationPresent(CreateBrowsersUsing.class)) {
-            CreateBrowsersUsing annotation = testClass.getAnnotation(CreateBrowsersUsing.class);
-            proxyConfigurationClass = annotation.proxy();
-            factoryClass = annotation.value();
-        } else {
-            throw new NoBrowserFactoryException();
+    private Browser createBrowserFor(Field field) {
+
+        CreateUsing createUsing = getFieldLevelAnnotation(field);
+        if (createUsing != null) {
+            Class<? extends ProxyConfiguration> proxyConfigurationClass = createUsing.proxy();
+            Class<? extends BrowserFactory> factoryClass = createUsing.value();
+            return createBrowser(factoryClass, proxyConfigurationClass);
+        }
+
+        CreateBrowsersUsing createBrowsersUsing = getClassLevelAnnotation(field);
+        if (createBrowsersUsing != null) {
+            Class<? extends ProxyConfiguration> proxyConfigurationClass = createBrowsersUsing.proxy();
+            Class<? extends BrowserFactory> factoryClass = createBrowsersUsing.value();
+            return createBrowser(factoryClass, proxyConfigurationClass);
+        }
+
+        throw new NoBrowserFactoryException();
+
+    }
+
+    private CreateUsing getFieldLevelAnnotation(Field field) {
+        return field.getAnnotation(CreateUsing.class);
+    }
+
+    private CreateBrowsersUsing getClassLevelAnnotation(Field field) {
+        Class<?> testClass = field.getDeclaringClass();
+        CreateBrowsersUsing isPresent = testClass.getAnnotation(CreateBrowsersUsing.class);
+        if (isPresent == null && testClass.isAnnotationPresent(Nested.class)) {
+            Class<?> declaringClass = testClass.getDeclaringClass();
+            while (declaringClass != null && isPresent == null) {
+                isPresent = declaringClass.getAnnotation(CreateBrowsersUsing.class);
+                declaringClass = declaringClass.getDeclaringClass();
+            }
         }
+        return isPresent;
+    }
 
+    private Browser createBrowser(Class<? extends BrowserFactory> factoryClass,
+        Class<? extends ProxyConfiguration> proxyConfigurationClass) {
         try {
             ProxyConfiguration proxyConfiguration = proxyConfigurationClass.newInstance();
             return factoryClass.newInstance().withProxyConfiguration(proxyConfiguration).createBrowser();
         } catch (InstantiationException | IllegalAccessException e) {
             throw new UndeclaredThrowableException(e, "error while creating browser factory");
         }
-
     }
 
     @SuppressWarnings("unchecked")

webtester-support-junit5/src/test/java/info/novatec/testit/webtester/junit5/extensions/BaseExtensionTest.java

@@ -4,10 +4,8 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.expectThrows;
 import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
-import static org.mockito.Mockito.verifyZeroInteractions;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.UndeclaredThrowableException;
@@ -27,7 +25,6 @@
 import utils.MockitoExtension;
 
 import info.novatec.testit.webtester.junit5.internal.ReflectionUtils;
-import info.novatec.testit.webtester.junit5.internal.TestClassModel;
 import info.novatec.testit.webtester.junit5.internal.TestClassModelFactory;
 
 
@@ -136,60 +133,6 @@ void undeclaredThrowablesAreNotHandled() throws Exception {
 
     }
 
-    @Test
-    @DisplayName("getModel(..) model is returned if it was already loaded")
-    void modelIsReturnedIfItAlreadyExist() {
-
-        TestClassModel model = mock(TestClassModel.class);
-        doReturn(model).when(store).get(BaseExtension.EXTENSION_MODEL_KEY, TestClassModel.class);
-
-        TestClassModel actualModel = cut.getModel(context);
-        assertThat(actualModel).isSameAs(model);
-
-    }
-
-    @Test
-    @DisplayName("getModel(..) model is returned if it was already loaded without invoking producer")
-    void modelIsReturnedIfItAlreadyExistWithoutProducer() {
-
-        TestClassModel model = mock(TestClassModel.class);
-        doReturn(model).when(store).get(BaseExtension.EXTENSION_MODEL_KEY, TestClassModel.class);
-
-        cut.getModel(context);
-        verifyZeroInteractions(testClassModelFactory);
-
-    }
-
-    @Test
-    @DisplayName("getModel(..) model is lazily created if it doesn't exist already")
-    void modelIsLoadedLazilyIfItDoesNotExist() {
-
-        // store does not contain model >> lazy load
-        doReturn(null).when(store).get(BaseExtension.EXTENSION_MODEL_KEY, TestClassModel.class);
-
-        TestClassModel model = mock(TestClassModel.class);
-        doReturn(model).when(testClassModelFactory).create(TestClass.class);
-
-        TestClassModel actualModel = cut.getModel(context);
-        assertThat(actualModel).isSameAs(model);
-
-    }
-
-    @Test
-    @DisplayName("getModel(..) lazily created model is stored")
-    void modelIsStoredWhenLazilyLoaded() {
-
-        // store does not contain model >> lazy load
-        doReturn(null).when(store).get(BaseExtension.EXTENSION_MODEL_KEY, TestClassModel.class);
-
-        TestClassModel model = mock(TestClassModel.class);
-        doReturn(model).when(testClassModelFactory).create(TestClass.class);
-
-        cut.getModel(context);
-        verify(store).put(BaseExtension.EXTENSION_MODEL_KEY, model);
-
-    }
-
     @Test
     @DisplayName("getModel(..) exception is thrown if context doesn't contain test class")
     void exceptionIfNoTestClass() {