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

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

このコミットは、Go言語のビルドシステムにおいて、特にWindows環境でのビルドスクリプト（all.bat）が、ビルドの完了ステータスを正しく報告できるようにするための変更です。具体的には、ビルドダッシュボード（builder）がall.batの終了コードを適切に解釈できるよう、GOBUILDEXITという環境変数を導入し、all.batの終了処理を条件付きにしています。

コミット

commit 0bc6836e81223a82653c44a4a6023e762a1e51cc
Author: Russ Cox <rsc@golang.org>
Date:   Fri Feb 10 01:27:59 2012 -0500

    builder: set $GOBUILDEXIT for Windows
    
    Actually %GOBUILDEXIT% I suppose.
    
    R=golang-dev
    CC=golang-dev
    https://golang.org/cl/5651058

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

https://github.com/golang/go/commit/0bc6836e81223a82653c44a4a6023e762a1e51cc

元コミット内容

builder: set $GOBUILDEXIT for Windows

Actually %GOBUILDEXIT% I suppose.

R=golang-dev
CC=golang-dev
https://golang.org/cl/5651058

変更の背景

Go言語のプロジェクトでは、継続的インテグレーション（CI）システムやビルドダッシュボードが、様々なプラットフォームでのビルドの健全性を監視しています。Windows環境では、all.batというバッチスクリプトが主要なビルドプロセスを担っています。

このコミットが行われた2012年当時、Goのビルドシステムはまだ発展途上にあり、特にクロスプラットフォーム対応において細かな調整が必要でした。問題は、Windowsのバッチスクリプトであるall.batが、ビルドの成功または失敗を示す終了コードを、ビルドダッシュボードが期待する形で常に適切に返していなかった可能性です。あるいは、特定のシナリオでall.batがすぐに終了せず、ビルドダッシュボードがビルドの完了を判断できない、または誤ったステータスを受け取るという問題があったと考えられます。

このコミットは、GOBUILDEXITという新しい環境変数を導入することで、all.batの終了動作を明示的に制御し、ビルドダッシュボードがWindowsビルドの完了ステータスを正確に把握できるようにすることを目的としています。これにより、Windows環境でのビルドの信頼性と、ダッシュボードによる監視の正確性が向上します。

前提知識の解説

このコミットを理解するためには、以下の前提知識が役立ちます。

  • Go言語のビルドシステム: Goプロジェクトは、go buildコマンドだけでなく、より複雑なビルドプロセスを自動化するために、内部的にシェルスクリプトやバッチスクリプトを使用することがあります。all.batは、Windows環境におけるGoのソースコード全体のビルド、テスト、ツールのインストールなどを行うための主要なバッチスクリプトです。
  • Windowsバッチスクリプト (.bat):
    • 環境変数: %VARIABLE_NAME%の形式で環境変数を参照します。set VARIABLE_NAME=valueで設定します。
    • 終了コード: プログラムやスクリプトは、実行終了時にオペレーティングシステムに「終了コード」（Exit Code）を返します。通常、0は成功、0以外はエラーを示します。バッチスクリプトではexit %ERRORLEVEL%やexit /b %ERRORLEVEL%などで終了コードを返します。
    • 条件分岐: if文を使用して条件に応じた処理を行います。if %VAR%==VALUEのように変数の値を比較します。x%VAR%==xVALUEのようなxプレフィックスは、変数が未定義の場合に構文エラーになるのを防ぐための一般的なテクニックです（例: if x==x1はxが空の場合でも有効な比較となる）。
  • 継続的インテグレーション (CI) とビルドダッシュボード:
    • CIシステムは、コードの変更がリポジトリにプッシュされるたびに、自動的にビルドとテストを実行する仕組みです。
    • ビルドダッシュボードは、CIシステムからのビルド結果（成功、失敗、実行時間など）を集約し、視覚的に表示するウェブインターフェースです。ビルドの健全性を一目で確認できます。
    • これらのシステムは、実行されたスクリプトやプログラムの終了コードを監視し、その結果に基づいてビルドステータスを判断します。
  • Gerrit (golang.org/cl/): Goプロジェクトでは、コードレビューにGerritというツールが使われています。https://golang.org/cl/5651058のようなリンクは、Gerrit上の特定のチェンジリスト（変更のセット）を指します。
  • コードレビューの慣習 (R=, CC=): コミットメッセージに含まれるR=はレビュー担当者（Reviewer）、CC=はカーボンコピー（Carbon Copy）の略で、コードレビュープロセスにおける関係者を示します。

技術的詳細

