Mockery — เลิกเขียน mock ด้วยมือ

$ echo 'export PATH="$PATH:$(go env GOPATH)/bin"' >> ~/.zshrc && source ~/.zshrc

1 · ทบทวน: ราคาที่เราจ่ายมาตลอดบท 15–17

สูตรที่ใช้มาตั้งแต่ บทเรียน 15 จนถึง บทเรียน 17 มีสามชิ้นเสมอ:

  1) interface            2) DI                  3) mock เขียนมือ

  type UserRepository    func NewService(         type FakeUserRepository struct {
      interface {            repo UserRepository      GetByIDFunc  func(...) ...
      GetByID(...)       ) *Service {                 GetByIDCalls []int
      Save(...)              ...                      ...
      CountActive()      }                        }
  }                                               func (f *Fake) GetByID(...) {...}
       ▲                        ▲                 func (f *Fake) Save(...)    {...}
       │                        │                 func (f *Fake) CountActive(){...}
  โค้ดจริงพึ่งพา            เทสยัดของปลอม                     ▲
  "สัญญา" ไม่ใช่ตัวจริง        เข้ามาแทนได้         ชิ้นนี้เราพิมพ์เองทุกตัวอักษร

คำว่า DI ในภาพย่อมาจาก Dependency Injection — แปลตรงตัวว่า "ส่งของที่ต้องใช้เข้าไปให้" คือยื่น repository เข้าไปทางพารามิเตอร์ แทนที่จะให้ service ไปสร้างเอง · เพราะยื่นเข้าไปได้ ตอนเทสเราจึงยัดของปลอมเข้าไปแทนได้

ชิ้นที่ 1 กับ 2 เป็นการออกแบบ — เราได้ประโยชน์จากมันตรง ๆ (บทเรียน 10)
ชิ้นที่ 3 ไม่ใช่การออกแบบ มันคืองานถอดแบบ — อ่าน interface แล้วพิมพ์ struct ที่มี method ชื่อเดียวกัน signature เดียวกัน ครบทุกตัว (signature = พารามิเตอร์ที่รับ กับค่าที่คืน — ส่วนชื่อ method นับแยก ต้องตรงทั้งคู่ถึงจะ implement interface ได้) ถ้าพิมพ์ตกไปตัวหนึ่ง หรือแค่พิมพ์ GetById แทน GetByID compiler ก็ฟ้องว่าไม่ implement interface

นี่คือ mock เขียนมือของ interface ที่มีแค่ 3 method:

// mock เขียนมือ: struct + field เก็บค่า return + field เก็บ arg ที่ถูกเรียก
type FakeUserRepository struct {
    GetByIDFunc     func(id int) (*User, error)
    GetByIDCalls    []int
    SaveFunc        func(u *User) error
    SaveCalls       []*User
    CountActiveFunc func() int
    CountActiveHits int
}

func (f *FakeUserRepository) GetByID(id int) (*User, error) {
    f.GetByIDCalls = append(f.GetByIDCalls, id)
    if f.GetByIDFunc == nil {
        return nil, nil
    }
    return f.GetByIDFunc(id)
}

func (f *FakeUserRepository) Save(u *User) error {
    f.SaveCalls = append(f.SaveCalls, u)
    if f.SaveFunc == nil {
        return nil
    }
    return f.SaveFunc(u)
}

func (f *FakeUserRepository) CountActive() int {
    f.CountActiveHits++
    if f.CountActiveFunc == nil {
        return 0
    }
    return f.CountActiveFunc()
}

35 บรรทัด · 3 method · pattern เดียวกันเป๊ะทั้งสามอัน (บันทึก arg → เช็ค nil → เรียก func)
เพิ่ม method ที่ 4 ในวันหลัง = กลับมาพิมพ์ pattern เดิมอีกรอบ

2 · ความเจ็บปวดที่แท้จริงไม่ใช่ "เยอะ" แต่คือ "มันเงียบ"

