Merge pull request #13166 from runcom/small-streamformatter-refactor

Refactor pkg/stremformatter - custom constructors

streamformatter/streamformatter.go

@@ -12,8 +12,14 @@ type StreamFormatter struct {
 	json bool
 }
 
-func NewStreamFormatter(json bool) *StreamFormatter {
+// NewStreamFormatter returns a simple StreamFormatter
-	return &StreamFormatter{json}
+func NewStreamFormatter() *StreamFormatter {
+	return &StreamFormatter{}
+}
+
+// NewJSONStreamFormatter returns a StreamFormatter configured to stream json
+func NewJSONStreamFormatter() *StreamFormatter {
+	return &StreamFormatter{true}
 }
 
 const streamNewline = "\r\n"
@@ -62,7 +68,6 @@ func (sf *StreamFormatter) FormatProgress(id, action string, progress *jsonmessa
 		progress = &jsonmessage.JSONProgress{}
 	}
 	if sf.json {
-
 		b, err := json.Marshal(&jsonmessage.JSONMessage{
 			Status:          action,
 			ProgressMessage: progress.String(),
@@ -81,10 +86,6 @@ func (sf *StreamFormatter) FormatProgress(id, action string, progress *jsonmessa
 	return []byte(action + " " + progress.String() + endl)
 }
 
-func (sf *StreamFormatter) Json() bool {
-	return sf.json
-}
-
 type StdoutFormater struct {
 	io.Writer
 	*StreamFormatter

streamformatter/streamformatter_test.go

@@ -10,31 +10,55 @@ import (
 )
 
 func TestFormatStream(t *testing.T) {
-	sf := NewStreamFormatter(true)
+	sf := NewStreamFormatter()
+	res := sf.FormatStream("stream")
+	if string(res) != "stream"+"\r" {
+		t.Fatalf("%q", res)
+	}
+}
+
+func TestFormatJSONStatus(t *testing.T) {
+	sf := NewStreamFormatter()
+	res := sf.FormatStatus("ID", "%s%d", "a", 1)
+	if string(res) != "a1\r\n" {
+		t.Fatalf("%q", res)
+	}
+}
+
+func TestFormatSimpleError(t *testing.T) {
+	sf := NewStreamFormatter()
+	res := sf.FormatError(errors.New("Error for formatter"))
+	if string(res) != "Error: Error for formatter\r\n" {
+		t.Fatalf("%q", res)
+	}
+}
+
+func TestJSONFormatStream(t *testing.T) {
+	sf := NewJSONStreamFormatter()
 	res := sf.FormatStream("stream")
 	if string(res) != `{"stream":"stream"}`+"\r\n" {
 		t.Fatalf("%q", res)
 	}
 }
 
-func TestFormatStatus(t *testing.T) {
+func TestJSONFormatStatus(t *testing.T) {
-	sf := NewStreamFormatter(true)
+	sf := NewJSONStreamFormatter()
 	res := sf.FormatStatus("ID", "%s%d", "a", 1)
 	if string(res) != `{"status":"a1","id":"ID"}`+"\r\n" {
 		t.Fatalf("%q", res)
 	}
 }
 
-func TestFormatSimpleError(t *testing.T) {
+func TestJSONFormatSimpleError(t *testing.T) {
-	sf := NewStreamFormatter(true)
+	sf := NewJSONStreamFormatter()
 	res := sf.FormatError(errors.New("Error for formatter"))
 	if string(res) != `{"errorDetail":{"message":"Error for formatter"},"error":"Error for formatter"}`+"\r\n" {
 		t.Fatalf("%q", res)
 	}
 }
 
-func TestFormatJSONError(t *testing.T) {
+func TestJSONFormatJSONError(t *testing.T) {
-	sf := NewStreamFormatter(true)
+	sf := NewJSONStreamFormatter()
 	err := &jsonmessage.JSONError{Code: 50, Message: "Json error"}
 	res := sf.FormatError(err)
 	if string(res) != `{"errorDetail":{"code":50,"message":"Json error"},"error":"Json error"}`+"\r\n" {
@@ -42,8 +66,8 @@ func TestFormatJSONError(t *testing.T) {
 	}
 }
 
-func TestFormatProgress(t *testing.T) {
+func TestJSONFormatProgress(t *testing.T) {
-	sf := NewStreamFormatter(true)
+	sf := NewJSONStreamFormatter()
 	progress := &jsonmessage.JSONProgress{
 		Current: 15,
 		Total:   30,