test: fix test class and register view servlet with a context in OSGi

Part of vaadin/osgi#5
vaadin · Nov 30, 2020 · 48c9003 · 48c9003
1 parent a2da02b
commit 48c9003
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 5 deletions.
diff --git a/flow-tests/test-common/src/main/java/com/vaadin/flow/uitest/servlet/ViewTestServlet.java b/flow-tests/test-common/src/main/java/com/vaadin/flow/uitest/servlet/ViewTestServlet.java
@@ -31,7 +31,9 @@ public class ViewTestServlet extends VaadinServlet {
     @Override
     public void init(ServletConfig servletConfig) throws ServletException {
         super.init(servletConfig);
-        viewLocator = new ViewClassLocator(getService().getClassLoader());
+        if (getService() != null) {
+            viewLocator = new ViewClassLocator(getService().getClassLoader());
+        }
     }
 
     static ViewClassLocator getViewLocator() {

diff --git a/flow-tests/test-root-context/src/main/java/com/vaadin/flow/osgi/Activator.java b/flow-tests/test-root-context/src/main/java/com/vaadin/flow/osgi/Activator.java
@@ -19,13 +19,18 @@
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
 
+import java.util.Dictionary;
 import java.util.Hashtable;
 
+import org.osgi.framework.Bundle;
 import org.osgi.framework.BundleContext;
 import org.osgi.framework.FrameworkUtil;
+import org.osgi.framework.ServiceFactory;
+import org.osgi.framework.ServiceRegistration;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.http.NamespaceException;
+import org.osgi.service.http.context.ServletContextHelper;
 import org.osgi.service.http.whiteboard.HttpWhiteboardConstants;
 
 import com.vaadin.flow.server.VaadinServletConfiguration;
@@ -41,13 +46,41 @@ public static class OsgiResourceRgistration {
 
     }
 
+    private static final class CustomContextHelper
+            extends ServletContextHelper {
+
+        private CustomContextHelper(Bundle bundle) {
+            super(bundle);
+        }
+    }
+
+    private static class CustomContextHelperFactory
+            implements ServiceFactory<ServletContextHelper> {
+
+        @Override
+        public ServletContextHelper getService(Bundle bundle,
+                ServiceRegistration<ServletContextHelper> registration) {
+            return new CustomContextHelper(bundle);
+        }
+
+        @Override
+        public void ungetService(Bundle bundle,
+                ServiceRegistration<ServletContextHelper> registration,
+                ServletContextHelper service) {
+            // no op
+        }
+
+    }
+
     @VaadinServletConfiguration(productionMode = false)
     private static class FixedViewServlet extends ViewTestServlet {
         @Override
         public void init(ServletConfig servletConfig) throws ServletException {
             super.init(servletConfig);
 
-            getService().setClassLoader(getClass().getClassLoader());
+            if (getService() != null) {
+                getService().setClassLoader(getClass().getClassLoader());
+            }
         }
     }
 
@@ -57,7 +90,9 @@ private static class FixedRouterServlet extends RouterTestServlet {
         public void init(ServletConfig servletConfig) throws ServletException {
             super.init(servletConfig);
 
-            getService().setClassLoader(getClass().getClassLoader());
+            if (getService() != null) {
+                getService().setClassLoader(getClass().getClassLoader());
+            }
         }
     }
 
@@ -69,7 +104,9 @@ private static class FixedProductionModeViewServlet
         public void init(ServletConfig servletConfig) throws ServletException {
             super.init(servletConfig);
 
-            getService().setClassLoader(getClass().getClassLoader());
+            if (getService() != null) {
+                getService().setClassLoader(getClass().getClassLoader());
+            }
         }
     }
 
@@ -80,7 +117,9 @@ private static class FixedProductionModeTimingDataViewServlet
         public void init(ServletConfig servletConfig) throws ServletException {
             super.init(servletConfig);
 
-            getService().setClassLoader(getClass().getClassLoader());
+            if (getService() != null) {
+                getService().setClassLoader(getClass().getClassLoader());
+            }
         }
     }
 
@@ -106,6 +145,13 @@ void activate() throws NamespaceException {
                 new FixedProductionModeTimingDataViewServlet(),
                 createProperties("/view-production-timing/*"));
 
+        registerPlainJsResource(context);
+
+        String contextName = registerCustomContext(context);
+        registerCustomContextServlet(context, contextName);
+    }
+
+    private void registerPlainJsResource(BundleContext context) {
         Hashtable<String, Object> properties = new Hashtable<>();
         properties.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_RESOURCE_PATTERN,
                 "/plain-script.js");
@@ -115,6 +161,28 @@ void activate() throws NamespaceException {
                 new OsgiResourceRgistration(), properties);
     }
 
+    private String registerCustomContext(BundleContext context) {
+        Dictionary<String, String> contextProps = new Hashtable<String, String>();
+        String contextName = "test-context";
+        contextProps.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME,
+                contextName);
+        contextProps.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH,
+                "/custom-test-context");
+        context.registerService(ServletContextHelper.class,
+                new CustomContextHelperFactory(), contextProps);
+        return contextName;
+    }
+
+    private void registerCustomContextServlet(BundleContext context,
+            String contextName) {
+        Hashtable<String, Object> properties = createProperties("/view/*");
+        properties.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+                "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME + "="
+                        + contextName + ")");
+        context.registerService(Servlet.class, new FixedViewServlet(),
+                properties);
+    }
+
     private Hashtable<String, Object> createProperties(String mapping) {
         Hashtable<String, Object> properties = new Hashtable<>();
         properties.put(