Skip to content

Migration to JUnit 5 #1558

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
merged 1 commit into from
Nov 22, 2025
Merged

Migration to JUnit 5 #1558

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
251 changes: 143 additions & 108 deletions src/test/java/org/apache/maven/plugins/dependency/TestSkip.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,165 +18,200 @@
*/
package org.apache.maven.plugins.dependency;

import java.io.File;
import javax.inject.Inject;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.api.di.Provides;
import org.apache.maven.api.plugin.testing.InjectMojo;
import org.apache.maven.api.plugin.testing.MojoParameter;
import org.apache.maven.api.plugin.testing.MojoTest;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.Mojo;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.descriptor.MojoDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.dependency.testUtils.stubs.DependencyProjectStub;
import org.apache.maven.project.MavenProject;
import org.mockito.ArgumentCaptor;

import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.mock;
import org.apache.maven.plugins.dependency.analyze.AnalyzeDepMgt;
import org.apache.maven.plugins.dependency.analyze.AnalyzeDuplicateMojo;
import org.apache.maven.plugins.dependency.analyze.AnalyzeMojo;
import org.apache.maven.plugins.dependency.analyze.AnalyzeOnlyMojo;
import org.apache.maven.plugins.dependency.analyze.AnalyzeReport;
import org.apache.maven.plugins.dependency.fromConfiguration.CopyMojo;
import org.apache.maven.plugins.dependency.fromConfiguration.UnpackMojo;
import org.apache.maven.plugins.dependency.fromDependencies.BuildClasspathMojo;
import org.apache.maven.plugins.dependency.fromDependencies.CopyDependenciesMojo;
import org.apache.maven.plugins.dependency.fromDependencies.UnpackDependenciesMojo;
import org.apache.maven.plugins.dependency.resolvers.GoOfflineMojo;
import org.apache.maven.plugins.dependency.resolvers.ListMojo;
import org.apache.maven.plugins.dependency.resolvers.OldResolveDependencySourcesMojo;
import org.apache.maven.plugins.dependency.resolvers.ResolveDependenciesMojo;
import org.apache.maven.plugins.dependency.resolvers.ResolvePluginsMojo;
import org.apache.maven.plugins.dependency.tree.TreeMojo;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.mockito.ArgumentMatchers.contains;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class TestSkip extends AbstractDependencyMojoTestCase {

@Override
protected void setUp() throws Exception {
super.setUp();
MavenProject project = new DependencyProjectStub();
getContainer().addComponent(project, MavenProject.class.getName());
@ExtendWith(MockitoExtension.class)
@MojoTest
class TestSkip {

MavenSession session = newMavenSession(project);
getContainer().addComponent(session, MavenSession.class.getName());
}

public void testSkipAnalyze() throws Exception {
doTest("analyze");
}
@Inject
private MojoExecution mojoExecution;

public void testSkipAnalyzeDepMgt() throws Exception {
doTest("analyze-dep-mgt");
}
@Mock
private Log log;

public void testSkipAnalyzeOnly() throws Exception {
doTest("analyze-only");
@Provides
private Log logProvides() {
return log;
}

public void testSkipAnalyzeReport() throws Exception {
doSpecialTest("analyze-report", true);
@Test
@InjectMojo(goal = "analyze")
@MojoParameter(name = "skip", value = "true")
void testSkipAnalyze(AnalyzeMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipAnalyzeDuplicate() throws Exception {
doTest("analyze-duplicate");
@Test
@InjectMojo(goal = "analyze-dep-mgt")
@MojoParameter(name = "skip", value = "true")
void testSkipAnalyzeDepMgt(AnalyzeDepMgt mojo) throws Exception {
doTest(mojo);
}

public void testSkipBuildClasspath() throws Exception {
doTest("build-classpath");
@Test
@InjectMojo(goal = "analyze-only")
@MojoParameter(name = "skip", value = "true")
void testSkipAnalyzeOnly(AnalyzeOnlyMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipCopy() throws Exception {
doTest("copy");
}
@Test
@InjectMojo(goal = "analyze-report")
@MojoParameter(name = "skip", value = "true")
void testSkipAnalyzeReport(AnalyzeReport mojo) throws Exception {
Plugin plugin = new Plugin();
plugin.setArtifactId("maven-dependency-plugin");
plugin.setVersion("1.0.0");
when(mojoExecution.getPlugin()).thenReturn(plugin);
when(mojoExecution.getGoal()).thenReturn("analyze-report");

public void testSkipCopyDependencies() throws Exception {
doTest("copy-dependencies");
mojo.execute();
verify(log)
.info(contains(
"Skipping org.apache.maven.plugins:maven-dependency-plugin:1.0.0:analyze-report report goal"));
}

public void testSkipGet() throws Exception {
doSpecialTest("get");
@Test
@InjectMojo(goal = "analyze-duplicate")
@MojoParameter(name = "skip", value = "true")
void testSkipAnalyzeDuplicate(AnalyzeDuplicateMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipGoOffline() throws Exception {
doTest("go-offline");
@Test
@InjectMojo(goal = "build-classpath")
@MojoParameter(name = "skip", value = "true")
void testSkipBuildClasspath(BuildClasspathMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipList() throws Exception {
doTest("list");
@Test
@InjectMojo(goal = "copy")
@MojoParameter(name = "skip", value = "true")
void testSkipCopy(CopyMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipProperties() throws Exception {
doTest("properties");
@Test
@InjectMojo(goal = "copy-dependencies")
@MojoParameter(name = "skip", value = "true")
void testSkipCopyDependencies(CopyDependenciesMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipPurgeLocalRepository() throws Exception {
doSpecialTest("purge-local-repository");
@Test
@InjectMojo(goal = "get")
@MojoParameter(name = "skip", value = "true")
void testSkipGet(GetMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipResolve() throws Exception {
doTest("resolve");
@Test
@InjectMojo(goal = "go-offline")
@MojoParameter(name = "skip", value = "true")
void testSkipGoOffline(GoOfflineMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipResolvePlugins() throws Exception {
doTest("resolve-plugins");
@Test
@InjectMojo(goal = "list")
@MojoParameter(name = "skip", value = "true")
void testSkipList(ListMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipSources() throws Exception {
doTest("sources");
@Test
@InjectMojo(goal = "properties")
@MojoParameter(name = "skip", value = "true")
void testSkipProperties(PropertiesMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipTree() throws Exception {
doTest("tree");
@Test
@InjectMojo(goal = "purge-local-repository")
@MojoParameter(name = "skip", value = "true")
void testSkipPurgeLocalRepository(PurgeLocalRepositoryMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipUnpack() throws Exception {
doTest("unpack");
@Test
@InjectMojo(goal = "resolve")
@MojoParameter(name = "skip", value = "true")
void testSkipResolve(ResolveDependenciesMojo mojo) throws Exception {
doTest(mojo);
}

public void testSkipUnpackDependencies() throws Exception {
doTest("unpack-dependencies");
@Test
@InjectMojo(goal = "resolve-plugins")
@MojoParameter(name = "skip", value = "true")
void testSkipResolvePlugins(ResolvePluginsMojo mojo) throws Exception {
doTest(mojo);
}

protected void doTest(String mojoName) throws Exception {
doConfigTest(mojoName, "plugin-config.xml");
@Test
@InjectMojo(goal = "sources")
@MojoParameter(name = "skip", value = "true")
void testSkipSources(OldResolveDependencySourcesMojo mojo) throws Exception {
doTest(mojo);
}

protected void doSpecialTest(String mojoName) throws Exception {
doConfigTest(mojoName, "plugin-" + mojoName + "-config.xml", false);
@Test
@InjectMojo(goal = "tree")
@MojoParameter(name = "skip", value = "true")
void testSkipTree(TreeMojo mojo) throws Exception {
doTest(mojo);
}

protected void doSpecialTest(String mojoName, boolean addMojoExecution) throws Exception {
doConfigTest(mojoName, "plugin-" + mojoName + "-config.xml", addMojoExecution);
@Test
@InjectMojo(goal = "unpack")
@MojoParameter(name = "skip", value = "true")
void testSkipUnpack(UnpackMojo mojo) throws Exception {
doTest(mojo);
}

private void doConfigTest(String mojoName, String configFile) throws Exception {
doConfigTest(mojoName, configFile, false);
@Test
@InjectMojo(goal = "unpack-dependencies")
@MojoParameter(name = "skip", value = "true")
void testSkipUnpackDependencies(UnpackDependenciesMojo mojo) throws Exception {
doTest(mojo);
}

private void doConfigTest(String mojoName, String configFile, boolean addMojoExecution) throws Exception {
File testPom = new File(getBasedir(), "target/test-classes/unit/skip-test/" + configFile);
Mojo mojo = lookupMojo(mojoName, testPom);
assertNotNull("Mojo not found.", mojo);

if (addMojoExecution) {
setVariableValueToObject(mojo, "mojoExecution", getMockMojoExecution(mojoName));
}
Log log = mock(Log.class);
mojo.setLog(log);
private void doTest(Mojo mojo) throws Exception {
mojo.execute();

ArgumentCaptor<String> captor = ArgumentCaptor.forClass(String.class);
verify(log, atLeastOnce()).info(captor.capture());
String skipMessage;
if (addMojoExecution) {
MojoExecution me = getMockMojoExecution(mojoName);
String reportMojoInfo = me.getPlugin().getId() + ":" + me.getGoal();
skipMessage = "Skipping " + reportMojoInfo + " report goal";
} else {
skipMessage = "Skipping plugin execution";
}
assertTrue(captor.getValue().contains(skipMessage));
}

private MojoExecution getMockMojoExecution(String goal) {
MojoDescriptor md = new MojoDescriptor();
md.setGoal(goal);

MojoExecution me = new MojoExecution(md);

PluginDescriptor pd = new PluginDescriptor();
Plugin p = new Plugin();
p.setGroupId("org.apache.maven.plugins");
p.setArtifactId("maven-dependency-plugin");
pd.setPlugin(p);
md.setPluginDescriptor(pd);

return me;
verify(log).info(contains("Skipping plugin"));
}
}
20 changes: 10 additions & 10 deletions src/test/java/org/apache/maven/plugins/dependency/exclusion/ExclusionCheckerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@
import java.util.HashSet;
import java.util.Set;

import org.junit.Before;
import org.junit.Test;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.apache.maven.plugins.dependency.exclusion.Coordinates.coordinates;
import static org.assertj.core.api.Assertions.assertThat;

public class ExclusionCheckerTest {
class ExclusionCheckerTest {

private ExclusionChecker checker;

@Before
public void setUp() throws Exception {
@BeforeEach
void setUp() throws Exception {
checker = new ExclusionChecker();
}

@Test
public void shallReportInvalidExclusions() {
void shallReportInvalidExclusions() {
Coordinates artifact = coordinates("com.current", "artifact");
Set<Coordinates> excludes = new HashSet<>(Arrays.asList(
coordinates("com.example", "one"),
Expand All @@ -59,21 +59,21 @@ public void shallReportInvalidExclusions() {
}

@Test
public void noViolationsWhenEmptyExclusions() {
void noViolationsWhenEmptyExclusions() {
checker.check(coordinates("a", "b"), new HashSet<>(), new HashSet<>());
assertThat(checker.getViolations()).isEmpty();
}

@Test
public void shallReportInvalidExclusionsWhenNoDependencies() {
void shallReportInvalidExclusionsWhenNoDependencies() {
Coordinates artifact = coordinates("a", "b");
HashSet<Coordinates> actualDependencies = new HashSet<>();
checker.check(artifact, new HashSet<>(Collections.singletonList(coordinates("p", "m"))), actualDependencies);
assertThat(checker.getViolations()).containsEntry(artifact, Collections.singletonList(coordinates("p", "m")));
}

@Test
public void shallHandleWildcardExclusions() {
void shallHandleWildcardExclusions() {
Coordinates artifact = coordinates("com.current", "artifact");
Set<Coordinates> excludes = new HashSet<>(Collections.singletonList(coordinates("*", "*")));

Expand All @@ -86,7 +86,7 @@ public void shallHandleWildcardExclusions() {
}

@Test
public void shallHandleWildcardGroupIdExclusion() {
void shallHandleWildcardGroupIdExclusion() {
Coordinates artifact = coordinates("com.current", "artifact");
Set<Coordinates> excludes = new HashSet<>(Collections.singletonList(coordinates("javax", "*")));

Expand Down
Loading