Go 테스트 코드 작성 및 실행

sungil 22.02.09

5,525 7 0

facebook twitter kakao link

7 0

facebook twitter kakao link

소프트웨어 개발에서 테스트는 매우 중요하다. 테스트는 여러가지 단계로 나누어 수행되는데 모듈별 테스트로부터 통합테스트까지 다양한 기준점으로 나뉜 테스트들이 개발과정 곳곳에서 수행된다.

단위 모듈 관점에서 테스트 코드를 넣고 이를 주기적으로 돌리는 방식이 단위 테스트이다. (한국에서) 근 20년동안 가장 사랑받는 언어인 Java에서 사용하는 JUnit과 같은 단위테스트 방법이 가장 유명하고 이러한 테스트를 통한 개발 방법론도 있다. (TDD)

Go의 영향력이 높아지면서 Go에서도 테스트에 대한 요구들이 나오고 있고 본 페이지를 통해 그 방법을 정리하고자 한다.

Go 테스트를 위한 기본 지식

Go에서 시스템적으로 정의하는 테스트 방법은 매우 간단하다. 다음의 규칙을 지켜주면 테스트 된다.

Go는 테스트 프레임워크를 내장
go test 명령을 통해 테스트
- *_test.go 에대한 테스트 수행
- TestXxx 형태의 임의의 매서드에 대해 테스트 진행

테스트 코드작성

기본

작성 규칙은 다음과 같다.

파일명은 \_test.go로 끝난다.
함수명은 Test로 시작한다.
매개변수는 t \*testing.T를 받는다.
실패지점에서 t.Fail()을 호출한다.

이를 통해 아래와 같이 작성한다.

package는 test
testing 모듈 import
함수 작성
- 입력으로 testing.T를 받고
- testing.T는 오류함수 제공
  - Fatal() / Error() / Fail() / Log() 등 함수 지원

package test

import "testing"

func TestFoo(t *testing.T) {
  // todo test code, the variable 'result' should be defined
	
  expected := 1
  actual := 0
  if result != actual {
    t.Fatal("원하는 결과가 아니네요.")
    // t.Error()
    // t.Fail()
    // t.Log()
  }
}

assert 패키지 사용

기본 test를 하다보면 원하는 조건을 찾기위해 많은 if 문이 발생하는데 이를 깔끔하게 정리하도록 도와주는 것이 assert 패키지 (github.com/stretchr/testify/assert)

package test

import (
	"testing"
	"github.com/stretchr/testify/assert"
)
	
func TestFoo(t *testing.T) {
  // todo test code
  expected := 1
  actual := 0
  assert.Equal(t, expected, actual, "원하는 결과가 아니네요.")
}

assert 패키지는 정리된 결과값을 보여준다.

siim@adm:~/go/src/tks-client/test$ go test 
--- FAIL: TestFoo (0.00s)
    service_copy_test.go:12: 
                Error Trace:    service_copy_test.go:12
                Error:          Not equal: 
                                expected: 1
                                actual  : 0
                Test:           TestFoo
                Messages:       원하는 결과가 아니네요.
FAIL
exit status 1
FAIL    github.com/openinfradev/tks-client/test 0.005s

테스트 실행

모든 테스트 실행 $ go test
*_test.go 대상으로 테스트 실행하며 상세한 수행내역( -v ) 확인 $ go test *_test.go -v\
특정 테스트 함수(TestFunctionName) 실행 $ go test -run TestFunctionName -v

테이블 주도 테스트(table-driven test)

하나의 함수를 테스트하기 위해 여러개의 테스트 케이스가 존재하며 일반적으로 테스트를 작성하면 하나의 테스트 함수는 하나의 테스트 케이스를 수행한다. 이런 경우 테스트 케이스의 숫자와 동일한 테스트 함수가 나오게되고 각 테스트 함수들은 동일 함수에 대한 테스트 이므로 중복된 코드들을 갖게 된다. 이러한 중복을 제거하고자 이를 통합하는 방법으로 테이블 주도 테스트가 이용되고 있다.

테이블 주도 테스트는 모든 테스트 케이스들을 테이블로 구성하고 하나의 테스트 함수에서 이 테이블을 순회하면서 테스트 한다. 이를 통해 함수 하나당 하나의 테이스 함수를 갖도록 구성할 수 있다.

이 방식은 여러 Go 언어 커뮤니티에서 권장하는 방식이다.

테이블의 구조

테스트 케이스를 구성하고 이에 대한 성공 실패를 판단에 충분한 데이터를 테이들에 포함시키는 것이 중요하다. 따라서 테스트를 위한 객체와 매개변수, 결과, 테스트를 위한 인자 등을 필요에 따라 구성하면 된다.

다음 예제는 아래와 같은 목적을 수행하기 위해 정의한 구조의 일부이다.

파라미터를 전달 - args
기대하는 출력을 전달 - out, err
불필요한 출력은 비교하지 않는다 - out_check

testcases := []struct {
	args      []string
	out_check bool
	err       error
	out       string
}{
	{[]string{"wrong"}, true, errors.New("unknown command \\"wrong\\" for \\"tks\\""), ""},
	{[]string{"wrong", "cmd"}, true, errors.New("unknown command \\"wrong\\" for \\"tks\\""), ""},

	{[]string{"completion", "powershell"}, false, nil, ""},

	{[]string{"--config"}, true, errors.New("flag needs an argument: --config"), ""},

	{[]string{"cluster", "create"}, true, errors.New("required flag(s) \\"contract-id\\", \\"csp-id\\" not set"), ""},
.........

테스트 수행

전체 케이스를 순회하면서 테스트를 진행한다.

for _, tc := range testcases {
	out, err := execute(t, rootCmd, tc.args...)

	is.Equal(tc.err, err)

	if tc.err == nil && tc.out_check {
		is.Equal(tc.out, out)
	}
}