Skip to content

Commit 2f3fa48

Browse files
chore: migrate tests to JUnit5 (refs #358)
* Migrate annotations and imports * Migrate assertions * Remove public visibility for test classes and methods * Minor code cleanup
1 parent 8f2edb6 commit 2f3fa48

16 files changed

+246
-274
lines changed

pom.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<licenses>
1818
<license>
1919
<name>MIT License</name>
20-
<url>http://opensource.org/licenses/MIT</url>
20+
<url>https://opensource.org/licenses/MIT</url>
2121
</license>
2222
</licenses>
2323

@@ -112,6 +112,10 @@
112112
<groupId>org.jenkins-ci.plugins</groupId>
113113
<artifactId>structs</artifactId>
114114
</dependency>
115+
<dependency>
116+
<groupId>org.junit.platform</groupId>
117+
<artifactId>junit-platform-suite</artifactId>
118+
</dependency>
115119

116120
<!-- Cucumber -->
117121
<dependency>
@@ -122,7 +126,7 @@
122126
</dependency>
123127
<dependency>
124128
<groupId>io.cucumber</groupId>
125-
<artifactId>cucumber-junit</artifactId>
129+
<artifactId>cucumber-junit-platform-engine</artifactId>
126130
<version>7.20.1</version>
127131
<scope>test</scope>
128132
</dependency>

src/test/java/org/jenkinsci/plugins/gwt/GenericCauseTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
import static org.assertj.core.api.Assertions.assertThat;
44

5-
import org.junit.Test;
5+
import org.junit.jupiter.api.Test;
66

7-
public class GenericCauseTest {
7+
class GenericCauseTest {
88

99
@Test
10-
public void sanitizeCauseString_link() {
10+
void sanitizeCauseString_link() {
1111
final String actual = new GenericCause(
1212
null, null, false, false, "<b>Triggered by:</b> <a href=\"https://test.org/pr/1\">PR 1</a>")
1313
.getShortDescription();
@@ -17,7 +17,7 @@ public void sanitizeCauseString_link() {
1717
}
1818

1919
@Test
20-
public void sanitizeCauseString_script() {
20+
void sanitizeCauseString_script() {
2121
final String actual = new GenericCause(
2222
null, null, false, false, "<b>Triggered by:</b> PR 1<div><script>somethingBad()</script></div>")
2323
.getShortDescription();

src/test/java/org/jenkinsci/plugins/gwt/GenericTriggerResultsTest.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
import static org.assertj.core.api.Assertions.assertThat;
44

55
import java.util.Map;
6-
import org.junit.Test;
6+
import org.junit.jupiter.api.Test;
7+
8+
class GenericTriggerResultsTest {
79

8-
public class GenericTriggerResultsTest {
910
@Test
10-
public void testNull() {
11+
void testNull() {
1112
final String url = null;
1213
final long id = 0;
1314
final boolean triggered = false;
@@ -23,7 +24,7 @@ public void testNull() {
2324
}
2425

2526
@Test
26-
public void testNullApi() {
27+
void testNullApi() {
2728
final String url = null;
2829
final long id = 2L;
2930
final boolean triggered = false;

src/test/java/org/jenkinsci/plugins/gwt/GenericTriggerTest.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import static org.assertj.core.api.Assertions.assertThat;
44
import static org.jenkinsci.plugins.gwt.GenericTrigger.HEADER_DRY_RUN;
55

6-
import java.util.Arrays;
76
import java.util.List;
87
import java.util.Map;
98
import java.util.TreeMap;
@@ -15,28 +14,28 @@ class GenericTriggerTest {
1514
void testDryRun() {
1615
assertThat(GenericTrigger.isDryRun(null)).isFalse();
1716

18-
final Map<String, List<String>> headers = new TreeMap<String, List<String>>();
17+
final Map<String, List<String>> headers = new TreeMap<>();
1918
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
2019

2120
headers.put("whatever", null);
2221
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
2322

24-
final List<String> headerValues = Arrays.asList("true");
23+
final List<String> headerValues = List.of("true");
2524
headers.put("whatever", headerValues);
2625
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
2726

2827
headers.put(HEADER_DRY_RUN, null);
2928
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
3029

31-
List<String> dryRunHeaderValues = Arrays.asList("false");
30+
List<String> dryRunHeaderValues = List.of("false");
3231
headers.put(HEADER_DRY_RUN, dryRunHeaderValues);
3332
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
3433

35-
dryRunHeaderValues = Arrays.asList("x");
34+
dryRunHeaderValues = List.of("x");
3635
headers.put(HEADER_DRY_RUN, dryRunHeaderValues);
3736
assertThat(GenericTrigger.isDryRun(headers)).isFalse();
3837

39-
dryRunHeaderValues = Arrays.asList("true");
38+
dryRunHeaderValues = List.of("true");
4039
headers.put(HEADER_DRY_RUN, dryRunHeaderValues);
4140
assertThat(GenericTrigger.isDryRun(headers)).isTrue();
4241
}

src/test/java/org/jenkinsci/plugins/gwt/GenericWebHookRequestReceiverTest.java

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
import java.util.HashMap;
1111
import java.util.List;
1212
import java.util.Map;
13-
import org.junit.Test;
13+
import org.junit.jupiter.api.Test;
1414
import org.kohsuke.stapler.StaplerRequest2;
1515

16-
public class GenericWebHookRequestReceiverTest {
16+
class GenericWebHookRequestReceiverTest {
1717

1818
@Test
19-
public void testThatNoTokenGivesNull() {
19+
void testThatNoTokenGivesNull() {
2020
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
2121
final Map<String, List<String>> headers = newHashMap();
2222
final Map<String, String[]> parameterMap = newHashMap();
@@ -28,7 +28,7 @@ public void testThatNoTokenGivesNull() {
2828
}
2929

3030
@Test
31-
public void testThatNoQuietPeriodGivesNegOne() {
31+
void testThatNoQuietPeriodGivesNegOne() {
3232
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
3333
final Map<String, List<String>> headers = newHashMap();
3434
final Map<String, String[]> parameterMap = newHashMap();
@@ -40,7 +40,7 @@ public void testThatNoQuietPeriodGivesNegOne() {
4040
}
4141

4242
@Test
43-
public void testThatParameterTokenGivesThatToken() {
43+
void testThatParameterTokenGivesThatToken() {
4444
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
4545
final Map<String, List<String>> headers = newHashMap();
4646
final Map<String, String[]> parameterMap = of( //
@@ -53,7 +53,7 @@ public void testThatParameterTokenGivesThatToken() {
5353
}
5454

5555
@Test
56-
public void testThatParameterQuietPeriodGivesThatQueitPeriod() {
56+
void testThatParameterQuietPeriodGivesThatQueitPeriod() {
5757
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
5858
final Map<String, List<String>> headers = newHashMap();
5959
final Map<String, String[]> parameterMap = of( //
@@ -66,10 +66,10 @@ public void testThatParameterQuietPeriodGivesThatQueitPeriod() {
6666
}
6767

6868
@Test
69-
public void testThatHeaderTokenGivesThatToken() {
69+
void testThatHeaderTokenGivesThatToken() {
7070
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
7171
final Map<String, List<String>> headers = of( //
72-
"token", (List<String>) newArrayList("tokenHeader"));
72+
"token", newArrayList("tokenHeader"));
7373
final Map<String, String[]> parameterMap = newHashMap();
7474

7575
final String actual = sut.getGivenToken(headers, parameterMap);
@@ -79,10 +79,10 @@ public void testThatHeaderTokenGivesThatToken() {
7979
}
8080

8181
@Test
82-
public void testThatGitLabTokenHeaderTokenGivesThatToken() {
82+
void testThatGitLabTokenHeaderTokenGivesThatToken() {
8383
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
8484
final Map<String, List<String>> headers = of( //
85-
"x-gitlab-token", (List<String>) newArrayList("gitlabtoken"));
85+
"x-gitlab-token", newArrayList("gitlabtoken"));
8686
final Map<String, String[]> parameterMap = newHashMap();
8787

8888
final String actual = sut.getGivenToken(headers, parameterMap);
@@ -92,10 +92,10 @@ public void testThatGitLabTokenHeaderTokenGivesThatToken() {
9292
}
9393

9494
@Test
95-
public void testThatHeaderQuietPeriodGivesThatQueitPeriod() {
95+
void testThatHeaderQuietPeriodGivesThatQueitPeriod() {
9696
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
9797
final Map<String, List<String>> headers = of( //
98-
"jobQuietPeriod", (List<String>) newArrayList("1"));
98+
"jobQuietPeriod", newArrayList("1"));
9999
final Map<String, String[]> parameterMap = newHashMap();
100100

101101
final int actual = sut.getGivenQuietPeriod(headers, parameterMap);
@@ -105,7 +105,7 @@ public void testThatHeaderQuietPeriodGivesThatQueitPeriod() {
105105
}
106106

107107
@Test
108-
public void testThatNonsensicalQuietPeriodGivesNegOne() {
108+
void testThatNonsensicalQuietPeriodGivesNegOne() {
109109
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
110110
final Map<String, List<String>> headers = newHashMap();
111111
final Map<String, String[]> parameterMap = of( //
@@ -118,10 +118,10 @@ public void testThatNonsensicalQuietPeriodGivesNegOne() {
118118
}
119119

120120
@Test
121-
public void testThatHeaderAuthorizationBearerTokenGivesThatToken() {
121+
void testThatHeaderAuthorizationBearerTokenGivesThatToken() {
122122
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
123123
final Map<String, List<String>> headers = of( //
124-
"authorization", (List<String>) newArrayList("Bearer baererTokenValue"));
124+
"authorization", newArrayList("Bearer baererTokenValue"));
125125
final Map<String, String[]> parameterMap = newHashMap();
126126

127127
final String actual = sut.getGivenToken(headers, parameterMap);
@@ -131,7 +131,7 @@ public void testThatHeaderAuthorizationBearerTokenGivesThatToken() {
131131
}
132132

133133
@Test
134-
public void testThatHeadersCanBeTransformedToList() {
134+
void testThatHeadersCanBeTransformedToList() {
135135
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
136136

137137
final StaplerRequest2 request = mock(StaplerRequest2.class);
@@ -152,7 +152,7 @@ public void testThatHeadersCanBeTransformedToList() {
152152
}
153153

154154
@Test
155-
public void testThatHeadersCanBeTransformedToListSeveralValues() {
155+
void testThatHeadersCanBeTransformedToListSeveralValues() {
156156
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
157157

158158
final StaplerRequest2 request = mock(StaplerRequest2.class);
@@ -173,7 +173,7 @@ public void testThatHeadersCanBeTransformedToListSeveralValues() {
173173
}
174174

175175
@Test
176-
public void testThatHeadersCanBeTransformedToListSeveralNames() {
176+
void testThatHeadersCanBeTransformedToListSeveralNames() {
177177
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
178178

179179
final StaplerRequest2 request = mock(StaplerRequest2.class);
@@ -198,7 +198,7 @@ public void testThatHeadersCanBeTransformedToListSeveralNames() {
198198
}
199199

200200
@Test
201-
public void testThatMessageIsCreatedFromExceptionWithNoStacktrace() {
201+
void testThatMessageIsCreatedFromExceptionWithNoStacktrace() {
202202
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
203203

204204
final Throwable t = new IndexOutOfBoundsException();
@@ -212,7 +212,7 @@ public void testThatMessageIsCreatedFromExceptionWithNoStacktrace() {
212212
}
213213

214214
@Test
215-
public void testThatMessageIsCreatedFromExceptionWithStacktrace() {
215+
void testThatMessageIsCreatedFromExceptionWithStacktrace() {
216216
final GenericWebHookRequestReceiver sut = new GenericWebHookRequestReceiver();
217217

218218
final Throwable t = new IndexOutOfBoundsException();
@@ -224,31 +224,35 @@ public void testThatMessageIsCreatedFromExceptionWithStacktrace() {
224224
}
225225

226226
@Test
227-
public void test404MessageNoToken_empty() {
227+
void test404MessageNoToken_empty() {
228228
final String actual = GenericWebHookRequestReceiver.construct404Message(null);
229229

230230
assertThat(actual)
231231
.isEqualToIgnoringWhitespace(
232-
"Did not find any jobs with GenericTrigger configured!\n"
233-
+ "No token was supplied.\n"
234-
+ "If you are using a token, you need to pass it like ...trigger/invoke?token=TOKENHERE\n"
235-
+ "If you are not using a token, you need to authenticate like http://user:passsword@example.org/generic-webhook...\n");
232+
"""
233+
Did not find any jobs with GenericTrigger configured!
234+
No token was supplied.
235+
If you are using a token, you need to pass it like ...trigger/invoke?token=TOKENHERE
236+
If you are not using a token, you need to authenticate like http://user:passsword@example.org/generic-webhook...
237+
""");
236238
}
237239

238240
@Test
239-
public void test404MessageNoToken_null() {
241+
void test404MessageNoToken_null() {
240242
final String actual = GenericWebHookRequestReceiver.construct404Message(null);
241243

242244
assertThat(actual)
243245
.isEqualToIgnoringWhitespace(
244-
"Did not find any jobs with GenericTrigger configured!\n"
245-
+ "No token was supplied.\n"
246-
+ "If you are using a token, you need to pass it like ...trigger/invoke?token=TOKENHERE\n"
247-
+ "If you are not using a token, you need to authenticate like http://user:passsword@example.org/generic-webhook...\n");
246+
"""
247+
Did not find any jobs with GenericTrigger configured!
248+
No token was supplied.
249+
If you are using a token, you need to pass it like ...trigger/invoke?token=TOKENHERE
250+
If you are not using a token, you need to authenticate like http://user:passsword@example.org/generic-webhook...
251+
""");
248252
}
249253

250254
@Test
251-
public void test404MessageNoToken_given() {
255+
void test404MessageNoToken_given() {
252256
final String actual = GenericWebHookRequestReceiver.construct404Message("something");
253257

254258
assertThat(actual)

0 commit comments

Comments
 (0)