Migrate spring-websocket test suite from JUnit 4 to JUnit Jupiter

See spring-projectsgh-23451

Author: sbrannen

spring-websocket/src/test/java/org/springframework/web/socket/AbstractHttpRequestTests.java

@@ -16,7 +16,7 @@
 
 package org.springframework.web.socket;
 
-import org.junit.Before;
+import org.junit.jupiter.api.BeforeEach;
 
 import org.springframework.http.server.ServerHttpAsyncRequestControl;
 import org.springframework.http.server.ServerHttpRequest;
@@ -44,7 +44,7 @@ public abstract class AbstractHttpRequestTests {
 	protected ServerHttpAsyncRequestControl asyncControl;
 
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		resetRequestAndResponse();
 	}

spring-websocket/src/test/java/org/springframework/web/socket/AbstractWebSocketIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,16 +16,19 @@
 
 package org.springframework.web.socket;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.rules.TestName;
-import org.junit.runners.Parameterized.Parameter;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.TestInfo;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import org.springframework.context.Lifecycle;
 import org.springframework.context.annotation.Bean;
@@ -56,23 +59,28 @@ public abstract class AbstractWebSocketIntegrationTests {
 	}
 
 
-	@Rule
-	public final TestName testName = new TestName();
-
-	@Parameter(0)
-	public WebSocketTestServer server;
+	@Retention(RetentionPolicy.RUNTIME)
+	@Target(ElementType.METHOD)
+	@ParameterizedTest(name = "server [{0}], client [{1}]")
+	@MethodSource("arguments")
+	protected @interface ParameterizedWebSocketTest {
+	}
 
-	@Parameter(1)
-	public WebSocketClient webSocketClient;
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
+	protected WebSocketTestServer server;
+
+	protected WebSocketClient webSocketClient;
+
 	protected AnnotationConfigWebApplicationContext wac;
 
 
