如何测试Golang命令行输出

Question

我希望测试一个 Golang 命令行应用程序的输出，但是我不太确定如何使用 Go 的测试库来做到这一点。

假设我有一个像这样的程序：

package main

import (
    "flag"
    "fmt"
)

func main() {
    const (
        cityDefault = "San Francisco"
        cityDoc     = "the city you want the forecast for"
    )
    var city string
    flag.StringVar(&city, "city", cityDefault, cityDoc)
    flag.StringVar(&city, "c", cityDefault, cityDoc)
    flag.Parse()

    fmt.Println(city)
}

我想测试这两个：

$ ./myapp -c "Los Angeles"
$ ./myapp -city "Los Angeles"

...输出失落的天使。所以，我想问题是，如何集成测试golang命令行应用程序的输出？

- Elliot Larson

---

@TheHippo 我的问题实际上并不是关于如何测试标志本身的。我给出的示例有点类似于这种情况，但主要是因为它是一个微不足道的示例。想象一下一个更复杂的应用程序，在其中有许多其他独立测试的功能部件。我想对使用这些部件的应用程序的输出进行集成测试。 - Elliot Larson

Answer 1

这是一个解析命令行参数的不良示例，但它展示了我在应用程序中测试命令行参数所使用的框架。

main.go

package main

import (
    "log"
    "os"
)

func main() {
    var city string
    parseFlags(&city, os.Args)

    log.Println(city)
}

func parseFlags(result *string, args []string) {
    cityDefault := "San Francisco"

    switch len(args) {
    case 3:
        *result = args[2]
    default:
        *result = cityDefault
    }
}

main_unit_test.go

package main

import (
    "log"
    "testing"
)

// TestParseFlags - test our command line flags
func TestParseFlags(t *testing.T) {
    var parseFlagsTests = []struct {
        flags    []string // input flags to the command line
        expected string   // expected
    }{
        {[]string{"/fake/loc/main"}, "San Francisco"},
        {[]string{"/fake/loc/main", "-c", "Los Angeles"}, "Los Angeles"},
        {[]string{"/fake/loc/main", "--city", "Los Angeles"}, "Los Angeles"},
    }

    for _, tt := range parseFlagsTests {
        var output string
        parseFlags(&output, tt.flags)
        if output != tt.expected {
            t.Errorf("expected: %s, actual: %s", tt.expected, output)
        }
    }
}

我通常使用这个包来解析所有应用程序中的命令行参数。我将按照以下结构编写代码（未显示测试，但它们通常遵循上面所示的要点）：

main.go

package main

import (
    "log"
    "os"

    "myDir/cli"
)

func main() {
    // Grab the user inputed CLI flags
    cliFlags := cli.FlagsStruct{}
    cliErr := cli.StartCLI(&cliFlags, os.Args)
    if cliErr != nil {
        log.Println("Error grabbing command line args")
        log.Fatal(cliErr)
    }

    // Do stuff ...
}

/myDir/cli.go

package cli

import "github.com/urfave/cli"

// FlagsStruct - holds command line args
type FlagsStruct struct {
    MyFlag string
}

// StartCLI - gathers command line args
func StartCLI(cliFlags *FlagsStruct, args []string) error {
    app := cli.NewApp()
    app.Action = func(ctx *cli.Context) error {
        MyFlag := ctx.GlobalString("my-flag")

        // build the cli struct to send back to main
        cliFlags.MyFlag = MyFlag
        return nil
    }
    app.Authors = []cli.Author{
        {
            Email: "[e-mail]",
            Name:  "Adam Hanna",
        },
    }
    app.Flags = []cli.Flag{
        cli.StringFlag{
            Name:  "my-flag, f",
            Usage: "My flag usage goes here",
            Value: "myDefault",
        },
    }
    app.Name = "myAppName"
    app.Usage = "My App's Usage"
    app.Version = "0.0.1"
    return app.Run(args)
}

- Adam

Answer 2

如何使用 test "$(./myapp -c "洛杉矶")" = "洛杉矶"，以及对于-city也是一样的。这与Go无关，只需将此测试交给您的集成测试套件即可。

- Volker

---

当然，这很有道理。我想我希望你能给我更多关于如何做到这一点的指导。但是，我猜这最终会变得太过开放，不适合在Stack Overflow上回答，因为它会演变成一个充满个人意见的工具链讨论（天哪）。不过，我认为这指引了我正确的方向。谢谢。 - Elliot Larson