如何模拟maven插件环境和/或项目配置

Question

我想为我的maven-plugin编写单元测试(junit4).我找到的所有例子都使用"AbstractMojoTestCase"(junit3 :-().为了摆脱这个我得到了答案.但问题是Mojos 如何实例化:

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

这意味着我需要为每个测试用例提供一个pom - pom是测试输入数据.但有没有办法模拟(我会使用Mockito)项目模型如何？可能lookupMojo(String groupId, String artifactId, String version, String goal, PlexusConfiguration pluginConfiguration)是一个很好的起点？在这种情况下,我会模拟"PlexusConfiguration",但有什么方法？一些maven-plugin测试doku使用类似"MavenProjectStub"的类.但我无法得到关于如何创建魔法以及它在创作中谈论的界面的一致画面.

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

@inject
MyMojo testObject;

并只是模拟它需要的所有东西让它工作(主要我需要@Parameters)

Answer 1

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

对于集成测试,新maven插件的maven原型已经提供了一个开箱即用的好例子,只需执行以下操作并查看它:

 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);

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