refactoring of tests

Author: saniales

.gitignore

@@ -2,4 +2,5 @@ debug
 arduino
 arduino-cli
 main
-.vscode/settings.json
+.vscode/settings.json
+cmd/formatter/debug.test

cmd/formatter/examples_test.go

@@ -6,6 +6,14 @@ import (
 	"github.com/bcmi-labs/arduino-cli/cmd/formatter"
 )
 
+type TestStruct struct {
+	Value int `json:"value"`
+}
+
+func (ts TestStruct) String() string {
+	return fmt.Sprint("VALUE = ", ts.Value)
+}
+
 func ExampleJSONFormatter_Print() {
 	var example struct {
 		Field1 string `json:"field1"`
@@ -68,3 +76,66 @@ func ExampleJSONFormatter_Format() {
 	// RESULT: {"field1":"test","field2":10,"field3":{"inner1":"inner test","inner2":10.432412}}
 	// RESULT: <empty string>
 }
+
+func ExampleJSONFormatter_Print_debug() {
+	valid := TestStruct{20}
+	invalid := "invalid"
+	jf := formatter.JSONFormatter{
+		Debug: false,
+	}
+	//using struct
+	jf.Print(valid)
+
+	//using string (invalid sine it's not a struct or a map)
+	jf.Print(invalid)
+
+	jf.Debug = true
+	jf.Print(valid)
+	jf.Print(invalid)
+
+	//using map
+	newValue := make(map[string]int)
+	newValue["value2"] = 10
+
+	jf.Print(newValue)
+	// Output:
+	// {"value":20}
+	//
+	// {"value":20}
+	// Only structs and maps values are accepted
+	// {"value2":10}
+}
+
+func ExampleFormat() {
+	formatter.SetFormatter("text")
+	result, err := formatter.Format(TestStruct{5})
+	if err == nil {
+		fmt.Println("RESULT: ", result)
+	} else {
+		fmt.Println("ERROR: ", err)
+	}
+
+	formatter.SetFormatter("json")
+	result, err = formatter.Format(TestStruct{10})
+	if err == nil {
+		fmt.Println("RESULT: ", result)
+	} else {
+		fmt.Println("ERROR: ", err)
+	}
+	result, err = formatter.Format(5)
+	if err == nil {
+		if result == "" {
+			result = "<empty string>"
+			fmt.Println("RESULT: ", result)
+		} else {
+			fmt.Println("unexpected RESULT: ", result)
+		}
+	} else {
+		fmt.Sprintln("ERROR: ", err)
+	}
+
+	// Output:
+	// RESULT:  VALUE = 5
+	// RESULT:  {"value":10}
+	// RESULT:  <empty string>
+}

cmd/formatter/formatter_test.go

@@ -1,102 +1 @@
-package formatter
-
-import (
-	"errors"
-	"fmt"
-	"testing"
-)
-
-type TestStruct struct {
-	Value int `json:"value"`
-}
-
-func (ts TestStruct) String() string {
-	return fmt.Sprint("VALUE = ", ts.Value)
-}
-func TestFormat(test *testing.T) {
-	SetFormatter("text")
-	result, err := Format(TestStruct{5})
-	if err == nil {
-		fmt.Println("RESULT: ", result)
-	} else {
-		fmt.Sprintln("ERROR: ", err)
-		test.Fail()
-	}
-
-	SetFormatter("json")
-	result, err = Format(TestStruct{10})
-	if err == nil {
-		fmt.Println("RESULT: ", result)
-	} else {
-		fmt.Sprintln("ERROR: ", err)
-		test.Fail()
-	}
-	result, err = Format(5)
-	if err == nil {
-		if result == "" {
-			result = "<empty string>"
-			fmt.Println("RESULT: ", result)
-		} else {
-			fmt.Println("unexpected RESULT: ", result)
-			test.Fail()
-		}
-	} else {
-		fmt.Sprintln("ERROR: ", err)
-	}
-
-	// Output:
-	// RESULT: VALUE = 5
-	// RESULT: {value:10}
-}
-
-func TestPrint(test *testing.T) {
-	SetFormatter("text")
-	Print(TestStruct{5})
-
-	SetFormatter("json")
-	Print(TestStruct{10})
-
-	// Output:
-	// RESULT: VALUE = 5
-	// RESULT: {value:10}
-}
-
-func TestJSONFormatterPrintDebug(test *testing.T) {
-	valid := TestStruct{20}
-	invalid := "invalid"
-	jf := JSONFormatter{
-		debug: false,
-	}
-	//using struct
-	jf.Print(valid)
-
-	//using string (invalid sine it's not a struct or a map)
-	jf.Print(invalid)
-
-	jf.debug = true
-	jf.Print(valid)
-	jf.Print(invalid)
-
-	//using map
-	newValue := make(map[string]int)
-	newValue["value2"] = 10
-
-	jf.Print(newValue)
-	// Output:
-	// {value:20}
-	//
-	// {value:20}
-	// Only structs and maps values are accepted
-	// {value2:10}
-}
-
-func TestPrintError(test *testing.T) {
-	SetFormatter("text")
-	PrintError(errors.New("text error"))
-	SetFormatter("json")
-	PrintError(errors.New("json error"))
-
-	// Output:
-	// text error
-	// {error:"json error"}
-}
+package formatter_test

cmd/formatter/json.go

@@ -35,7 +35,7 @@ import "errors"
 
 //JSONFormatter represents a Printer and Formatter of JSON objects.
 type JSONFormatter struct {
-	debug bool //if false, errors are not shown. Unparsable inputs are skipped. Otherwise an error message is shown.
+	Debug bool //if false, errors are not shown. Unparsable inputs are skipped. Otherwise an error message is shown.
 }
 
 // Format formaats a message into a JSON object.
@@ -44,10 +44,10 @@ type JSONFormatter struct {
 func (jf JSONFormatter) Format(msg interface{}) (string, error) {
 	msgType := reflect.TypeOf(msg).Kind().String()
 	if msgType == "struct" ||
-		msgType == "map" { // TODO : optimize if possible
+		msgType == "map" {
 		ret, err := json.Marshal(msg)
 		return string(ret), err
-	} else if jf.debug {
+	} else if jf.Debug {
 		return "", errors.New("Only structs and maps values are accepted")
 	}
 	return "", nil

cmd/formatter/print_test.go

@@ -1,6 +1,7 @@
 package formatter_test
 
 import (
+	"errors"
 	"fmt"
 
 	"github.com/bcmi-labs/arduino-cli/cmd/formatter"
@@ -43,3 +44,26 @@ func ExamplePrint() {
 	// Field3.Inner1: inner test
 	// Field3.Inner2: 10.432412
 }
+
+func ExamplePrint_alternative() {
+	formatter.SetFormatter("text")
+	formatter.Print(TestStruct{5})
+
+	formatter.SetFormatter("json")
+	formatter.Print(TestStruct{10})
+
+	// Output:
+	// VALUE = 5
+	// {"value":10}
+}
+
+func ExamplePrintError() {
+	formatter.SetFormatter("text")
+	formatter.PrintError(errors.New("text error"))
+	formatter.SetFormatter("json")
+	formatter.PrintError(errors.New("json error"))
+
+	// Output:
+	// text error
+	// {"error":"json error"}
+}