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

このコミットは、Go言語のcmd/apiツールがCgoが無効な環境でも動作するように修正するものです。具体的には、現在のユーザー名を特定する際に、os/userパッケージがCgoに依存している場合に備え、環境変数$USER (Unix系) または %USERNAME% (Windows系) をフォールバックとして利用するように変更されています。これにより、Cgoが利用できない環境でもcmd/apiツールが正常に機能するようになります。

コミット

commit 89ebc28b587228c6ce90b78db33925e19aeba7d5
Author: Shenghou Ma <minux.ma@gmail.com>
Date:   Mon Oct 14 00:18:46 2013 -0400

    cmd/api: make it work even when cgo is disabled
    make use of $USER or %USERNAME% to determine the current user.
    Fixes #6578.
    
    R=golang-dev, bradfitz, alex.brainman
    CC=golang-dev
    https://golang.org/cl/14649043

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

https://github.com/golang/go/commit/89ebc28b587228c6ce90b78db33925e19aeba7d5

元コミット内容

cmd/api: make it work even when cgo is disabled make use of $USER or %USERNAME% to determine the current user. Fixes #6578.

変更の背景

この変更の背景には、Go言語のos/userパッケージが、一部のプラットフォーム（特にUnix系システム）において、ユーザー情報を取得するためにCgo（C言語のコードをGoから呼び出す機能）に依存しているという問題がありました。Cgoが無効化されているビルド環境や実行環境では、user.Current()関数がエラーを返す可能性があり、その結果、cmd/apiツールが正常に動作しなくなるというバグ（Issue #6578）が存在していました。

cmd/apiツールは、GoのAPIドキュメントを生成するために、一時的なGOPATHを設定します。このGOPATHのパスには、ユーザー名が含まれることがあり、そのユーザー名を取得するためにos/userパッケージが使用されていました。Cgoが利用できない状況でこのツールを使用すると、ユーザー名の取得に失敗し、ツールがクラッシュしてしまうという問題が発生していました。

このコミットは、この問題を解決し、Cgoが利用できない環境でもcmd/apiツールが堅牢に動作するようにするためのものです。

前提知識の解説

Cgo

Cgoは、GoプログラムからC言語のコードを呼び出すためのGoの機能です。また、C言語のコードからGoの関数を呼び出すことも可能です。Cgoを使用すると、既存のCライブラリをGoプロジェクトに統合したり、Goでは直接アクセスできないOSの低レベルな機能を利用したりすることができます。

しかし、Cgoを使用すると、ビルドプロセスが複雑になったり、クロスコンパイルが難しくなったり、実行時の依存関係が増えたりする可能性があります。そのため、一部の環境や特定の目的（例えば、完全に静的なバイナリを生成したい場合など）では、Cgoを無効にしてGoプログラムをビルドすることがあります。Goのビルドコマンドに-tags nocgoオプションを付けることで、Cgoを無効にすることができます。

os/userパッケージ

os/userパッケージは、現在のユーザーや指定されたユーザーに関する情報を取得するためのGoの標準ライブラリです。このパッケージは、ユーザー名、ユーザーID、グループID、ホームディレクトリなどの情報を提供します。

Unix系システムでは、os/userパッケージは通常、getpwnamやgetpwuidといったCライブラリ関数を内部的に呼び出してユーザー情報を取得します。これらのCライブラリ関数を呼び出すためにCgoが使用されます。したがって、Cgoが無効な環境では、user.Current()のような関数が期待通りに動作しない可能性があります。

一方、Windowsでは、os/userパッケージはCgoに依存せず、ネイティブのWindows API（syscall）を使用してユーザー情報を取得します。そのため、Windows環境ではCgoが無効であってもuser.Current()は通常問題なく動作します。

環境変数 $USER および %USERNAME%

環境変数は、オペレーティングシステムが提供する動的な名前付きの値であり、実行中のプロセスに影響を与えます。

• $USER: Unix系システム（Linux, macOSなど）で一般的に使用される環境変数で、現在のログインユーザー名が格納されています。
• %USERNAME%: Windowsシステムで一般的に使用される環境変数で、現在のログインユーザー名が格納されています。

これらの環境変数は、Cgoに依存せずにGoプログラムからos.Getenv()関数を使って簡単に取得できます。

技術的詳細

このコミットの技術的な核心は、os/user.Current()の呼び出しが失敗した場合のフォールバックメカニズムを導入することです。

元のコードでは、user.Current()を呼び出し、エラーが発生した場合は即座にlog.Fatalfでプログラムを終了していました。

u, err := user.Current()
if err != nil {
    log.Fatalf("Error getting current user: %v", err)
}

変更後のコードでは、user.Current()がエラーを返した場合でも、プログラムがクラッシュするのではなく、環境変数からユーザー名を取得しようと試みます。

