我正在尝试学习如何为我的代码编写测试以便编写更好的代码，但我似乎最难弄清楚如何实际测试我编写的一些代码。我读了很多教程，其中大部分似乎只涵盖了将两个数字相加或模拟某些数据库或服务器的函数。

我在下面编写了一个简单的函数，它将文本模板和 CSV 文件作为输入并使用 CSV 的值执行模板。我已经通过反复试验、传递文件和打印值“测试”了代码，但我想学习如何为它编写适当的测试。我觉得学习测试自己的代码会帮助我更快更好地理解和学习。感谢您的帮助。

// generateCmds generates configuration commands from a text template using
// the values from a CSV file. Multiple commands in the text template must
// be delimited by a semicolon. The first row of the CSV file is assumed to
// be the header row and the header values are used for key access in the
// text template.
func generateCmds(cmdTmpl string, filename string) ([]string, error) {
    t, err := template.New("cmds").Parse(cmdTmpl)
    if err != nil {
        return nil, fmt.Errorf("parsing template: %v", err)
    }

    f, err := os.Open(filename)
    if err != nil {
        return nil, fmt.Errorf("reading file: %v", err)
    }
    defer f.Close()

    records, err := csv.NewReader(f).ReadAll()
    if err != nil {
        return nil, fmt.Errorf("reading records: %v", err)
    }
    if len(records) == 0 {
        return nil, errors.New("no records to process")
    }

    var (
        b    bytes.Buffer
        cmds []string
        keys = records[0]
        vals = make(map[string]string, len(keys))
    )

    for _, rec := range records[1:] {
        for k, v := range rec {
            vals[keys[k]] = v
        }
        if err := t.Execute(&b, vals); err != nil {
            return nil, fmt.Errorf("executing template: %v", err)
        }
        for _, s := range strings.Split(b.String(), ";") {
            if cmd := strings.TrimSpace(s); cmd != "" {
                cmds = append(cmds, cmd)
            }
        }
        b.Reset()
    }
    return cmds, nil
}

编辑:感谢您迄今为止提出的所有建议!我的问题被标记为过于宽泛，因此我对我的示例有一些具体问题。

1. 测试表在这样的函数中有用吗？而且，如果是这样，测试结构是否需要包含返回的 cmds 字符串 slice 和 err 的值？例如:

type tmplTest struct {
    name     string   // test name
    tmpl     string   // the text template
    filename string   // CSV file with template values
    expected []string // expected configuration commands
    err      error    // expected error
}

1. 您如何处理应该针对特定测试用例返回的错误？例如，如果遇到错误，os.Open() 将返回类型为 *PathError 的错误。如何初始化与 os.Open() 返回的等效的 *PathError？ template.Parse()、template.Execute() 等的思路相同

编辑 2: 下面是我想出的一个测试函数。我在第一次编辑时提出的两个问题仍然有效。

package cmd

import (
    "testing"
    "strings"
    "path/filepath"
)

type tmplTest struct {
    name     string   // test name
    tmpl     string   // text template to execute
    filename string   // CSV containing template text values
    cmds     []string // expected configuration commands
}

var tests = []tmplTest{
    {"empty_error", ``, "", nil},
    {"file_error", ``, "fake_file.csv", nil},
    {"file_empty_error", ``, "empty.csv", nil},
    {"file_fmt_error", ``, "fmt_err.csv", nil},
    {"template_fmt_error", `{{ }{{`, "test_values.csv", nil},
    {"template_key_error", `{{.InvalidKey}}`, "test_values.csv", nil},
}

func TestGenerateCmds(t *testing.T) {
    for _, tc := range tests {
        t.Run(tc.name, func(t *testing.T) {
            cmds, err := generateCmds(tc.tmpl, filepath.Join("testdata", tc.filename))
            if err != nil {
                // Unexpected error. Fail the test.
                if !strings.Contains(tc.name, "error") {
                    t.Fatal(err)
                }
                // TODO: Otherwise, check that the function failed at the expected point.
            }
            if tc.cmds == nil && cmds != nil {
                t.Errorf("expected no commands; got %d", len(cmds))
            }
            if len(cmds) != len(tc.cmds) {
                t.Errorf("expected %d commands; got %d", len(tc.cmds), len(cmds))
            }
            for i := range cmds {
                if cmds[i] != tc.cmds[i] {
                    t.Errorf("expected %q; got %q", tc.cmds[i], cmds[i])
                }
            }
        })
    }
}

最佳答案

你基本上需要有一些示例文件，其中包含你要测试的内容，然后在你的测试代码中你可以调用 generateCmds 函数传入模板字符串和文件，然后验证结果如您所愿。

它与您可能在更简单的情况下看到的示例没有太大区别。

您可以将这些文件放在同一包内的 testdata 文件夹下(testdata 是 Go 工具在构建期间将忽略的特殊名称)。

然后你可以这样做:

func TestCSVProcessing(t *testing.T) {
    templateStr := `<your template here>`
    testFile := "testdata/yourtestfile.csv"
    result, err := generateCmds(templateStr, testFile)
    if err != nil {
        // fail the test here, unless you expected an error with this file
    }
    // compare the "result" contents with what you expected
    // failing the test if it does not match
}

编辑

关于你后面添加的具体问题:

Would a test table be useful in a function like this? And, if so, would the test struct need to include the returned cmds string slice and the value of err?

是的，包含要返回的预期字符串和预期错误(如果有)是有意义的。

How do you handle errors that are supposed to be returned for specific test cases? For example, os.Open() returns an error of type *PathError if an error is encountered. How do I initialize a *PathError that is equivalent to the one returned by os.Open()?

我认为您无法为每种情况“初始化”一个等效错误。有时，库可能会使用内部类型来解决错误，从而使这成为不可能。最简单的方法是使用 Error() 方法中返回的相同值“初始化”一个常规错误，然后只需将返回错误的 Error() 值与预期值进行比较.

关于unit-testing - 学习编写单元测试，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/51181347/