erg/doc/JA/tools/test.md

testサブコマンド

ergコマンドにはtestというサブコマンドがあり、テスト実装、及び実行の支援を行う。

Testデコレータ(@Test)

Ergではパッケージ中のtestsディレクトリか*.test.erファイル中の@Testを付けたサブルーチンをerg testコマンドでテストする。 testsのサブルーチンはブラックボックステスト、*.test.erのサブルーチンはホワイトボックステストを担当する。

# tests/test1.er
{add; ...} = import "foo"

@Test
test_1_plus_n(n: Nat) =
    assert add(1, n) == n + 1

実行結果がサマリとして表示され、各種ファイル形式(.md, .csv, etc.)で出力もできる。

Doc Test

Ergでは#, #[でコメント行となるが、##, #[[でdoc commentとなり、VSCodeなどエディタからコメントをmd表示できる。 さらにdoc comment中のソースコードはergと指定されていれば、erg testコマンドで自動テストされる。 以下はテストの例である。

VM = ...
    ...
    #[[
    execute commands.
    ```erg
    # VM in standard configuration
    {vm1; ...} = import "tests/template"

    assert vm1.exec!("i = 0") == None
    assert vm1.exec!("i").try_into(Int)? == 0
    ```
    ]]#
    .exec! ref self, src =
        ...
    ...

テストを行う際に使う典型的なオブジェクトはtests/templateモジュールに定義する。