PR을 열 때 Github Actions를 통해 Golang 테스트를 자동으로 실행하고, 리포트를 생성해보자

테스트 코드

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으로 나누는 것은 허용하지 않으므로, 에러를 반환하도록 했다.

Test 코드

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를 이용해 성공, 실패에 따른 뱃지로 예쁘게 표시되게끔 했다. (대단한 건 아니고, 이런 아이콘을 붙여주는 것이다)

성공