ถ้าปัญหามีแค่ "พิมพ์เยอะ" มันก็แค่น่าเบื่อ ไม่ถึงกับอันตราย
แต่ mock เขียนมือมีรูโหว่ที่ใหญ่กว่านั้นมาก — ลองอ่านเทสข้างล่างนี้ก่อน

โค้ดที่กำลังจะเทสมีแค่นี้ — จำไว้ว่ามันเอา Name ที่ repository คืนมา ต่อหน้าด้วย "Mr. ":

type UserRepository interface {
    GetByID(id int) (*User, error)
    Save(u *User) error
    CountActive() int
}

func (s *Service) DisplayName(id int) (string, error) {
    u, err := s.repo.GetByID(id)
    if err != nil {
        return "", err
    }
    return "Mr. " + u.Name, nil
}

// mock เขียนมือ: GetByIDFunc คืน user id 7 เสมอ
func TestManual_WrongArgSilentlyPasses(t *testing.T) {
    repo := &FakeUserRepository{
        GetByIDFunc: func(id int) (*User, error) {
            return &User{ID: 7, Name: "Somchai"}, nil
        },
    }
    svc := NewService(repo)
    got, err := svc.DisplayName(999) // ควรจะเรียกด้วย 7 แต่เรียก 999
    if err != nil {
        t.Fatal(err)
    }
    if got != "Mr. Somchai" {
        t.Fatalf("got %q", got)
    }
    // ไม่มี assert เรื่อง arg
}

=== RUN   TestManual_WrongArgSilentlyPasses
--- PASS: TestManual_WrongArgSilentlyPasses (0.00s)
PASS
ok  	example.com/manual/user	0.435s

ก่อนไปต่อ ขอปูคำเดียวที่จะใช้ทั้งบท: code generation (การสร้างโค้ดอัตโนมัติ)
mockery ไม่ใช่ library ที่เรา import แล้วมันเสกของปลอมให้ตอนโปรแกรมรัน แต่เป็น โปรแกรมแยกอีกตัวที่เรารันเองจาก terminal มันอ่านไฟล์ .go ของเรา เห็นว่ามี interface ชื่ออะไร มี method อะไรบ้าง แล้ว เขียนไฟล์ .go ใหม่ขึ้นมาให้ ซึ่งหน้าตาเหมือนเรานั่งพิมพ์เองทุกตัวอักษร

จำสามข้อนี้ไว้ เดี๋ยวมันจะอธิบายเกือบทุกเหตุการณ์ในบทนี้:

1. ไฟล์ที่ได้เป็นโค้ด Go ธรรมดา เปิดอ่านได้ คอมไพล์รวมกับโปรเจกต์ตามปกติ
2. มันคือภาพนิ่ง ณ เวลาที่รัน — แก้ interface แล้วไฟล์เก่าไม่อัปเดตให้เอง ต้องรัน mockery ใหม่
3. เราไม่แก้ไฟล์นั้นด้วยมือ เพราะรันครั้งหน้ามันจะถูกเขียนทับทิ้ง

3 · ส่วนประกอบของ mockery — สไลด์บอก 3 แต่จริง ๆ มี 4

ชิ้นที่ 4 ต้องเติมเอง ด้วยคำสั่งที่คุ้นจาก บทเรียน 17:

$ go mod tidy
go: finding module for package github.com/stretchr/testify/mock
go: finding module for package github.com/stretchr/testify/assert
go: found github.com/stretchr/testify/assert in github.com/stretchr/testify v1.12.0
go: found github.com/stretchr/testify/mock in github.com/stretchr/testify v1.12.0
go: downloading github.com/stretchr/objx v0.5.3

4 · ติดตั้ง — และคำสั่งสองอันที่สไลด์เขียนผิด

$ go install github.com/vektra/mockery/v3@latest
$ which mockery
/Users/tuwanon/go/bin/mockery

binary ชื่อ mockery เฉย ๆ ไม่มี v3 ต่อท้าย
ทีนี้เช็คเวอร์ชัน — และนี่คือจุดแรกที่สไลด์พาหลงทาง:

