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

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

このコミットは、Go言語のランタイムにおけるガベージコレクション（GC）関連のテスト TestGcSys の挙動を修正するものです。具体的には、環境変数 GOGC が "off" に設定されている場合に、テストを失敗させるのではなく、スキップするように変更しています。これにより、GCが無効な環境でのテスト実行時の不必要な失敗を防ぎ、テストの堅牢性を向上させています。

コミット

  • コミットハッシュ: 59ae9d9ac9234b07c9940fa617ca09a4f43d352c
  • 作者: Albert Strasheim fullung@gmail.com
  • コミット日時: 2013年3月30日 土曜日 15:10:53 -0700

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

https://github.com/golang/go/commit/59ae9d9ac9234b07c9940fa617ca09a4f43d352c

元コミット内容

runtime: TestGcSys: if GOGC=off, skip instead of failing

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/8201043

変更の背景

Go言語のランタイムには、ガベージコレクション（GC）の動作を制御するための GOGC という環境変数があります。この変数を "off" に設定すると、GCが無効になります。TestGcSys はシステムレベルのGC動作をテストするためのものであり、GCが完全に無効になっている環境では、そのテストが意図した結果を生成できない、あるいはテスト自体が意味をなさなくなる可能性があります。

元の実装では、GOGC=off の場合に t.Fatalf を呼び出してテストを強制的に失敗させていました。しかし、これはGCを無効にしてGoプログラムを実行したいユーザーにとっては、テストスイート全体が不必要に失敗する原因となり、CI/CDパイプラインなどでの運用上の問題を引き起こす可能性がありました。

このコミットの目的は、このような状況下でテストが不必要に失敗するのを防ぎ、より適切なテストの挙動を提供することです。GCがテストの前提条件である場合、その前提条件が満たされない環境ではテストをスキップするのが、テストフレームワークにおける一般的なプラクティスです。これにより、テストの実行環境に柔軟性を持たせつつ、テスト結果の信頼性を維持することができます。

前提知識の解説

Go言語のガベージコレクション (GC)

Go言語は、自動メモリ管理のためにガベージコレクタを内蔵しています。開発者が手動でメモリを解放する必要がなく、メモリリークのリスクを低減します。GoのGCは、並行マーク＆スイープ方式を採用しており、プログラムの実行と並行してGCが動作することで、アプリケーションの一時停止（Stop-the-World）時間を最小限に抑えるように設計されています。

GOGC 環境変数

GOGC はGoランタイムのガベージコレクタの動作を制御する環境変数です。

  • GOGC のデフォルト値は 100 です。これは、前回のGC後にヒープサイズが100%増加した場合に次のGCがトリガーされることを意味します。
  • GOGC=off または GOGC=0 に設定すると、ガベージコレクションが無効になります。これは、非常に特殊なケースやデバッグ目的で使用されることがほとんどで、通常の本番環境では推奨されません。GCが無効になると、プログラムはメモリを解放せず、最終的にメモリ不足に陥る可能性があります。

Goのテストフレームワーク (testing パッケージ)

Go言語には、標準ライブラリとして testing パッケージが提供されており、ユニットテストやベンチマークテストを記述するための機能を提供します。

  • *testing.T: テスト関数に渡される型で、テストの実行状態を制御したり、結果を報告したりするためのメソッドを提供します。
  • t.Fatalf(format string, args ...interface{}): テストを失敗としてマークし、メッセージを出力して、現在のテスト関数を即座に終了させます。この関数が呼び出されると、テストは失敗と見なされます。
  • t.Skip(format string, args ...interface{}): テストをスキップとしてマークし、メッセージを出力して、現在のテスト関数を即座に終了させます。この関数が呼び出されても、テストは失敗とは見なされず、単に実行されなかったものとして扱われます。これは、特定の環境条件が満たされない場合にテストを実行しないようにする際に便利です。

技術的詳細

この変更は、Goのテストスイートにおける TestGcSys の堅牢性を高めるためのものです。TestGcSys は、Goランタイムのガベージコレクションシステムが正しく機能するかどうかを検証することを目的としています。しかし、GOGC=off が設定されている環境では、ガベージコレクション自体が無効になっているため、このテストが期待通りに動作することは不可能です。

元のコードでは、GOGC=off の場合に t.Fatalf を使用していました。これは、テストの前提条件が満たされない場合に、そのテストを「失敗」として扱うことを意味します。しかし、GCが無効な環境でGCのテストが失敗するのは当然のことであり、これはコードのバグを示すものではありません。むしろ、テストがその環境では実行できないことを示しています。

t.Skip への変更は、この状況をより適切に処理します。t.Skip を使用することで、テストは「失敗」ではなく「スキップ」として報告されます。これにより、CI/CDシステムや開発者がテスト結果を解釈する際に、GCが無効な環境でのテスト失敗が、実際のコードのバグによるものではないことを明確に区別できるようになります。これは、テストスイート全体の健全性を保ち、誤ったアラートを減らす上で重要です。

この変更は、Goのテストプラクティスにおけるベストプラクティスに沿ったものです。テストが特定の環境設定や外部依存関係に依存する場合、それらが満たされない場合はテストをスキップすることが推奨されます。これにより、テストの実行がより柔軟になり、様々な環境でのGoプログラムのテストが可能になります。

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

--- a/src/pkg/runtime/gc_test.go
+++ b/src/pkg/runtime/gc_test.go
@@ -13,7 +13,7 @@ import (

 func TestGcSys(t *testing.T) {
 	if os.Getenv("GOGC") == "off" {
-		t.Fatalf("GOGC=off in environment; test cannot pass")
+		t.Skip("skipping test; GOGC=off in environment")
 	}
 	data := struct{ Short bool }{testing.Short()}
 	got := executeTest(t, testGCSysSource, &data)

コアとなるコードの解説

変更は src/pkg/runtime/gc_test.go ファイル内の TestGcSys 関数にあります。

元のコード:

	if os.Getenv("GOGC") == "off" {
		t.Fatalf("GOGC=off in environment; test cannot pass")
	}

このコードは、環境変数 GOGC の値が "off" であるかどうかをチェックしています。もし "off" であれば、t.Fatalf を呼び出し、"GOGC=off in environment; test cannot pass" というメッセージを出力してテストを失敗させ、テスト関数を終了していました。

変更後のコード:

	if os.Getenv("GOGC") == "off" {
		t.Skip("skipping test; GOGC=off in environment")
	}

変更後も同様に GOGC 環境変数の値をチェックしますが、"off" であった場合には t.Skip を呼び出すように変更されています。これにより、"skipping test; GOGC=off in environment" というメッセージを出力してテストをスキップし、テスト関数を終了します。テストは失敗とは見なされず、単に実行されなかったものとして扱われます。

この一文字の変更（Fatalf から Skip へ）は、テストの振る舞いに大きな影響を与え、GCが無効な環境でのテスト結果の解釈をより正確にするものです。

関連リンク

参考にした情報源リンク