Go中的高级单元测试模式（下）

lsekfe · 发表于 2022-3-4 10:10:28

　　在测试中使用外部数据
　　在Go中，你应该把测试的外部数据放在一个叫做testdata 的目录中。当你为你的程序构建二进制文件时，testdata 目录会被忽略，所以你可以使用这种方法来存储你想测试程序的输入。
　　例如，让我们写一个函数，从一个二进制文件生成base64 编码。

func getBase64Encoding(b []byte) string {
　　 return base64.StdEncoding.EncodeToString(b)
　　}

复制代码

　为了测试这个函数产生正确的输出，让我们把一些样本文件和它们相应的base64 编码放在我们项目根部的testdata 目录下。

　$ ls testdata
　　img1.jpg img1_base64.txt img2.jpg img2_base64.txt img3.jpg img3_base64.txt

复制代码

为了测试我们的getBase64Encoding() 功能，运行下面的代码。

func TestGetBase64Encoding(t *testing.T) {
　　 cases := []string{"img1", "img2", "img3"}
　　 for _, v := range cases {
　　 t.Run(v, func(t *testing.T) {
　　 b, err := os.ReadFile(filepath.Join("testdata", v+".jpg"))
　　 if err != nil {
　　 t.Fatal(err)
　　 }
　　 expected, err := os.ReadFile(filepath.Join("testdata", v+"_base64.txt"))
　　 if err != nil {
　　 t.Fatal(err)
　　 }
　　 got := getBase64Encoding(b)
　　 if string(expected) != got {
　　 t.Fatalf("Expected output to be: '%s', but got: '%s'", string(expected), got)
　　 }
　　 })
　　 }
　　}

复制代码

　从文件系统中读取每个样本文件的字节，然后送入getBase64Encoding() 函数。随后将输出与预期输出进行比较，预期输出也是从testdata 目录中获取的。
　　让我们通过在testdata 中创建一个子目录，使测试更容易维护。在我们的子目录中，我们将添加所有的输入文件，允许我们简单地迭代每个二进制文件，并比较实际输出和预期输出。
　　现在，我们可以添加更多的测试案例，而不需要接触源代码。

　$ go test -v
　　=== RUN TestGetBase64Encoding
　　=== RUN TestGetBase64Encoding/img1
　　=== RUN TestGetBase64Encoding/img2
　　=== RUN TestGetBase64Encoding/img3
　　--- PASS: TestGetBase64Encoding (0.04s)
　　 --- PASS: TestGetBase64Encoding/img1 (0.01s)
　　 --- PASS: TestGetBase64Encoding/img2 (0.01s)
　　 --- PASS: TestGetBase64Encoding/img3 (0.01s)
　　PASS
　　ok github.com/ayoisaiah/random 0.044s

复制代码

　使用黄金文件
　　如果你在使用Go模板，最好是测试一下生成的输出与预期的输出，以确认模板是否按预期工作。Go模板通常比较大，所以不建议像我们在本教程中迄今为止所做的那样在源代码中硬编码预期输出。
　　让我们来探讨一下Go模板的另一种方法，它可以在项目的整个生命周期内简化测试的编写和维护。
　　黄金文件是一种特殊类型的文件，包含测试的预期输出。测试函数从黄金文件中读取，将其内容与测试的预期输出进行比较。
　　在下面的例子中，我们将使用html/template ，生成一个HTML表格，其中包含库存中每本书的一行。

