String 如何让golang测试多行输出匹配

我有以下生成一些字符串输出的代码：

package formatter

import (
    "bytes"
    "log"
    "text/template"

    "github.com/foo/bar/internal/mapper"
)

// map of template functions that enable us to identify the final item within a
// collection being iterated over.
var fns = template.FuncMap{
    "plus1": func(x int) int {
        return x + 1
    },
}

// Dot renders our results in dot format for use with graphviz
func Dot(results []mapper.Page) string {
    dotTmpl := `digraph sitemap { {{range .}}
  "{{.URL}}"
    -> { {{$n := len .Anchors}}{{range  $i, $v := .Anchors}}
      "{{.}}"{{if eq (plus1 $i) $n}}{{else}},{{end}}{{end}}
    } {{end}}
}`

    tmpl, err := template.New("digraph").Funcs(fns).Parse(dotTmpl)
    if err != nil {
        log.Fatal(err)
    }

    var output bytes.Buffer
    if err := tmpl.Execute(&output, results); err != nil {
        log.Fatal(err)
    }

    return output.String()
}

它生成如下输出：

digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}

下面是此功能的测试

package formatter

import (
    "testing"

    "github.com/foo/bar/internal/mapper"
)

func TestDot(t *testing.T) {
    input := []mapper.Page{
        mapper.Page{
            URL: "http://www.example.com/",
            Anchors: []string{
                "http://www.example.com/foo",
                "http://www.example.com/bar",
                "http://www.example.com/baz",
            },
            Links: []string{
                "http://www.example.com/foo.css",
                "http://www.example.com/bar.css",
                "http://www.example.com/baz.css",
            },
            Scripts: []string{
                "http://www.example.com/foo.js",
                "http://www.example.com/bar.js",
                "http://www.example.com/baz.js",
            },
        },
    }

    output := `digraph sitemap {
      "http://www.example.com/"
          -> {
              "http://www.example.com/foo",
              "http://www.example.com/bar",
              "http://www.example.com/baz"
      }
    }`

    actual := Dot(input)

    if actual != output {
        t.Errorf("expected: %s\ngot: %s", output, actual)
    }
}

失败，出现以下错误（与输出的格式间距有关）

我试着调整我的test

output

变量，以便间距与实际代码的实际输出一致。那没用

我还尝试在我的输出变量和实际输出的内容上使用

strings.Replace（）

，奇怪的是，函数的输出（即使是通过

strings传递的）。Replace

仍然是多行的（因此测试会失败）

有人知道为了代码验证，我如何使输出一致吗

谢谢

更新 我尝试了@icza建议的方法，但仍然没有通过测试，尽管测试中的输出看起来更像预期的：

=== RUN   TestDot
--- FAIL: TestDot (0.00s)
    format_test.go:65: expected: digraph sitemap {
          "http://www.example.com/"
            -> {
              "http://www.example.com/foo",
              "http://www.example.com/bar",
              "http://www.example.com/baz"
            }
        }
        got: digraph sitemap { 
          "http://www.example.com/"
            -> { 
              "http://www.example.com/foo",
              "http://www.example.com/bar",
              "http://www.example.com/baz"
            }
        }

---

最简单的解决方案是在指定预期输出时在测试中使用相同的缩进（与在模板中使用的缩进相同）

你有：

output := `digraph sitemap {
  "http://www.example.com/"
      -> {
          "http://www.example.com/foo",
          "http://www.example.com/bar",
          "http://www.example.com/baz"
  }
}`

将其更改为：

    output := `digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

请注意，例如，最后一行没有缩进。当您使用原始字符串文字时，包括缩进字符在内的每个字符都是文字的一部分

创建正确的未缩进原始字符串文字的步骤

---

毕竟，这完全是一个非编码问题，而是一个编辑器自动格式化和定义原始字符串文字的问题。一个简单的方法是首先编写一个空的原始字符串文字，在其中添加一个空行，并清除编辑器插入的自动缩进：

    output := `
`

如果有此项，请在结束回勾之前复制粘贴正确的输入，例如：

    output := `
digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

作为最后一步，从原始字符串文字的第一行删除换行符，您就得到了正确的原始字符串文字：

    output := `digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

一旦你有了它，运行

gofmt

或编辑器的自动格式化就不会再干扰它了

更新：

我检查了您更新的测试结果，在您得到的结果中，第一行后面有一个空格：

digraph sitemap{

，第三行后面也有一个空格：

->{

，但您不会将它们添加到预期的输出中。也可以将它们添加到预期的输出中，或者从模板中删除这些空格！在比较字符串时，它们会按字节进行比较，每个字符（包括空格）都很重要

要从模板中删除这些额外空格，请执行以下操作：

    dotTmpl := `digraph sitemap { {{- range .}}
  "{{.URL}}"
    -> { {{- $n := len .Anchors}}{{range  $i, $v := .Anchors}}
      "{{.}}"{{if eq (plus1 $i) $n}}{{else}},{{end}}{{end}}
    } {{end}}
}`

---

注意

{-

的使用。这是添加到中的。

最简单的解决方案是在指定预期输出时在测试中使用相同的缩进（与在模板中使用的缩进相同）

你有：

output := `digraph sitemap {
  "http://www.example.com/"
      -> {
          "http://www.example.com/foo",
          "http://www.example.com/bar",
          "http://www.example.com/baz"
  }
}`

将其更改为：

    output := `digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

