Go Hello 函数编写单元测试

不念不忘少年蓝@ 2023-10-12 08:29 28阅读 0赞

#### 阅读目录 ####

*  示例
 *  编写测试规则
 *  Hello, YOU
 *  常量
 *  再次回到 Hello, world 子测试
 *  hello函数需要支持第二个参数
 *   *  重构 hello 函数
     *  最后一次重构

## 示例 ##

hello.go

package main
    
    import "fmt"
    
    func Hello() string {
        
    	return "Hello, world"
    }
    
    func main() {
        
    	fmt.Println(Hello())
    }

hello\_test.go

package main
    
    import "testing"
    
    func TestHello(t *testing.T) {
        
    	got := Hello()
    	want := "Hello, world"
    
    	if got != want {
        
    		t.Errorf("got %q want %q", got, want)
    	}
    }

PS D:\TEXT\test> go test
    PASS
    ok      test    0.204s
    PS D:\TEXT\test>

t.Errorf("got %q want %q", got, wants)

PS D:\TEXT\test> go test
    # test [test.test]
    .\hello_test.go:10:35: undefined: wants
    FAIL    test [build failed]
    PS D:\TEXT\test>

## 编写测试规则 ##

1 程序需要编写在 xxx\_test.go 文件中  
2 测试函数的命名必须以单词 Test 开始  
3 测试函数只接受一个参数 t \*testing.T

现在这些信息足以让我们明白，类型为 \*testing.T 的变量 t 是你在测试框架中的 「hook」，所以当你想让测试失败时可以执行 t.Fail() 之类的操作。

## Hello, YOU ##

hello\_test.go

package main
    
    import "testing"
    
    func TestHello(t *testing.T) {
        
        got := Hello("Chris")
        want := "Hello, Chris"
    
        if got != want {
        
            t.Errorf("got %q want %q", got, want)
        }
    }

现在运行 go test, 你应该会接收到一个编译错误：

PS D:\TEXT\test> go test
    # test [test.test]
    .\hello_test.go:6:15: too many arguments in call to Hello
            have (string)
            want ()
    FAIL    test [build failed]
    PS D:\TEXT\test>

## 常量 ##

package main
    
    import "fmt"
    
    const englishHelloPrefix = "Hello, "
    
    func Hello(name string) string {
        
    	return englishHelloPrefix + name
    }
    
    func main() {
        
    	fmt.Println(Hello("wgchen"))
    }

## 再次回到 Hello, world 子测试 ##

当我们的函数用空字符串调用时，它默认为打印 「Hello, World」 而不是 「Hello, 」。

首先编写一个新的失败测试

package main
    
    import "testing"
    
    func TestHello(t *testing.T) {
        
    
    	t.Run("saying hello to people", func(t *testing.T) {
        
    		got := Hello("Chris")
    		want := "Hello, Chris"
    
    		if got != want {
        
    			t.Errorf("got %q want %q", got, want)
    		}
    	})
    
    	t.Run("say 'Hello, World' when an empty string is supplied", func(t *testing.T) {
        
    		got := Hello("")
    		want := "Hello, World"
    
    		if got != want {
        
    			t.Errorf("got %q want %q", got, want)
    		}
    	})
    }

PS D:\TEXT\test> go test -v
    === RUN   TestHello
    === RUN   TestHello/saying_hello_to_people
    === RUN   TestHello/say_'Hello,_World'_when_an_empty_string_is_supplied
        hello_test.go:21: got "Hello, " want "Hello, World"
    --- FAIL: TestHello (0.00s)
        --- PASS: TestHello/saying_hello_to_people (0.00s)
        --- FAIL: TestHello/say_'Hello,_World'_when_an_empty_string_is_supplied (0.00s)
    FAIL
    exit status 1
    FAIL    test    0.204s
    PS D:\TEXT\test>

这里我们将介绍测试库中的另一个工具 —— 子测试。有时，对一个「事情」进行分组测试，然后再对不同场景进行子测试非常有效。

这种方法的一个好处是，您可以编写在其他测试中也可以使用的共享代码。

当我们检查信息是否符合预期时，会有重复的代码。

重构不 只 是针对生产代码！

重要的是，你的测试 清楚地说明 了代码需要做什么。

我们可以并且应该重构我们的测试

