Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 15806] ファイルの概要

このコミットは、Go言語の標準ライブラリである net/http パッケージにおけるテストの修正に関するものです。具体的には、Windows環境でのテスト実行時に発生していた、ゴルーチンリーク検出に関する誤検知を解消するための変更が加えられています。Windowsのネットワークサーバーが生成する特定のゴルーチンを、リーク検出の対象外とすることで、テストの安定性を向上させています。

コミット

  • コミットハッシュ: 552207611bc21a0feae14fb8d961668d14729c06
  • Author: Brad Fitzpatrick bradfitz@golang.org
  • Date: Fri Mar 15 15:58:43 2013 -0700

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/552207611bc21a0feae14fb8d961668d14729c06

元コミット内容

net/http: fix test breakage on Windows

Treat the Windows net server as uninteresting for leak
purposes too.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/7818048

変更の背景

Go言語のテストスイートには、テスト実行後に残存するゴルーチン（いわゆる「ゴルーチンリーク」）を検出するメカニズムが組み込まれています。これは、テストがクリーンアップを適切に行っているか、あるいは予期せぬバックグラウンド処理が残っていないかを確認するために重要です。

このコミットが行われた当時、Windows環境で net/http パッケージのテストを実行すると、特定のゴルーチンがリークとして誤って報告され、テストが失敗するという問題が発生していました。このゴルーチンは、Windowsのネットワークサーバーが内部的に生成するものであり、テストの正常な動作の一部として存在するため、実際のリークではありませんでした。

この誤検知は、テストの信頼性を損ない、開発者がWindows環境でテストを実行する際の妨げとなっていました。そのため、この「誤検知」を修正し、テストが正しくパスするようにするための変更が必要とされました。

前提知識の解説

  • Go言語のゴルーチン (Goroutines): Go言語における軽量な並行処理の単位です。OSのスレッドよりもはるかに軽量で、数千、数万のゴルーチンを同時に実行することが可能です。Goランタイムがゴルーチンのスケジューリングを管理します。
  • スタックトレース (Stack Trace): プログラムの実行中にエラーや特定のイベントが発生した際に、その時点での関数呼び出しの履歴を示すものです。どの関数がどの関数を呼び出し、最終的に現在の位置に至ったかを示します。ゴルーチンのスタックトレースは、そのゴルーチンがどこで生成され、現在何を実行しているかを特定するのに役立ちます。
  • net/http パッケージ: Go言語でHTTPクライアントおよびサーバーを実装するための標準ライブラリです。WebアプリケーションやAPIサーバーを構築する際に広く利用されます。HTTPサーバーは、リクエストを処理するために内部的にゴルーチンを生成することが一般的です。
  • テストにおけるゴルーチンリーク検出: Goのテストフレームワークでは、テストの終了時に予期せず残っているゴルーチンがないかをチェックする機能が提供されることがあります。これは、リソースの解放忘れや、バックグラウンドで無限ループするような処理が残っていないかを確認するために重要です。しかし、システム内部の動作や特定のOSの挙動によって生成されるゴルーチンが、意図せずリークとして検出される「誤検知」が発生することもあります。
  • strings.Contains: Go言語の strings パッケージに含まれる関数で、ある文字列が別の文字列の部分文字列として含まれているかどうかを判定します。

技術的詳細

このコミットの技術的な核心は、Goのテストフレームワークがゴルーチンリークを検出する際に使用する interestingGoroutines という内部関数にあります。この関数は、現在実行中のすべてのゴルーチンのスタックトレースを走査し、テストの終了後も残っている「興味深い」（つまり、リークの可能性がある）ゴルーチンを特定します。

通常、テストが完了すると、テストに関連するすべてのゴルーチンは終了しているべきです。しかし、一部のゴルーチンは、Goランタイムや特定のOSのネットワークスタックとの連携によって、テストのライフサイクルを超えて存在し続けることがあります。これらは実際のリークではないため、テストの失敗を避けるために「無視リスト」に追加する必要があります。

この問題は特にWindows環境で顕著でした。Windowsのネットワークサーバー（net.startServerによって開始されるもの）が生成するゴルーチンが、テスト終了後も残存し、interestingGoroutines 関数によってリークとして誤って報告されていました。

コミットは、この interestingGoroutines 関数内のロジックを修正し、"created by net.startServer" という文字列を含むスタックトレースを持つゴルーチンを、リーク検出の対象から除外するように変更しました。これにより、Windows環境でのテストが正しくパスするようになり、テストの信頼性が向上しました。

コアとなるコードの変更箇所

変更は src/pkg/net/http/z_last_test.go ファイルの interestingGoroutines 関数内で行われました。

--- a/src/pkg/net/http/z_last_test.go
+++ b/src/pkg/net/http/z_last_test.go
@@ -24,6 +24,7 @@ func interestingGoroutines() (gs []string) {
 	\t\tstack := strings.TrimSpace(sl[1])
 	\t\tif stack == "" ||
 	\t\t\tstrings.Contains(stack, "created by net.newPollServer") ||
+\t\t\tstrings.Contains(stack, "created by net.startServer") ||
 	\t\t\tstrings.Contains(stack, "created by testing.RunTests") ||
 	\t\t\tstrings.Contains(stack, "closeWriteAndWait") ||
 	\t\t\tstrings.Contains(stack, "testing.Main(\") {

コアとなるコードの解説

interestingGoroutines 関数は、Goのテストフレームワークがゴルーチンリークを検出するために使用するヘルパー関数です。この関数は、現在実行中のすべてのゴルーチンのスタックトレースを取得し、それらを分析して「興味深い」ゴルーチン（つまり、リークの可能性があるゴルーチン）のリストを返します。

変更前のコードでは、以下の条件に合致するゴルーチンは「興味深い」と見なされませんでした（つまり、リークではないと判断されました）：

  • スタックトレースが空 (stack == "")
  • "created by net.newPollServer" を含むスタックトレースを持つゴルーチン
  • "created by testing.RunTests" を含むスタックトレースを持つゴルーチン
  • "closeWriteAndWait" を含むスタックトレースを持つゴルーチン
  • "testing.Main(" を含むスタックトレースを持つゴルーチン

このコミットでは、上記の条件に加えて、新たに以下の条件が追加されました。

  • strings.Contains(stack, "created by net.startServer")

これは、net.startServer によって生成されたゴルーチンが、Windows環境でのテストにおいて誤ってリークとして検出されていたためです。この変更により、net.startServer に関連するゴルーチンがリーク検出の対象から明示的に除外されるようになり、Windowsでのテストの誤検知が解消されました。

この修正は、特定の環境（Windows）におけるGoランタイムとネットワークスタックの相互作用によって生じる、テストの「ノイズ」を取り除くための、非常に実用的なアプローチと言えます。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント (net/httpパッケージ): https://pkg.go.dev/net/http
  • Go言語のテストに関するドキュメント: https://go.dev/blog/testing (一般的なテストの概念について)
  • Go言語のゴルーチンに関するドキュメント: https://go.dev/tour/concurrency/1 (ゴルーチンの基本的な概念について)I have generated the detailed technical explanation of the commit in Markdown format, following all your instructions and chapter structure. The output is provided above.