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

我正在尝试使用Maven将我的测试类打包到具有依赖项的可执行jar中,但我正在努力做到这一点。

到目前为止,这是我.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>

当我执行构建时,会创建3个jar:mvn clean package

  • 可执行测试-1.0.jar // 由 mvn 包阶段构建
  • 可执行-测试-1.0-teststjar // 由 jar-plugin 构建
  • cucumber-tests.jar // 由 shade-plugin 构建

Cucumber-tests.jar包含依赖项,但不包含 .info.cukeexecutable-tests-1.0-tests.jar

我已经做了各种各样的事情来尝试并包含测试类,但没有任何效果,我错过了什么?

编辑:我已经将我的示例项目推送到GitHub,如果有人喜欢使用它:)https://github.com/C0deAttack/ExecutableTests


答案 1

回答较晚,但得到了一个可行的解决方案,这可能有助于这个问题的未来访问者。

我成功地只使用一个Maven插件就有了一个胖罐,包括:

  • 测试类
  • 应用程序代码类
  • 应用程序代码所需的外部依赖项(在作用域中)compile
  • 测试代码所需的外部依赖项(在作用域内)test

这基本上意味着一个胖罐,添加了测试类(及其依赖项)。Maven Jar插件及其测试jar目标不适合这种需求。Maven Shade Plugin及其shadeTestJar选项也无济于事。

那么,如何在Maven中创建一个带有测试类和外部依赖项的胖罐?

在这种情况下,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\assemblyassembly.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>

上面的配置是:

  • 设置要从作用域中获取的外部依赖项(这也将占用作用域)testcompile
  • 将 a 设置为将已编译的测试类作为打包胖罐的一部分fileset
  • 使用分类器设置最终的 jar(因此您的最终文件将类似于 )。fat-testssampleproject-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可以调用其他测试或应用程序代码(因此需要外部依赖项,在两者或范围内),一切都可以正常工作。compiletest


从这样的主,您还可以调用所有测试用例,如下所示:

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


答案 2

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

首先,我使用 来获取依赖项并在本地解压缩它们,然后使用 创建并包含解压缩依赖项中的类。maven-dependency-pluginmaven-jar-plugintest-jar


推荐