1. まず、username := ""としてusername変数を初期化します。
2. u, err := user.Current()を呼び出します。
3. err == nilの場合、つまりuser.Current()が成功した場合は、username = u.Usernameとして取得したユーザー名をusername変数に格納します。
4. err != nilの場合、つまりuser.Current()が失敗した場合は、以下のフォールバックロジックが実行されます。
   • コメントに「Only need to handle Unix here, as Windows's os/user uses native syscall and should work fine without cgo.」とあるように、このフォールバックは主にUnix系システムを対象としています。Windowsではos/userがCgoなしで動作するため、このパスには通常入りません。
   • username = os.Getenv("USER")を呼び出し、Unix系システムで一般的なUSER環境変数の値を取得します。
   • もしUSER環境変数も空文字列だった場合（つまり、環境変数からユーザー名を取得できなかった場合）、その時点で初めてlog.Fatalfを呼び出してプログラムを終了します。これは、ユーザー名を特定する手段が完全に尽きたことを意味します。

この変更により、gopathの生成に使用されるユーザー名が、user.Current()がCgoの制約で失敗しても、環境変数から取得できるようになり、cmd/apiツールの堅牢性が向上しました。

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

変更は src/cmd/api/run.go ファイルに集中しています。

--- a/src/cmd/api/run.go
+++ b/src/cmd/api/run.go
@@ -93,13 +93,21 @@ func file(s ...string) string {
 func prepGoPath() string {
 	const tempBase = "go.tools.TMP"
 
+	username := ""
 	u, err := user.Current()
-	if err != nil {
-		log.Fatalf("Error getting current user: %v", err)
+	if err == nil {
+		username = u.Username
+	} else {
+		// Only need to handle Unix here, as Windows's os/user uses
+		// native syscall and should work fine without cgo.
+		username = os.Getenv("USER")
+		if username == "" {
+			log.Fatalf("Error getting current user: %v", err)
+		}
 	}
 
 	// The GOPATH we'll return
-	gopath := filepath.Join(os.TempDir(), "gopath-api-"+cleanUsername(u.Username), goToolsVersion)
+	gopath := filepath.Join(os.TempDir(), "gopath-api-"+cleanUsername(username), goToolsVersion)
 
 	// cloneDir is where we run "hg clone".
 	cloneDir := filepath.Join(gopath, "src", "code.google.com", "p")

コアとなるコードの解説

変更前

変更前のコードでは、user.Current()の呼び出しが失敗した場合、エラーメッセージを出力してプログラムを終了していました。これは、Cgoが無効な環境でuser.Current()がエラーを返すと、cmd/apiツールがクラッシュすることを意味します。

u, err := user.Current()
if err != nil {
    log.Fatalf("Error getting current user: %v", err)
}
// ...
gopath := filepath.Join(os.TempDir(), "gopath-api-"+cleanUsername(u.Username), goToolsVersion)

変更後

変更後のコードでは、usernameという新しい変数が導入され、ユーザー名の取得ロジックがより堅牢になっています。

1. username := ""：ユーザー名を格納する変数を初期化します。
2. u, err := user.Current()：まず、標準的な方法で現在のユーザー情報を取得しようと試みます。
3. if err == nil：user.Current()が成功した場合、u.Usernameをusernameに代入します。
4. else：user.Current()が失敗した場合（Cgoが無効な場合など）、フォールバックロジックに入ります。
   • username = os.Getenv("USER")：Unix系システムで一般的なUSER環境変数からユーザー名を取得しようと試みます。Windowsではos/userがCgoなしで動作するため、このパスは主にUnix系システム向けです。
   • if username == ""：もし環境変数からもユーザー名が取得できなかった場合、その時点で初めてlog.Fatalfを呼び出してプログラムを終了します。これは、ユーザー名を特定するすべての試みが失敗したことを意味します。
5. gopath := filepath.Join(os.TempDir(), "gopath-api-"+cleanUsername(username), goToolsVersion)：最後に、取得したusername変数を使用してgopathを構築します。これにより、user.Current()が失敗しても、環境変数からユーザー名が取得されていれば、ツールは正常に動作を継続できます。

この変更により、cmd/apiツールは、Cgoの有無にかかわらず、より多くの環境で安定して動作するようになりました。

関連リンク

• Go Issue #6578: https://github.com/golang/go/issues/6578
• Go Change List 14649043: https://golang.org/cl/14649043

参考にした情報源リンク

• Go Documentation: os/user package: https://pkg.go.dev/os/user
• Go Documentation: os package: https://pkg.go.dev/os
• Go Documentation: Cgo: https://go.dev/blog/cgo
• Environment Variables (Wikipedia): https://en.wikipedia.org/wiki/Environment_variable
• getpwnam (man page): https://man7.org/linux/man-pages/man3/getpwnam.3.html
• getpwuid (man page): https://man7.org/linux/man-pages/man3/getpwuid.3.html