如何针对 Go 中的枚举对命令行标志值进行单元测试？

在 Go 中测试命令行标志

本文探讨了 Golang 中命令行标志的测试技术。具体来说，我们将研究如何针对枚举对标志值进行单元测试。

问题陈述

给出以下代码：

<code class="go">// Define flag for output format
var formatType string

// Constants representing valid format types
const (
    text = "text"
    json = "json"
    hash = "hash"
)

// Initialize flags
func init() {
    flag.StringVar(&formatType, "format", "text", "Desired output format")
}

// Main function
func main() {
    flag.Parse()
}</code>

我们希望编写一个单元测试来验证 -format 标志值是否与预定义常量之一匹配。

使用自定义标志类型的解决方案

要在更多中测试标志以灵活的方式，我们可以利用 flag.Var 函数和实现 Value 接口的自定义类型。

<code class="go">package main

import (
    "errors"
    "flag"
    "fmt"
)

// Custom type representing format type
type formatType string

// String() method for Value interface
func (f *formatType) String() string {
    return fmt.Sprint(*f)
}

// Set() method for Value interface
func (f *formatType) Set(value string) error {
    if len(*f) > 0 && *f != "text" {
        return errors.New("format flag already set")
    }
    if value != "text" && value != "json" && value != "hash" {
        return errors.New("Invalid Format Type")
    }
    *f = formatType(value)
    return nil
}

// Initialize flag with custom type
func init() {
    typeFlag := "text" // Default value
    usage := `Format type. Must be "text", "json" or "hash". Defaults to "text".`
    flag.Var(&typeFlag, "format", usage)
}

// Main function
func main() {
    flag.Parse()
    fmt.Println("Format type is", typeFlag)
}
</code>

在此解决方案中，flag.Var 接受一个指向满足 Value 接口的自定义类型的指针，允许我们在 Set 方法中定义自己的验证逻辑。

单元测试自定义标志类型

自定义标志类型的单元测试可以编写如下：

<code class="go">// Test unit validates that the format flag is within the enumeration
func TestFormatFlag(t *testing.T) {
    testCases := []struct {
        input       string
        expectedErr string
    }{
        {"text", ""},
        {"json", ""},
        {"hash", ""},
        {"", "Invalid Format Type"},
        {"xml", "Invalid Format Type"},
    }

    for _, tc := range testCases {
        t.Run(tc.input, func(t *testing.T) {
            args := []string{"-format", tc.input}
            flag.CommandLine = flag.NewFlagSet("test", flag.PanicOnError)
            err := flag.CommandLine.Parse(args)

            if err != nil && err.Error() != tc.expectedErr {
                t.Errorf("Unexpected error: %v", err)
                return
            }
        })
    }
}</code>

以上是如何针对 Go 中的枚举对命令行标志值进行单元测试？的详细内容。更多信息请关注PHP中文网其他相关文章！