如何进行快照测试?

时间:2019-10-30 07:34:39

标签: go

testing软件包是否支持快照测试?

这是我的情况:

package main

import (
  "bytes"
  "fmt"
  "html/template"
)

func main() {
  query := `
    INSERT INTO "ADGROUP_PERFORMANCE_REPORT" (
      {{.columnPrefix}}_adgroup_id, 
      {{.columnPrefix}}_adgroup_nme, 
      {{.columnPrefix}}_adgroup_status, 
      {{.columnPrefix}}_campaign_id, 
      {{.columnPrefix}}_campaign_nme, 
      {{.columnPrefix}}_campaign_status, 
      {{.columnPrefix}}_clicks, 
      {{.columnPrefix}}_impressions, 
      {{.columnPrefix}}_ctr, 
      {{.columnPrefix}}_average_cpc, 
      {{.columnPrefix}}_cost, 
      {{.columnPrefix}}_conversions, 
      {{.columnPrefix}}_average_position, 
      {{.columnPrefix}}_device, 
      google_adwords_client_customer_id
    ) VALUES
  `
  vars := make(map[string]interface{})
  vars["columnPrefix"] = "adgroup_performance_report"
  result := processString(query, vars)
  fmt.Printf("result=%s\n", result)
}

func process(t *template.Template, vars interface{}) string {
  var tmplBytes bytes.Buffer
  err := t.Execute(&tmplBytes, vars)
  if err != nil {
    panic(err)
  }
  return tmplBytes.String()
}

func processString(str string, vars interface{}) string {
  tmpl, err := template.New("tmpl").Parse(str)
  if err != nil {
    panic(err)
  }
  return process(tmpl, vars)
}

现在,我将为此编写单元测试,我想使用快照测试来测试由html/template pkg处理的SQL查询字符串的结构。

这是标准输出中的输出:

result=
    INSERT INTO "ADGROUP_PERFORMANCE_REPORT" (
      adgroup_performance_report_adgroup_id, 
      adgroup_performance_report_adgroup_nme, 
      adgroup_performance_report_adgroup_status, 
      adgroup_performance_report_campaign_id, 
      adgroup_performance_report_campaign_nme, 
      adgroup_performance_report_campaign_status, 
      adgroup_performance_report_clicks, 
      adgroup_performance_report_impressions, 
      adgroup_performance_report_ctr, 
      adgroup_performance_report_average_cpc, 
      adgroup_performance_report_cost, 
      adgroup_performance_report_conversions, 
      adgroup_performance_report_average_position, 
      adgroup_performance_report_device, 
      google_adwords_client_customer_id
    ) VALUES

我不想在单元测试文件中重复写入该期望值并声明它。我更喜欢使用快照测试,它将生成一个快照文件。像jestjs snapshot-testing

1 个答案:

答案 0 :(得分:2)

据我所知,testing软件包不支持类似这样的东西。 Go有一种可以利用的模式,称为“黄金文件测试”。约定是将测试数据与测试一起存储在testdata文件夹中。在这种情况下,您可以将渲染的模板存储在所谓的“黄金文件”中。测试本身提供了一个update标志来写出最新版本(这样您就不必手动维护输出了):

var update = flag.Bool("update", false, "update .golden files")
func TestProcessString(t *testing.T) {
  vars := make(map[string]interface{})
  vars["columnPrefix"] = "adgroup_performance_report"
  actual := processString(query, vars)
  golden := filepath.Join(“testdata”, ”performance_report.golden”)
  if *update {
    ioutil.WriteFile(golden, actual, 0644)
  }
  expected, _ := ioutil.ReadFile(golden)

  if !bytes.Equal(actual, expected) {
    t.Fatalf("Output did not match, expected %v, recieved %v, expected, actual)
  }
}

可以在gofmt源代码:https://golang.org/src/cmd/gofmt/gofmt_test.go

中找到这种模式的一个很好的例子。