/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.examples.sse;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import javax.ws.rs.ProcessingException;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.media.sse.EventInput;
import org.glassfish.jersey.media.sse.EventListener;
import org.glassfish.jersey.media.sse.EventSource;
import org.glassfish.jersey.media.sse.InboundEvent;
import org.glassfish.jersey.media.sse.SseFeature;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
/**
* SSE example resources test.
*
* @author Pavel Bucek (pavel.bucek at oracle.com)
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public class ServerSentEventsTest extends JerseyTest {
@Override
protected Application configure() {
// enable(TestProperties.LOG_TRAFFIC);
return new ResourceConfig(ServerSentEventsResource.class, DomainResource.class, SseFeature.class);
}
/**
* Test consuming a single SSE event via event source.
*
* @throws Exception in case of a failure during the test execution.
*/
@Test
public void testEventSource() throws Exception {
final CountDownLatch latch = new CountDownLatch(1);
final AtomicReference<String> message = new AtomicReference<String>();
final EventSource eventSource = new EventSource(target().path(App.ROOT_PATH)) {
@Override
public void onEvent(InboundEvent inboundEvent) {
try {
final String value = inboundEvent.readData();
message.set(value);
latch.countDown();
} catch (ProcessingException e) {
e.printStackTrace();
}
}
};
target().path(App.ROOT_PATH).request().post(Entity.text("message"));
try {
assertTrue("Waiting for message to be delivered has timed out.",
latch.await(5 * getAsyncTimeoutMultiplier(), TimeUnit.SECONDS));
} finally {
eventSource.close();
}
assertThat("Unexpected SSE event data value.", message.get(), equalTo("message"));
}
/**
* Test consuming multiple SSE events sequentially using event input.
*
* @throws Exception in case of a failure during the test execution.
*/
@Test
public void testInboundEventReader() throws Exception {
final int MAX_MESSAGES = 5;
final CountDownLatch startLatch = new CountDownLatch(1);
final ExecutorService executor = Executors.newSingleThreadExecutor();
try {
final Future<List<String>> futureMessages =
executor.submit(new Callable<List<String>>() {
@Override
public List<String> call() throws Exception {
final EventInput eventInput = target(App.ROOT_PATH).register(SseFeature.class)
.request().get(EventInput.class);
startLatch.countDown();
final List<String> messages = new ArrayList<String>(MAX_MESSAGES);
try {
for (int i = 0; i < MAX_MESSAGES; i++) {
InboundEvent event = eventInput.read();
messages.add(event.readData());
}
} finally {
if (eventInput != null) {
eventInput.close();
}
}
return messages;
}
});
assertTrue("Waiting for receiver thread to start has timed out.",
startLatch.await(5, TimeUnit.SECONDS));
for (int i = 0; i < MAX_MESSAGES; i++) {
target(App.ROOT_PATH).request().post(Entity.text("message " + i));
}
int i = 0;
for (String message : futureMessages.get(5000, TimeUnit.SECONDS)) {
assertThat("Unexpected SSE event data value.", message, equalTo("message " + i++));
}
} finally {
executor.shutdownNow();
}
}
/**
* Test receiving all streamed messages in parallel by multiple event sources.
*
* @throws Exception in case of a failure during the test execution.
*/
@Test
public void testCreateDomain() throws Exception {
final int MAX_CLIENTS = 25;
final int MESSAGE_COUNT = 6;
final Response response = target().path("domain/start")
.queryParam("testSources", MAX_CLIENTS)
.request().post(Entity.text("data"), Response.class);
assertThat("Unexpected start domain response status code.",
response.getStatus(), equalTo(Response.Status.CREATED.getStatusCode()));
final Map<Integer, Integer> messageCounts = new ConcurrentHashMap<Integer, Integer>(MAX_CLIENTS);
final CountDownLatch doneLatch = new CountDownLatch(MAX_CLIENTS);
final EventSource[] sources = new EventSource[MAX_CLIENTS];
final String processUriString = target().getUri().relativize(response.getLocation()).toString();
final WebTarget sseTarget = target().path(processUriString).queryParam("testSource", "true");
for (int i = 0; i < MAX_CLIENTS; i++) {
final int id = i;
sources[id] = EventSource.target(sseTarget).build();
sources[id].register(new EventListener() {
private final AtomicInteger messageCount = new AtomicInteger(0);
@Override
public void onEvent(InboundEvent inboundEvent) {
messageCount.incrementAndGet();
final String message = inboundEvent.readData(String.class);
if ("done".equals(message)) {
messageCounts.put(id, messageCount.get());
doneLatch.countDown();
}
}
});
sources[i].open();
}
doneLatch.await(5 * getAsyncTimeoutMultiplier(), TimeUnit.SECONDS);
for (EventSource source : sources) {
source.close();
}
for (int i = 0; i < MAX_CLIENTS; i++) {
final Integer count = messageCounts.get(i);
assertThat("Final message not received by event source " + i, count, notNullValue());
assertThat("Unexpected number of messages received by event source " + i,
count, equalTo(MESSAGE_COUNT));
}
}
}