讓你的 Backend 萬物皆虛，萬事皆可測 - Clean Architecture 測試篇

• Github(包含程式碼)

• Medium

• iT 邦幫忙

文章為自己的經驗與夥伴整理的內容，設計沒有標準答案，如有可以改進的地方，請告訴我，我會盡我所能的修改，謝謝大家～

高可測試(Testability)性

一個簡單的測試

// ... 其他程式碼

import "service"

func GetName() int {
  nameService := service.NewNameService()
  result := nameService.GetName()
  // ... 關於result的演算
  return result
}

// ... 其他程式碼

將所需的變數、實體、函示從外部帶入

package logic

import "service"

func GetName(nameService *service.Engine) int {
  result := nameService.GetName()
  // ... 關於result的演算
  return result
}

// ... 其他程式碼

// ... 其他程式碼

import (
  "logic"
  "mock"
  "github.com/stretchr/testify/assert"
)

func TestGetName(t *testing.T) {
  mockNameService := mock.NewNameService()
  result := logic.GetName(&mockNameService)
  assert.Equal(t, 3, result)
}

如果是這樣的話那我不就每層都可以測試了？！

Clean Architecture 每層都用依賴注入(DI)，所以你每層都可以換成 Mock 實體來測試

Repository 層

// ... 其他程式碼

import (
	"context"
	"testing"

	digimonPostgresqlRepo "go-server/digimon/repository/postgresql"

	"github.com/stretchr/testify/assert"
	sqlmock "gopkg.in/DATA-DOG/go-sqlmock.v1"

	"go-server/domain"
)

func TestGetByID(t *testing.T) {
  // !!! 講解1 !!!
	db, mock, err := sqlmock.New()
	if err != nil {
		t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
	}

  // !!! 講解2 !!!
	mockDigimon := &domain.Digimon{
		ID:     "69770f2d-933e-474d-8357-a2f8a9c874df",
		Name:   "Customer",
		Status: "Good",
	}

  // !!! 講解3 !!!
	rows := sqlmock.NewRows([]string{"id", "name", "status"}).
		AddRow(mockDigimon.ID, mockDigimon.Name, mockDigimon.Status)

  // !!! 講解4 !!!
	query := "SELECT id, name, status FROM digimons WHERE id =?"

  // !!! 講解4 !!!
  mock.ExpectQuery(query).WithArgs("69770f2d-933e-474d-8357-a2f8a9c874df").WillReturnRows(rows)
  // !!! 講解5 !!!
	d := digimonPostgresqlRepo.NewpostgresqlDigimonRepository(db)
  aDeit, _ := d.GetByID(context.TODO(), "69770f2d-933e-474d-8357-a2f8a9c874df")
  // !!! 講解5 !!!
	assert.Equal(t, mockDigimon, aDeit)
}

// ... 其他程式碼

測試重點: 呼叫外部物件的方式是否正確，並非測試外部物件

• 講解1 - go-sqlmock製作一個假的mock DB: 如重點所說，我們並不關心外部 DB 的實際狀況，我們只關心組出來的SQL command是否正確，所以可以用 go-sqlmock 做一個假的 DB。

• 講解2 - 產生在mock DB需要的假資料: 既然要測試的是GetByID的邏輯，那就必須先產生一組假的資料，讓GetByID真的有資料可以撈取。

• 講解3 - 將假資料轉換成row的struct: 講解2產生的資料是domain.Digimon的 data struct，我們必須把它轉換成 row 的 data struct，才會符合真實對 DB 取 row 的狀況。

• 講解4 - 預定mock DB會接收到何種SQL command: 這邊是重點，我們還必須預定好會回傳的值，mock DB 在接收到正確的 command 就會回傳預定的回傳值。

• 講解5 - 把 mock DB 丟入後 Repository 層，驗證結果是否正確

Usecase 層

// ... 其他程式碼

import (
	"context"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/mock"

	"errors"
	ucase "go-server/digimon/usecase"
	"go-server/domain"
	"go-server/domain/mocks"
)

