Clean up formatting

Author: yolken-segment

cmd/kubeapply/subcmd/validate.go

@@ -2,6 +2,7 @@ package subcmd
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"path/filepath"
 
@@ -144,69 +145,27 @@ func execValidation(ctx context.Context, clusterConfig *config.ClusterConfig) er
 		return err
 	}
 
-	numInvalidResourceChecks := 0
-	numValidResourceChecks := 0
-	numSkippedResourceChecks := 0
-
-	for _, result := range results {
-		for _, checkResult := range result.CheckResults {
-			switch checkResult.Status {
-			case validation.StatusValid:
-				numValidResourceChecks++
-				log.Debugf(
-					"Resource %s in file %s OK according to check %s",
-					result.Resource.PrettyName(),
-					result.Resource.Path,
-					checkResult.CheckName,
-				)
-			case validation.StatusSkipped:
-				numSkippedResourceChecks++
-				log.Debugf(
-					"Resource %s in file %s was skipped by check %s",
-					result.Resource.PrettyName(),
-					result.Resource.Path,
-					checkResult.CheckName,
-				)
-			case validation.StatusError:
-				numInvalidResourceChecks++
-				log.Errorf(
-					"Resource %s in file %s could not be processed by check %s: %s",
-					result.Resource.PrettyName(),
-					result.Resource.Path,
-					checkResult.CheckName,
-					checkResult.Message,
-				)
-			case validation.StatusInvalid:
-				numInvalidResourceChecks++
-				log.Errorf(
-					"Resource %s in file %s is invalid according to check %s: %s",
-					result.Resource.PrettyName(),
-					result.Resource.Path,
-					checkResult.CheckName,
-					checkResult.Message,
-				)
-			case validation.StatusEmpty:
-			default:
-				log.Infof("Unrecognized result type: %+v", result)
-			}
+	counts := validation.CountsByStatus(results)
+	resultsWithIssues := validation.ResultsWithIssues(results)
+
+	if len(resultsWithIssues) > 0 {
+		log.Warnf("Found %d resources with potential issues", len(resultsWithIssues))
+		for _, result := range resultsWithIssues {
+			fmt.Println(
+				validation.ResultTable(
+					result,
+					clusterConfig.DescriptiveName(),
+					clusterConfig.ExpandedPath,
+					debug,
+				),
+			)
 		}
 	}
 
-	if numInvalidResourceChecks > 0 {
-		return fmt.Errorf(
-			"Validation failed for %d resources in cluster %s (%d checks valid, %d skipped)",
-			numInvalidResourceChecks,
-			clusterConfig.DescriptiveName(),
-			numValidResourceChecks,
-			numSkippedResourceChecks,
-		)
+	if counts[validation.StatusError]+counts[validation.StatusInvalid] > 0 {
+		return errors.New("Validation failed")
 	}
 
-	log.Infof(
-		"Validation of cluster %s passed (%d checks valid, %d skipped)",
-		clusterConfig.DescriptiveName(),
-		numValidResourceChecks,
-		numSkippedResourceChecks,
-	)
+	log.Infof("Validation passed")
 	return nil
 }

pkg/validation/format.go

@@ -0,0 +1,131 @@
+package validation
+
+import (
+	"bytes"
+	"fmt"
+	"path/filepath"
+	"strings"
+
+	"github.com/fatih/color"
+	"github.com/olekukonko/tablewriter"
+)
+
+func ResultTable(
+	result ResourceResult,
+	clusterName string,
+	baseDir string,
+	verbose bool,
+) string {
+	buf := &bytes.Buffer{}
+
+	table := tablewriter.NewWriter(buf)
+	table.SetHeader(
+		[]string{
+			"Property",
+			"Value",
+		},
+	)
+	table.SetAutoWrapText(false)
+	table.SetColumnAlignment(
+		[]int{
+			tablewriter.ALIGN_RIGHT,
+			tablewriter.ALIGN_LEFT,
+		},
+	)
+	table.SetBorders(
+		tablewriter.Border{
+			Left:   false,
+			Top:    true,
+			Right:  false,
+			Bottom: true,
+		},
+	)
+
+	if clusterName != "" {
+		table.Append(
+			[]string{
+				"cluster",
+				clusterName,
+			},
+		)
+	}
+
+	var displayPath string
+
+	relPath, err := filepath.Rel(baseDir, result.Resource.Path)
+	if err != nil {
+		displayPath = result.Resource.Path
+	} else {
+		displayPath = relPath
+	}
+
+	table.Append(
+		[]string{
+			"path",
+			displayPath,
+		},
+	)
+	table.Append(
+		[]string{
+			"resource",
+			result.Resource.PrettyName(),
+		},
+	)
+
+	errorPrinter := color.New(color.FgHiRed).SprintfFunc()
+	warnPrinter := color.New(color.FgHiYellow).SprintfFunc()
+	standardPrinter := fmt.Sprintf
+
+	for _, checkResult := range result.CheckResults {
+		if !verbose && (checkResult.Status != StatusError &&
+			checkResult.Status != StatusInvalid &&
+			checkResult.Status != StatusWarning) {
+			continue
+		}
+
+		reasonLines := []string{checkResult.Message}
+		for r, reason := range checkResult.Reasons {
+			reasonLines = append(reasonLines, fmt.Sprintf("(%d) %s", r+1, reason))
+		}
+
+		table.Append(
+			[]string{
+				"checkType",
+				string(checkResult.CheckType),
+			},
+		)
+		table.Append(
+			[]string{
+				"checkName",
+				checkResult.CheckName,
+			},
+		)
+
+		var printer func(f string, a ...interface{}) string
+		switch checkResult.Status {
+		case StatusError, StatusInvalid:
+			printer = errorPrinter
+		case StatusWarning:
+			printer = warnPrinter
+		default:
+			printer = standardPrinter
+		}
+
+		table.Append(
+			[]string{
+				"checkStatus",
+				printer(string(checkResult.Status)),
+			},
+		)
+
+		table.Append(
+			[]string{
+				"checkMessage",
+				strings.Join(reasonLines, "\n"),
+			},
+		)
+	}
+
+	table.Render()
+	return string(bytes.TrimRight(buf.Bytes(), "\n"))
+}

pkg/validation/result.go

@@ -21,7 +21,7 @@ const (
 )
 
 // Result stores the results of validating a single resource in a single file, for all checks.
-type Result struct {
+type ResourceResult struct {
 	Resource     Resource
 	CheckResults []CheckResult
 }
@@ -34,3 +34,43 @@ type CheckResult struct {
 	Message   string
 	Reasons   []string
 }
+
+// HasIssues returns whether a ResourceResult has at least one check result with an
+// error or warning.
+func (r ResourceResult) HasIssues() bool {
+	for _, checkResult := range r.CheckResults {
+		if checkResult.Status == StatusError || checkResult.Status == StatusInvalid ||
+			checkResult.Status == StatusWarning {
+			return true
+		}
+	}
+
+	return false
+}
+
+// CountsByStatus returns the number of check results for each status type.
+func CountsByStatus(results []ResourceResult) map[Status]int {
+	counts := map[Status]int{}
+
+	for _, result := range results {
+		for _, checkResult := range result.CheckResults {
+			counts[checkResult.Status]++
+		}
+	}
+
+	return counts
+}
+
+// ResultsWithIssues filters the argument resource results to just those with potential
+// issues.
+func ResultsWithIssues(results []ResourceResult) []ResourceResult {
+	filteredResults := []ResourceResult{}
+
+	for _, result := range results {
+		if result.HasIssues() {
+			filteredResults = append(filteredResults, result)
+		}
+	}
+
+	return filteredResults
+}

pkg/validation/validation.go

@@ -37,7 +37,7 @@ func NewKubeValidator(config KubeValidatorConfig) *KubeValidator {
 func (k *KubeValidator) RunChecks(
 	ctx context.Context,
 	path string,
-) ([]Result, error) {
+) ([]ResourceResult, error) {
 	resources := []Resource{}
 	index := 0
 
@@ -87,12 +87,12 @@ func (k *KubeValidator) RunChecks(
 	}
 	defer close(resourcesChan)
 
-	resultsChan := make(chan Result, len(resources))
+	resultsChan := make(chan ResourceResult, len(resources))
 
 	for i := 0; i < k.config.NumWorkers; i++ {
 		go func() {
 			for resource := range resourcesChan {
-				result := Result{
+				result := ResourceResult{
 					Resource: resource,
 				}
 				for _, checker := range k.config.Checkers {
@@ -107,7 +107,7 @@ func (k *KubeValidator) RunChecks(
 		}()
 	}
 
-	results := []Result{}
+	results := []ResourceResult{}
 	for i := 0; i < len(resources); i++ {
 		results = append(results, <-resultsChan)
 	}

pkg/validation/validation_test.go

@@ -23,13 +23,13 @@ func TestKubeValidator(t *testing.T) {
 
 	type testCase struct {
 		path     string
-		expected []Result
+		expected []ResourceResult
 	}
 
 	testCases := []testCase{
 		{
 			path: "testdata/configs",
-			expected: []Result{
+			expected: []ResourceResult{
 				{
 					Resource: Resource{
 						Path:      "testdata/configs/deployment.yaml",