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

How can I include test classes into Maven jar and execute them?

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

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

在测试类中访问源码类没有问题, 但我想 运行 在主要方法中测试 运行ner 并访问 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并执行测试?

您不应从您的应用程序代码访问测试 classes,而是在测试范围内创建一个主程序(同一个主程序)并为您的项目创建一个额外的工件。

但是,在这个额外的工件(jar)中,您需要:

  • 测试classes
  • 申请代码classes
  • 应用程序代码所需的外部依赖项(在 compile 范围内)
  • 测试代码需要的外部依赖(在test范围内)

这基本上意味着添加了测试 classes(及其依赖项)的 fat jar。 Maven Jar Plugin and its test-jar goal would not suit this need. The Maven Shade Plugin and its shadeTestJar 选项也无济于事。

那么,如何在 Maven 中创建一个带有测试 classes 和外部依赖项的 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>

上面的配置设置了您在测试classes 中定义的主要class。但这还不够。

您还需要创建一个 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 以包含已编译的测试 classes 作为打包的 fat jar 的一部分
  • 使用 fat-tests classifier 设置最终 jar(因此你的最终文件将类似于 sampleproject-1.0-SNAPSHOT-fat-tests.jar)。

然后您可以如下调用主程序(从 target 文件夹):

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

从这样的 main 中,您还可以按如下方式调用所有测试用例:

  • 创建 JUnit 测试套件
  • 将相关测试添加到测试套件
  • 从普通 Java main
  • 调用测试套件

测试套件示例:

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 样本测试。

然后你可以有一个主要的 class 如下:

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 将执行测试套件,该测试套件将链式执行所有配置的测试。