refactor: small refactors in printers (datreeio#662)

meain · Jun 2, 2022 · 868b76f · 868b76f
1 parent c6d9ca9
commit 868b76f
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 30 deletions.
diff --git a/cmd/validate-yaml/main.go b/cmd/validate-yaml/main.go
@@ -5,8 +5,6 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/fatih/color"
-
 	"github.com/datreeio/datree/pkg/cliClient"
 	pkgExtractor "github.com/datreeio/datree/pkg/extractor"
 	"github.com/datreeio/datree/pkg/localConfig"
@@ -15,8 +13,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var out = color.Output
-
 const (
 	STATUS_PASSED = "passed"
 	STATUS_FAILED = "failed"
@@ -125,10 +121,7 @@ func PrintValidationResults(printer IPrinter, invalidFiles []*pkgExtractor.Inval
 	validFilesCount := filesCount - len(invalidFiles)
 	sb.WriteString(printer.GetYamlValidationSummaryText(validFilesCount, filesCount))
 
-	_, err := out.Write([]byte(sb.String()))
-	if err != nil {
-		panic(err)
-	}
+	fmt.Print(sb.String())
 }
 
 func SendResults(localConfig ILocalConfig, client ICliClient, cliVersion string, isValid bool, invalidYamlFiles []*pkgExtractor.InvalidFile, filesPaths []string) {

diff --git a/pkg/evaluation/printer.go b/pkg/evaluation/printer.go
@@ -83,18 +83,18 @@ func GetResultsText(resultsData *PrintResultsData) (string, error) {
 
 		switch resultsData.OutputFormat {
 		case "json":
-			return jsonOutput(&formattedOutput)
+			return getJsonOutput(&formattedOutput)
 		case "yaml":
-			return yamlOutput(&formattedOutput)
+			return getYamlOutput(&formattedOutput)
 		case "xml":
-			return xmlOutput(&formattedOutput)
+			return getXmlOutput(&formattedOutput)
 		case "JUnit":
-			return jUnitOutput(&formattedOutput, resultsData.AdditionalJUnitData)
+			return getJUnitOutput(&formattedOutput, resultsData.AdditionalJUnitData)
 		default:
 			panic(errors.New("invalid output format"))
 		}
 	} else {
-		return textOutput(textOutputData{
+		return getTextOutput(textOutputData{
 			results:               resultsData.Results.EvaluationResults,
 			invalidYamlFiles:      resultsData.InvalidYamlFiles,
 			invalidK8sFiles:       resultsData.InvalidK8sFiles,
@@ -109,7 +109,7 @@ func GetResultsText(resultsData *PrintResultsData) (string, error) {
 	}
 }
 
-func jsonOutput(formattedOutput *FormattedOutput) (string, error) {
+func getJsonOutput(formattedOutput *FormattedOutput) (string, error) {
 	jsonOutput, err := json.Marshal(formattedOutput)
 	if err != nil {
 		return "", err
@@ -118,7 +118,7 @@ func jsonOutput(formattedOutput *FormattedOutput) (string, error) {
 	return fmt.Sprintln(string(jsonOutput)), nil
 }
 
-func yamlOutput(formattedOutput *FormattedOutput) (string, error) {
+func getYamlOutput(formattedOutput *FormattedOutput) (string, error) {
 	yamlOutput, err := yaml.Marshal(formattedOutput)
 	if err != nil {
 		return "", err
@@ -127,15 +127,15 @@ func yamlOutput(formattedOutput *FormattedOutput) (string, error) {
 	return fmt.Sprintln(string(yamlOutput)), nil
 }
 
-func xmlOutput(formattedOutput *FormattedOutput) (string, error) {
-	return getXmlOutput(formattedOutput)
+func getXmlOutput(formattedOutput *FormattedOutput) (string, error) {
+	return convertStructToXml(formattedOutput)
 }
 
-func jUnitOutput(formattedOutput *FormattedOutput, additionalJUnitData AdditionalJUnitData) (string, error) {
-	return getXmlOutput(FormattedOutputToJUnitOutput(*formattedOutput, additionalJUnitData))
+func getJUnitOutput(formattedOutput *FormattedOutput, additionalJUnitData AdditionalJUnitData) (string, error) {
+	return convertStructToXml(FormattedOutputToJUnitOutput(*formattedOutput, additionalJUnitData))
 }
 
-func getXmlOutput(output interface{}) (string, error) {
+func convertStructToXml(output interface{}) (string, error) {
 	xmlOutput, err := xml.MarshalIndent(output, "", "\t")
 	xmlOutput = []byte(xml.Header + string(xmlOutput))
 	if err != nil {
@@ -145,7 +145,7 @@ func getXmlOutput(output interface{}) (string, error) {
 	return fmt.Sprintln(string(xmlOutput)), nil
 }
 
-func textOutput(outputData textOutputData) (string, error) {
+func getTextOutput(outputData textOutputData) (string, error) {
 	sb := strings.Builder{}
 	pwd, err := os.Getwd()
 	if err != nil {

diff --git a/pkg/evaluation/printer_test.go b/pkg/evaluation/printer_test.go
@@ -111,16 +111,16 @@ func TestCustomOutputs(t *testing.T) {
 	additionalJUnitData := createAdditionalJUnitData()
 	expectedOutputs := getExpectedOutputs()
 
-	jsonStdout, _ := jsonOutput(&formattedOutput)
+	jsonStdout, _ := getJsonOutput(&formattedOutput)
 	assert.Equal(t, expectedOutputs.json, jsonStdout)
 
-	yamlStdout, _ := yamlOutput(&formattedOutput)
+	yamlStdout, _ := getYamlOutput(&formattedOutput)
 	assert.Equal(t, expectedOutputs.yaml, yamlStdout)
 
-	xmlStdout, _ := xmlOutput(&formattedOutput)
+	xmlStdout, _ := getXmlOutput(&formattedOutput)
 	assert.Equal(t, expectedOutputs.xml, xmlStdout)
 
-	JUnitStdout, _ := jUnitOutput(&formattedOutput, additionalJUnitData)
+	JUnitStdout, _ := getJUnitOutput(&formattedOutput, additionalJUnitData)
 	assert.Equal(t, expectedOutputs.JUnit, JUnitStdout)
 }
 
@@ -129,7 +129,7 @@ func TestInvalidK8sCustomOutputs(t *testing.T) {
 	additionalJUnitData := createAdditionalJUnitDataInvalidK8sFile()
 	expectedOutputs := getInvalidK8sFileExpectedOutputs()
 
-	JUnitStdout, _ := jUnitOutput(&formattedOutput, additionalJUnitData)
+	JUnitStdout, _ := getJUnitOutput(&formattedOutput, additionalJUnitData)
 	assert.Equal(t, expectedOutputs.JUnit, JUnitStdout)
 }
 

diff --git a/pkg/printer/printer.go b/pkg/printer/printer.go
@@ -118,10 +118,7 @@ func (p *Printer) getK8sValidationWarningText(warning Warning) string {
 }
 
 func (p *Printer) PrintYamlSchemaResults(errorsResult []jsonschema.Detailed, error error) {
-	_, err := out.Write([]byte(p.getYamlSchemaResultsText(errorsResult, error)))
-	if err != nil {
-		panic(err)
-	}
+	fmt.Print(p.getYamlSchemaResultsText(errorsResult, error))
 }
 
 func (p *Printer) getYamlSchemaResultsText(errorsResult []jsonschema.Detailed, error error) string {