java - 如何模拟 Maven 插件环境和/或项目配置

Question

我想为我的 maven 插件编写单元测试 (junit4)。我找到的所有示例都使用“AbstractMojoTestCase”(junit3 :-()。为了摆脱这个，我得到了 answer here。但问题是 Mojos 如何实例化:

MyMojo myMojo = (MyMojo) lookupMojo( "touch", pom );

这意味着我需要为每个测试用例创建一个 pom - pom 是测试输入数据。但是有没有办法以某种方式模拟(我会使用 Mockito)项目模型？lookupMojo(String groupId, String artifactId, String version, String goal, PlexusConfiguration pluginConfiguration) 可以作为一个好的起点吗？在这种情况下，我会模拟“PlexusConfiguration”，但是什么方法呢？一些maven-plugin testing doku使用像“MavenProjectStub”这样的类。但是我无法一致地了解 mojo 是如何创建的，以及它在创建时谈论的是什么界面。

一个完美的解决方案是如果我可以

@inject
MyMojo testObject;

然后模拟让它工作所需的所有东西(主要我需要@Parameters)

Answer 1

根据我编写 Maven 插件的经验，有两个级别的插件测试:通过单元测试(使用模拟)和通过集成测试(使用 maven-invoker-plugin)。

对于集成测试，新 maven 插件的 maven 原型(prototype)已经提供了一个很好的开箱即用示例，只需执行以下命令并查看它:

 mvn archetype:generate \
  -DgroupId=sample.plugin \
  -DartifactId=hello-maven-plugin \
  -DarchetypeGroupId=org.apache.maven.archetypes \
  -DarchetypeArtifactId=maven-archetype-plugin

默认情况下，您将从配置文件中获取集成测试。一个示例 Maven 项目也将可用(在 src\it\simple-it\pom.xml 下)，它可以执行您的插件目标。我还建议通过该 pom.xml 中的附加约束来强制执行集成测试的结果。例如:您可以添加 Maven Enforcer 插件规则来检查创建的文件，如果这对您的插件有意义的话。

为了更具体地回答您关于如何为自定义 Maven 插件编写单元测试的问题，这是我正在使用的方法:

• JUnit + Mockito。
• 使用@RunWith(MockitoJUnitRunner.class) 运行测试用例
• 使用@Mock 注释模拟 Maven 特定类(MavenProject、Log、Build、DependencyNode 等)
• 在@Before 方法(通常是 setUp() 方法)中启动和链接您的模拟对象
• 测试你的插件:)

例如，您可能将以下模拟对象作为单元测试的类变量:

@Mock
private MavenProject project;
@Mock
private Log log;
@Mock
Build build;

然后，在您的@Before 方法中，您需要添加大量胶水代码，如下所示:

Mockito.when(this.project.getBuild()).thenReturn(this.build);

例如，我用来编写一些自定义的 Enforcer 插件规则，因此我需要

@Mock
private EnforcerRuleHelper helper;

在@Before 方法中:

    Mockito.when(this.helper.evaluate("${project}")).thenReturn(this.project);
    Mockito.when(this.helper.getLog()).thenReturn(this.log);
    Mockito.when(this.project.getBuild()).thenReturn(this.build);
    Mockito.when(this.helper.getComponent(DependencyGraphBuilder.class)).thenReturn(this.graphBuilder);
    Mockito.when(this.graphBuilder.buildDependencyGraph(this.project, null)).thenReturn(this.node);

因此，可以轻松地将这些模拟对象用于您的测试。例如，必须进行的第一个虚拟测试是针对空构建进行测试，如下所示(在测试自定义 Enforcer 规则下方):

@Test
public void testEmptyBuild() throws Exception {
    try {
        this.rule.execute(this.helper);
    } catch (EnforcerRuleException e) {
        Assert.fail("Rule should not fail");
    }
}

例如，如果您需要针对构建的依赖项进行测试，您最终可能会编写如下实用方法:

private static DependencyNode generateNode(String groupId, String artifactId, String version) {
    DependencyNode node = Mockito.mock(DependencyNode.class);
    Artifact artifact = Mockito.mock(Artifact.class);
    Mockito.when(node.getArtifact()).thenReturn(artifact);
    // mock artifact
    Mockito.when(artifact.getGroupId()).thenReturn(groupId);
    Mockito.when(artifact.getArtifactId()).thenReturn(artifactId);
    Mockito.when(artifact.getVersion()).thenReturn(version);

    return node;
}

为了轻松地在构建的依赖关系图中创建依赖关系，如下所示:

List<DependencyNode> nodes = new ArrayList<DependencyNode>();
nodes.add(generateNode("junit", "junit", "4.12"));

Mockito.when(node.getChildren()).thenReturn(nodes);

注意:如果您需要更多详细信息(例如依赖项的范围或分类器)，您可以改进实用方法。

如果你还需要模拟一个插件的配置，因为你需要扫描现有的插件和它们的配置，例如，你可以这样做:

List<Plugin> plugins = new ArrayList<Plugin>();
Plugin p = new Plugin(); // no need to mock it
p.setArtifactId("maven-surefire-plugin");
Xpp3Dom conf = new Xpp3Dom("configuration");
Xpp3Dom skip = new Xpp3Dom("skip");
skip.setValue("true");
conf.addChild(skip);
p.setConfiguration(conf);
plugins.add(p);

Mockito.when(this.build.getPlugins()).thenReturn(plugins);

我显然不会涵盖所有可能的情况，但我相信您对方法和用法有所了解。希望对您有所帮助。