TL;DR
testing/synctestは、bubble と呼ばれる環境の中で偽の時計を使い、非同期処理のテストを実時間を待たずに確実に実行する。- bubble 内のすべてのゴルーチンが durably blocked になると時刻が進む。
Waitで非同期処理が落ち着くのを待ってから検証する。
内容
導入の経緯
非同期処理のテストは難しい。time.Sleep で待つとテストに時間がかかり、待ち時間が足りないと Flaky test になりやすい。この問題を解決するために Go 1.24 で導入された testing/synctest パッケージが、Go 1.25 で標準パッケージになった。
Test 関数
処理を待つ時間は無駄なので、短くしたい。これを実現するのが synctest.Test 関数である。Test は、渡された関数を bubble の中で実行し、bubble 内のすべてのゴルーチンが終了するまで待つ。すべてのゴルーチンが durably blocked で、進める先の時刻もなければ、デッドロックとみなして panic を起こす。
bubble 内の時刻は偽の時計（fake clock）で、UTC の 2000-01-01 から始まる。bubble 内のすべてのゴルーチンが durably blocked になると、bubble 内の時刻が進む。 time.Sleep やチャネルの送受信は、ゴルーチンを durably blocked にする。sync.Mutex での待ちは durably blocked にならない。bubble 内で作ったチャネルを bubble の外から操作すると panic になる。
Wait 関数
非同期処理の完了を確かめてから検証するには、synctest.Wait を使う。Wait は、現在の bubble 内で、呼び出したゴルーチン以外のすべてのゴルーチンが durably blocked になるまでブロックする。ゴルーチンの終了を待つわけではない点に注意する。bubble の外から呼んだり、同じ bubble 内の 2 つのゴルーチンから同時に呼んだりすると panic になる。
Go 1.24 からの変更点
RunがTestになり、引数で*testing.Tを受け取れるようになった。- bubble のルートゴルーチンが終了したら、時刻の進行を止めるようになった。
- スタックトレースが改善された。
キーワード
自分の理解
bubble と durably blocked が、synctest を理解するうえで重要な概念だと思った。