Added Guice tests.

Simone Bordet · Simone Bordet · commit 0bfb0170b512 · 2011-04-21T09:45:15.000Z
diff --git a/cometd-java/cometd-java-annotations/pom.xml b/cometd-java/cometd-java-annotations/pom.xml
@@ -79,6 +79,13 @@
             <version>2.2</version>
             <scope>test</scope>
         </dependency>
+        <!-- Guice dependencies -->
+        <dependency>
+            <groupId>com.google.inject</groupId>
+            <artifactId>guice</artifactId>
+            <version>3.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>
diff --git a/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/CometDModule.java b/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/CometDModule.java
@@ -0,0 +1,26 @@
+package org.cometd.java.annotation.guice;
+
+import javax.inject.Singleton;
+
+import com.google.inject.AbstractModule;
+import org.cometd.bayeux.server.BayeuxServer;
+import org.cometd.server.BayeuxServerImpl;
+
+public class CometDModule extends AbstractModule
+{
+    @Override
+    protected void configure()
+    {
+        // Binds but does not call start() yet, since it's not good practice in modules
+        // (modules do not have a lifecycle: cannot be stopped)
+
+        // Specifies that the implementation class must be a singleton.
+        // This is needed in case a dependency declares to depend on
+        // BayeuxServerImpl instead of BayeuxServer so that Guice does
+        // not create one instance for BayeuxServer dependencies and
+        // one instance for BayeuxServerImpl dependencies.
+        bind(BayeuxServerImpl.class).in(Singleton.class);
+        // Binds the interface to the implementation class
+        bind(BayeuxServer.class).to(BayeuxServerImpl.class);
+    }
+}
diff --git a/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/GuiceAnnotationTest.java b/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/GuiceAnnotationTest.java
@@ -0,0 +1,55 @@
+package org.cometd.java.annotation.guice;
+
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+import org.cometd.java.annotation.ServerAnnotationProcessor;
+import org.cometd.server.BayeuxServerImpl;
+import org.junit.Assert;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+public class GuiceAnnotationTest
+{
+    @Test
+    public void testGuiceWiringOfCometDServices() throws Exception
+    {
+        // Configure Guice
+        Injector injector = Guice.createInjector(new CometDModule());
+        // Manually start BayeuxServer
+        BayeuxServerImpl bayeuxServer = injector.getInstance(BayeuxServerImpl.class);
+        bayeuxServer.setOption("logLevel", "3");
+        bayeuxServer.start();
+
+        // Configure services
+        // Guice does not handle @PostConstruct and @PreDestroy, so we need to handle them
+        ServerAnnotationProcessor processor = new ServerAnnotationProcessor(bayeuxServer);
+        GuiceBayeuxService service = injector.getInstance(GuiceBayeuxService.class);
+        Assert.assertTrue(processor.process(service));
+
+        // At this point we're configured properly
+        // The code above should be put into a ServletContextListener.contextInitialized()
+        // method, so that it is triggered by the web application lifecycle handling
+        // and the BayeuxServer instance can be put into the ServletContext
+
+        // Test that we're configured properly
+        Assert.assertNotNull(service);
+        assertNotNull(service.dependency);
+        assertNotNull(service.bayeuxServer);
+        assertNotNull(service.serverSession);
+        assertTrue(service.active);
+        assertEquals(1, service.bayeuxServer.getChannel(GuiceBayeuxService.CHANNEL).getSubscribers().size());
+
+        // Deconfigure services
+        // The code below should be put into a ServletContextListener.contextDestroyed()
+        // method, so that it is triggered by the web application lifecycle handling
+        Assert.assertTrue(processor.deprocess(service));
+        // Manually stop the BayeuxServer
+        bayeuxServer.stop();
+
+        assertFalse(service.active);
+    }
+}
diff --git a/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/GuiceBayeuxService.java b/cometd-java/cometd-java-annotations/src/test/java/org/cometd/java/annotation/guice/GuiceBayeuxService.java
@@ -0,0 +1,63 @@
+package org.cometd.java.annotation.guice;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+
+import org.cometd.bayeux.Message;
+import org.cometd.bayeux.server.BayeuxServer;
+import org.cometd.bayeux.server.ConfigurableServerChannel;
+import org.cometd.bayeux.server.ServerSession;
+import org.cometd.java.annotation.Configure;
+import org.cometd.java.annotation.Service;
+import org.cometd.java.annotation.Session;
+import org.cometd.java.annotation.Subscription;
+
+@Service // CometD annotation that marks the class as a CometD service
+public class GuiceBayeuxService
+{
+    public static final String CHANNEL = "/foo";
+
+    public final Dependency dependency; // Injected by Guice via constructor
+    @Inject
+    public BayeuxServer bayeuxServer; // Injected by Guice
+    public boolean configured;
+    public boolean active;
+    @Session
+    public ServerSession serverSession; // Injected by CometD's annotation processor
+
+    @Inject
+    public GuiceBayeuxService(Dependency dependency)
+    {
+        this.dependency = dependency;
+    }
+
+    @PostConstruct
+    public void start() // Initialization method invoked by Guice
+    {
+        if (!configured)
+            throw new IllegalStateException();
+        active = true;
+    }
+
+    @PreDestroy
+    public void stop() // Destruction method invoked by Guice
+    {
+        active = false;
+    }
+
+    @Configure(CHANNEL)
+    private void configureFoo(ConfigurableServerChannel channel)
+    {
+        configured = true;
+    }
+
+    @Subscription(CHANNEL)
+    public void foo(Message message) // Subscription method detected by CometD's annotation processor
+    {
+    }
+
+    public static class Dependency // Another bean
+    {
+    }
+}
