logo标签列表

如何在由maven-shade-plugin创建的Jar中包含测试类？

javamavendependenciesmaven-shade-pluginmaven-jar-plugin
34

我正在尝试使用Maven将我的测试类及其依赖打包成可执行的jar文件，但我在实现这个过程时遇到了困难。

这是我目前的pom.xml文件:

<project>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.c0deattack</groupId>
    <artifactId>executable-tests</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>

    <name>executable-tests</name>

    <dependencies>
        <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-java</artifactId>
            <version>1.0.0</version>
        </dependency>
        <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-junit</artifactId>
            <version>1.0.0</version>
        </dependency>

        <dependency>
            <groupId>org.seleniumhq.selenium</groupId>
            <artifactId>selenium-java</artifactId>
            <version>2.21.0</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.4</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>test-jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>1.6</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <finalName>cucumber-tests</finalName>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>cucumber.cli.Main</mainClass>
                                </transformer>
                            </transformers>
                            <artifactSet>
                                <includes>
                                    <include>info.cukes:*</include>
                                </includes>
                            </artifactSet>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>com.c0deattack</groupId>
                        <artifactId>executable-tests</artifactId>
                        <version>1.0</version>
                        <type>test-jar</type>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>
执行mvn clean package命令时，会生成3个jar包：
  • executable-tests-1.0.jar //由mvn package阶段构建
  • executable-tests-1.0-teststjar //由jar-plugin构建
  • cucumber-tests.jar //由shade-plugin构建
Cucumber-tests.jar包含info.cuke依赖项，但不包含executable-tests-1.0-tests.jar。
我尝试了各种方法来包括测试类，但都没有成功，我错过了什么？ 编辑：我已将示例项目提交到GitHub，如果有人想玩玩 :)https://github.com/C0deAttack/ExecutableTests
你尝试过明确指定分类器吗：<include>com.c0deattack:executable-tests:jar:tests</include>。 - user944849
嗨，是的，我也尝试过那个。甚至尝试使用<include>的通配符支持，但那也不起作用。真的很困惑！ - C0deAttack
如果你执行 mvn clean install 然后再执行 mvn clean package，它能正常工作吗？我在想它是否需要测试 jar 包在本地仓库里？ - user944849
这是一个重复的问题，与https://dev59.com/XW435IYBdhLWcg3w50f4相同。 - Steve K
2个回答
27

虽然回答晚了，但我有一个可行的解决方案，可以帮助未来访问这个问题的用户。

我成功地使用了一个Maven插件，并包含以下内容：

  • 测试类
  • 应用程序代码类
  • 应用程序代码所需的外部依赖项（在compile范围内）
  • 测试代码所需的外部依赖项（在test范围内）

这基本上意味着一个带有测试类（及其依赖项）的fat jar。Maven Jar Plugin及其test-jar目标不能满足这个需求。Maven Shade Plugin及其shadeTestJar选项也无法帮助。

那么，在Maven中如何创建一个带有测试类和外部依赖项的fat jar呢？

Maven Assembly Plugin在这种情况下是一个完美的选择。

这里是一个最小的POM示例：

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.sample</groupId>
    <artifactId>sample-project</artifactId>
    <version>1.0-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <descriptor>src/main/assembly/assembly.xml</descriptor>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <archive>
                                <manifest>
                                    <mainClass>com.sample.TestMain</mainClass>
                                </manifest>
                            </archive>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

上面的配置还设置了一个在测试类中定义的主类（为了快速检查它是否起作用，见下面答案）。但这还不够。
你还需要在 src\main\assembly 文件夹中创建一个描述符文件，并创建一个名为assembly.xml 的文件，其内容如下：
<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
    <id>fat-tests</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>test</scope>
        </dependencySet>
    </dependencySets>
    <fileSets>
        <fileSet>
            <directory>${project.build.directory}/test-classes</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>**/*.class</include>
            </includes>
            <useDefaultExcludes>true</useDefaultExcludes>
        </fileSet>
    </fileSets>
</assembly>

上述配置包括：
  • 将外部依赖设置为从“test”范围获取（也将获取“compile”范围）
  • 设置一个fileset，将编译的测试类作为打包的fat jar的一部分包含在内
  • 设置一个带有fat-tests分类器的最终jar文件（因此您的最终文件将类似于sampleproject-1.0-SNAPSHOT-fat-tests.jar）。

我们该如何测试它？

构建jar：

mvn clean compile test-compile assembly:single

从 target 文件夹运行：

java -jar sampleproject-1.0-SNAPSHOT-fat-tests.jar

我们需要执行主要的测试类中的主函数。主函数可能会调用其他测试或应用程序代码（因此需要在compile或test范围内具有外部依赖项），一切都将正常工作。

从这样一个主函数，你也可以像以下这样调用所有的测试用例：

  • 创建一个JUnit测试套件
  • 将相关测试添加到测试套件中
  • 从你的纯Java主函数中调用测试套件

测试套件的示例：

import org.junit.runner.RunWith;
import org.junit.runners.Suite;
import org.junit.runners.Suite.SuiteClasses;

@RunWith(Suite.class)
@SuiteClasses({ AppTest.class })
public class AllTests {

}

注意：在这种情况下，测试套件仅涉及AppTest示例测试。
然后，您可以拥有一个主类，如下所示：
import org.junit.internal.TextListener;
import org.junit.runner.JUnitCore;

public class MainAppTest {

    public static void main(String[] args) {
        System.out.println("Running tests!");

        JUnitCore engine = new JUnitCore();
        engine.addListener(new TextListener(System.out)); // required to print reports
        engine.run(AllTests.class);
    }
}

主函数将执行测试套件，该套件将依次执行所有已配置的测试。
另外，不需要包含主方法。您可以启动org.junit.runner.JUnitCore并指定任何或所有测试方法和类。 - Aleksandr Dubinsky
@AleksandrDubinsky 和 A_Di-Matteo：非常感谢你们的回答。它帮助了我，也节省了很多时间 :) - Dreams
@A_Di-Matteo和AleksandrDubinsky - 谢谢你们。它运行得很好！ - Binita Bharati
4
我用另外两个插件解决了我的问题。首先，我使用maven-dependency-plugin获取依赖并将其本地解压缩，然后我使用maven-jar-plugin创建一个test-jar并包含从解压的依赖项中提取的类。
1
我也遇到了同样的问题。你能否分享一下你的POM文件或者这两个依赖项的代码？ - Prashant Vaidyanathan
4
请查看我在Github仓库中的示例项目，链接在原问题上方。 - C0deAttack
11
这个回答质量较差。您能否选择@A_Di-Matteo的回答？或者至少写一个带有代码的完整回答。 - Aleksandr Dubinsky
我们能用 maven-shade 来做这件事吗？ - Arjun Sunil Kumar
使用 maven shade，如果我们将类放在 main 文件夹中，一切都会很顺利。 - Arjun Sunil Kumar
显示剩余4条评论
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接