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

2 回答

• 16

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

  我成功使用了一个只使用一个Maven插件的胖 jar ，包括：

  • 测试类

  • 应用程序代码类

  • 应用程序代码所需的外部依赖项（在 compile 范围内）

  • 测试代码所需的外部依赖项（在 test 范围内）

  这基本上意味着增加了测试类（及其依赖项）的胖 jar . Maven Jar Plugin及其test-jar目标不适合这种需要 . Maven Shade Plugin及其shadeTestJar选项也无济于事 .

  So, how to create in Maven a fat jar with test classes and external dependencies?

  在这种情况下，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>
  

  上面的配置还设置了在测试类中定义的主类（用于快速检查它是否有效，在答案上） . 但这还不够 .

  您还需要在 src\main\assembly 文件夹中创建descriptor file 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 以包含已编译的测试类作为打包的胖jar的一部分

  • 使用 fat-tests 分类器设置最终jar（因此您的最终文件将类似于 sampleproject-1.0-SNAPSHOT-fat-tests.jar ） .

  我们如何测试它？

  Build jar：

  mvn clean compile test-compile assembly:single
  

  从 target 文件夹运行：

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

  我们将执行main（来自测试类） . main可能会调用其他测试或应用程序代码（因此需要外部依赖项，在 compile 或 test 范围内），一切都可以正常工作 .

  ---

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

  • 创建一个JUni测试套件

  • 将相关测试添加到测试套件中

  • 从普通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 样本测试 .

  然后你可以有一个主类如下：

  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);
      }
  }
  

  然后，上面的主要部分将执行测试套件，该套件将链执行所有已配置的测试 .

  回复于 2024-05-14T12:12:56+08:00
• 4

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

  首先，我使用 maven-dependency-plugin 获取依赖项并在本地解压缩，然后使用 maven-jar-plugin 创建 test-jar 并包含解压缩依赖项中的类 .

  回复于 2024-05-14T12:12:56+08:00