Add the 'ColorOutput' server config option

hoisie · hoisie · commit 128d5dd585a2 · 2016-07-30T11:28:21.000-07:00
When this option is set to true, the log output will contain color escape sequences. Set it to false to disable color escape sequences. Inspired by xyproto@88b1a31 Resolves hoisie#153
diff --git a/server.go b/server.go
@@ -27,6 +27,7 @@ type ServerConfig struct {
 	CookieSecret string
 	RecoverPanic bool
 	Profiler     bool
+	ColorOutput  bool
 }
 
 // Server represents a web.go server.
@@ -284,10 +285,18 @@ func (s *Server) logRequest(ctx Context, sTime time.Time) {
 		client = req.RemoteAddr
 	}
 
-	fmt.Fprintf(&logEntry, "%s - \033[32;1m %s %s\033[0m - %v", client, req.Method, requestPath, duration)
+	if s.Config.ColorOutput {
+		fmt.Fprintf(&logEntry, "%s - \x1b[32;1m%s %s\x1b[0m - %v", client, req.Method, requestPath, duration)
+	} else {
+		fmt.Fprintf(&logEntry, "%s - %s %s - %v", client, req.Method, requestPath, duration)
+	}
 
 	if len(ctx.Params) > 0 {
-		fmt.Fprintf(&logEntry, " - \033[37;1mParams: %v\033[0m\n", ctx.Params)
+		if s.Config.ColorOutput {
+			fmt.Fprintf(&logEntry, " - \x1b[37;1mParams: %v\x1b[0m\n", ctx.Params)
+		} else {
+			fmt.Fprintf(&logEntry, " - Params: %v\n", ctx.Params)
+		}
 	}
 
 	ctx.Server.Logger.Print(logEntry.String())
diff --git a/web.go b/web.go
@@ -265,6 +265,7 @@ func SetLogger(logger *log.Logger) {
 // Config is the configuration of the main server.
 var Config = &ServerConfig{
 	RecoverPanic: true,
+	ColorOutput:  true,
 }
 
 var mainServer = NewServer()
diff --git a/web_test.go b/web_test.go
@@ -540,6 +540,45 @@ func TestDuplicateHeader(t *testing.T) {
 	}
 }
 
+// test that output contains ASCII color codes by default
+func TestColorOutputDefault(t *testing.T) {
+	s := NewServer()
+	var logOutput bytes.Buffer
+	logger := log.New(&logOutput, "", 0)
+	s.Logger = logger
+	s.Get("/test", func() string {
+		return "test"
+	})
+	req := buildTestRequest("GET", "/test", "", nil, nil)
+	var buf bytes.Buffer
+	iob := ioBuffer{input: nil, output: &buf}
+	c := scgiConn{wroteHeaders: false, req: req, headers: make(map[string][]string), fd: &iob}
+	s.Process(&c, req)
+	if !strings.Contains(logOutput.String(), "\x1b") {
+		t.Fatalf("The default log output does not seem to be colored")
+	}
+}
+
+// test that output contains ASCII color codes by default
+func TestNoColorOutput(t *testing.T) {
+	s := NewServer()
+	s.Config.ColorOutput = false
+	var logOutput bytes.Buffer
+	logger := log.New(&logOutput, "", 0)
+	s.Logger = logger
+	s.Get("/test", func() string {
+		return "test"
+	})
+	req := buildTestRequest("GET", "/test", "", nil, nil)
+	var buf bytes.Buffer
+	iob := ioBuffer{input: nil, output: &buf}
+	c := scgiConn{wroteHeaders: false, req: req, headers: make(map[string][]string), fd: &iob}
+	s.Process(&c, req)
+	if strings.Contains(logOutput.String(), "\x1b") {
+		t.Fatalf("The log contains color escape codes")
+	}
+}
+
 func BuildBasicAuthCredentials(user string, pass string) string {
 	s := user + ":" + pass
 	return "Basic " + base64.StdEncoding.EncodeToString([]byte(s))

Original file line number	Diff line number	Diff line change
`@@ -265,6 +265,7 @@ func SetLogger(logger *log.Logger) {`
`265`	`265`	`// Config is the configuration of the main server.`
`266`	`266`	`var Config = &ServerConfig{`
`267`	`267`	`RecoverPanic: true,`
	`268`	`+ ColorOutput: true,`
`268`	`269`	`}`
`269`	`270`
`270`	`271`	`var mainServer = NewServer()`