如何将测试类包含到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如何打包一个包含测试类的胖jar并执行测试？

Answer 1

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

但是，在这个额外的工件（jar）中，您需要：

• 测试类别

这基本上意味着添加了测试类（及其依赖项）的胖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）

然后，您可以按以下方式调用main（从目标文件夹）：

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

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

• 创建一个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);
    }
}

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