Skip to content

Commit 0257469

Browse files
Artur-mcollovati
andauthored
test: Migrate vaadin-dev-server tests to JUnit 6 (#23622)
* refactor: Migrate vaadin-dev-server tests to JUnit 5 * fix: Address PR review comments for vaadin-dev-server JUnit 5 migration Move setup code outside assertThrows blocks so only the throwing call is verified, remove unused @tempdir fields and imports, add @AfterEach to overridden teardown(), and document why CleanupMode.NEVER is needed. * fix: Explain why CleanupMode.NEVER is needed for @tempdir JUnit 4 TemporaryFolder silently ignored cleanup failures, but JUnit 5 @tempdir fails the test. node_modules created by dev mode cannot always be deleted, so automatic cleanup must be skipped. * format * fix: remove obsolete uiInit_registersUIRefreshClientSideEvent test The test referenced UIInitEvent and refreshUIClientListenerRegistered which no longer exist after the JS listener was moved to TypeScript in 7968bda. * fix: add missing @OverRide to DevModeEndpointTest.setup() * fix: address PR review comments for vaadin-dev-server JUnit 5 migration - Add missing @AfterEach to ViteWebsocketConnectionTest.tearDown() - Use @tempdir instead of Files.createTempDirectory() in DevModeInitializerTest for proper cleanup --------- Co-authored-by: Marco Collovati <marco@vaadin.com>
1 parent 33a9838 commit 0257469

32 files changed

Lines changed: 1288 additions & 1304 deletions

‎vaadin-dev-server/src/test/java/com/vaadin/base/devserver/AbstractDevServerRunnerTest.java‎

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@
3737
import java.util.function.Consumer;
3838
import java.util.regex.Pattern;
3939

40-
import org.junit.Assert;
4140
import org.junit.AssumptionViolatedException;
42-
import org.junit.Test;
41+
import org.junit.jupiter.api.Test;
4342
import org.mockito.Mockito;
4443

4544
import com.vaadin.base.devserver.startup.AbstractDevModeTest;
@@ -48,7 +47,11 @@
4847
import com.vaadin.flow.server.frontend.FrontendTools;
4948
import com.vaadin.flow.server.frontend.FrontendToolsSettings;
5049

51-
public class AbstractDevServerRunnerTest extends AbstractDevModeTest {
50+
import static org.junit.jupiter.api.Assertions.assertEquals;
51+
import static org.junit.jupiter.api.Assertions.assertNotNull;
52+
import static org.junit.jupiter.api.Assertions.assertTrue;
53+
54+
class AbstractDevServerRunnerTest extends AbstractDevModeTest {
5255

5356
private class DummyRunner extends AbstractDevServerRunner {
5457

@@ -106,14 +109,14 @@ public HttpURLConnection prepareConnection(String path, String method)
106109

107110
// Expose for testing
108111
@Override
109-
public void updateServerStartupEnvironment(FrontendTools frontendTools,
110-
Map<String, String> environment) {
112+
protected void updateServerStartupEnvironment(
113+
FrontendTools frontendTools, Map<String, String> environment) {
111114
super.updateServerStartupEnvironment(frontendTools, environment);
112115
}
113116
}
114117

115118
@Test
116-
public void shouldPassEncodedUrlToDevServer() throws Exception {
119+
void shouldPassEncodedUrlToDevServer() throws Exception {
117120
handler = new DummyRunner();
118121
waitForDevServer();
119122
DevModeHandler devServer = Mockito.spy(handler);
@@ -133,49 +136,44 @@ public void shouldPassEncodedUrlToDevServer() throws Exception {
133136
requestedPath.set((String) invocation.getArguments()[0]);
134137
return Mockito.mock(HttpURLConnection.class);
135138
});
136-
Assert.assertTrue("Dev server should have served the resource",
137-
devServer.serveDevModeRequest(request, response));
138-
Assert.assertEquals("foo%20bar", requestedPath.get());
139+
assertTrue(devServer.serveDevModeRequest(request, response),
140+
"Dev server should have served the resource");
141+
assertEquals("foo%20bar", requestedPath.get());
139142

140143
}
141144

142145
@Test
143-
public void updateServerStartupEnvironment_preferIpv4_LocalhostIpAddressAddedToProcessEnvironment() {
146+
void updateServerStartupEnvironment_preferIpv4_LocalhostIpAddressAddedToProcessEnvironment() {
144147
assertOnDevProcessEnvironment(Inet4Address.class, environment -> {
145-
Assert.assertNotNull(
146-
"Expecting watchDogPort to be added to environment, but was not",
147-
environment.get("watchDogPort"));
148+
assertNotNull(environment.get("watchDogPort"),
149+
"Expecting watchDogPort to be added to environment, but was not");
148150

149151
String watchDogHost = environment.get("watchDogHost");
150-
Assert.assertNotNull(
151-
"Expecting watchDogHost to be added to environment, but was not",
152-
watchDogHost);
152+
assertNotNull(watchDogHost,
153+
"Expecting watchDogHost to be added to environment, but was not");
153154
// From InetAddress javadocs:
154155
// The IPv4 loopback address returned is only one of many in the
155156
// form 127.*.*.*
156-
Assert.assertTrue(
157+
assertTrue(watchDogHost.matches("127\\.\\d+\\.\\d+\\.\\d+"),
157158
"Expecting watchDogHost to be an ipv4 address, but was "
158-
+ watchDogHost,
159-
watchDogHost.matches("127\\.\\d+\\.\\d+\\.\\d+"));
159+
+ watchDogHost);
160160
});
161161
}
162162

163163
@Test
164-
public void updateServerStartupEnvironment_preferIpv6_LocalhostIpAddressAddedToProcessEnvironment() {
164+
void updateServerStartupEnvironment_preferIpv6_LocalhostIpAddressAddedToProcessEnvironment() {
165165
assertOnDevProcessEnvironment(Inet6Address.class, environment -> {
166-
Assert.assertNotNull(
167-
"Expecting watchDogPort to be added to environment, but was not",
168-
environment.get("watchDogPort"));
166+
assertNotNull(environment.get("watchDogPort"),
167+
"Expecting watchDogPort to be added to environment, but was not");
169168

170169
String watchDogHost = environment.get("watchDogHost");
171-
Assert.assertNotNull(
172-
"Expecting watchDogHost to be added to environment, but was not",
173-
watchDogHost);
174-
Assert.assertTrue(
175-
"Expecting watchDogHost to be an ipv6 address, but was "
176-
+ watchDogHost,
170+
assertNotNull(watchDogHost,
171+
"Expecting watchDogHost to be added to environment, but was not");
172+
assertTrue(
177173
"0:0:0:0:0:0:0:1".equals(watchDogHost)
178-
|| "::1".equals(watchDogHost));
174+
|| "::1".equals(watchDogHost),
175+
"Expecting watchDogHost to be an ipv6 address, but was "
176+
+ watchDogHost);
179177
});
180178
}
181179

‎vaadin-dev-server/src/test/java/com/vaadin/base/devserver/BrowserLiveReloadAccessorImplTest.java‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515
*/
1616
package com.vaadin.base.devserver;
1717

18-
import org.junit.Assert;
19-
import org.junit.Test;
18+
import org.junit.jupiter.api.Test;
2019
import org.mockito.Mockito;
2120

2221
import com.vaadin.flow.function.DeploymentConfiguration;
@@ -25,48 +24,52 @@
2524
import com.vaadin.flow.server.VaadinService;
2625
import com.vaadin.flow.server.startup.ApplicationConfiguration;
2726

28-
public class BrowserLiveReloadAccessorImplTest {
27+
import static org.junit.jupiter.api.Assertions.assertNotNull;
28+
import static org.junit.jupiter.api.Assertions.assertNull;
29+
import static org.junit.jupiter.api.Assertions.assertSame;
30+
31+
class BrowserLiveReloadAccessorImplTest {
2932

3033
private BrowserLiveReloadAccessorImpl access = new BrowserLiveReloadAccessorImpl();
3134

3235
@Test
33-
public void getLiveReload_productionMode_nullIsReturned() {
36+
void getLiveReload_productionMode_nullIsReturned() {
3437
VaadinService service = mockConfiguration(true, false);
3538

36-
Assert.assertNull(access.getLiveReload(service));
39+
assertNull(access.getLiveReload(service));
3740
}
3841

3942
@Test
40-
public void getLiveReload_liveReloadDisabled_instanceIsCreated() {
43+
void getLiveReload_liveReloadDisabled_instanceIsCreated() {
4144
VaadinService service = mockConfiguration(false, false);
4245
VaadinContext context = service.getContext();
4346
Mockito.when(context.getAttribute(Mockito.eq(BrowserLiveReload.class),
4447
Mockito.any()))
4548
.thenReturn(Mockito.mock(BrowserLiveReload.class));
4649

47-
Assert.assertNotNull(access.getLiveReload(service));
50+
assertNotNull(access.getLiveReload(service));
4851
}
4952

5053
@Test
51-
public void getLiveReload_devMode_contextHasNoReloadInstance_instanceIsCreated() {
54+
void getLiveReload_devMode_contextHasNoReloadInstance_instanceIsCreated() {
5255
VaadinService service = mockConfiguration(false, true);
5356
VaadinContext context = service.getContext();
5457
Mockito.when(context.getAttribute(Mockito.eq(BrowserLiveReload.class),
5558
Mockito.any()))
5659
.thenReturn(Mockito.mock(BrowserLiveReload.class));
5760

58-
Assert.assertNotNull(access.getLiveReload(service));
61+
assertNotNull(access.getLiveReload(service));
5962
}
6063

6164
@Test
62-
public void getLiveReload_devMode_contextHasReloadInstance_instanceIsReturned() {
65+
void getLiveReload_devMode_contextHasReloadInstance_instanceIsReturned() {
6366
VaadinService service = mockConfiguration(false, true);
6467
BrowserLiveReload reload = Mockito.mock(BrowserLiveReload.class);
6568
Mockito.when(service.getContext().getAttribute(
6669
Mockito.eq(BrowserLiveReload.class), Mockito.any()))
6770
.thenReturn(reload);
6871

69-
Assert.assertSame(reload, access.getLiveReload(service));
72+
assertSame(reload, access.getLiveReload(service));
7073
}
7174

7275
private VaadinService mockConfiguration(boolean productionMode,

‎vaadin-dev-server/src/test/java/com/vaadin/base/devserver/DebugWindowConnectionLicenseCheckTest.java‎

Lines changed: 58 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222

2323
import org.atmosphere.cpr.AtmosphereResource;
2424
import org.atmosphere.cpr.Broadcaster;
25-
import org.junit.Assert;
26-
import org.junit.Test;
25+
import org.junit.jupiter.api.Test;
2726
import org.mockito.Answers;
2827
import org.mockito.MockedStatic;
2928
import org.mockito.Mockito;
@@ -45,12 +44,16 @@
4544
import com.vaadin.pro.licensechecker.PreTrialLicenseValidationException;
4645
import com.vaadin.pro.licensechecker.Product;
4746

47+
import static org.junit.jupiter.api.Assertions.assertEquals;
48+
import static org.junit.jupiter.api.Assertions.assertNotNull;
49+
import static org.junit.jupiter.api.Assertions.assertNull;
50+
import static org.junit.jupiter.api.Assertions.assertTrue;
4851
import static org.mockito.ArgumentMatchers.any;
4952
import static org.mockito.ArgumentMatchers.anyString;
5053
import static org.mockito.ArgumentMatchers.eq;
5154
import static org.mockito.ArgumentMatchers.same;
5255

53-
public class DebugWindowConnectionLicenseCheckTest {
56+
class DebugWindowConnectionLicenseCheckTest {
5457

5558
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
5659
private static final Product TEST_PRODUCT = new Product(
@@ -65,124 +68,117 @@ public class DebugWindowConnectionLicenseCheckTest {
6568
private final ClientMessageReceiver receiver = new ClientMessageReceiver();
6669

6770
@Test
68-
public void checkLicense_validLicense_sendLicenseOk() {
71+
void checkLicense_validLicense_sendLicenseOk() {
6972
DebugWindowMessage message = doLicenseCheck(LicenseCheckResult.VALID);
70-
Assert.assertEquals("license-check-ok", message.getCommand());
71-
Assert.assertTrue("Expected a Product object in response message",
72-
message.getData() instanceof Product);
73-
Assert.assertEquals(TEST_PRODUCT.toString(),
74-
message.getData().toString());
73+
assertEquals("license-check-ok", message.getCommand());
74+
assertTrue(message.getData() instanceof Product,
75+
"Expected a Product object in response message");
76+
assertEquals(TEST_PRODUCT.toString(), message.getData().toString());
7577
}
7678

7779
@Test
78-
public void checkLicense_invalidLicense_sendLicenseCheckFailed() {
80+
void checkLicense_invalidLicense_sendLicenseCheckFailed() {
7981
DebugWindowMessage message = doLicenseCheck(LicenseCheckResult.INVALID);
80-
Assert.assertEquals("license-check-failed", message.getCommand());
81-
Assert.assertTrue(
82-
"Expected a ProductAndMessage object in response message",
83-
message.getData() instanceof ProductAndMessage);
82+
assertEquals("license-check-failed", message.getCommand());
83+
assertTrue(message.getData() instanceof ProductAndMessage,
84+
"Expected a ProductAndMessage object in response message");
8485
ProductAndMessage productAndMessage = (ProductAndMessage) message
8586
.getData();
86-
Assert.assertEquals(INVALID_LICENSE_ERROR,
87-
productAndMessage.getMessage());
88-
Assert.assertEquals(TEST_PRODUCT.toString(),
87+
assertEquals(INVALID_LICENSE_ERROR, productAndMessage.getMessage());
88+
assertEquals(TEST_PRODUCT.toString(),
8989
productAndMessage.getProduct().toString());
90-
Assert.assertNull("Expected pre-trial info to be absent",
91-
productAndMessage.getPreTrial());
90+
assertNull(productAndMessage.getPreTrial(),
91+
"Expected pre-trial info to be absent");
9292
}
9393

9494
@Test
95-
public void checkLicense_noLicenseKeys_sendLicenseCheckFailed() {
95+
void checkLicense_noLicenseKeys_sendLicenseCheckFailed() {
9696
DebugWindowMessage message = doLicenseCheck(
9797
LicenseCheckResult.MISSING_KEYS);
9898

99-
Assert.assertEquals("license-check-nokey", message.getCommand());
100-
Assert.assertTrue(
101-
"Expected a ProductAndMessage object in response message",
102-
message.getData() instanceof ProductAndMessage);
99+
assertEquals("license-check-nokey", message.getCommand());
100+
assertTrue(message.getData() instanceof ProductAndMessage,
101+
"Expected a ProductAndMessage object in response message");
103102
ProductAndMessage productAndMessage = (ProductAndMessage) message
104103
.getData();
105-
Assert.assertTrue(
106-
productAndMessage.getMessage().contains(MISSING_KEY_ERROR));
107-
Assert.assertEquals(TEST_PRODUCT.toString(),
104+
assertTrue(productAndMessage.getMessage().contains(MISSING_KEY_ERROR));
105+
assertEquals(TEST_PRODUCT.toString(),
108106
productAndMessage.getProduct().toString());
109-
Assert.assertEquals(TEST_PRODUCT.toString(),
107+
assertEquals(TEST_PRODUCT.toString(),
110108
productAndMessage.getProduct().toString());
111-
Assert.assertNotNull("Expected pre-trial info to be present",
112-
productAndMessage.getPreTrial());
113-
Assert.assertEquals(TEST_PRE_TRIAL.toString(),
109+
assertNotNull(productAndMessage.getPreTrial(),
110+
"Expected pre-trial info to be present");
111+
assertEquals(TEST_PRE_TRIAL.toString(),
114112
productAndMessage.getPreTrial().toString());
115113
}
116114

117115
@Test
118-
public void startPreTrial_preTrialAllowed_sendPreTrialInfo() {
116+
void startPreTrial_preTrialAllowed_sendPreTrialInfo() {
119117
DebugWindowMessage message = doStartPreTrial(
120118
PreTrial.PreTrialState.START_ALLOWED);
121-
Assert.assertEquals("license-pretrial-started", message.getCommand());
122-
Assert.assertTrue("Expected a PreTrial object in response message",
123-
message.getData() instanceof PreTrial);
119+
assertEquals("license-pretrial-started", message.getCommand());
120+
assertTrue(message.getData() instanceof PreTrial,
121+
"Expected a PreTrial object in response message");
124122
PreTrial preTrial = (PreTrial) message.getData();
125-
Assert.assertEquals(TEST_PRE_TRIAL.toString(), preTrial.toString());
123+
assertEquals(TEST_PRE_TRIAL.toString(), preTrial.toString());
126124
}
127125

128126
@Test
129-
public void startPreTrial_preTrialRunning_sendPreTrialInfo() {
127+
void startPreTrial_preTrialRunning_sendPreTrialInfo() {
130128
DebugWindowMessage message = doStartPreTrial(
131129
PreTrial.PreTrialState.RUNNING);
132-
Assert.assertEquals("license-pretrial-started", message.getCommand());
133-
Assert.assertTrue("Expected a PreTrial object in response message",
134-
message.getData() instanceof PreTrial);
130+
assertEquals("license-pretrial-started", message.getCommand());
131+
assertTrue(message.getData() instanceof PreTrial,
132+
"Expected a PreTrial object in response message");
135133
PreTrial preTrial = (PreTrial) message.getData();
136-
Assert.assertEquals(TEST_PRE_TRIAL.toString(), preTrial.toString());
134+
assertEquals(TEST_PRE_TRIAL.toString(), preTrial.toString());
137135
}
138136

139137
@Test
140-
public void startPreTrial_preTrialExpired_sendPreTrialExpiredFailure() {
138+
void startPreTrial_preTrialExpired_sendPreTrialExpiredFailure() {
141139
DebugWindowMessage message = doStartPreTrial(
142140
PreTrial.PreTrialState.EXPIRED);
143-
Assert.assertEquals("license-pretrial-expired", message.getCommand());
141+
assertEquals("license-pretrial-expired", message.getCommand());
144142
}
145143

146144
@Test
147-
public void startPreTrial_preTrialNotAllowed_sendPreTrialNotAllowedFailure() {
145+
void startPreTrial_preTrialNotAllowed_sendPreTrialNotAllowedFailure() {
148146
DebugWindowMessage message = doStartPreTrial(null);
149-
Assert.assertEquals("license-pretrial-failed", message.getCommand());
147+
assertEquals("license-pretrial-failed", message.getCommand());
150148
}
151149

152150
@Test
153-
public void startPreTrial_genericError_sendPreTrialNotAllowedFailure() {
151+
void startPreTrial_genericError_sendPreTrialNotAllowedFailure() {
154152
DebugWindowMessage message = doStartPreTrial(
155153
PreTrial.PreTrialState.ACCESS_DENIED);
156-
Assert.assertEquals("license-pretrial-failed", message.getCommand());
154+
assertEquals("license-pretrial-failed", message.getCommand());
157155
}
158156

159157
@Test
160-
public void downloadLicenseKey_licenseKeyAvailable_notifiesDownloadStartAndSuccess() {
158+
void downloadLicenseKey_licenseKeyAvailable_notifiesDownloadStartAndSuccess() {
161159
AtomicReference<Runnable> callbackHolder = new AtomicReference<>();
162160
DebugWindowMessage message = doDownloadKey(true, callbackHolder);
163-
Assert.assertEquals("license-download-started", message.getCommand());
164-
Assert.assertEquals(TEST_PRODUCT.toString(),
165-
message.getData().toString());
161+
assertEquals("license-download-started", message.getCommand());
162+
assertEquals(TEST_PRODUCT.toString(), message.getData().toString());
166163
callbackHolder.get().run();
167-
Assert.assertEquals(1, receiver.messages.size());
168-
Assert.assertEquals("license-download-completed",
164+
assertEquals(1, receiver.messages.size());
165+
assertEquals("license-download-completed",
169166
receiver.messages.get(0).getCommand());
170-
Assert.assertEquals(TEST_PRODUCT.toString(),
167+
assertEquals(TEST_PRODUCT.toString(),
171168
receiver.messages.get(0).getData().toString());
172169
}
173170

174171
@Test
175-
public void downloadLicenseKey_licenseKeyNotAvailable_notifiesDownloadStartAndFailure() {
172+
void downloadLicenseKey_licenseKeyNotAvailable_notifiesDownloadStartAndFailure() {
176173
AtomicReference<Runnable> callbackHolder = new AtomicReference<>();
177174
DebugWindowMessage message = doDownloadKey(false, callbackHolder);
178-
Assert.assertEquals("license-download-started", message.getCommand());
179-
Assert.assertEquals(TEST_PRODUCT.toString(),
180-
message.getData().toString());
175+
assertEquals("license-download-started", message.getCommand());
176+
assertEquals(TEST_PRODUCT.toString(), message.getData().toString());
181177
callbackHolder.get().run();
182-
Assert.assertEquals(1, receiver.messages.size());
183-
Assert.assertEquals("license-download-failed",
178+
assertEquals(1, receiver.messages.size());
179+
assertEquals("license-download-failed",
184180
receiver.messages.get(0).getCommand());
185-
Assert.assertEquals(TEST_PRODUCT.toString(),
181+
assertEquals(TEST_PRODUCT.toString(),
186182
receiver.messages.get(0).getData().toString());
187183
}
188184

@@ -250,7 +246,7 @@ private DebugWindowMessage sendAndReceive(ObjectNode command,
250246
withMockedLicenseChecker(instrumenter,
251247
() -> reload.onMessage(receiver.resource, command.toString()));
252248
int responses = receiver.messages.size();
253-
Assert.assertEquals("Expected messages", 1, responses);
249+
assertEquals(1, responses, "Expected messages");
254250
DebugWindowMessage message = receiver.messages.get(0);
255251
receiver.messages.clear();
256252
return message;

0 commit comments

Comments
 (0)