Go で os.exit(1) する関数をユニットテストする

Go にはまだ深く入れ込んでいないが、いちいち迂遠なことを強いられている気がする。

要約

• os.exit(1) するような関数は、別プロセスで対応するテスト関数を動かす
• プロセスから返ってきた終了ステータスをチェックして、os.exit(1) していたら OK とする

詳細

やりたかったこと

この世には os.Exit(1) するような関数が存在する。それが Go の流儀に沿っているかはわからないが、とにかく存在する。ここでは以下のような関数があると仮定する。

func ExitWithZero() {
	os.Exit(0)
}

func ExitWithOne() {
	os.Exit(1)
}

これら２つに対するテストコードは、最も素朴な形では以下の通りになる。
ただ、TestExitWithZero はパスするが TestExitWithOne はパスしない。何故ならば ExitWithOne() は終了ステータスとして 1 を返す（= 異常終了する）からである。

func TestExitWithZero(t *testing.T) {
	ExitWithZero()
}

func TestExitWithOne(t *testing.T) {
	ExitWithOne()
}

解決策

os.exit(1) するテストを別プロセスで実行してやる。別プロセスで os.Exit(1) する分にはメインのテストの失敗扱いにはならないので、これを上手いことラッピングしてやることでテストを設計できる。具体的には以下の通りになる。

1. 環境変数（今回は FLAG_BE_CRASHED ）が設定されている場合は、テスト対象関数を動かして return させる
2. テスト本体ではテスト関数を環境変数付きでの別プロセスで動かす
3. 別プロセスから返ってきた終了ステータスが 1 であればテスト成功とする

サンプルコードは以下の通り。

func TestExitWithOne2(t *testing.T) {
	if os.Getenv("FLAG_BE_CRASHED") == "1" {
		ExitWithOne()
		return
	}

	cmd := exec.Command(os.Args[0], "-test.run=TestExitWithOne2")
	cmd.Env = append(os.Environ(), "FLAG_BE_CRASHED=1")

	err := cmd.Run()
	var e *exec.ExitError
	if errors.As(err, &e) && !e.Success() {
		return
	}

	log.Fatalf(err.Error())
}

うわぁ、複雑！

終わりに

調べが悪いだけかもしれないが、同じような回避方法は他の人も実践してるっぽい（資料1, 資料2）ので、そこそこ妥当な手法ではあるようだ。

ちなみに Python だと今回と同じことは以下のコードで済んでしまう。例外を捕捉することにはなるが、プロセスを生やすみたいな曲芸はしないので Go の場合よりだいぶ見通しが良いように思える。

import sys

def exit_with_one():
    sys.exit(1)

def test_exit_with_one():
    try:
        exit_with_one()
    except SystemExit as e:
        assert e.code == 1

もし Go でも Python と同じぐらいの分量かつ明瞭さでテストを書けるって場合はコメントで具体的なパターンを教えてほしい。