【GoCN酷Go推薦】golang 打樁測試庫 gostub

1、gostub是什么？

GoStub是一款輕量級的單元測試框架，接口友好，可以對全局變量、函數(shù)或過程進(jìn)行打樁。

2、應(yīng)用場景有哪些？

場景1：打樁全局變量

場景2：打樁普通函數(shù)

場景3：打樁系統(tǒng)函數(shù)

3、常用方法有哪些？

func New() *Stubs

New返回用于打樁變量的*Stubs變量

func (s *Stubs) Reset()

Reset重置打樁的所有變量到其原始值

func (s *Stubs) ResetSingle(varToStub interface{})

ResetSingle重置打樁的單個(gè)變量到其原始值

func (s *Stubs) SetEnv(k, v string) *Stubs

SetEnv設(shè)置指定的環(huán)境變量到指定值

func (s *Stubs) UnsetEnv(k string) *Stubs

UnsetEnv還原指定環(huán)境變量的值

最常用的兩個(gè)函數(shù)如下

func (s *Stubs) Stub(varToStub interface{}, stubVal interface{}) *Stubs

Stub使用stubVal替代存儲在varToStub變量的值

varToStub必須是指向變量的指針。

stubVal是可賦值到變量的類型

func (s *Stubs) StubFunc(funcVarToStub interface{}, stubVal ...interface{}) *Stubs

StubFunc用返回stubval值的函數(shù)替換函數(shù)變量，返回*Stubs類型變量

funcVarToStub是指向函數(shù)變量的指針。如果函數(shù)返回多個(gè)值，返回的多個(gè)值被傳遞給StubFunc。

go get github.com/prashantv/gostub

3.1 打樁全局變量

//場景1:給全局變量打樁
func stubValue() {
   //初始值為100
   num := 100
   fmt.Println("origin value is:", num)

   //stub打樁后的值
   stubs := gostub.Stub(&num, 150)
   fmt.Println("after stub, value is:", num)

   //還原到之前的值
   stubs.Reset()
   fmt.Println("after stub reset, value is:", num)
}

3.2 打樁普通函數(shù)

//場景2:給普通函數(shù)打樁
func Exec(cmd string) (string, error) {
   return "hello world", errors.New("I am error!")
}
func stubFunc() {
   var (
      output string
   )

   //不能直接把Exec傳遞給gostub.StubFunc
   var Exec = Exec                                                               //very important!!!
   stubs := gostub.StubFunc(&Exec, "haolipeng", errors.New("stub error string")) //打樁

   output, _ = Exec("action") //調(diào)用函數(shù)

   fmt.Printf("output: %s\n", output) //驗(yàn)證結(jié)果

   stubs.Reset()
}

3.3 打樁系統(tǒng)庫函數(shù)

//場景3:給標(biāo)準(zhǔn)庫函數(shù)打樁(函數(shù)返回多返回值)
func stubLibraryFunc() {
   host, err := os.Hostname()
   if err == nil {
      fmt.Printf("host:%s\n", host)
   }

   var hostName = os.Hostname
   stubs := gostub.StubFunc(&hostName, "localhost", nil)
   host, err = hostName() //import
   if err == nil {
      fmt.Printf("after stub host:%s\n", host)
   }
   defer stubs.Reset()
}

3.4 打樁系統(tǒng)環(huán)境變量

//場景4：設(shè)置環(huán)境變量
func stubEnv() {
   stubs := gostub.New()
   stubs.SetEnv("GOSTUB_VAR", "test_value") //設(shè)置環(huán)境變量
   stubs.Reset()
}

gostub基本上滿足平時(shí)的測試需求，但是如果想更好的測試自己的程序，還需要搭配上其他的測試框架才行。