　　type Book struct {
　　 Name string
　　 Author string
　　 Publisher string
　　 Pages int
　　 PublishedYear int
　　 Price int
　　}
　　var tmpl = `<table class="table">
　　 <thead>
　　 <tr>
　　 <th>Name</th>
　　 <th>Author</th>
　　 <th>Publisher</th>
　　 <th>Pages</th>
　　 <th>Year</th>
　　 <th>Price</th>
　　 </tr>
　　 </thead>
　　 <tbody>
　　 {{ range . }}<tr>
　　 <td>{{ .Name }}</td>
　　 <td>{{ .Author }}</td>
　　 <td>{{ .Publisher }}</td>
　　 <td>{{ .Pages }}</td>
　　 <td>{{ .PublishedYear }}</td>
　　 <td>${{ .Price }}</td>
　　 </tr>{{ end }}
　　 </tbody>
　　</table>
　　`
　　var tpl = template.Must(template.New("table").Parse(tmpl))
　　func generateTable(books []Book, w io.Writer) error {
　　 return tpl.Execute(w, books)
　　}
　　func main() {
　　 books := []Book{
　　 {
　　 Name: "The Odessa File",
　　 Author: "Frederick Forsyth",
　　 Pages: 334,
　　 PublishedYear: 1979,
　　 Publisher: "Bantam",
　　 Price: 15,
　　 },
　　 }
　　 err := generateTable(books, os.Stdout)
　　 if err != nil {
　　 log.Fatal(err)
　　 }
　　}

复制代码

上面的generateTable() 函数从Book 对象的片断中创建HTML表。上面的代码将产生以下输出。

　$ go run main.go
　　<table class="table">
　　 <thead>
　　 <tr>
　　 <th>Name</th>
　　 <th>Author</th>
　　 <th>Publisher</th>
　　 <th>Pages</th>
　　 <th>Year</th>
　　 <th>Price</th>
　　 </tr>
　　 </thead>
　　 <tbody>
　　 <tr>
　　 <td>The Odessa File</td>
　　 <td>Frederick Forsyth</td>
　　 <td>Bantam</td>
　　 <td>334</td>
　　 <td>1979</td>
　　 <td>$15</td>
　　 </tr>
　　 </tbody>
　　</table>

复制代码

　为了测试上面的函数，我们将捕获实际结果并与预期结果进行比较。我们将像上一节那样把预期结果存储在testdata 目录中，然而，我们必须做一些改变。
　　假设我们在一个库存中拥有以下的书籍列表。

var inventory = []Book{
　　 {
　　 Name: "The Solitare Mystery",
　　 Author: "Jostein Gaarder",
　　 Publisher: "Farrar Straus Giroux",
　　 Pages: 351,
　　 PublishedYear: 1990,
　　 Price: 12,
　　 },
　　 {
　　 Name: "Also Known As",
　　 Author: "Robin Benway",
　　 Publisher: "Walker Books",
　　 Pages: 208,
　　 PublishedYear: 2013,
　　 Price: 10,
　　 },
　　 {
　　 Name: "Ego Is the Enemy",
　　 Author: "Ryan Holiday",
　　 Publisher: "Portfolio",
　　 Pages: 226,
　　 PublishedYear: 2016,
　　 Price: 18,
　　 },
　　}

复制代码

这个图书清单的预期输出将跨越许多行，因此，很难将其作为一个字符串字面放在源代码内。

<table class="table">
　　 <thead>
　　 <tr>
　　 <th>Name</th>
　　 <th>Author</th>
　　 <th>Publisher</th>
　　 <th>Pages</th>
　　 <th>Year</th>
　　 <th>Price</th>
　　 </tr>
　　 </thead>
　　 <tbody>
　　 <tr>
　　 <td>The Solitaire Mystery</td>
　　 <td>Jostein Gaarder</td>
　　 <td>Farrar Straus Giroux</td>
　　 <td>351</td>
　　 <td>1990</td>
　　 <td>$12</td>
　　 </tr>
　　 <tr>
　　 <td>Also Known As</td>
　　 <td>Robin Benway</td>
　　 <td>Walker Books</td>
　　 <td>308</td>
　　 <td>2013</td>
　　 <td>$10</td>
　　 </tr>
　　 <tr>
　　 <td>Ego Is The Enemy</td>
　　 <td>Ryan Holiday</td>
　　 <td>Portfolio</td>
　　 <td>226</td>
　　 <td>2016</td>
　　 <td>$18</td>
　　 </tr>
　　 </tbody>
　　</table>