このコミットは、Goのビルドシステムにおける2つの主要なコンポーネントに影響を与えます。

  1. ビルドダッシュボードのビルダー (misc/dashboard/builder/main.go):

    • このGoプログラムは、Goのビルドダッシュボードの一部であり、様々な環境でGoのビルドを実行する役割を担っています。
    • ビルドを実行する際に、子プロセス（この場合はall.bat）に渡す環境変数を設定します。
    • 変更点では、Windows環境でのビルドのために、GOBUILDEXIT=1という環境変数を明示的に設定しています。この1という値は、all.batに対して「ビルド完了時に終了ステータスを返すように」という指示として機能します。

  2. Windowsビルドスクリプト (src/all.bat):

    • このバッチスクリプトは、Goのソースツリーのルートにあるsrcディレクトリに配置されており、Windows環境でのGoのビルド、テスト、および関連ツールのコンパイルを行います。
    • スクリプトの末尾には、ビルドの成否を示す%GOBUILDFAIL%という変数（0が成功、1が失敗）を使って終了コードを返すexit %GOBUILDFAIL%という行がありました。
    • 変更後、この行はif x%GOBUILDEXIT%==x1 exit %GOBUILDFAIL%に修正されました。これにより、GOBUILDEXIT環境変数が1に設定されている場合にのみ、all.batが%GOBUILDFAIL%の値を終了コードとして返して終了するようになります。GOBUILDEXITが設定されていない、または1以外の値の場合、all.batは終了コードを返さずに継続するか、あるいは別の終了パスをたどる可能性があります。

このメカニズムにより、ビルドダッシュボードのビルダーは、Windowsビルドの実行時にGOBUILDEXIT=1を設定することで、all.batが確実に終了ステータスを返し、そのステータスをダッシュボードが正確に解釈できるようになります。これは、ビルドの自動化と監視の信頼性を高める上で重要な調整です。

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

このコミットによるコードの変更は以下の2ファイルです。

  1. misc/dashboard/builder/main.go

    --- a/misc/dashboard/builder/main.go
+++ b/misc/dashboard/builder/main.go
@@ -478,6 +478,7 @@ func (b *Builder) envv() []string {
 		"GOOS=" + b.goos,
 		"GOARCH=" + b.goarch,
 		"GOROOT_FINAL=/usr/local/go",
+		"GOBUILDEXIT=1", // On Windows, exit all.bat with completion status.
 	}
 	for _, k := range extraEnv {
 		s, err := os.Getenverror(k)

  2. src/all.bat

    --- a/src/all.bat
+++ b/src/all.bat
@@ -16,4 +16,4 @@ if %GOBUILDFAIL%==1 goto end
 ..\bin\tool\dist banner
 
 :end
-exit %GOBUILDFAIL%
+if x%GOBUILDEXIT%==x1 exit %GOBUILDFAIL%

コアとなるコードの解説

  • misc/dashboard/builder/main.go の変更:

    • func (b *Builder) envv() []string は、ビルドを実行する際に子プロセスに渡す環境変数のリストを生成するメソッドです。
    • このメソッド内で、"GOBUILDEXIT=1" という文字列が環境変数リストに追加されています。
    • コメント // On Windows, exit all.bat with completion status. が示唆するように、この環境変数はWindows環境でのall.batの動作を制御するために導入されました。GOBUILDEXITが1に設定されることで、all.batがビルドの完了ステータスを返して終了することが期待されます。

  • src/all.bat の変更:

    • 元のコード exit %GOBUILDFAIL% は、%GOBUILDFAIL%（ビルドの成否を示す変数）の値を終了コードとして、スクリプトを無条件に終了させていました。
    • 変更後のコード if x%GOBUILDEXIT%==x1 exit %GOBUILDFAIL% は、GOBUILDEXIT環境変数の値が1である場合にのみ、%GOBUILDFAIL%の値を終了コードとしてスクリプトを終了させるように条件を追加しています。
    • x%GOBUILDEXIT%==x1 のように、変数名の前にxを付けるのは、バッチスクリプトで環境変数が未定義の場合に比較が失敗するのを防ぐための一般的なテクニックです。これにより、GOBUILDEXITが設定されていない場合でも、x==x1という比較になり、エラーを回避できます。
    • この変更により、all.batの終了動作がGOBUILDEXIT変数の存在と値に依存するようになり、ビルドダッシュボードからの制御が可能になりました。

これらの変更は連携して機能し、ビルドダッシュボードがWindowsビルドの終了ステータスをより確実に取得できるようにします。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント (当時のビルドシステムに関する情報)
  • Windowsバッチスクリプトに関する一般的な情報
  • 継続的インテグレーションおよびビルドダッシュボードの概念に関する一般的な情報
  • コミットメッセージとコード差分そのもの