How to verify if a specific function is called

go mocking stubbing
Patrick picture Patrick · Sep 6, 2015 · Viewed 14.8k times · Source

I'm trying my hand at writing TDD in Go. I am however stuck at the following.

The test to write:

func TestFeatureStart(t *testing.T) {}

Implementation to test:

func (f *Feature) Start() error {
  cmd := exec.Command(f.Cmd)
  cmd.Start()
}

How would one test this simple bit? I figured I only wanted to verify that the exec library is spoken to correctly. That's the way I would do it in Java using Mockito. Can anyone help me write this test? From what I've read the usage of interfaces is suggested.

The Feature-struct only contains a string Cmd.

Answer

Ainar-G picture Ainar-G · Sep 6, 2015

You can fake the whole deal with interfaces, but you could also use fakeable functions. In the code:

var cmdStart = (*exec.Cmd).Start
func (f *Feature) Start() error {
    cmd := exec.Command(f.Cmd)
    return cmdStart(cmd)
}

In the tests:

called := false
cmdStart = func(*exec.Cmd) error { called = true; return nil }
f.Start()
if !called {
    t.Errorf("command didn't start")
}

See also: Andrew Gerrand's Testing Techniques talk.

Related questions

Mock functions in Go

I'm puzzled with dependencies. I want to be able to replace some function calls with mock ones. Here's a snippet of my code: func get_page(url string) string { get_dl_slot(url) defer free_dl_slot(url) resp, err := …

Read More
Make mock gin.Context in Golang

I'm writing a REST API using Gin framework. But I was faced a trouble testing my controllers and researching TDD and Mock. I tried to apply TDD and Mock to my code but I could not. I created a very …

Read More
Golang gorm mocking

I am using gorm in my projects. Can I mock this database orm for testing without database connection? The problem we have CI tools where I don't have database or database with enough data for testing. The other way, I …

Read More