Skip to content

Commit b268910

Browse files
slachiewiczTeamModerne
slachiewicz
and
TeamModerne
authored
JUnit Jupiter best practices (#1548)
Co-authored-by: Moderne <team@moderne.io>
1 parent 7be4ef7 commit b268910

File tree

8 files changed

+62
-74
lines changed

8 files changed

+62
-74
lines changed

‎src/test/java/org/apache/maven/plugins/dependency/analyze/TestAnalyzeDepMgt.java‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
package org.apache.maven.plugins.dependency.analyze;
2020

2121
import java.io.File;
22-
import java.io.IOException;
2322
import java.util.ArrayList;
2423
import java.util.HashMap;
2524
import java.util.List;
@@ -31,7 +30,6 @@
3130
import org.apache.maven.model.DependencyManagement;
3231
import org.apache.maven.model.Exclusion;
3332
import org.apache.maven.plugin.MojoExecutionException;
34-
import org.apache.maven.plugin.MojoFailureException;
3533
import org.apache.maven.plugins.dependency.testUtils.DependencyArtifactStubFactory;
3634
import org.apache.maven.plugins.dependency.testUtils.stubs.DependencyProjectStub;
3735
import org.apache.maven.project.MavenProject;
@@ -44,7 +42,7 @@
4442
import static org.junit.Assert.assertTrue;
4543
import static org.junit.Assert.fail;
4644

47-
public class TestAnalyzeDepMgt {
45+
class TestAnalyzeDepMgt {
4846

4947
AnalyzeDepMgt mojo;
5048

@@ -57,7 +55,7 @@ public class TestAnalyzeDepMgt {
5755
DependencyManagement depMgt;
5856

5957
@BeforeEach
60-
public void setUp() throws Exception {
58+
void setUp() throws Exception {
6159

6260
MavenProject project = new DependencyProjectStub();
6361
mojo = new AnalyzeDepMgt(project);
@@ -92,7 +90,7 @@ public void setUp() throws Exception {
9290
}
9391

9492
@Test
95-
public void testGetManagementKey() throws IOException {
93+
void getManagementKey() throws Exception {
9694
Dependency dep = new Dependency();
9795
dep.setArtifactId("artifact");
9896
dep.setClassifier("class");
@@ -152,7 +150,7 @@ public void testGetManagementKey() throws IOException {
152150
}
153151

154152
@Test
155-
public void testAddExclusions() {
153+
void addExclusions() {
156154

157155
assertEquals(0, mojo.addExclusions(null).size());
158156

@@ -166,7 +164,7 @@ public void testAddExclusions() {
166164
}
167165

168166
@Test
169-
public void testGetExclusionErrors() {
167+
void getExclusionErrors() {
170168
List<Exclusion> list = new ArrayList<>();
171169
list.add(ex);
172170

@@ -181,7 +179,7 @@ public void testGetExclusionErrors() {
181179
}
182180

183181
@Test
184-
public void testGetMismatch() throws IOException {
182+
void getMismatch() throws Exception {
185183
Map<String, Dependency> depMgtMap = new HashMap<>();
186184

187185
depMgtMap.put(exclusion.getManagementKey(), exclusion);
@@ -196,7 +194,7 @@ public void testGetMismatch() throws IOException {
196194
}
197195

198196
@Test
199-
public void testMojo() throws IOException, MojoExecutionException, MojoFailureException {
197+
void mojo() throws Exception {
200198
mojo.setIgnoreDirect(false);
201199
// test with nothing in depMgt
202200
mojo.execute();

‎src/test/java/org/apache/maven/plugins/dependency/utils/TestDependencyUtil.java‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
package org.apache.maven.plugins.dependency.utils;
2020

2121
import java.io.File;
22-
import java.io.IOException;
2322

2423
import org.apache.maven.artifact.Artifact;
2524
import org.apache.maven.artifact.DefaultArtifact;
@@ -75,7 +74,7 @@ protected void setUp() {
7574
}
7675

7776
@Test
78-
void testDirectoryName() {
77+
void directoryName() {
7978
File folder = new File("target/a");
8079
final Artifact artifact = release;
8180
File name =
@@ -148,7 +147,7 @@ void testDirectoryName() {
148147
}
149148

150149
@Test
151-
void testDirectoryName2() {
150+
void directoryName2() {
152151
File folder = new File("target/a");
153152
final Artifact artifact = snap;
154153
File name =
@@ -201,7 +200,7 @@ void testDirectoryName2() {
201200
}
202201

203202
@Test
204-
void testDirectoryNameSources() {
203+
void directoryNameSources() {
205204
File folder = new File("target/a");
206205
File name = DependencyUtil.getFormattedOutputDirectory(false, false, true, false, true, false, folder, sources);
207206
String expectedResult = folder.getAbsolutePath() + File.separatorChar + "two-sources";
@@ -221,7 +220,7 @@ void testDirectoryNameSources() {
221220
}
222221

223222
@Test
224-
void testFileName() {
223+
void fileName() {
225224
Artifact artifact = release;
226225

227226
String name = DependencyUtil.getFormattedFileName(artifact, false);
@@ -233,7 +232,7 @@ void testFileName() {
233232
}
234233

235234
@Test
236-
void testFileNameUseBaseVersion() {
235+
void fileNameUseBaseVersion() {
237236
Artifact artifact = snapResolvedVersion;
238237

239238
String name = DependencyUtil.getFormattedFileName(artifact, false, false, true);
@@ -245,7 +244,7 @@ void testFileNameUseBaseVersion() {
245244
}
246245

247246
@Test
248-
void testTestJar() {
247+
void testJar() {
249248
ArtifactHandler ah = new DefaultArtifactHandlerStub("test-jar", null);
250249
VersionRange vr = VersionRange.createFromVersion("1.1-SNAPSHOT");
251250
Artifact artifact =
@@ -257,7 +256,7 @@ void testTestJar() {
257256
}
258257

259258
@Test
260-
void testFileNameClassifier() {
259+
void fileNameClassifier() {
261260
ArtifactHandler ah = new DefaultArtifactHandlerStub("jar", "sources");
262261
VersionRange vr = VersionRange.createFromVersion("1.1-SNAPSHOT");
263262
Artifact artifact =
@@ -283,7 +282,7 @@ void testFileNameClassifier() {
283282
}
284283

285284
@Test
286-
void testFileNameClassifierWithFile() {
285+
void fileNameClassifierWithFile() {
287286
// specifically testing the default operation that getFormattedFileName
288287
// returns
289288
// the actual name of the file if available unless remove version is
@@ -321,7 +320,7 @@ void testFileNameClassifierWithFile() {
321320
}
322321

323322
@Test
324-
void outputFileShouldBeOverridden() throws IOException {
323+
void outputFileShouldBeOverridden() throws Exception {
325324
File file = new File(temDir, "file1.out");
326325
assertThat(file).doesNotExist();
327326

@@ -333,7 +332,7 @@ void outputFileShouldBeOverridden() throws IOException {
333332
}
334333

335334
@Test
336-
void outputFileShouldBeAppended() throws IOException {
335+
void outputFileShouldBeAppended() throws Exception {
337336
File file = new File(temDir, "file2.out");
338337
assertThat(file).doesNotExist();
339338

‎src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestDestFileFilter.java‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
import java.util.Set;
2525

2626
import org.apache.maven.artifact.Artifact;
27-
import org.apache.maven.plugin.MojoExecutionException;
2827
import org.apache.maven.plugins.dependency.testUtils.DependencyArtifactStubFactory;
2928
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
30-
import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
3129
import org.junit.jupiter.api.BeforeEach;
3230
import org.junit.jupiter.api.Test;
3331
import org.junit.jupiter.api.io.TempDir;
@@ -86,7 +84,7 @@ public File createFile(
8684
}
8785

8886
@Test
89-
public void testDestFileRelease() throws IOException, ArtifactFilterException {
87+
void destFileRelease() throws Exception {
9088
DestFileFilter filter = new DestFileFilter(outputFolder);
9189
Artifact artifact = fact.getReleaseArtifact();
9290

@@ -99,7 +97,7 @@ public void testDestFileRelease() throws IOException, ArtifactFilterException {
9997
}
10098

10199
@Test
102-
public void testDestFileSnapshot() throws IOException, ArtifactFilterException {
100+
void destFileSnapshot() throws Exception {
103101
DestFileFilter filter = new DestFileFilter(outputFolder);
104102
Artifact artifact = fact.getSnapshotArtifact();
105103

@@ -112,7 +110,7 @@ public void testDestFileSnapshot() throws IOException, ArtifactFilterException {
112110
}
113111

114112
@Test
115-
public void testDestFileStripVersion() throws IOException, ArtifactFilterException {
113+
void destFileStripVersion() throws Exception {
116114
DestFileFilter filter = new DestFileFilter(outputFolder);
117115
Artifact artifact = fact.getSnapshotArtifact();
118116
filter.setRemoveVersion(true);
@@ -126,7 +124,7 @@ public void testDestFileStripVersion() throws IOException, ArtifactFilterExcepti
126124
}
127125

128126
@Test
129-
public void testDestFileStripClassifier() throws IOException, ArtifactFilterException {
127+
void destFileStripClassifier() throws Exception {
130128
DestFileFilter filter = new DestFileFilter(outputFolder);
131129
Artifact artifact = fact.getSnapshotArtifact();
132130
filter.setRemoveClassifier(true);
@@ -140,7 +138,7 @@ public void testDestFileStripClassifier() throws IOException, ArtifactFilterExce
140138
}
141139

142140
@Test
143-
public void testDestFileSubPerArtifact() throws IOException, ArtifactFilterException {
141+
void destFileSubPerArtifact() throws Exception {
144142
DestFileFilter filter = new DestFileFilter(outputFolder);
145143
Artifact artifact = fact.getSnapshotArtifact();
146144
filter.setUseSubDirectoryPerArtifact(true);
@@ -154,7 +152,7 @@ public void testDestFileSubPerArtifact() throws IOException, ArtifactFilterExcep
154152
}
155153

156154
@Test
157-
public void testDestFileSubPerType() throws MojoExecutionException, IOException, ArtifactFilterException {
155+
void destFileSubPerType() throws Exception {
158156
DestFileFilter filter = new DestFileFilter(outputFolder);
159157
Artifact artifact = fact.getSnapshotArtifact();
160158
filter.setUseSubDirectoryPerType(true);
@@ -168,7 +166,7 @@ public void testDestFileSubPerType() throws MojoExecutionException, IOException,
168166
}
169167

170168
@Test
171-
public void testDestFileOverwriteIfNewer() throws MojoExecutionException, IOException, ArtifactFilterException {
169+
void destFileOverwriteIfNewer() throws Exception {
172170
DestFileFilter filter = new DestFileFilter(outputFolder);
173171

174172
fact.setCreateFiles(true);
@@ -194,7 +192,7 @@ public void testDestFileOverwriteIfNewer() throws MojoExecutionException, IOExce
194192
}
195193

196194
@Test
197-
public void testGettersSetters() {
195+
void gettersSetters() {
198196
DestFileFilter filter = new DestFileFilter(null);
199197
assertNull(filter.getOutputFileDirectory());
200198
filter.setOutputFileDirectory(outputFolder);

‎src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestMarkerFileFilter.java‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,12 @@
1919
package org.apache.maven.plugins.dependency.utils.filters;
2020

2121
import java.io.File;
22-
import java.io.IOException;
2322
import java.util.HashSet;
2423
import java.util.Set;
2524

2625
import org.apache.maven.artifact.Artifact;
27-
import org.apache.maven.plugin.MojoExecutionException;
2826
import org.apache.maven.plugins.dependency.testUtils.DependencyArtifactStubFactory;
2927
import org.apache.maven.plugins.dependency.utils.markers.DefaultFileMarkerHandler;
30-
import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
3128
import org.junit.jupiter.api.BeforeEach;
3229
import org.junit.jupiter.api.Test;
3330
import org.junit.jupiter.api.io.TempDir;
@@ -39,7 +36,7 @@
3936
/**
4037
* @author brianf
4138
*/
42-
public class TestMarkerFileFilter {
39+
class TestMarkerFileFilter {
4340
Set<Artifact> artifacts = new HashSet<>();
4441

4542
@TempDir
@@ -54,7 +51,7 @@ protected void setUp() throws Exception {
5451
}
5552

5653
@Test
57-
public void testMarkerFile() throws ArtifactFilterException {
54+
void markerFile() throws Exception {
5855
MarkerFileFilter filter = new MarkerFileFilter(true, true, false, new DefaultFileMarkerHandler(outputFolder));
5956
Set<Artifact> result = filter.filter(artifacts);
6057
assertEquals(2, result.size());
@@ -66,7 +63,7 @@ public void testMarkerFile() throws ArtifactFilterException {
6663
}
6764

6865
@Test
69-
public void testMarkerSnapshots() throws ArtifactFilterException, MojoExecutionException, IOException {
66+
void markerSnapshots() throws Exception {
7067
DefaultFileMarkerHandler handler = new DefaultFileMarkerHandler(fact.getSnapshotArtifact(), outputFolder);
7168
handler.setMarker();
7269

@@ -81,7 +78,7 @@ public void testMarkerSnapshots() throws ArtifactFilterException, MojoExecutionE
8178
}
8279

8380
@Test
84-
public void testMarkerRelease() throws IOException, ArtifactFilterException, MojoExecutionException {
81+
void markerRelease() throws Exception {
8582
DefaultFileMarkerHandler handler = new DefaultFileMarkerHandler(fact.getReleaseArtifact(), outputFolder);
8683
handler.setMarker();
8784

@@ -97,7 +94,7 @@ public void testMarkerRelease() throws IOException, ArtifactFilterException, Moj
9794
}
9895

9996
@Test
100-
public void testMarkerTimestamp() throws IOException, MojoExecutionException, ArtifactFilterException {
97+
void markerTimestamp() throws Exception {
10198
// filter includes release artifact because no marker present
10299
// filter includes snapshot artifact because it is newer than marker
103100
DependencyArtifactStubFactory fileFact = new DependencyArtifactStubFactory(outputFolder, true);
@@ -131,7 +128,7 @@ public void testMarkerTimestamp() throws IOException, MojoExecutionException, Ar
131128
}
132129

133130
@Test
134-
public void testGettersSetters() {
131+
void gettersSetters() {
135132
MarkerFileFilter filter = new MarkerFileFilter(true, false, true, new DefaultFileMarkerHandler(outputFolder));
136133
assertTrue(filter.isOverWriteReleases());
137134
assertFalse(filter.isOverWriteSnapshots());

‎src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestResolveMarkerFileFilter.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,8 @@
2222
import java.io.IOException;
2323

2424
import org.apache.maven.artifact.Artifact;
25-
import org.apache.maven.plugin.MojoExecutionException;
2625
import org.apache.maven.plugins.dependency.testUtils.DependencyArtifactStubFactory;
2726
import org.apache.maven.plugins.dependency.utils.markers.SourcesFileMarkerHandler;
28-
import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
2927
import org.junit.jupiter.api.BeforeEach;
3028
import org.junit.jupiter.api.Test;
3129
import org.junit.jupiter.api.io.TempDir;
@@ -36,7 +34,7 @@
3634
/**
3735
* @author brianf
3836
*/
39-
public class TestResolveMarkerFileFilter {
37+
class TestResolveMarkerFileFilter {
4038

4139
@TempDir
4240
File outputFolder;
@@ -50,7 +48,7 @@ protected void setUp() throws IOException {
5048
}
5149

5250
@Test
53-
public void testResolveFile() throws IOException, ArtifactFilterException, MojoExecutionException {
51+
void resolveFile() throws Exception {
5452
SourcesFileMarkerHandler handler = new SourcesFileMarkerHandler(outputFolder);
5553

5654
Artifact artifact = fact.getReleaseArtifact();

0 commit comments

Comments
 (0)