如何将测试类包含到 Maven jar 中并执行它们？

Question

在一个 Maven 项目中，我在同一个包中拥有测试类和源类，但位于不同的物理位置。

.../src/main/java/package/** <-- application code
.../src/test/java/package/** <-- test code

在测试类中访问源类是没问题的， 但我想在 main 方法中运行一个测试运行程序并访问 AllTest.class 以便我可以创建 jar 并执行我的测试。

 public static void main(String[] args) {
    // AllTest not found
    Result result = JUnitCore.runClasses(AllTest.class);
    for (Failure failure : result.getFailures()) {
        System.out.println(failure.toString());
    }
    System.out.println(result.wasSuccessful());
}

但它不起作用，因为我无权访问测试代码。我不明白，因为它们在同一个包中。

问题：如何从应用程序类中访问测试类？或者，Maven如何打包一个包含测试类的fat jar并执行测试？

Answer 1

您不应从应用程序代码中访问测试类，而应在测试范围内创建一个 main（相同的 main）并为您的项目创建一个额外的工件。

但是，在这个额外的工件 (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）。

然后您可以按以下方式调用 main（来自 target 文件夹）：

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

---

您还可以从这样的 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 将执行测试套件，该套件将链式执行所有配置的测试。