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

Question

我正在尝试使用 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包阶段构建
• 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

Answer 1

我以不同的方式解决了我的问题；使用另外两个插件。

首先我使用maven-dependency-plugin 获取依赖项并在本地解包它们，然后我使用maven-jar-plugin 创建一个test-jar 并包含解包后的依赖项中的类。

Answer 2

回答晚了，但得到了一个可行的解决方案，可以帮助这个问题的未来访问者。

我只使用一个 Maven 插件就成功地拥有了一个胖 jar，其中包括：

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

这基本上意味着添加了测试类（及其依赖项）的胖 jar。 Maven Jar Plugin 及其 test-jar 目标不适合这种需要。 Maven Shade Plugin 及其 shadeTestJar 选项也无济于事。

那么，如何在 Maven 中创建一个包含测试类和外部依赖项的胖 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>

上面的配置还设置了一个在测试类中定义的主类（为了快速检查它是否有效，请按答案）。但这还不够。

您还需要创建一个descriptor file，在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

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

---

您还可以从这样的 main 中调用所有测试用例，如下所示：

• 创建 JUni 测试套件
• 将相关测试添加到测试套件中
• 从纯 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);
    }
}

然后上面的 main 将执行测试套件，该套件将链式执行所有配置的测试。