登录
首页 >  Golang >  Go问答

进行快照测试的步骤是什么?

来源:stackoverflow

时间:2024-03-21 19:30:39 225浏览 收藏

进行快照测试的步骤涉及使用“黄金文件”技术。黄金文件是与测试一起存储在 `testdata` 文件夹中的测试数据。测试本身包含一个 `update` 标志,允许更新黄金文件,从而无需手动维护输出。在测试中,渲染的模板与黄金文件中的预期输出进行比较。如果两者不匹配,则测试失败。这种方法避免了在测试文件中重复写入期望值,使快照测试能够轻松生成和维护。

问题内容

测试包支持快照测试吗?

这是我的案例:

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 快照测试之类的东西


解决方案


据我所知,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

以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于Golang的相关知识,也可关注golang学习网公众号。

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>