func TestGetByID(t *testing.T) {
  // !!! 講解1 !!!
	mockDigimonRepo := new(mocks.DigimonRepository)
	mockDigimon := domain.Digimon{
		ID:     "2e72c27e-0feb-44e1-89ef-3d58fd30a1b3",
		Name:   "Metrics",
		Status: "Good",
	}

  // !!! 講解2 !!!
	t.Run("Success", func(t *testing.T) {
    // !!! 講解3 !!!
		mockDigimonRepo.
			On("GetByID", mock.Anything, mock.MatchedBy(func(value string) bool { return value == "e9addf2d-8739-427a-8b30-2383b9b045b1" })).
			Return(&mockDigimon, nil).Once()

    // !!! 講解4 !!!
		u := ucase.NewDigimonUsecase(mockDigimonRepo)
		aDigimon, err := u.GetByID(context.TODO(), "e9addf2d-8739-427a-8b30-2383b9b045b1")

    // !!! 講解5 !!!
		assert.NoError(t, err)
		assert.NotNil(t, aDigimon)

		mockDigimonRepo.AssertExpectations(t)
	})
	t.Run("Fail", func(t *testing.T) {
		mockDigimonRepo.
			On("GetByID", mock.Anything, mock.MatchedBy(func(value string) bool { return value == "e9addf2d-8739-427a-8b30-2383b9b045b1" })).
			Return(nil, errors.New("Get error")).Once()

		u := ucase.NewDigimonUsecase(mockDigimonRepo)
		aDigimon, err := u.GetByID(context.TODO(), "e9addf2d-8739-427a-8b30-2383b9b045b1")

		assert.Error(t, err)
		assert.Nil(t, aDigimon)

		mockDigimonRepo.AssertExpectations(t)
	})
}

// ... 其他程式碼

測試重點: 業務邏輯路線是否預期，並非測試 Repository 層

$ cd go-server/domain
$ mockery --all --keeptree

• 講解1 - 透過mocks資料夾產生mockDigimonRepo

• 講解2 - 依照不同情境區分測試: Usecase 層比較會有 不同的程式路線產生，例如：「數碼蛋參數如果沒帶的話、如果 DB 爆掉的話等等」，所以我們可以依照這些情境來區分測試

• 講解3 - 設定mockDigimonRepo預定接收的參數與回傳的資料: 這邊是最有趣的部分，你可以透過.On()來定義 mockDigimonRepo 在 Usecase 層裡被呼叫的時候預定要接收什麼，並且回傳資料供邏輯繼續使用。

• 講解4 - 將mockDigimonRepo丟入Usecase層並實際運行。

• 講解5 - 驗證Usecase回傳資料與mockDigimonRepo運行的結果: .AssertExpectations要稍微注意一下，他是在驗證.On()是否真的有被 call 到。

• .On(): 預期要呼叫什麼 function。

• mock.MatchedBy(): 預期參數要長什麼樣子。

• .Return(): 指定回傳值。

• .Once(): 將此.On效果只作用一次，這可以使你設定同個function在不同次的.On都有不同結果。

• .Run(): 雖然沒有出現在此測試，但非常有用。Golang 有者許多bind(&body)的指標綁定資料方式，這不是一進一出的方式，所以無法用.Return()來指定結果。而.Run()可以捕捉bind(&body)中的body指標位置，並且修改其內容，以達到指定結果的效果

Delivery 層

import (
	"bytes"
	"encoding/json"
	"go-server/domain"
	"go-server/domain/mocks"
	"net/http"
	"net/http/httptest"
	"testing"

	digimonHandlerHttpDelivery "go-server/digimon/delivery/http"

	"github.com/gin-gonic/gin"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/mock"
)

func TestGetDigimonByDigimonID(t *testing.T) {
	mockDigimon := domain.Digimon{
		ID:     "8c862535-6de2-4da2-ad21-c853e4343bd7",
		Name:   "III",
		Status: "good",
	}
	mockDigimonMarshal, _ := json.Marshal(mockDigimon)
	mockDigimonCase := new(mocks.DigimonUsecase)

	mockDigimonCase.On("GetByID", mock.Anything, mockDigimon.ID).Return(&mockDigimon, nil)

	r := gin.Default()

	handler := digimonHandlerHttpDelivery.DigimonHandler{
		DigimonUsecase: mockDigimonCase,
	}

	r.GET("/api/v1/digimons/:digimonID", handler.GetDigimonByDigimonID)

  // !!! 講解1 !!!
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/api/v1/digimons/8c862535-6de2-4da2-ad21-c853e4343bd7", nil)
	r.ServeHTTP(w, req)

	assert.Equal(t, 200, w.Code)
	assert.Equal(t, string(mockDigimonMarshal), w.Body.String())
}

測試重點: Delivery 層是否都正確接收了引擎的參數，並非測試 Usecase 層

好用的測試指令

$ cd go-server
$ go test ./...

$ cd go-server
$ go test -coverprofile cover.out ./...
$ go tool cover -html=cover.out -o cover.html
$ open cover.html

參考

• bxcodec/go-clean-arch

• Trying Clean Architecture on Golang

• unit testing - How to measure code coverage in Golang? - Stack Overflow

• testing - How to go test all tests in my project? - Stack Overflow

• unit testing - Mock interface method twice with different input and output using testify - Stack Overflow

• Using testify for Golang tests – ncona.com – Learning about computers