$ mockery --version
Error: unknown flag: --version
Usage:
  mockery [flags]
  mockery [command]
... (ตามด้วยรายการ command ทั้งหมด)

$ mockery version
v3.7.3

จุดที่สองอยู่ตรงคำสั่ง generate — ลองดู help ทั้งหมดที่ v3 มี:

$ mockery --help
Generate mock objects for your Go interfaces

Usage:
  mockery [flags]
  mockery [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Generate a basic .mockery.yml file
  migrate     Migrate v2 config to v3.
  showconfig  Show the yaml config
  version     Print the version of mockery

Flags:
      --config string      config file to use
  -h, --help               help for mockery
      --log-level string   Level of logging

$ mockery generate mock
Error: unknown command "generate" for "mockery"
Run 'mockery --help' for usage.

5 · mockery init — argument ที่ใส่ผิดกันบ่อยที่สุด

$ mockery init --help
This command generates a basic .mockery.yml file that can be used as a
starting point for your config.

Usage:
  mockery init [module_name] [flags]

คำในวงเล็บคือ module_name ไม่ใช่ package_name — ต้องเป็น module path จากบรรทัดแรกของ go.mod (บทเรียน 27) ไม่ใช่ชื่อ package ย่อยอย่าง user หรือ repository
และมันบังคับหนึ่งตัวเสมอ:

$ mockery init
Error: accepts 1 arg(s), received 0

$ mockery init example.com/shop
INF writing to file file=.mockery.yml version=v3.7.3
INF done version=v3.7.3

$ cd app/user && mockery
INF Starting mockery config-file=/.../app/.mockery.yml version=v3.7.3

=== ชื่อไฟล์: mockery.yml ===
FTL app failed error="getting config: discovering mockery config: file not found"
=== ชื่อไฟล์: .mockery.yaml ===
INF Starting mockery config-file=/.../app/.mockery.yaml version=v3.7.3
=== ชื่อไฟล์: mockery.yaml ===
FTL app failed error="getting config: discovering mockery config: file not found"

6 · config ที่ init สร้างจริง — 27 บรรทัด ไม่ใช่ 8 ฟิลด์

$ cat .mockery.yml
all: false
dir: '{{.InterfaceDir}}'
filename: mocks_test.go
force-file-write: true
formatter: goimports
formatter-options:
  goimports:
    all-errors: false
    comments: true
    format-only: true
    fragment: false
    local-prefix: ""
    tab-indent: true
    tab-width: 8
generate: true
include-auto-generated: false
log-level: info
structname: '{{.Mock}}{{.InterfaceName}}'
pkgname: '{{.SrcPackageName}}'
recursive: false
require-template-schema-exists: true
template: testify
template-schema: '{{.Template}}.schema.json'
packages:
  example.com/shop:
    config:
      all: true

อ่านทีละบรรทัดเฉพาะตัวที่เปลี่ยนชีวิตคุณจริง ๆ:

7 · รัน mockery แล้วรู้ได้ยังไงว่าสำเร็จ

คำตอบที่คนส่วนใหญ่ใช้คือ exit code — และมันใช้ไม่ได้กับเครื่องมือตัวนี้

INF Starting mockery config-file=...
INF Parsing configured packages...
INF Done parsing configured packages.
EXITCODE=0

INF Parsing configured packages...
INF Done parsing configured packages.
INF adding interface to collection
    interface=UserRepository
INF Executing template file=.../mocks_test.go
INF Writing template to file file=.../mocks_test.go

แก้ได้สองทาง ยืนยันแล้วทั้งคู่ — ทางที่ผมชอบกว่าคือเติมบรรทัดเดียว:

packages:
  example.com/shop:
    config:
      all: true
      # ← บรรทัดที่เปลี่ยน "รันแล้วเงียบ" เป็น "ใช้งานได้"
      recursive: true

(คอมเมนต์ในไฟล์ YAML ขึ้นต้นด้วย # ไม่ใช่ // แบบ Go — ใส่ // ลงไปจะกลายเป็นส่วนหนึ่งของค่า แล้ว recursive จะไม่ทำงาน)

เหตุผลที่ต้องเติม: mockery init เขียน key เป็น module root (example.com/shop) ซึ่งคือโฟลเดอร์บนสุด ที่มักมีแต่ go.mod กับโฟลเดอร์ย่อย ไม่มีไฟล์ .go เลย พอ recursive: false mockery จึงมองแค่ชั้นนั้นชั้นเดียว ไม่เจอ interface ที่อยู่ในโฟลเดอร์ย่อย user/ แล้วก็จบงานเงียบ ๆ

$ mockery
INF adding interface to collection collection=/.../app/user/mocks_test.go
    interface=UserRepository package-path=example.com/shop/user version=v3.7.3
INF Writing template to file file=/.../app/user/mocks_test.go

อีกทางคือเปลี่ยน key ให้เป็น package path เต็ม เช่น example.com/shop/user: แทน module root — ตรงกว่าแต่ต้องมาเติมทุกครั้งที่มี package ใหม่

8 · mock ที่ได้ออกมา หน้าตาเป็นยังไง

ไฟล์ที่ generate มา 193 บรรทัด ขึ้นต้นด้วยบรรทัดที่บอกชัดว่าอย่าไปแก้:

// Code generated by mockery; DO NOT EDIT.
// github.com/vektra/mockery
// template: testify

package user

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

// NewMockUserRepository creates a new instance of MockUserRepository. It also
// registers a testing interface on the mock and a cleanup function to assert
// the mocks expectations.
func NewMockUserRepository(t interface {
    mock.TestingT
    Cleanup(func())
}) *MockUserRepository {
    mock := &MockUserRepository{}
    mock.Mock.Test(t)

    t.Cleanup(func() { mock.AssertExpectations(t) })

    return mock
}

type MockUserRepository struct {
    mock.Mock
}

อ่านบรรทัดพารามิเตอร์ก่อน มันหน้าตาแปลกกว่า interface ที่เคยเจอใน บทเรียน 10: t interface { mock.TestingT; Cleanup(func()) } คือการ ประกาศ interface คาไว้ตรงนั้นเลยโดยไม่ตั้งชื่อ อ่านว่า "รับอะไรก็ได้ที่ทำได้สองอย่าง: ทำสิ่งที่ mock.TestingT ต้องการ (Errorf, FailNow) และมี method Cleanup(func())"
แล้วอะไรที่เข้าเงื่อนไขนี้? *testing.T ที่คุณใช้มาตั้งแต่ บทเรียน 15 นั่นเอง — ตาม duck typing ของบทเรียน 10 มันเข้าเงื่อนไขโดยไม่ต้องประกาศอะไรเพิ่ม เวลาใช้จริงจึงเขียนแค่ NewMockUserRepository(t)
เหตุผลที่ mockery เขียนแบบนี้แทนที่จะรับ *testing.T ตรง ๆ คือจะได้รับ *testing.B (benchmark) หรือ mock ตัวอื่นได้ด้วย

ถัดมาคือ method จริงที่ implement interface ให้:

func (_mock *MockUserRepository) GetByID(id int) (*User, error) {
    ret := _mock.Called(id)

    if len(ret) == 0 {
        panic("no return value specified for GetByID")
    }
    ...
}

และชั้น EXPECT() ที่เป็นพระเอกของ v3:

func (_m *MockUserRepository) EXPECT() *MockUserRepository_Expecter {
    return &MockUserRepository_Expecter{mock: &_m.Mock}
}

// GetByID is a helper method to define mock.On call
//   - id int
func (_e *MockUserRepository_Expecter) GetByID(id any) *MockUserRepository_GetByID_Call {
    return &MockUserRepository_GetByID_Call{Call: _e.mock.On("GetByID", id)}
}

func (_c *MockUserRepository_GetByID_Call) Return(user *User, err error) *MockUserRepository_GetByID_Call {
    _c.Call.Return(user, err)
    return _c
}

func (_c *MockUserRepository_GetByID_Call) RunAndReturn(run func(id int) (*User, error)) *MockUserRepository_GetByID_Call {
    _c.Call.Return(run)
    return _c
}

9 · เขียนเทสจริงด้วย mock ที่ได้มา

นี่คือ interface ต้นทางทั้งหมด — 3 method เท่าที่เห็นในหัวข้อ 1:

type UserRepository interface {
    GetByID(id int) (*User, error)
    Save(u *User) error
    CountActive() int
}

func (s *Service) DisplayName(id int) (string, error) {
    u, err := s.repo.GetByID(id)
    if err != nil {
        return "", err
    }
    return "Mr. " + u.Name, nil
}

func (s *Service) Register(name, email string) error {
    if email == "" {
        return errors.New("email required")
    }
    return s.repo.Save(&User{Name: name, Email: email})
}

และนี่คือเทส 5 เคสที่รันผ่านจริง — สังเกตว่าไม่มี AssertExpectations สักบรรทัด:

func TestDisplayName_OK(t *testing.T) {
    repo := NewMockUserRepository(t)
    repo.EXPECT().GetByID(7).Return(&User{ID: 7, Name: "Somchai"}, nil)

    svc := NewService(repo)
    got, err := svc.DisplayName(7)

    assert.NoError(t, err)
    assert.Equal(t, "Mr. Somchai", got)
}

func TestDisplayName_RepoError(t *testing.T) {
    repo := NewMockUserRepository(t)
    repo.EXPECT().GetByID(99).Return(nil, ErrNotFound)

    svc := NewService(repo)
    _, err := svc.DisplayName(99)

    assert.ErrorIs(t, err, ErrNotFound)   // errors.Is จากบทเรียน 12
}

func TestRegister_UsesMatcher(t *testing.T) {
    repo := NewMockUserRepository(t)
    repo.EXPECT().Save(mock.MatchedBy(func(u *User) bool {
        return u.Email == "a@b.com"
    })).Return(nil)

    svc := NewService(repo)
    assert.NoError(t, svc.Register("Ann", "a@b.com"))
}

func TestRegister_NoEmail_RepoNeverCalled(t *testing.T) {
    repo := NewMockUserRepository(t)
    // ไม่ตั้ง expectation เลย
    svc := NewService(repo)
    err := svc.Register("Ann", "")
    assert.Error(t, err)
    repo.AssertNotCalled(t, "Save", mock.Anything)
}

func TestOldStyle_OnStillWorks(t *testing.T) {
    repo := NewMockUserRepository(t)
    repo.On("GetByID", 1).Return(&User{ID: 1, Name: "Old"}, nil)

    svc := NewService(repo)
    got, err := svc.DisplayName(1)
    assert.NoError(t, err)
    assert.Equal(t, "Mr. Old", got)
}

$ go test ./... -v
=== RUN   TestDisplayName_OK
--- PASS: TestDisplayName_OK (0.00s)
=== RUN   TestDisplayName_RepoError
--- PASS: TestDisplayName_RepoError (0.00s)
=== RUN   TestRegister_UsesMatcher
--- PASS: TestRegister_UsesMatcher (0.00s)
=== RUN   TestRegister_NoEmail_RepoNeverCalled
--- PASS: TestRegister_NoEmail_RepoNeverCalled (0.00s)
=== RUN   TestOldStyle_OnStillWorks
--- PASS: TestOldStyle_OnStillWorks (0.00s)
PASS
ok  	example.com/shop/user	0.245s

10 · กับดัก — อาการที่ทำให้มือใหม่งงที่สุด

เทสตกทั้งที่โค้ด production ถูก · error ชี้ไปที่ไฟล์ที่เราไม่ได้เขียน · ขึ้นมาสามก้อนพร้อมกัน — นี่คือกับดักที่คุณจะเจอบ่อยที่สุด

func TestTrap_WrongArgument(t *testing.T) {
    repo := NewMockUserRepository(t)
    repo.EXPECT().GetByID(7).Return(&User{ID: 7, Name: "Somchai"}, nil)

    svc := NewService(repo)
    _, _ = svc.DisplayName(8)   // ← ส่ง 8 แต่ตั้ง expectation ไว้ที่ 7
}

=== RUN   TestTrap_WrongArgument
    mock.go:361:

        mock: Unexpected Method Call
        -----------------------------

        GetByID(int)
        		0: 8

        The closest call I have is:

        GetByID(int)
        		0: 7


        Diff: 0: FAIL:  (int=8) != (int=7)
        at: [/.../app/user/mocks_test.go:84 /.../app/user/user.go:29 /.../app/user/fail2_test.go:11]
    mocks_test.go:20: FAIL:	GetByID(int)
        		at: [/.../app/user/mocks_test.go:118 /.../app/user/fail2_test.go:8]
    mocks_test.go:20: FAIL: 0 out of 1 expectation(s) were met.
        	The code you are testing needs to make 1 more call(s).
--- FAIL: TestTrap_WrongArgument (0.00s)
FAIL
FAIL	example.com/shop/user	0.440s

กับดักฝาแฝด: ตั้ง expectation แล้วไม่ถูกเรียกเลย

อาการคล้ายกันแต่คนละสาเหตุ — และหน้าตา error ต่างกันชัดเจน ถ้าอ่านเป็นจะแยกออกทันที

=== RUN   TestTrap_ExpectationNeverCalled
    mocks_test.go:20: FAIL:	Save(*user.User)
        		at: [/.../app/user/mocks_test.go:169 /.../app/user/fail1_test.go:8]
    mocks_test.go:20: FAIL: 0 out of 1 expectation(s) were met.
        	The code you are testing needs to make 1 more call(s).
        	at: [/.../app/user/mocks_test.go:20 .../testing/testing.go:1317 ...]
--- FAIL: TestTrap_ExpectationNeverCalled (0.00s)
FAIL
FAIL	example.com/shop/user	0.457s

กับดักที่เหลือ ซึ่งเจอแน่ระหว่างทาง

INF Executing template file=/.../app/user/mocks_test.go
INF Writing template to file file=/.../app/user/mocks_test.go
ERR output file exists, can't write mocks file=/.../app/user/mocks_test.go force-file-write=false
FTL app failed error="outfile exists"

11 · แล้วตกลง mockery คุ้มไหม — ตัวเลขจริง

mock เขียนมือ  →  --- PASS  (บั๊กหลุดออก production)
mockery       →  Diff: 0: FAIL:  (int=8) != (int=7)

ทดสอบความเข้าใจ

=== RUN   TestTrap_ForgotReturn
--- FAIL: TestTrap_ForgotReturn (0.00s)
panic: no return value specified for CountActive [recovered, repanicked]

goroutine 35 [running]:
testing.tRunner.func1.2({0x1029efc20, 0x102a43f40})
	/Users/.../go/1.26.5/src/testing/testing.go:1974 +0x1a0
...
example.com/shop/user.(*MockUserRepository).CountActive(0x2baf863d6460?)
	/.../app/user/mocks_test.go:43 +0xb4
example.com/shop/user.TestTrap_ForgotReturn(0x2baf863fc6c8?)
	/.../app/user/fail3_test.go:9 +0x5c
FAIL	example.com/shop/user	0.547s

อ้างอิง

• Mockery — เอกสารทางการ · Configuration — รายการฟิลด์ทั้งหมดใน .mockery.yml
• github.com/vektra/mockery — source · เวอร์ชันที่ใช้ในบทนี้คือ v3.7.3
• pkg.go.dev — testify/mock — On · Return · Times · MatchedBy · Anything · AssertExpectations
• pkg.go.dev — testing.T.Cleanup — กลไกที่ทำให้ constructor ตรวจ expectation ให้เอง
• Go Modules Reference — go install — ทำไม binary ถึงไปอยู่ที่ $GOPATH/bin