feat(logging): extract logging to its own package and write tests (#166)

Author: Joshua-Anderson

cmd/apps.go

@@ -6,13 +6,12 @@ import (
 	"strings"
 	"time"
 
-	"github.com/deis/pkg/prettyprint"
-
 	"github.com/deis/controller-sdk-go/api"
 	"github.com/deis/controller-sdk-go/apps"
 	"github.com/deis/controller-sdk-go/config"
 	"github.com/deis/controller-sdk-go/domains"
 	"github.com/deis/workflow-cli/pkg/git"
+	"github.com/deis/workflow-cli/pkg/logging"
 	"github.com/deis/workflow-cli/pkg/webbrowser"
 	"github.com/deis/workflow-cli/settings"
 )
@@ -177,20 +176,8 @@ func AppLogs(appID string, lines int) error {
 		return err
 	}
 
-	return printLogs(logs)
-}
-
-// printLogs prints each log line with a color matched to its category.
-func printLogs(logs string) error {
-	for _, log := range strings.Split(logs, `\n`) {
-		category := "unknown"
-		parts := strings.Split(strings.Split(log, " -- ")[0], " ")
-		category = parts[0]
-		colorVars := map[string]string{
-			"Color": chooseColor(category),
-			"Log":   log,
-		}
-		fmt.Println(prettyprint.ColorizeVars("{{.V.Color}}{{.V.Log}}{{.C.Default}}", colorVars))
+	for _, log := range strings.Split(strings.TrimRight(logs, `\n`), `\n`) {
+		logging.PrintLog(os.Stdout, log)
 	}
 
 	return nil

cmd/apps_test.go

@@ -2,21 +2,6 @@ package cmd
 
 import "testing"
 
-func TestPrintLogLinesBadLine(t *testing.T) {
-	t.Parallel()
-
-	// Regression test for https://github.com/deis/deis/issues/4420
-	logs := `\nDone preparing production files\n\n\u001b[4mRunning \"concat:plugins\" (concat) task\u001b[24m\n`
-	if err := printLogs(logs); err != nil {
-		t.Fatal(err)
-	}
-
-	logs = `\n\n\n`
-	if err := printLogs(logs); err != nil {
-		t.Fatal(err)
-	}
-}
-
 type expandURLCases struct {
 	Input    string
 	Expected string

cmd/colors_windows.go

@@ -14,5 +14,6 @@ import:
   - ssh/terminal
 - package: gopkg.in/yaml.v2
 - package: github.com/olekukonko/tablewriter
+- package: github.com/arschles/assert
 - package: github.com/deis/controller-sdk-go
   version: 09f8465bf5598f84987734082d22f4201632a320

glide.lock

@@ -0,0 +1,2 @@
+// Package logging is used to print deis application logs with colored output, when supported.
+package logging

glide.yaml

@@ -1,8 +1,14 @@
 // +build linux darwin
 
-package cmd
+package logging
 
-import "fmt"
+import (
+	"fmt"
+	"io"
+	"strings"
+
+	"github.com/deis/pkg/prettyprint"
+)
 
 const colorStringEscape = "\033[3%dm"
 
@@ -34,3 +40,15 @@ func chooseColor(input string) string {
 
 	return fmt.Sprintf(colorStringEscape, color)
 }
+
+// PrintLog prints a log line with a color matched to its category.
+func PrintLog(out io.Writer, log string) {
+	category := "unknown"
+	parts := strings.Split(strings.Split(log, " -- ")[0], " ")
+	category = parts[0]
+	colorVars := map[string]string{
+		"Color": chooseColor(category),
+		"Log":   log,
+	}
+	fmt.Fprintln(out, prettyprint.ColorizeVars("{{.V.Color}}{{.V.Log}}{{.C.Default}}", colorVars))
+}

pkg/logging/doc.go

@@ -0,0 +1,43 @@
+// +build linux darwin
+
+package logging
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/arschles/assert"
+)
+
+type colorsTestCase struct {
+	Input    string
+	Expected string
+}
+
+func TestChooseColor(t *testing.T) {
+	t.Parallel()
+
+	colors := []colorsTestCase{
+		{"INFO", "\033[35m"},
+		{"a", "\033[32m"},
+		{"b", "\033[33m"},
+		{"c", "\033[34m"},
+		{"d", "\033[39m"},
+		{"e", "\033[36m"},
+		{"f", "\033[31m"},
+	}
+	for _, color := range colors {
+		assert.Equal(t, chooseColor(color.Input), color.Expected, "color")
+	}
+}
+
+func TestPrintLogs(t *testing.T) {
+	var b bytes.Buffer
+	PrintLog(&b, "INFO [test]: testing")
+	assert.Equal(t, b.String(), "\033[35mINFO [test]: testing\033[0m\n", "log line")
+	b.Reset()
+	// Regression test for https://github.com/deis/deis/issues/4420
+	PrintLog(&b, "\nDone preparing production files\n\n\u001b[4mRunning \"concat:plugins\" (concat) task\u001b[24m\n")
+	assert.Equal(t, b.String(),
+		"\033[31m\nDone preparing production files\n\n\u001b[4mRunning \"concat:plugins\" (concat) task\u001b[24m\n\033[0m\n", "log line")
+}

cmd/colors_unix.go pkg/logging/log_unix.gocmd/colors_unix.go renamed to pkg/logging/log_unix.go

@@ -0,0 +1,14 @@
+// +build windows
+
+package logging
+
+import (
+	"fmt"
+	"io"
+)
+
+// PrintLog prints each log line. Windows doesn't support ansi escape codes,
+// so color is not printed.
+func PrintLog(out io.Writer, log string) {
+	fmt.Fprintln(out, log)
+}