-	@Before
-	public void setup() throws Exception {
-		logger.debug("Setting up '" + this.testName.getMethodName() + "', client=" +
+	protected void setup(WebSocketTestServer server, WebSocketClient webSocketClient, TestInfo testInfo) throws Exception {
+		this.server = server;
+		this.webSocketClient = webSocketClient;
+
+		logger.debug("Setting up '" + testInfo.getTestMethod().get().getName() + "', client=" +
 				this.webSocketClient.getClass().getSimpleName() + ", server=" +
 				this.server.getClass().getSimpleName());
 
@@ -94,8 +102,8 @@ public void setup() throws Exception {
 
 	protected abstract Class<?>[] getAnnotatedConfigClasses();
 
-	@After
-	public void teardown() throws Exception {
+	@AfterEach
+	void teardown() throws Exception {
 		try {
 			if (this.webSocketClient instanceof Lifecycle) {
 				((Lifecycle) this.webSocketClient).stop();
@@ -147,6 +155,7 @@ public DefaultHandshakeHandler handshakeHandler() {
 	@Configuration
 	static class JettyUpgradeStrategyConfig extends AbstractRequestUpgradeStrategyConfig {
 
+		@Override
 		@Bean
 		public RequestUpgradeStrategy requestUpgradeStrategy() {
 			return new JettyRequestUpgradeStrategy();
@@ -157,6 +166,7 @@ public RequestUpgradeStrategy requestUpgradeStrategy() {
 	@Configuration
 	static class TomcatUpgradeStrategyConfig extends AbstractRequestUpgradeStrategyConfig {
 
+		@Override
 		@Bean
 		public RequestUpgradeStrategy requestUpgradeStrategy() {
 			return new TomcatRequestUpgradeStrategy();
@@ -167,6 +177,7 @@ public RequestUpgradeStrategy requestUpgradeStrategy() {
 	@Configuration
 	static class UndertowUpgradeStrategyConfig extends AbstractRequestUpgradeStrategyConfig {
 
+		@Override
 		@Bean
 		public RequestUpgradeStrategy requestUpgradeStrategy() {
 			return new UndertowRequestUpgradeStrategy();

spring-websocket/src/test/java/org/springframework/web/socket/TextMessageTests.java

@@ -16,7 +16,7 @@
 
 package org.springframework.web.socket;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

spring-websocket/src/test/java/org/springframework/web/socket/WebSocketExtensionTests.java

@@ -18,7 +18,7 @@
 
 import java.util.List;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

spring-websocket/src/test/java/org/springframework/web/socket/WebSocketHandshakeTests.java

@@ -23,14 +23,12 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.junit.runners.Parameterized.Parameters;
+import org.junit.jupiter.api.TestInfo;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.web.socket.client.WebSocketClient;
 import org.springframework.web.socket.client.jetty.JettyWebSocketClient;
 import org.springframework.web.socket.client.standard.StandardWebSocketClient;
 import org.springframework.web.socket.config.annotation.EnableWebSocket;
@@ -47,12 +45,11 @@
  *
  * @author Rossen Stoyanchev
  * @author Juergen Hoeller
+ * @author Sam Brannen
  */
-@RunWith(Parameterized.class)
-public class WebSocketHandshakeTests extends AbstractWebSocketIntegrationTests {
+class WebSocketHandshakeTests extends AbstractWebSocketIntegrationTests {
 
-	@Parameters(name = "server [{0}], client [{1}]")
-	public static Iterable<Object[]> arguments() {
+	static Iterable<Object[]> arguments() {
 		return Arrays.asList(new Object[][] {
 				{new JettyWebSocketTestServer(), new JettyWebSocketClient()},
 				{new TomcatWebSocketTestServer(), new StandardWebSocketClient()},
@@ -66,8 +63,11 @@ protected Class<?>[] getAnnotatedConfigClasses() {
 		return new Class<?>[] {TestConfig.class};
 	}
 
-	@Test
-	public void subProtocolNegotiation() throws Exception {
+
+	@ParameterizedWebSocketTest
+	void subProtocolNegotiation(WebSocketTestServer server, WebSocketClient webSocketClient, TestInfo testInfo) throws Exception {
+		super.setup(server, webSocketClient, testInfo);
+
 		WebSocketHttpHeaders headers = new WebSocketHttpHeaders();
 		headers.setSecWebSocketProtocol("foo");
 		URI url = new URI(getWsBaseUrl() + "/ws");
@@ -76,8 +76,10 @@ public void subProtocolNegotiation() throws Exception {
 		session.close();
 	}
 
-	@Test  // SPR-12727
-	public void unsolicitedPongWithEmptyPayload() throws Exception {
+	@ParameterizedWebSocketTest  // SPR-12727
+	void unsolicitedPongWithEmptyPayload(WebSocketTestServer server, WebSocketClient webSocketClient, TestInfo testInfo) throws Exception {
+		super.setup(server, webSocketClient, testInfo);
+
 		String url = getWsBaseUrl() + "/ws";
 		WebSocketSession session = this.webSocketClient.doHandshake(new AbstractWebSocketHandler() {}, url).get();
 

spring-websocket/src/test/java/org/springframework/web/socket/adapter/jetty/JettyWebSocketHandlerAdapterTests.java

@@ -19,8 +19,8 @@
 import org.eclipse.jetty.websocket.api.Session;
 import org.eclipse.jetty.websocket.api.UpgradeRequest;
 import org.eclipse.jetty.websocket.api.UpgradeResponse;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 import org.springframework.web.socket.CloseStatus;
@@ -46,7 +46,7 @@ public class JettyWebSocketHandlerAdapterTests {
 	private Session session;
 
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		this.session = mock(Session.class);
 		given(this.session.getUpgradeRequest()).willReturn(Mockito.mock(UpgradeRequest.class));

spring-websocket/src/test/java/org/springframework/web/socket/adapter/jetty/JettyWebSocketSessionTests.java

@@ -22,7 +22,7 @@
 import org.eclipse.jetty.websocket.api.Session;
 import org.eclipse.jetty.websocket.api.UpgradeRequest;
 import org.eclipse.jetty.websocket.api.UpgradeResponse;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 import org.springframework.web.socket.handler.TestPrincipal;

spring-websocket/src/test/java/org/springframework/web/socket/adapter/standard/ConvertingEncoderDecoderSupportTests.java

@@ -22,9 +22,9 @@
 import javax.websocket.EncodeException;
 import javax.websocket.Encoder;
 
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
@@ -62,12 +62,12 @@ public class ConvertingEncoderDecoderSupportTests {
 	private MyType myType = new MyType("test");
 
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		setup(Config.class);
 	}
 
-	@After
+	@AfterEach
 	public void teardown() {
 		ContextLoaderTestUtils.setCurrentWebApplicationContext(null);
 	}

spring-websocket/src/test/java/org/springframework/web/socket/adapter/standard/StandardWebSocketHandlerAdapterTests.java

@@ -22,8 +22,8 @@
 import javax.websocket.MessageHandler;
 import javax.websocket.Session;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.web.socket.CloseStatus;
 import org.springframework.web.socket.WebSocketHandler;
@@ -51,7 +51,7 @@ public class StandardWebSocketHandlerAdapterTests {
 	private Session session;
 
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		this.session = mock(Session.class);
 		this.webSocketHandler = mock(WebSocketHandler.class);

spring-websocket/src/test/java/org/springframework/web/socket/adapter/standard/StandardWebSocketSessionTests.java

@@ -20,7 +20,7 @@
 import java.util.Map;
 import javax.websocket.Session;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 import org.springframework.http.HttpHeaders;