Test in Go: กฎเกมที่ต้องรู้ก่อนเขียนบรรทัดแรก

1 · ระดับของการทดสอบ — ปิรามิดเทส

              ╱╲
             ╱  ╲        E2E      น้อย · ช้า · แพง · เปราะ
            ╱────╲                 ทดสอบทั้งระบบเสมือนผู้ใช้จริง
           ╱      ╲
          ╱ Integr. ╲    Integration  ปานกลาง
         ╱──────────╲               ทดสอบว่าโมดูลคุยกันรู้เรื่อง
        ╱            ╲
       ╱  Unit Tests  ╲  Unit     เยอะ · เร็ว · ถูก · เสถียร
      ╱────────────────╲            ทดสอบฟังก์ชันเดียวแบบแยกเดี่ยว

2 · กฎข้อที่ 1: ชื่อไฟล์ต้องลงท้าย _test.go

// ไฟล์ชื่อ mytests.go (ไม่มี _test)
package notest

import "testing"

func TestSomething(t *testing.T) { t.Log("hi") }

admin_handler.go
admin_handler_test.go   ← วางไว้คู่กัน folder เดียวกัน

3 · กฎข้อที่ 2: ชื่อฟังก์ชันต้องขึ้นต้นด้วย Test

func TestDiscount(t *testing.T) {
    // โค้ดเทส
}

• ต้องขึ้นต้นด้วย Test (T ตัวใหญ่)
• ตัวถัดจาก Test ต้องเป็นตัวใหญ่หรือ _ — Testdiscount จะไม่ถูกมองว่าเป็นเทส
• รับ t *testing.T ตัวเดียว ไม่คืนค่าอะไร
• t คือตัวที่ test runner ส่งเข้ามาให้ควบคุมการทดสอบและเก็บผลลัพธ์ — รายละเอียดอยู่ใน บทเรียน 15

4 · กฎข้อที่ 3 (ข้อยกเว้นพิเศษ): 1 folder มีได้ 2 package

ปกติ Go บังคับว่า 1 folder = 1 package — แต่มีข้อยกเว้นเดียวในภาษา คือ package ที่ลงท้ายด้วย _test อยู่ร่วม folder เดียวกันได้ ทำให้เกิดสองสไตล์:

// calc_test.go
package calc      // ชื่อเดียวกับไฟล์จริง

import "testing"

func TestPrivate(t *testing.T) {
    // เรียก unexported ได้เลย
    if double(21) != 42 {
        t.Error("พัง")
    }
}

// calc_external_test.go
package calc_test   // ลงท้าย _test

import (
    "testing"
    "myapp/calc"   // ต้อง import!
)

func TestPublic(t *testing.T) {
    calc.Discount(100, 10)
}

package calc_test

func TestX(t *testing.T) {
    calc.double(3)   // double เป็น unexported
}

5 · คำสั่ง go test

go test [options] [packages]

packages — จะรันตรงไหน

options ที่ใช้จริงทุกวัน

-count=1 สำคัญกว่าที่คิด

$ go test .
ok  	day5check	0.212s

$ go test .
ok  	day5check	(cached)      ← ไม่ได้รันจริง! ใช้ผลเดิม

$ go test -count=1 .
ok  	day5check	0.207s      ← บังคับรันใหม่

Go จำผลเทสรอบก่อนไว้ถ้าโค้ดไม่เปลี่ยน เรียกว่า cache ปกติแล้วดี เพราะรันซ้ำได้เร็วมาก แต่ถ้าเทสของคุณพึ่งพาสิ่งภายนอกที่ Go มองไม่เห็น (เวลา, database, network) ผลที่ cache ไว้จะหลอกคุณได้
-count=1 คือวิธีมาตรฐานในการปิด cache ส่วน -count=10 ใช้จับ flaky test — เทสที่บางทีผ่านบางทีไม่ผ่าน

-run เจาะจงถึง subtest ได้

subtest = เทสย่อยที่ซ้อนอยู่ข้างในเทสตัวใหญ่อีกที (วิธีเขียนอยู่ในบทเรียน 16) · ส่วน -run รับ regex คือรูปแบบข้อความเอาไว้จับคู่ชื่อ ไม่ใช่ชื่อเต็ม ๆ จึงใส่ | เพื่อบอกว่า “ตัวนี้หรือตัวนั้น” ได้

go test -v -run 'TestCalculateDiscount' .            # ทั้งฟังก์ชัน
go test -v -run 'TestCalculateDiscount/ลด_10' .    # เฉพาะ subtest
go test -v -run 'TestUser|TestOrder' .            # regex OR

6 · Coverage — ดูว่าโค้ดบรรทัดไหนยังไม่ถูกเทส

# รันเทส + บันทึกข้อมูล coverage ลงไฟล์
go test -coverprofile=c.out .

# เปิดดูเป็นตาราง
go tool cover -func=c.out

# เปิดดูเป็นหน้าเว็บ ระบายสีทีละบรรทัด
go tool cover -html=c.out

ผลรันจริงของ -func:

day5check/calc.go:7:   CalculateDiscount   100.0%
day5check/calc.go:14:  Division              0.0%   ← ยังไม่มีเทสเลย
day5check/calc.go:21:  double                0.0%
total:                 (statements)          42.9%

7 · Build tag — แยก integration test ออกจาก unit test

//go:build integration
                              ← ต้องเว้นบรรทัดว่างก่อน package เสมอ
package user

import "testing"

func TestRealDatabase(t *testing.T) {
    // เทสที่ต้องต่อ database จริง
}

$ go test ./...                          # unit test เท่านั้น — เร็ว
ok  	day5check	0.433s                   ← TestRealDatabase ไม่ถูกนับเข้ามาเลย

$ go test -v ./... | grep RealDatabase   # พิสูจน์ว่ามันหายไปจริง
(ไม่มีบรรทัดไหนออกมา)

$ go test -v -tags integration ./...     # รวม integration ด้วย
=== RUN   TestRealDatabase
--- PASS: TestRealDatabase (0.00s)
=== RUN   TestHi
--- PASS: TestHi (0.00s)
PASS
ok  	day5check	0.434s

วิธีเช็คที่ชัวร์ที่สุดคือดูว่าชื่อเทสโผล่ใน -v หรือไม่ — อย่าดูแค่บรรทัด ok เพราะถ้าใน package ยังมีเทสตัวอื่นอยู่ มันก็ขึ้น ok เหมือนเดิม

8 · ทดสอบความจำ

9 · ลงมือทำ

อ่านต่อจากต้นทาง

แหล่งหลักที่แนะนำ: Add a test — Go tutorial สั้นมาก (10 นาที) พาเขียนเทสตัวแรกจนรันได้จริง พออยากรู้ว่ามี option อะไรบ้างครบ ๆ ให้สั่ง go help test และ go help testflag ในเทอร์มินัล — เอกสารอยู่ในเครื่องคุณอยู่แล้ว ไม่ต้องเปิดเว็บ

อ้างอิง

• Add a test — tutorial ทางการ เขียนเทสตัวแรก
• pkg.go.dev — testing — เอกสารของ package testing ทั้งหมด
• cmd/go — Test packages — กฎการหาไฟล์เทสและ package _test
• cmd/go — Testing flags — รายการ flag ครบทุกตัว
• cmd/go — Build constraints — กฎของ //go:build
• The Go Blog — The cover story — coverage ทำงานยังไงข้างใน