web-dev-qa-db-ja.com

テストクラスをMaven jarに含めて実行するにはどうすればよいですか?

Mavenプロジェクトでは、同じパッケージにテストクラスとソースクラスがありますが、物理的な場所は異なります。

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

テストクラスのソースクラスにアクセスしても問題ありませんが、メインメソッドでテストランナーを実行し、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をどのようにパッケージ化し、テストを実行できますか?

24
jam

アプリケーションコードからテストクラスにアクセスするのではなく、テストスコープでメイン(同じメイン)を作成し、プロジェクトの追加のアーティファクトを作成する必要があります。

ただし、この追加のアーティファクト(jar)には次のものが必要です。

  • テストクラス
  • アプリケーションコードクラス
  • アプリケーションコードに必要な外部依存関係(compileスコープ内)
  • テストコードに必要な外部依存関係(testスコープ内)

これは基本的に、テストクラス(およびその依存関係)が追加されたファットjarを意味します。 Maven Jar Plugin およびその test-jar の目標は、このニーズに適合しません。 Maven Shade Plugin およびその shadeTestJar オプションはどちらも役に立ちません。

では、Mavenでテストクラスと外部依存関係を持つファットジャーを作成する方法は?

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フォルダーには、次の内容の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のようなものになります)。

その後、メインを次のように呼び出すことができます(targetフォルダーから):

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

このようなメインから、次のようにすべてのテストケースを呼び出すこともできます。

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

上記のメインはテストスイートを実行し、構成されたすべてのテストをチェーンで実行します。

37
A_Di-Matteo