gitでコードを取得する

git clone https://gitbox.apache.org/repos/asf/commons-io.git

タグを確認して、リリース版をチェックアウト

git tag
....
commons-io-2.6-RC2
commons-io-2.6-RC3
commons-io-2.7-RC1
commons-io-2.8.0-RC1
commons-io-2.8.0-RC2
commons-io-2.9.0-RC1
rel/commons-io-2.10.0
rel/commons-io-2.11.0
rel/commons-io-2.7
rel/commons-io-2.8.0
rel/commons-io-2.9.0

git checkout rel/commons-io-2.9.0

テストコードを見てみる

簡単そうな名前のクラスのテストがあったので見てみます。

https://javadoc.io/static/commons-io/commons-io/2.11.0/org/apache/commons/io/file/Counters.html

テストコードで見たことないアノテーションを発見しました。。

org.apache.commons.io.file.CountersTest.java

@ParameterizedTest
    @MethodSource("numberCounters")
    public void testInitialValue(final Counter counter) {
        assertCounter(0, counter, "");
    }

@ParameterizedTest
- インプットが違うだけで、結果やテスト内容が変わらないものを便利にテストする
- https://qiita.com/rhirabay/items/2631359a095e3f87b2ae
@MethodSource(“staticmethodname”)
- staticファクトリメソッドのメソッド名を渡すStream, Iterable, Iteratorのいずれかを返り値としていること
  - Stream, Iterable, Iteratorのいずれかを返り値としていること

つまりcounter引数にはnumberCountersメソッドの結果が入ってくるということです。こういった引数に関する記載は基底クラスに定義があります

static Stream<Arguments> numberCounters() {
        // @formatter:off
        return Stream.of(
          Arguments.of(Counters.longCounter()),
          Arguments.of(Counters.bigIntegerCounter()));
        // @formatter:on
    }

2種類のCounterを返しています

LongCounter
BigIntegerCounter

アサートの詳細は以下のようになっています。

static void assertCounter(final long expected, final Counter actual, final String message) {
        assertEquals(expected, actual.get(), message);
        assertEquals(Long.valueOf(expected), actual.getLong(), message);
        assertEquals(BigInteger.valueOf(expected), actual.getBigInteger(), message);
    }

今回の場合は2種類のCounterの初期値が0であることを確認しています。

実行すると成功しています

pathCounters

次にCountingPathVisitorTestクラスのtestCountFolders2FileSize2テストを見ていきます。

@ParameterizedTest
    @MethodSource("countingPathVisitors")
    public void testCountFolders2FileSize2(final CountingPathVisitor visitor) throws IOException {
        checkZeroCounts(visitor);
        assertCounts(3, 2, 2, PathUtils.visitFileTree(visitor,
                "src/test/resources/org/apache/commons/io/dirs-2-file-size-2"));
    }

引数に渡ってくるストリームCountingPathVisitorはPathVisitorを実装しているクラスです。PathVisitorはUtilクラスを通してファイルツリーなど取得できるようになっています。

visitorに特定のパスへvisitさせることで、そのパスに含まれるディレクトリやファイルの数を取得させることができます。visitorは内部でpathCounterを持っている状態です。

pathCounterは内部でCounterを持っています

private static class AbstractPathCounters implements PathCounters {

        private final Counter byteCounter;
        private final Counter directoryCounter;
        private final Counter fileCounter;

引数のストリーム

static Stream<Arguments> countingPathVisitors() {
        // @formatter:off
        return Stream.of(
          Arguments.of(CountingPathVisitor.withBigIntegerCounters()),
          Arguments.of(CountingPathVisitor.withLongCounters()));
        // @formatter:on
    }

それぞれBigIntegerCounters、LongCountersで持ちます。

public static CountingPathVisitor withBigIntegerCounters() {
        return new CountingPathVisitor(Counters.bigIntegerPathCounters());
    }

コンストラクタで先ほどのフィールドに設定しています

public CountingPathVisitor(final PathCounters pathCounter, final PathFilter fileFilter, final PathFilter dirFilter) {
        this.pathCounters = Objects.requireNonNull(pathCounter, "pathCounter");
        this.fileFilter = Objects.requireNonNull(fileFilter, "fileFilter");
        this.dirFilter = Objects.requireNonNull(dirFilter, "dirFilter");
    }

visitorに特定のパスへvisitさせた結果を検証します。

static void assertCounts(final long expectedDirCount, final long expectedFileCount, final long expectedByteCount,
        final CountingPathVisitor actualVisitor) {
        assertCounts(expectedDirCount, expectedFileCount, expectedByteCount, actualVisitor.getPathCounters());
    }

    static void assertCounts(final long expectedDirCount, final long expectedFileCount, final long expectedByteCount,
        final PathCounters actualPathCounters) {
        assertCounter(expectedDirCount, actualPathCounters.getDirectoryCounter(), "getDirectoryCounter");
        assertCounter(expectedFileCount, actualPathCounters.getFileCounter(), "getFileCounter");
        assertCounter(expectedByteCount, actualPathCounters.getByteCounter(), "getByteCounter");
    }

実際のパスも確認してみます

ディレクトリ3でファイルの数が2です。指定したディレクトリの数も含まれています。

検証コード

検証コードが1行で書かれていて見やすいです

@ParameterizedTest
    @MethodSource("countingPathVisitors")
    public void testCountFolders1FileSize0(final CountingPathVisitor visitor) throws IOException {
        checkZeroCounts(visitor);
        assertCounts(1, 1, 0, PathUtils.visitFileTree(visitor,
                "src/test/resources/org/apache/commons/io/dirs-1-file-size-0"));
    }

シンプルにテストコードを書くためにやっていること

テストの目的だけが書かれている
目的を達成する以外のコードは外に追いやる
- アノテーションを使う
- 専用のアサーションクラスを作成する

Java | apache.commons.ioのCountersテストコードを読んでみる勉強