|
| 1 | + |
| 2 | +/******************************************************************************* |
| 3 | + * Copyright (c) 2025 IBM Corporation and others. |
| 4 | + * All rights reserved. This program and the accompanying materials |
| 5 | + * are made available under the terms of the Eclipse Public License 2.0 |
| 6 | + * which accompanies this distribution, and is available at |
| 7 | + * http://www.eclipse.org/legal/epl-2.0/ |
| 8 | + * |
| 9 | + * SPDX-License-Identifier: EPL-2.0 |
| 10 | + *******************************************************************************/ |
| 11 | +package io.openliberty.checkpoint.fat; |
| 12 | + |
| 13 | +import static org.junit.Assert.assertNotNull; |
| 14 | +import static org.junit.Assert.assertTrue; |
| 15 | + |
| 16 | +import java.lang.StringBuilder; |
| 17 | +import java.util.Arrays; |
| 18 | +import java.util.concurrent.CountDownLatch; |
| 19 | +import java.util.concurrent.TimeUnit; |
| 20 | +import java.util.logging.Logger; |
| 21 | + |
| 22 | +import org.asynchttpclient.Dsl; |
| 23 | +import org.asynchttpclient.ws.WebSocket; |
| 24 | +import org.asynchttpclient.ws.WebSocketListener; |
| 25 | +import org.asynchttpclient.ws.WebSocketUpgradeHandler; |
| 26 | +import org.junit.AfterClass; |
| 27 | +import org.junit.Before; |
| 28 | +import org.junit.BeforeClass; |
| 29 | +import org.junit.Test; |
| 30 | +import org.junit.runner.RunWith; |
| 31 | + |
| 32 | +import com.ibm.websphere.simplicity.ShrinkHelper; |
| 33 | + |
| 34 | +import componenttest.annotation.CheckpointTest; |
| 35 | +import componenttest.annotation.Server; |
| 36 | +import componenttest.custom.junit.runner.FATRunner; |
| 37 | +import componenttest.topology.impl.LibertyServer; |
| 38 | +import io.openliberty.checkpoint.spi.CheckpointPhase; |
| 39 | + |
| 40 | +/** |
| 41 | + * Basic WebSockets tests to ensure the behavior works as expected after a checkpoint restore. |
| 42 | + */ |
| 43 | +@RunWith(FATRunner.class) |
| 44 | +@CheckpointTest |
| 45 | +public class BasicTest { |
| 46 | + |
| 47 | + @Server("basicWsocServer") |
| 48 | + public static LibertyServer server; |
| 49 | + |
| 50 | + private static final Logger LOG = Logger.getLogger(BasicTest.class.getName()); |
| 51 | + |
| 52 | + private static final String APP_NAME = "basic"; |
| 53 | + |
| 54 | + private static Boolean IS_EXPECTED_RESULT = false; |
| 55 | + |
| 56 | + private static CountDownLatch latch; // Used to address timing issues between when the message is recived and when the assert is checked |
| 57 | + |
| 58 | + @BeforeClass |
| 59 | + public static void setUp() throws Exception { |
| 60 | + |
| 61 | + // Build the war app and add the dependencies |
| 62 | + ShrinkHelper.defaultDropinApp(server, APP_NAME + ".war", "io.openliberty.wsoc.basic"); |
| 63 | + |
| 64 | + server.setCheckpoint(CheckpointPhase.AFTER_APP_START, true, null); |
| 65 | + server.setCheckpoint(CheckpointPhase.AFTER_APP_START, false, |
| 66 | + server -> { |
| 67 | + assertNotNull("'SRVE0169I: Loading Web Module: " + APP_NAME + "' message not found in log before rerstore", |
| 68 | + server.waitForStringInLogUsingMark("SRVE0169I: .*" + APP_NAME, 0)); |
| 69 | + assertNotNull("'CWWKZ0001I: Application " + APP_NAME + " started' message not found in log.", |
| 70 | + server.waitForStringInLogUsingMark("CWWKZ0001I: .*" + APP_NAME, 0)); |
| 71 | + }); |
| 72 | + server.startServer(); |
| 73 | + server.checkpointRestore(); |
| 74 | + } |
| 75 | + |
| 76 | + @AfterClass |
| 77 | + public static void tearDown() throws Exception { |
| 78 | + |
| 79 | + if (server != null && server.isStarted()) { |
| 80 | + server.stopServer(); |
| 81 | + } |
| 82 | + |
| 83 | + } |
| 84 | + |
| 85 | + @Before |
| 86 | + public void resetResult() throws Exception { |
| 87 | + IS_EXPECTED_RESULT = false; |
| 88 | + latch = null; |
| 89 | + } |
| 90 | + |
| 91 | + private WebSocketUpgradeHandler createWebSocketUpgradeHandler(Object expectedResult) { |
| 92 | + |
| 93 | + latch = new CountDownLatch(1); // forces the asserts in each test to be checked once the message is recieved (via countdown / await) |
| 94 | + |
| 95 | + WebSocketUpgradeHandler.Builder upgradeHandlerBuilder = new WebSocketUpgradeHandler.Builder(); |
| 96 | + WebSocketUpgradeHandler wsHandler = upgradeHandlerBuilder |
| 97 | + .addWebSocketListener(new WebSocketListener() { |
| 98 | + @Override |
| 99 | + public void onOpen(WebSocket websocket) { |
| 100 | + // WebSocket connection opened |
| 101 | + LOG.info("Opened Websocket"); |
| 102 | + } |
| 103 | + |
| 104 | + @Override |
| 105 | + public void onClose(WebSocket websocket, int code, String reason) { |
| 106 | + // WebSocket connection closed |
| 107 | + LOG.info("Closed Websocket"); |
| 108 | + } |
| 109 | + |
| 110 | + @Override |
| 111 | + public void onError(Throwable t) { |
| 112 | + // WebSocket connection error |
| 113 | + LOG.info("Session Error Occurred: " + t); |
| 114 | + } |
| 115 | + |
| 116 | + @Override |
| 117 | + public void onBinaryFrame(byte[] payload, boolean finalFragment, int rsv) { |
| 118 | + // Log message |
| 119 | + StringBuilder sb = new StringBuilder(); |
| 120 | + for (byte b : payload) { |
| 121 | + sb.append((char) b); |
| 122 | + } |
| 123 | + LOG.info("Debugging binary message: " + sb.toString()); |
| 124 | + IS_EXPECTED_RESULT = Arrays.equals(payload, (byte[]) expectedResult); |
| 125 | + latch.countDown(); |
| 126 | + } |
| 127 | + |
| 128 | + @Override |
| 129 | + public void onTextFrame(String payload, boolean finalFragment, int rsv) { |
| 130 | + // Log message |
| 131 | + LOG.info("Debugging text message: " + payload); |
| 132 | + IS_EXPECTED_RESULT = expectedResult.equals(payload); |
| 133 | + latch.countDown(); |
| 134 | + } |
| 135 | + }) |
| 136 | + .build(); |
| 137 | + return wsHandler; |
| 138 | + } |
| 139 | + |
| 140 | + /* |
| 141 | + * Tested the PathParam annotation |
| 142 | + */ |
| 143 | + @Test |
| 144 | + public void testAnnotatedByteArray() throws Exception { |
| 145 | + Object expectedResult = "test message".getBytes(); |
| 146 | + |
| 147 | + WebSocketUpgradeHandler wsHandler = createWebSocketUpgradeHandler(expectedResult); |
| 148 | + |
| 149 | + WebSocket webSocketClient = Dsl.asyncHttpClient() |
| 150 | + .prepareGet("ws://" + |
| 151 | + server.getHostname() + ":" + |
| 152 | + server.getHttpDefaultPort() + "/" + |
| 153 | + APP_NAME + |
| 154 | + "/annotatedByteArray/true") |
| 155 | + .setRequestTimeout(5000) |
| 156 | + .execute(wsHandler) |
| 157 | + .get(); |
| 158 | + |
| 159 | + if (webSocketClient.isOpen()) { |
| 160 | + LOG.info("sending message"); |
| 161 | + webSocketClient.sendBinaryFrame("test message".getBytes()); |
| 162 | + } |
| 163 | + latch.await(3L, TimeUnit.SECONDS); |
| 164 | + webSocketClient.sendCloseFrame(); |
| 165 | + assertTrue("Results do not match! ", IS_EXPECTED_RESULT); |
| 166 | + } |
| 167 | + |
| 168 | + /* |
| 169 | + * Verifies the decoder annotation is picked up |
| 170 | + */ |
| 171 | + @Test |
| 172 | + public void testDecoder() throws Exception { |
| 173 | + Object expectedResult = "[class io.openliberty.wsoc.basic.BinaryStreamDecoder]"; |
| 174 | + |
| 175 | + WebSocketUpgradeHandler wsHandler = createWebSocketUpgradeHandler(expectedResult); |
| 176 | + WebSocket webSocketClient = Dsl.asyncHttpClient() |
| 177 | + .prepareGet("ws://" + |
| 178 | + server.getHostname() + ":" + |
| 179 | + server.getHttpDefaultPort() + "/" + |
| 180 | + APP_NAME + |
| 181 | + "/defaults") |
| 182 | + .setRequestTimeout(5000) |
| 183 | + .execute(wsHandler) |
| 184 | + .get(); |
| 185 | + |
| 186 | + if (webSocketClient.isOpen()) { |
| 187 | + LOG.info("sending message"); |
| 188 | + webSocketClient.sendTextFrame("decoders"); |
| 189 | + } |
| 190 | + latch.await(3L, TimeUnit.SECONDS); |
| 191 | + webSocketClient.sendCloseFrame(); |
| 192 | + assertTrue("Results do not match! ", IS_EXPECTED_RESULT); |
| 193 | + } |
| 194 | + |
| 195 | + /* |
| 196 | + * Verifies the WsWsocServerContainer#doUprade works (deprecated in 2.1) |
| 197 | + */ |
| 198 | + @Test |
| 199 | + public void testUpgrade() throws Exception { |
| 200 | + Object expectedResult = "got your message hello world"; |
| 201 | + |
| 202 | + WebSocketUpgradeHandler wsHandler = createWebSocketUpgradeHandler(expectedResult); |
| 203 | + WebSocket webSocketClient = Dsl.asyncHttpClient() |
| 204 | + .prepareGet("ws://" + |
| 205 | + server.getHostname() + ":" + |
| 206 | + server.getHttpDefaultPort() + "/" + |
| 207 | + APP_NAME + |
| 208 | + "/upgradeEcho") |
| 209 | + .setRequestTimeout(5000) |
| 210 | + .execute(wsHandler) |
| 211 | + .get(); |
| 212 | + |
| 213 | + if (webSocketClient.isOpen()) { |
| 214 | + LOG.info("sending message"); |
| 215 | + webSocketClient.sendTextFrame("hello world"); |
| 216 | + } |
| 217 | + latch.await(3L, TimeUnit.SECONDS); |
| 218 | + webSocketClient.sendCloseFrame(); |
| 219 | + assertTrue("Results do not match! ", IS_EXPECTED_RESULT); |
| 220 | + } |
| 221 | + |
| 222 | +} |
0 commit comments