package main
    
    import "testing"
    
    func TestHello(t *testing.T) {
        
    
    	assertCorrectMessage := func(t *testing.T, got, want string) {
        
    		t.Helper()
    		if got != want {
        
    			t.Errorf("got %q want %q", got, want)
    		}
    	}
    
    	t.Run("saying hello to people", func(t *testing.T) {
        
    		got := Hello("Chris")
    		want := "Hello, Chris"
    		assertCorrectMessage(t, got, want)
    	})
    
    	t.Run("empty string defaults to 'World'", func(t *testing.T) {
        
    		got := Hello("")
    		want := "Hello, World"
    		assertCorrectMessage(t, got, want)
    	})
    
    }

PS D:\TEXT\test> go test -v
    === RUN   TestHello
    === RUN   TestHello/saying_hello_to_people
    === RUN   TestHello/empty_string_defaults_to_'World'
        hello_test.go:23: got "Hello, " want "Hello, World"
    --- FAIL: TestHello (0.00s)
        --- PASS: TestHello/saying_hello_to_people (0.00s)
        --- FAIL: TestHello/empty_string_defaults_to_'World' (0.00s)
    FAIL
    exit status 1
    FAIL    test    0.210s
    PS D:\TEXT\test>

t.Helper() 需要告诉测试套件这个方法是辅助函数。

通过这样做，当测试失败时所报告的行号将在 函数调用中 而不是在辅助函数内部。这将帮助其他开发人员更容易地跟踪问题。如果你仍然不理解，请注释掉它，使测试失败并观察测试输出。

现在我们有了一个很好的失败测试，让我们使用 if 修复代码。

package main
    
    import "fmt"
    
    const englishHelloPrefix = "Hello, "
    
    func Hello(name string) string {
        
    	if name == "" {
        
    		name = "World"
    	}
    	return englishHelloPrefix + name
    }
    
    func main() {
        
    	fmt.Println(Hello("s"))
    }

如果我们运行我们的测试，我们应该看到它满足新的需求，并且我们没有意外地破坏其他功能。

## hello函数需要支持第二个参数 ##

hello.go

hello\_test.go

package main
    
    import "testing"
    
    func TestHello(t *testing.T) {
        
    	assertCorrectMessage := func(t *testing.T, got, want string) {
        
    		t.Helper()
    		if got != want {
        
    			t.Errorf("got %q want %q", got, want)
    		}
    	}
    	t.Run("in Spanish", func(t *testing.T) {
        
    		got := Hello("Elodie", "Spanish")
    		want := "Hola, Elodie"
    		assertCorrectMessage(t, got, want)
    	})
    
    }

.\hello_test.go:7:26: too many arguments in call to Hello
            have (string, string)
            want (string)
    .\hello_test.go:9:3: undefined: assertCorrectMessage
    FAIL    test [build failed]
    PS D:\TEXT\test>

func Hello(name string, language string) string {
        
        if name == "" {
        
            name = "World"
        }
        return englishHelloPrefix + name
    }

./hello.go:15:19: not enough arguments in call to Hello
         have (string)
         want (string, string)

package main
    
    const englishHelloPrefix = "Hello, "
    
    func Hello(name string, language string) string {
        
    	if name == "" {
        
    		name = "World"
    	}
    
    	if language == "Spanish" {
        
    		return "Hola, " + name
    	}
    
    	return englishHelloPrefix + name
    }
    
    func main() {
        
    
    }

PS D:\TEXT\test> go test
    PASS
    ok      test    0.217s
    PS D:\TEXT\test>

### 重构 hello 函数 ###

const spanish = "Spanish"
    const englishHelloPrefix = "Hello, "
    const spanishHelloPrefix = "Hola, "
    
    func Hello(name string, language string) string {
        
        if name == "" {
        
            name = "World"
        }
    
        if language == spanish {
        
            return spanishHelloPrefix + name
        }
    
        return englishHelloPrefix + name
    }

### 最后一次重构 ###

func Hello(name string, language string) string {
        
        if name == "" {
        
            name = "World"
        }
    
        return greetingPrefix(language) + name
    }
    
    func greetingPrefix(language string) (prefix string) {
        
        switch language {
        
        case french:
            prefix = frenchHelloPrefix
        case spanish:
            prefix = spanishHelloPrefix
        default:
            prefix = englishHelloPrefix
        }
        return
    }