复制代码

除了对较大的输出实用外，一个黄金文件可以自动更新和生成。
　　虽然可以写一个辅助函数来创建和更新黄金文件，但我们可以利用goldie，一个专门为黄金文件创建的工具。
　　用下面的命令安装最新版本的goldie。

　$ go get -u github.com/sebdah/goldie/v2

复制代码

让我们继续使用goldie来测试generateTable() 函数。

　func TestGenerateTable(t *testing.T) {
　　 var buf bytes.Buffer
　　 err := generateTable(inventory, &buf)
　　 if err != nil {
　　 t.Fatal(err)
　　 }
　　 actual := buf.Bytes()
　　 g := goldie.New(t)
　　 g.Assert(t, "books", actual)
　　}

复制代码

　　上面的测试在一个字节的缓冲区中捕获了generateTable() 函数的输出。然后，它将缓冲区的内容传递给goldie 实例的Assert() 方法。缓冲区中的内容将与testdata 目录中的books.golden 文件的内容进行比较。
　　最初，运行该测试会失败，因为我们还没有创建books.golden 文件。

$ go test -v
　　=== RUN TestGenerateTable
　　 main_test.go:48: Golden fixture not found. Try running with -update flag.
　　--- FAIL: TestGenerateTable (0.00s)
　　FAIL
　　exit status 1
　　FAIL github.com/ayoisaiah/random 0.006s

复制代码

错误信息建议我们添加-update 标志，这将用缓冲区的内容创建books.golden 文件。

$ go test -v -update
　　=== RUN TestGenerateTable
　　--- PASS: TestGenerateTable (0.00s)
　　PASS
　　ok github.com/ayoisaiah/random 0.006s

复制代码

在随后的运行中，我们应该删除-update 标志，这样我们的黄金文件就不会被不断地更新。
　　对模板的任何改变都会导致测试失败。例如，如果你将价格字段更新为欧元而不是美元，你会立即收到一个错误。这些错误的发生是因为generateTable() 函数的输出不再符合黄金文件的内容。
　　Goldie提供了差异功能，以帮助你在这些错误发生时发现变化。

$ go test -v
　　=== RUN TestGenerateTable
　　 main_test.go:48: Result did not match the golden fixture. Diff is below:
　　 --- Expected
　　 +++ Actual
　　 [url=home.php?mod=space&uid=40658]@@[/url] -18,3 +18,3 @@
　　 <td>1990</td>
　　 - <td>$12</td>
　　 + <td>€12</td>
　　 </tr><tr>
　　 @@ -25,3 +25,3 @@
　　 <td>2013</td>
　　 - <td>$10</td>
　　 + <td>€10</td>
　　 </tr><tr>
　　 @@ -32,3 +32,3 @@
　　 <td>2016</td>
　　 - <td>$18</td>
　　 + <td>€18</td>
　　 </tr>
　　--- FAIL: TestGenerateTable (0.00s)
　　FAIL
　　exit status 1
　　FAIL github.com/ayoisaiah/random 0.007s

复制代码

在上面的输出中，该变化被清楚地突出显示。这些变化是故意的，所以我们可以通过使用-update 标志更新黄金文件，使我们的测试再次通过。

　$ go test -v -update
　　=== RUN TestGenerateTable
　　--- PASS: TestGenerateTable (0.00s)
　　PASS
　　ok github.com/ayoisaiah/random 0.006s

复制代码

结论
　　在本教程中，我们研究了Go中的一些高级测试技术。首先，我们深入研究了我们的HTTP包，并学习了如何用自定义接口模拟我们的HTTP客户端。然后，我们回顾了如何在测试中使用外部数据并使用goldie创建黄金文件。

		自动登录	找回密码
密码			(注-册)加入51Testing

Go中的高级单元测试模式（下）

站长推荐 /1