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

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

このコミットは、Go言語の標準ライブラリnetパッケージ内のdialgoogle_test.goファイルにおけるテストの修正に関するものです。具体的には、Googleへのダイヤルテストが安定して動作するように、テストで使用するHTTPリクエストのパスを/intl/en/privacy/から/robots.txtに変更しています。これにより、テストの信頼性が向上し、外部サービスへの依存による不安定性を低減することを目的としています。

コミット

commit 9acea02de2eb5ee0ac3a20613a8e1c3ce44e755b
Author: Mikio Hara <mikioh.mikioh@gmail.com>
Date:   Thu Jan 26 07:38:49 2012 +0900

    net: fix dialing google test
    
    R=golang-dev, bradfitz, rsc
    CC=golang-dev
    https://golang.org/cl/5573060

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

https://github.com/golang/go/commit/9acea02de2eb5ee0ac3a20613a8e1c3ce44e755b

元コミット内容

net: fix dialing google test

このコミットは、Go言語のnetパッケージにおけるGoogleへのダイヤルテストの不具合を修正することを目的としています。

変更の背景

Go言語の標準ライブラリには、ネットワーク関連の機能を提供するnetパッケージが含まれています。このパッケージには、外部サービスへの接続性を検証するためのテストが含まれることがあります。今回のケースでは、dialgoogle_test.goというファイルが存在することから、Googleのサーバーへの接続をテストする目的のコードがあったと推測されます。

元のテストでは、HTTPリクエストのパスとして/intl/en/privacy/が使用されていました。しかし、ウェブサイトのコンテンツや構造は時間とともに変化する可能性があり、特定のページ（この場合はプライバシーポリシーページ）のURLや内容が変更されると、テストが意図せず失敗する原因となります。テストは、検証したい機能が正しく動作するかどうかを安定して確認できるべきであり、外部要因による不安定性は避けるべきです。

このコミットの背景には、おそらく/intl/en/privacy/パスがGoogleのサーバー上で不安定になった、あるいはテストの目的には不適切になったという問題があったと考えられます。テストの安定性を確保し、Go言語のネットワーク機能が正しく動作することを継続的に検証するために、より安定したパスへの変更が必要とされました。

前提知識の解説

Go言語のnetパッケージ

Go言語のnetパッケージは、ネットワークI/O機能を提供する標準ライブラリです。TCP/IP、UDP、Unixドメインソケットなどのネットワークプロトコルを扱うための基本的なインターフェースと実装が含まれています。クライアントとサーバーアプリケーションの両方を構築するために使用され、ネットワーク接続の確立、データの送受信、DNSルックアップなど、幅広い機能を提供します。

HTTP/1.0

HTTP/1.0は、Hypertext Transfer Protocolのバージョンの一つです。ウェブブラウザとウェブサーバー間の通信に使用されるプロトコルで、ウェブページの取得やデータの送信を行います。HTTP/1.0は、リクエストごとに新しいTCP接続を確立し、レスポンスを受け取った後に接続を閉じることが一般的でした。このコミットでは、GET /robots.txt HTTP/1.0という形式でHTTPリクエストを構築しており、これはHTTP/1.0プロトコルに準拠した基本的なリクエスト形式です。

robots.txt

robots.txtは、ウェブサイトのルートディレクトリに配置されるテキストファイルです。このファイルは、ウェブクローラー（検索エンジンのボットなど）に対して、ウェブサイトのどの部分をクロールしてもよいか、またはクロールしてはいけないかを指示するために使用されます。robots.txtは、ウェブサイトの公開された情報であり、通常は常にアクセス可能で、その内容が頻繁に変わることはありません。そのため、ウェブサイトの存在確認や基本的な接続テストには非常に適したエンドポイントとされています。

Go言語のテスト

Go言語には、標準でテストフレームワークが組み込まれています。テストファイルは通常、テスト対象のソースファイルと同じディレクトリに配置され、ファイル名の末尾に_test.goが付きます。テスト関数はTestで始まり、*testing.T型の引数を取ります。t.Error()やt.Fatal()などのメソッドを使用してテストの失敗を報告します。このコミットのdialgoogle_test.goも、Goの標準テストフレームワークに則って記述されています。

技術的詳細

このコミットの技術的な核心は、テストの安定性を向上させるために、HTTPリクエストのターゲットパスを/intl/en/privacy/から/robots.txtに変更した点にあります。

