Wie testen Sie eine Funktion Ausgabe (stdout/stderr) in Go unit-tests

Habe ich eine einfache Funktion, die ich testen möchte:

func (t *Thing) print(min_verbosity int, message string) {
    if t.verbosity >= minv {
        fmt.Print(message)
    }
}

Aber wie kann ich testen, was die Funktion eigentlich sendet auf der standard-Ausgabe? Test::Output tut, was ich will in Perl. Ich weiß, ich könnte schreiben, die alle meine eigene boilerplate, das gleiche zu tun in der Go (wie beschrieben hier):

orig = os.Stdout
r,w,_ = os.Pipe()
thing.print("Some message")
var buf bytes.Buffer
io.Copy(&buf, r)
w.Close()
os.Stdout = orig
if(buf.String() != "Some message") {
    t.Error("Failure!")
}

Aber das ist viel zusätzliche Arbeit für jeden einzelnen test. Ich hoffe, es gibt ein standard-Art, oder vielleicht eine Abstraktion, die Bibliothek zu handhaben.

InformationsquelleAutor Flimzy | 2014-11-07
  1. 25

    Einer Sache auch Bedenken, es gibt nichts hindert Sie schreiben von Funktionen zu vermeiden, die boilerplate.

    Zum Beispiel habe ich ein Kommandozeilen-app, die verwendet log und ich schrieb diese Funktion:

    func captureOutput(f func()) string {
    var buf bytes.Buffer
    log.SetOutput(&buf)
    f()
    log.SetOutput(os.Stderr)
    return buf.String()
}

    Dann verwendet es wie folgt:

    output := captureOutput(func() {
    client.RemoveCertificate("www.example.com")
})
assert.Equal("removed certificate www.example.com\n", output)

    Verwendung dieser assert-Bibliothek: http://godoc.org/github.com/stretchr/testify/assert.

    • Dies ist wahrscheinlich, was ich tun werde, da es eine allgemeinere Lösung als @Ainar-G, die erfordert, dass ich das alles Steuern Sie den code, die möglicherweise Ausgabe etwas.
    InformationsquelleAutor Caleb
  2. 15

    Können Sie eines von zwei Dingen tun. Die erste ist die Verwendung Beispiele.

    Das Paket auch ausgeführt und überprüft, Beispiel-code. Beispiel-Funktionen gehören die Abschluss-line-Kommentar beginnt mit "Output:" und der ist im Vergleich mit den standard-output der Funktion, wenn die tests ausgeführt werden. (Der Vergleich ignoriert führende und nachfolgende Leerzeichen.) Die folgenden Beispiele verdeutlichen ein Beispiel:

    func ExampleHello() {
        fmt.Println("hello")
        //Output: hello
}

    Den zweiten (und passender, IMO) ist die Verwendung von fake-Funktionen für Ihre IO. In Ihrem code können Sie tun:

    var myPrint = fmt.Print

func (t *Thing) print(min_verbosity int, message string) {
    if t.verbosity >= minv {
        myPrint(message) //N.B.
    }
}

    Und in den tests:

    func init() {
    myPrint = fakePrint //fakePrint records everything it's supposed to print.
}

func Test...

    Andere Möglichkeit ist die Verwendung fmt.Fprintf mit einem io.Writer ist os.Stdout in der Produktion code, kann aber sagen bytes.Buffer in tests.

    • Beispiele sind gut, wenn Sie für deterministische Ausgang und fmt.Fprint ist gut für Sie, wenn Sie können Steuern, den Druck-code (die Sie nicht können, wenn Sie in eine externe Bibliothek oder so etwas). Ich denke, die meisten der Zeit diese Dinge werden wahr. Wenn es ist ein Fall, wo weder die wahr ist, eine option zu Lesen, was geschrieben wird os.Stdout in eine string-wäre schön.
    InformationsquelleAutor Ainar-G
  3. 1

    Könnten Sie überlegen, das hinzufügen einer return-Anweisung, um Ihre Funktion auf den string, der tatsächlich ausgedruckt. 

    func (t *Thing) print(min_verbosity int, message string) string {
    if t.verbosity >= minv {
        fmt.Print(message)
        return message
    }
    return ""
}

    Nun, Ihren test konnte nur überprüfen Sie die zurückgegebene Zeichenfolge gegen eine zu erwartende string (eher als die print-out). Vielleicht ein bisschen mehr in-line mit Test-Driven Development (TDD).

    Und, in Ihrer Produktions-code, nichts würde ändern müssen, da Sie nicht haben, weisen Sie den Rückgabewert einer Funktion, wenn Sie es nicht brauchen.

    InformationsquelleAutor Joe Bergevin
Schreibe einen Kommentar