请注意，例如，最后一行没有缩进。当您使用原始字符串文字时，包括缩进字符在内的每个字符都是文字的一部分

创建正确的未缩进原始字符串文字的步骤

---

毕竟，这完全是一个非编码问题，而是一个编辑器自动格式化和定义原始字符串文字的问题。一个简单的方法是首先编写一个空的原始字符串文字，在其中添加一个空行，并清除编辑器插入的自动缩进：

    output := `
`

如果有此项，请在结束回勾之前复制粘贴正确的输入，例如：

    output := `
digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

作为最后一步，从原始字符串文字的第一行删除换行符，您就得到了正确的原始字符串文字：

    output := `digraph sitemap {
  "http://www.example.com/"
    -> {
      "http://www.example.com/foo",
      "http://www.example.com/bar",
      "http://www.example.com/baz"
    }
}`

一旦你有了它，运行

gofmt

或编辑器的自动格式化就不会再干扰它了

更新：

我检查了您更新的测试结果，在您得到的结果中，第一行后面有一个空格：

digraph sitemap{

，第三行后面也有一个空格：

->{

，但您不会将它们添加到预期的输出中。也可以将它们添加到预期的输出中，或者从模板中删除这些空格！在比较字符串时，它们会按字节进行比较，每个字符（包括空格）都很重要

要从模板中删除这些额外空格，请执行以下操作：

    dotTmpl := `digraph sitemap { {{- range .}}
  "{{.URL}}"
    -> { {{- $n := len .Anchors}}{{range  $i, $v := .Anchors}}
      "{{.}}"{{if eq (plus1 $i) $n}}{{else}},{{end}}{{end}}
    } {{end}}
}`

---

注意

{-

的用法。这是到，这是添加的。

问题是在格式化文本中

{

之后有一个额外的空间。这似乎是您的问题。您可以通过将格式字符串更改为此来修复它

`digraph sitemap {{{range .}}
  "{{.URL}}"
    -> {{{$n := len .Anchors}}{{range  $i, $v := .Anchors}}
      "{{.}}"{{if eq (plus1 $i) $n}}{{else}},{{end}}{{end}}
    }{{end}}
}`

---

问题在于，在格式化文本的

{

之后有一个额外的空格。这似乎是您的问题。您可以通过将格式字符串更改为

`digraph sitemap {{{range .}}
  "{{.URL}}"
    -> {{{$n := len .Anchors}}{{range  $i, $v := .Anchors}}
      "{{.}}"{{if eq (plus1 $i) $n}}{{else}},{{end}}{{end}}
    }{{end}}
}`

---

如果要忽略格式，可以使用

strings.Fields

output := strings.Fields(`digraph sitemap {
  "http://www.example.com/"
      -> {
          "http://www.example.com/foo",
          "http://www.example.com/bar",
          "http://www.example.com/baz"
  }
}`)

actual := strings.Fields(Dot(input))

if !equal(output,actual) {
    // ...
}

---

其中equal是一个比较两个切片的简单函数。

如果要忽略格式，可以使用

strings.Fields

output := strings.Fields(`digraph sitemap {
  "http://www.example.com/"
      -> {
          "http://www.example.com/foo",
          "http://www.example.com/bar",
          "http://www.example.com/baz"
  }
}`)

actual := strings.Fields(Dot(input))

if !equal(output,actual) {
    // ...
}

---

其中equal是一个比较两个切片的简单函数。

是的，这是我尝试过的，但我仍然失败了：-（它也感觉很微妙（我想我已经匹配好了，但显然我不希望它失败）因此，我想我更喜欢“leaf bebop”所描述的

strings.Fields

方法。当指定

output

变量时，第一行将缩进。这不是问题，重要的是反勾之间的内容。因此，当指定预期输出时，代码编辑器不得缩进后续行。编辑器如果您足够聪明，就不会自动缩进原始字符串文本中的内容。很容易出错，因为如果您在回退标记之间复制粘贴有效的输出，代码编辑器会将其格式化错误（自动缩进多行）。最简单的方法是编写变量声明，例如，

输出：=`

，然后在第一个回勾后按Enter键，清除缩进，然后复制粘贴有效输出（最后删除第一个换行符）。毕竟，这完全是一个非编码问题