From a7f7fb87410536c83d4541023d3d0b35ac781b86 Mon Sep 17 00:00:00 2001
From: Brad Fitzpatrick <brad@danga.com>
Date: Sun, 24 Nov 2013 15:04:20 -0800
Subject: [PATCH] serverconfig test: simplify pretty-printing, use test.Diff,
 add flag to update golden files

Change-Id: I8c259dad8fc6f161f25fb4f63f97c4aef4b703b0
---
 pkg/serverconfig/serverconfig_test.go | 74 ++++++++-------------------
 1 file changed, 22 insertions(+), 52 deletions(-)

diff --git a/pkg/serverconfig/serverconfig_test.go b/pkg/serverconfig/serverconfig_test.go
index ac66d3684..eb2085dd0 100644
--- a/pkg/serverconfig/serverconfig_test.go
+++ b/pkg/serverconfig/serverconfig_test.go
@@ -18,12 +18,13 @@ package serverconfig_test
 
 import (
 	"bytes"
+	"encoding/json"
 	"errors"
+	"flag"
 	"fmt"
 	"io"
 	"io/ioutil"
 	"os"
-	"os/exec"
 	"path/filepath"
 	"sort"
 	"strings"
@@ -31,8 +32,11 @@ import (
 
 	"camlistore.org/pkg/jsonconfig"
 	"camlistore.org/pkg/serverconfig"
+	"camlistore.org/pkg/test"
 )
 
+var updateGolden = flag.Bool("update_golden", false, "Update golden *.want files")
+
 func init() {
 	// Avoid Linux vs. OS X differences in tests.
 	serverconfig.SetTempDirFunc(func() string { return "/tmp" })
@@ -47,33 +51,12 @@ func sortedKeys(m map[string]interface{}) (keys []string) {
 	return
 }
 
-func prettyPrint(w io.Writer, i interface{}, indent int) {
-	switch ei := i.(type) {
-	case jsonconfig.Obj:
-		for _, k := range sortedKeys(map[string]interface{}(ei)) {
-			fmt.Fprintf(w, "\n")
-			fmt.Fprintf(w, "%s: ", k)
-			prettyPrint(w, ei[k], indent+1)
-		}
-		fmt.Fprintf(w, "\n")
-	case map[string]interface{}:
-		for _, k := range sortedKeys(ei) {
-			fmt.Fprintf(w, "\n")
-			for i := 0; i < indent; i++ {
-				fmt.Fprintf(w, "	")
-			}
-			fmt.Fprintf(w, "%s: ", k)
-			prettyPrint(w, ei[k], indent+1)
-		}
-		fmt.Fprintf(w, "\n")
-	case []interface{}:
-		fmt.Fprintf(w, "	")
-		for _, v := range ei {
-			prettyPrint(w, v, indent+1)
-		}
-	default:
-		fmt.Fprintf(w, "%v, ", i)
+func prettyPrint(t *testing.T, w io.Writer, i interface{}, indent int) {
+	out, err := json.MarshalIndent(i, "", "  ")
+	if err != nil {
+		t.Fatal(err)
 	}
+	w.Write(out)
 }
 
 func TestConfigs(t *testing.T) {
@@ -145,38 +128,25 @@ func testConfig(name string, t *testing.T) {
 		return
 	}
 
-	baseName := strings.Replace(filepath.Base(name), ".json", "", 1)
 	wantFile := strings.Replace(name, ".json", "-want.json", 1)
 	wantConf, err := configParser().ReadFile(wantFile)
 	if err != nil {
 		t.Fatalf("test %s: ReadFile: %v", name, err)
 	}
 	var got, want bytes.Buffer
-	prettyPrint(&got, lowLevelConf.Obj, 0)
-	prettyPrint(&want, wantConf, 0)
+	prettyPrint(t, &got, lowLevelConf.Obj, 0)
+	prettyPrint(t, &want, wantConf, 0)
 	if got.String() != want.String() {
-		tempGot := tempFile(baseName+"-got", got.Bytes())
-		tempWant := tempFile(baseName+"-want", want.Bytes())
-		defer os.Remove(tempGot.Name())
-		defer os.Remove(tempWant.Name())
-		diff, err := exec.Command("diff", "-u", tempWant.Name(), tempGot.Name()).Output()
-		if err != nil {
-			t.Logf("test %s diff failure: %v", name, err)
+		if *updateGolden {
+			contents, err := json.MarshalIndent(lowLevelConf.Obj, "", "\t")
+			if err != nil {
+				t.Fatal(err)
+			}
+			if err := ioutil.WriteFile(wantFile, contents, 0644); err != nil {
+				t.Fatal(err)
+			}
 		}
-		t.Errorf("test %s configurations differ.\nGot:\n%s\nWant:\n%s\nDiff:\n%s",
-			name, &got, &want, diff)
+		t.Errorf("test %s configurations differ.\nGot:\n%s\nWant:\n%s\nDiff (got -> want), %s:\n%s",
+			name, &got, &want, name, test.Diff(got.Bytes(), want.Bytes()))
 	}
 }
-
-func tempFile(prefix string, b []byte) *os.File {
-	f, err := ioutil.TempFile("", prefix+"-")
-	if err != nil {
-		panic(err)
-	}
-	_, err = f.Write(b)
-	if err != nil {
-		panic(err)
-	}
-	f.Close()
-	return f
-}