Skip to content

Move OverlayManagerTest to JUnit 5 #561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slawekjaranowski merged 1 commit into from
Oct 19, 2025
Merged

Move OverlayManagerTest to JUnit 5 #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,16 @@
<version>4.13.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-testing</groupId>
<artifactId>maven-plugin-testing-harness</artifactId>
Expand Down
131 changes: 55 additions & 76 deletions src/test/java/org/apache/maven/plugins/war/overlay/OverlayManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,54 +25,50 @@
import org.apache.maven.plugins.war.Overlay;
import org.apache.maven.plugins.war.stub.MavenProjectArtifactsStub;
import org.apache.maven.plugins.war.stub.WarArtifactStub;
import org.codehaus.plexus.PlexusTestCase;
import org.junit.jupiter.api.Test;

import static org.apache.maven.plugins.war.Overlay.DEFAULT_EXCLUDES;
import static org.apache.maven.plugins.war.Overlay.DEFAULT_INCLUDES;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

/**
* @author Stephane Nicoll
*/
public class OverlayManagerTest extends PlexusTestCase {
class OverlayManagerTest {

@Test
public void testEmptyProject() throws Exception {
final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final List<Overlay> overlays = new ArrayList<>();
try {
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(1, manager.getOverlays().size());
assertEquals(currentProjectOverlay, manager.getOverlays().get(0));
} catch (InvalidOverlayConfigurationException e) {
e.printStackTrace();
fail("Should not have failed to validate a valid overly config " + e.getMessage());
}
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(1, manager.getOverlays().size());
assertEquals(currentProjectOverlay, manager.getOverlays().get(0));
}

public void testAutodetectSimpleOverlay(Overlay currentProjectOverlay) throws Exception {
// TODO investigate what test should do ....
void testAutodetectSimpleOverlay(Overlay currentProjectOverlay) throws Exception {

final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final ArtifactStub first = newWarArtifact("test", "test-webapp");
project.addArtifact(first);

final List<Overlay> overlays = new ArrayList<>();

try {
final Overlay overlay = currentProjectOverlay;
OverlayManager manager = new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, overlay);
assertNotNull(manager.getOverlays());
assertEquals(2, manager.getOverlays().size());
assertEquals(overlay, manager.getOverlays().get(0));
assertEquals(new DefaultOverlay(first), manager.getOverlays().get(1));
} catch (InvalidOverlayConfigurationException e) {
e.printStackTrace();
fail("Should not have failed to validate a valid overlay config " + e.getMessage());
}
final Overlay overlay = currentProjectOverlay;
OverlayManager manager = new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, overlay);
assertNotNull(manager.getOverlays());
assertEquals(2, manager.getOverlays().size());
assertEquals(overlay, manager.getOverlays().get(0));
assertEquals(new DefaultOverlay(first), manager.getOverlays().get(1));
}

public void testSimpleOverlay() throws Exception {
@Test
void testSimpleOverlay() throws Exception {

final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final ArtifactStub first = newWarArtifact("test", "test-webapp");
Expand All @@ -81,21 +77,17 @@ public void testSimpleOverlay() throws Exception {
final List<Overlay> overlays = new ArrayList<>();
overlays.add(new DefaultOverlay(first));

try {
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(2, manager.getOverlays().size());
assertEquals(Overlay.createInstance(), manager.getOverlays().get(0));
assertEquals(overlays.get(0), manager.getOverlays().get(1));
} catch (InvalidOverlayConfigurationException e) {
e.printStackTrace();
fail("Should not have failed to validate a valid overlay config " + e.getMessage());
}
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(2, manager.getOverlays().size());
assertEquals(Overlay.createInstance(), manager.getOverlays().get(0));
assertEquals(overlays.get(0), manager.getOverlays().get(1));
}

public void testUnknownOverlay() throws Exception {
@Test
void testUnknownOverlay() throws Exception {

final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final ArtifactStub first = newWarArtifact("test", "test-webapp");
Expand All @@ -104,16 +96,14 @@ public void testUnknownOverlay() throws Exception {
final List<Overlay> overlays = new ArrayList<>();
overlays.add(new Overlay("test", "test-webapp-2"));

try {
final Overlay currentProjectOverlay = Overlay.createInstance();
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
fail("Should have failed to validate an unknown overlay");
} catch (InvalidOverlayConfigurationException e) {
// OK
}
final Overlay currentProjectOverlay = Overlay.createInstance();
assertThrows(
InvalidOverlayConfigurationException.class,
() -> new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay));
}

public void testCustomCurrentProject() throws Exception {
@Test
void testCustomCurrentProject() throws Exception {

final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final ArtifactStub first = newWarArtifact("test", "test-webapp");
Expand All @@ -126,22 +116,17 @@ public void testCustomCurrentProject() throws Exception {
final Overlay currentProjectOverlay = Overlay.createInstance();
overlays.add(currentProjectOverlay);

try {
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(3, manager.getOverlays().size());
assertEquals(overlays.get(0), manager.getOverlays().get(0));
assertEquals(currentProjectOverlay, manager.getOverlays().get(1));
assertEquals(new DefaultOverlay(second), manager.getOverlays().get(2));

} catch (InvalidOverlayConfigurationException e) {
e.printStackTrace();
fail("Should not have failed to validate a valid overlay config " + e.getMessage());
}
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(3, manager.getOverlays().size());
assertEquals(overlays.get(0), manager.getOverlays().get(0));
assertEquals(currentProjectOverlay, manager.getOverlays().get(1));
assertEquals(new DefaultOverlay(second), manager.getOverlays().get(2));
}

public void testOverlaysWithSameArtifactAndGroupId() throws Exception {
@Test
void testOverlaysWithSameArtifactAndGroupId() throws Exception {

final MavenProjectArtifactsStub project = new MavenProjectArtifactsStub();
final ArtifactStub first = newWarArtifact("test", "test-webapp");
Expand All @@ -154,24 +139,18 @@ public void testOverlaysWithSameArtifactAndGroupId() throws Exception {
overlays.add(new DefaultOverlay(first));
overlays.add(new DefaultOverlay(second));

try {
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(3, manager.getOverlays().size());
assertEquals(currentProjectOverlay, manager.getOverlays().get(0));
assertEquals(overlays.get(0), manager.getOverlays().get(1));
assertEquals(overlays.get(1), manager.getOverlays().get(2));

} catch (InvalidOverlayConfigurationException e) {
e.printStackTrace();
fail("Should not have failed to validate a valid overlay config " + e.getMessage());
}
final Overlay currentProjectOverlay = Overlay.createInstance();
OverlayManager manager =
new OverlayManager(overlays, project, DEFAULT_INCLUDES, DEFAULT_EXCLUDES, currentProjectOverlay);
assertNotNull(manager.getOverlays());
assertEquals(3, manager.getOverlays().size());
assertEquals(currentProjectOverlay, manager.getOverlays().get(0));
assertEquals(overlays.get(0), manager.getOverlays().get(1));
assertEquals(overlays.get(1), manager.getOverlays().get(2));
}

protected ArtifactStub newWarArtifact(String groupId, String artifactId, String classifier) {
final WarArtifactStub a = new WarArtifactStub(getBasedir());
final WarArtifactStub a = new WarArtifactStub("");
a.setGroupId(groupId);
a.setArtifactId(artifactId);
if (classifier != null) {
Expand Down