なぜ/robots.txtがテストに適しているのか

  1. 安定性: robots.txtファイルは、ウェブサイトの構造やコンテンツが変更されても、その場所や内容が頻繁に変わることはほとんどありません。これは、検索エンジンのクローラーがウェブサイトを適切にインデックスするために不可欠なファイルであるため、ウェブマスターが安易に変更しない傾向があるためです。
  2. 普遍的な存在: ほとんどすべてのウェブサイトがrobots.txtファイルを公開しています。これは、ウェブサイトの基本的な存在確認や接続テストを行う上で、非常に信頼性の高いエンドポイントとなります。
  3. 軽量なレスポンス: robots.txtファイルは通常、非常に小さく、静的なテキストファイルです。これをリクエストすることで、サーバーへの負荷を最小限に抑えつつ、ネットワーク接続が正常に確立され、HTTPレスポンスが返されることを効率的に確認できます。
  4. コンテンツの変動リスクの低減: プライバシーポリシーページのような動的なコンテンツや、頻繁に更新される可能性のあるページは、その内容や構造が変更されるたびにテストが失敗するリスクがあります。robots.txtは、このようなコンテンツの変動リスクが極めて低いという利点があります。

変更による効果

この変更により、dialgoogle_test.goはGoogleのサーバーへの接続テストをより安定して実行できるようになりました。テストが外部のウェブサイトのコンテンツ変更に左右されにくくなり、Go言語のnetパッケージの機能自体が正しく動作しているかどうかの検証に集中できるようになります。これは、CI/CDパイプラインにおけるテストの信頼性向上に直結し、開発者がネットワーク関連のバグをより迅速に特定・修正できる環境を提供します。

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

--- a/src/pkg/net/dialgoogle_test.go
+++ b/src/pkg/net/dialgoogle_test.go
@@ -19,7 +19,7 @@ var ipv6 = flag.Bool("ipv6", false, "assume ipv6 tunnel is present")
 // fd is already connected to the destination, port 80.
 // Run an HTTP request to fetch the appropriate page.
 func fetchGoogle(t *testing.T, fd Conn, network, addr string) {
-\treq := []byte("GET /intl/en/privacy/ HTTP/1.0\\r\\nHost: www.google.com\\r\\n\\r\\n")
+\treq := []byte("GET /robots.txt HTTP/1.0\\r\\nHost: www.google.com\\r\\n\\r\\n")
 \tn, err := fd.Write(req)
 \n \tbuf := make([]byte, 1000)

コアとなるコードの解説

変更はsrc/pkg/net/dialgoogle_test.goファイルのfetchGoogle関数内の一行に限定されています。

元のコードでは、reqというバイトスライスにHTTP GETリクエストの文字列を構築していました。その際、リクエストのパスとしてGET /intl/en/privacy/ HTTP/1.0が指定されていました。

req := []byte("GET /intl/en/privacy/ HTTP/1.0\\r\\nHost: www.google.com\\r\\n\\r\\n")

このコミットでは、このパスがGET /robots.txt HTTP/1.0に変更されました。

req := []byte("GET /robots.txt HTTP/1.0\\r\\nHost: www.google.com\\r\\n\\r\\n")

この変更の目的は、前述の通り、テストの安定性を向上させることです。fetchGoogle関数は、既にGoogleのサーバー（ポート80）に接続されているfd（ファイルディスクリプタ、ここではnet.Connインターフェースの実装）に対してHTTPリクエストを送信し、そのレスポンスを読み取ることで接続性をテストしています。パスをより安定した/robots.txtに変更することで、Googleのウェブサイトのコンテンツ変更に起因するテストの失敗を防ぎ、ネットワーク接続自体の検証に焦点を当てられるようになりました。

\r\nはCRLF（Carriage Return Line Feed）を表し、HTTPプロトコルにおける行の終端を示します。Host: www.google.comはHTTPヘッダーの一部で、どのホストに対するリクエストであるかを示します。最後の\r\n\r\nは、HTTPヘッダーの終わりとリクエストボディの開始を示します（この場合はボディがないため、ヘッダーの直後にリクエストの終わりが来ます）。

関連リンク

参考にした情報源リンク

  • Go言語公式ドキュメント: netパッケージ
  • HTTP/1.0 プロトコル仕様
  • robots.txtに関する情報 (Google Developersなど)
  • Go言語のテストに関する公式ドキュメント
  • 一般的なソフトウェアテストのプラクティスに関する知識
  • Google検索: "why use robots.txt for testing"
  • Google検索: "golang net package"
  • Google検索: "http 1.0 request example"
  • Google検索: "what is robots.txt"
  • Google検索: "golang testing best practices"