PRを作成する際にGithub Actionsを介してGolangテストを自動で実行し、レポートを生成してみよう

2025年2月17日

どこでも、どんな言語でも、テストのためにビルドやテストを自動化することは非常に重要といえます。

もちろんローカルで直接テストを実行してアップロードするようにすることもできますが、人が作業する際にはテストを実行せずにアップロードする場合も時々あるため、ローカルに依存しすぎるよりは、自動化をしておくと、長く使うためにも良く、保守にも費用が少なくて済むでしょう。

この記事では、Golangでテストのためのアクションを作成し、PRを作成する際に自動でテストを実行し、レポートを生成する方法について紹介します。

シナリオは以下のように設計しました。

Goのセットアップ
Go Testの実行
テストレポートの生成
PRにコメントとしてレポートのリンクを残す

テストコード

Goコード

math.go

package math

import "errors"

var (
	ErrDivideByZero = errors.New("cannot divide by zero")
)

func Divide(a, b int) (int, error) {
	if b == 0 {
		return 0, ErrDivideByZero
	}
	return a / b, nil
}

このコードは Divide() という関数を実装したものです。単純に aをbで割る関数で、0で割ることは許可されていないため、エラーを返すようにしました。

テストコード

math.go

package math

import "testing"

func TestDivide(t *testing.T) {
	type args struct {
		a int
		b int
	}
	tests := []struct {
		name    string
		args    args
		want    int
		wantErr bool
	}{
		{
			name: "10を2で割る",
			args: args{
				a: 10,
				b: 2,
			},
			want:    5,
			wantErr: false,
		},
		{
			name: "10を0で割る",
			args: args{
				a: 10,
				b: 0,
			},
			want:    0,
			wantErr: true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := Divide(tt.args.a, tt.args.b)
			if (err != nil) != tt.wantErr {
				t.Errorf("Divide() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if got != tt.want {
				t.Errorf("Divide() got = %v, want %v", got, tt.want)
			}
		})
	}
}

go test -v ./... でローカルでテストすることもできますが、Github Actionsでテストが実行されるためにはyamlファイルの記述が必要です。

Github Actions

.github/workflows/go-test.yml

name: Go Test and Coverage

on:
  pull_request:
    types: [ opened, synchronize, reopened ]
  workflow_dispatch:

jobs:
  test:
    name: Run Go Tests
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: 1.23


      - name: Test Report
        id: test-report
        uses: robherley/go-test-action@v0
        with:
          testArguments: ${{ github.event_name == 'pull_request' && '-short -v ./...' || '-count 1 -v ./...' }}

      - name: PR Comment
        if: always() && github.event_name == 'pull_request'
        uses: mshick/add-pr-comment@v2
        with:
          message: |
            ${{ steps.test-report.outcome == 'success' && '![image](https://img.shields.io/badge/testing-success-green)' || '![image](https://img.shields.io/badge/testing-failure-red)' }}
            
            **📃 Report**: https://github.com/${{github.repository}}/actions/runs/${{ github.run_id }}

筆者が作成しテストまで完了したコードなので、そのままコピーして使用しても問題ありません。

説明は以下の通りです。

      - name: Checkout Repository
        uses: actions/checkout@v4

このステップはリポジトリをチェックアウトするステップです。ローカルで行う git clone コマンドと似たようなもので、アクションランナーのファイルシステムにそのリポジトリのコードを持ってくるものだと見てください。

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: 1.23

このステップはGoをインストールするステップです。もちろん直接apt-getを通じてインストールしてもかまいませんが、このようなSetupアクション系は一般的にアクションキャッシュを適用するため、ビルド速度をより速くする利点があります。

      - name: Test Report
        id: test-report
        uses: robherley/go-test-action@v0
        with:
          testArguments: '-count 1 -v ./...'

テストレポートを生成するために自作のアクションを作成することもできますが、既に出来上がっている良いアクションがあるのでそれを活用してみました。

筆者は robherley/go-test-action を使用しました。このアクションはGoテストを実行しながら、レポートをSummaryに残すアクションです。

追加的に testArguments を適用しましたが、この部分は書いても書かなくてもかまいません。書かない場合、デフォルトで -v ./... が付くと考えてください。筆者はキャッシュがされないようにするために count 1 オプションを適用しました。

関連内容は以前のGo Testキャッシュに関する記事を参照してください。

      - name: PR Comment
        if: always() && github.event_name == 'pull_request'
        uses: mshick/add-pr-comment@v2
        with:
          message: |
            ${{ steps.test-report.outcome == 'success' && '![image](https://img.shields.io/badge/testing-success-green)' || '![image](https://img.shields.io/badge/testing-failure-red)' }}
            
            **📃 Report**: https://github.com/${{github.repository}}/actions/runs/${{ github.run_id }}

その後、このアクションを通じてPRにレポートリンクを残すアクションです。PRが必要であるため、コメントが残されることになるので、if: always() && github.event_name == 'pull_request' 条件を設けました。 always() は前のアクションが成功か失敗かに関係なく実行されるようにします。そして shield.io を利用して成功、失敗に応じたバッジで美しく表示されるようにしました。（大したことではなく、このようなアイコンを付けるものです）

成功