| // |
| // ======================================================================== |
| // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd. |
| // ------------------------------------------------------------------------ |
| // All rights reserved. This program and the accompanying materials |
| // are made available under the terms of the Eclipse Public License v1.0 |
| // and Apache License v2.0 which accompanies this distribution. |
| // |
| // The Eclipse Public License is available at |
| // http://www.eclipse.org/legal/epl-v10.html |
| // |
| // The Apache License v2.0 is available at |
| // http://www.opensource.org/licenses/apache2.0.php |
| // |
| // You may elect to redistribute this code under either of these licenses. |
| // ======================================================================== |
| // |
| |
| package org.eclipse.jetty.websocket.jsr356.server; |
| |
| import static org.hamcrest.Matchers.notNullValue; |
| |
| import java.io.Reader; |
| import java.lang.reflect.Field; |
| import java.nio.ByteBuffer; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Date; |
| import java.util.List; |
| |
| import javax.websocket.CloseReason; |
| import javax.websocket.PongMessage; |
| import javax.websocket.Session; |
| import javax.websocket.server.ServerEndpoint; |
| import javax.websocket.server.ServerEndpointConfig; |
| |
| import org.eclipse.jetty.websocket.api.WebSocketPolicy; |
| import org.eclipse.jetty.websocket.common.scopes.SimpleContainerScope; |
| import org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope; |
| import org.eclipse.jetty.websocket.jsr356.annotations.AnnotatedEndpointScanner; |
| import org.eclipse.jetty.websocket.jsr356.annotations.JsrCallable; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicBinaryMessageByteBufferSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicCloseReasonSessionSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicCloseReasonSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicCloseSessionReasonSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicCloseSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicErrorSessionSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicErrorSessionThrowableSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicErrorSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicErrorThrowableSessionSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicErrorThrowableSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicOpenSessionSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicOpenSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicPongMessageSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.BasicTextMessageStringSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.StatelessTextMessageStringSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.beans.DateTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.BooleanObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.BooleanTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.ByteObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.ByteTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.CharTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.CharacterObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.DoubleObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.DoubleTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.FloatObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.FloatTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.IntTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.IntegerObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.ShortObjectTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.primitives.ShortTextSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.streaming.ReaderParamSocket; |
| import org.eclipse.jetty.websocket.jsr356.server.samples.streaming.StringReturnReaderParamSocket; |
| import org.junit.Assert; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.Parameterized; |
| import org.junit.runners.Parameterized.Parameters; |
| |
| /** |
| * Test {@link AnnotatedEndpointScanner} against various simple, 1 method {@link ServerEndpoint} annotated classes with valid signatures. |
| */ |
| @RunWith(Parameterized.class) |
| public class ServerAnnotatedEndpointScanner_GoodSignaturesTest |
| { |
| public static class Case |
| { |
| public static void add(List<Case[]> data, Class<?> pojo, Field metadataField, Class<?>... expectedParams) |
| { |
| data.add(new Case[] |
| { new Case(pojo,metadataField,expectedParams) }); |
| } |
| |
| // The websocket pojo to test against |
| Class<?> pojo; |
| // The JsrAnnotatedMetadata field that should be populated |
| Field metadataField; |
| // The expected parameters for the Callable found by the scanner |
| Class<?> expectedParameters[]; |
| |
| public Case(Class<?> pojo, Field metadataField, Class<?>... expectedParams) |
| { |
| this.pojo = pojo; |
| this.metadataField = metadataField; |
| this.expectedParameters = expectedParams; |
| } |
| } |
| |
| @Parameters |
| public static Collection<Case[]> data() throws Exception |
| { |
| List<Case[]> data = new ArrayList<>(); |
| Field fOpen = findFieldRef(AnnotatedServerEndpointMetadata.class,"onOpen"); |
| Field fClose = findFieldRef(AnnotatedServerEndpointMetadata.class,"onClose"); |
| Field fError = findFieldRef(AnnotatedServerEndpointMetadata.class,"onError"); |
| Field fText = findFieldRef(AnnotatedServerEndpointMetadata.class,"onText"); |
| Field fTextStream = findFieldRef(AnnotatedServerEndpointMetadata.class,"onTextStream"); |
| Field fBinary = findFieldRef(AnnotatedServerEndpointMetadata.class,"onBinary"); |
| @SuppressWarnings("unused") |
| Field fBinaryStream = findFieldRef(AnnotatedServerEndpointMetadata.class,"onBinaryStream"); |
| Field fPong = findFieldRef(AnnotatedServerEndpointMetadata.class,"onPong"); |
| |
| // @formatter:off |
| // -- Open Events |
| Case.add(data, BasicOpenSocket.class, fOpen); |
| Case.add(data, BasicOpenSessionSocket.class, fOpen, Session.class); |
| // -- Close Events |
| Case.add(data, BasicCloseSocket.class, fClose); |
| Case.add(data, BasicCloseReasonSocket.class, fClose, CloseReason.class); |
| Case.add(data, BasicCloseReasonSessionSocket.class, fClose, CloseReason.class, Session.class); |
| Case.add(data, BasicCloseSessionReasonSocket.class, fClose, Session.class, CloseReason.class); |
| // -- Error Events |
| Case.add(data, BasicErrorSocket.class, fError); |
| Case.add(data, BasicErrorSessionSocket.class, fError, Session.class); |
| Case.add(data, BasicErrorSessionThrowableSocket.class, fError, Session.class, Throwable.class); |
| Case.add(data, BasicErrorThrowableSocket.class, fError, Throwable.class); |
| Case.add(data, BasicErrorThrowableSessionSocket.class, fError, Throwable.class, Session.class); |
| // -- Text Events |
| Case.add(data, BasicTextMessageStringSocket.class, fText, String.class); |
| Case.add(data, StatelessTextMessageStringSocket.class, fText, Session.class, String.class); |
| // -- Primitives |
| Case.add(data, BooleanTextSocket.class, fText, Boolean.TYPE); |
| Case.add(data, BooleanObjectTextSocket.class, fText, Boolean.class); |
| Case.add(data, ByteTextSocket.class, fText, Byte.TYPE); |
| Case.add(data, ByteObjectTextSocket.class, fText, Byte.class); |
| Case.add(data, CharTextSocket.class, fText, Character.TYPE); |
| Case.add(data, CharacterObjectTextSocket.class, fText, Character.class); |
| Case.add(data, DoubleTextSocket.class, fText, Double.TYPE); |
| Case.add(data, DoubleObjectTextSocket.class, fText, Double.class); |
| Case.add(data, FloatTextSocket.class, fText, Float.TYPE); |
| Case.add(data, FloatObjectTextSocket.class, fText, Float.class); |
| Case.add(data, IntTextSocket.class, fText, Integer.TYPE); |
| Case.add(data, IntegerObjectTextSocket.class, fText, Integer.class); |
| Case.add(data, ShortTextSocket.class, fText, Short.TYPE); |
| Case.add(data, ShortObjectTextSocket.class, fText, Short.class); |
| // -- Beans |
| Case.add(data, DateTextSocket.class, fText, Date.class); |
| // -- Reader Events |
| Case.add(data, ReaderParamSocket.class, fTextStream, Reader.class, String.class); |
| Case.add(data, StringReturnReaderParamSocket.class, fTextStream, Reader.class, String.class); |
| // -- Binary Events |
| Case.add(data, BasicBinaryMessageByteBufferSocket.class, fBinary, ByteBuffer.class); |
| // -- Pong Events |
| Case.add(data, BasicPongMessageSocket.class, fPong, PongMessage.class); |
| // @formatter:on |
| |
| // TODO: validate return types |
| |
| return data; |
| } |
| |
| private static Field findFieldRef(Class<?> clazz, String fldName) throws Exception |
| { |
| return clazz.getField(fldName); |
| } |
| |
| private Case testcase; |
| |
| public ServerAnnotatedEndpointScanner_GoodSignaturesTest(Case testcase) |
| { |
| this.testcase = testcase; |
| System.err.printf("Testing signature of %s%n",testcase.pojo.getName()); |
| } |
| |
| @Test |
| public void testScan_Basic() throws Exception |
| { |
| WebSocketContainerScope container = new SimpleContainerScope(WebSocketPolicy.newClientPolicy()); |
| AnnotatedServerEndpointMetadata metadata = new AnnotatedServerEndpointMetadata(container,testcase.pojo,null); |
| AnnotatedEndpointScanner<ServerEndpoint, ServerEndpointConfig> scanner = new AnnotatedEndpointScanner<>(metadata); |
| scanner.scan(); |
| |
| Assert.assertThat("Metadata",metadata,notNullValue()); |
| |
| JsrCallable method = (JsrCallable)testcase.metadataField.get(metadata); |
| Assert.assertThat(testcase.metadataField.toString(),method,notNullValue()); |
| int len = testcase.expectedParameters.length; |
| for (int i = 0; i < len; i++) |
| { |
| Class<?> expectedParam = testcase.expectedParameters[i]; |
| Class<?> actualParam = method.getParamTypes()[i]; |
| |
| Assert.assertTrue("Parameter[" + i + "] - expected:[" + expectedParam + "], actual:[" + actualParam + "]",actualParam.equals(expectedParam)); |
| } |
| } |
| } |