如何在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：

• 可执行文件-tests-1.0。jar//由mvn包阶段构建
• executable-tests-1.0-teststjar//由jar插件构建
• cucumber试验。jar//通过shade插件构建

cucumber测试。jar包含信息。cuke依赖项，但不包含可执行测试-1.0-tests。jar。

我已经做了各种各样的事情来尝试包括测试类，但是没有任何效果，我错过了什么？

编辑：如果有人想玩它，我已经将我的示例项目推送到GitHub：）https://github.com/C0deAttack/ExecutableTests

Answer 1

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

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

Answer 2

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

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

• 测试类别

这基本上意味着添加了测试类（及其依赖项）的胖jar。Maven Jar插件及其测试Jar目标不适合这种需要。Maven Shade插件及其shadeTestJar选项也没有帮助。

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

在这种情况下，Maven Assembly插件是一个完美的候选者。

这是一个最小的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文件夹中创建一个描述符文件。包含以下内容的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>

上面的配置是：

• 设置要从测试范围中获取的外部依赖项（也将获取编译范围）
• 将文件集设置为包含已编译的测试类作为打包的fat jar的一部分
• 使用fat测试分类器设置最终jar（因此最终文件类似于sampleproject-1.0-SNAPSHOT-fat-tests.jar）

建造罐子：

mvn clean compile test-compile assembly:single

从目标文件夹运行：

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

我们将执行main（来自测试类）。main可以调用其他测试或应用程序代码（因此需要外部依赖，无论是在编译还是测试范围内），一切都可以正常工作。

从这样的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将执行测试套件，该套件将在链中执行所有配置的测试。