change Search to take an io.Writer, add first test

stelligent · Apr 21, 2018 · dd33dcb · dd33dcb
1 parent fe5f08e
commit dd33dcb
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 13 deletions.
diff --git a/cli/app.go b/cli/app.go
@@ -142,7 +142,7 @@ func applyRules(ruleSets []assertion.RuleSet, args arrayFlags, options ApplyOpti
 		}
 		if l != nil {
 			if options.SearchExpression != "" {
-				l.Search(ruleSet, options.SearchExpression)
+				l.Search(ruleSet, options.SearchExpression, os.Stdout)
 			} else {
 				options := linter.Options{
 					Tags:    options.Tags,

diff --git a/linter/aws_resource_linter.go b/linter/aws_resource_linter.go
@@ -3,6 +3,7 @@ package linter
 import (
 	"fmt"
 	"github.com/stelligent/config-lint/assertion"
+	"io"
 )
 
 type (
@@ -30,18 +31,18 @@ func (l AWSResourceLinter) Validate(ruleSet assertion.RuleSet, options Options)
 }
 
 // Search applies a JMESPath to all SecurityGroups
-func (l AWSResourceLinter) Search(ruleSet assertion.RuleSet, searchExpression string) {
+func (l AWSResourceLinter) Search(ruleSet assertion.RuleSet, searchExpression string, w io.Writer) {
 	resources, _ := l.Loader.Load()
 	for _, resource := range resources {
 		v, err := assertion.SearchData(searchExpression, resource.Properties)
 		if err != nil {
-			fmt.Println(err)
+			fmt.Fprintln(w, err)
 		} else {
 			s, err := assertion.JSONStringify(v)
 			if err != nil {
-				fmt.Println(err)
+				fmt.Fprintln(w, err)
 			} else {
-				fmt.Printf("%s: %s\n", resource.ID, s)
+				fmt.Fprintf(w, "%s: %s\n", resource.ID, s)
 			}
 		}
 	}

diff --git a/linter/aws_resource_linter_test.go b/linter/aws_resource_linter_test.go
@@ -1,7 +1,9 @@
 package linter
 
 import (
+	"bytes"
 	"github.com/stelligent/config-lint/assertion"
+	"strings"
 	"testing"
 )
 
@@ -25,6 +27,17 @@ func TestAWSResourceLinterValidate(t *testing.T) {
 	}
 }
 
+func TestAWSResourceLinterSearch(t *testing.T) {
+	ruleSet := loadRulesForTest("./testdata/rules/aws_resource.yml", t)
+	mockLoader := AWSMockLoader{}
+	linter := AWSResourceLinter{Loader: mockLoader, ValueSource: TestingValueSource{}}
+	var b bytes.Buffer
+	linter.Search(ruleSet, "@", &b)
+	if !strings.Contains(b.String(), "Name") {
+		t.Errorf("Expecting Search to find Name in %s", b.String())
+	}
+}
+
 type AWSMockLoader struct{}
 
 func (l AWSMockLoader) Load() ([]assertion.Resource, error) {

diff --git a/linter/file_linter.go b/linter/file_linter.go
@@ -3,6 +3,7 @@ package linter
 import (
 	"fmt"
 	"github.com/stelligent/config-lint/assertion"
+	"io"
 )
 
 type (
@@ -65,26 +66,26 @@ func (fl FileLinter) Validate(ruleSet assertion.RuleSet, options Options) (asser
 }
 
 // Search evaluates a JMESPath expression against resources in a collection of filenames
-func (fl FileLinter) Search(ruleSet assertion.RuleSet, searchExpression string) {
+func (fl FileLinter) Search(ruleSet assertion.RuleSet, searchExpression string, w io.Writer) {
 	for _, filename := range fl.Filenames {
 		include, _ := assertion.ShouldIncludeFile(ruleSet.Files, filename) // FIXME what about error?
 		if include {
-			fmt.Printf("Searching %s:\n", filename)
+			fmt.Fprintf(w, "Searching %s:\n", filename)
 			loaded, err := fl.Loader.Load(filename)
 			if err != nil {
-				fmt.Println("Error for file:", filename)
-				fmt.Println(err.Error())
+				fmt.Fprintln(w, "Error for file:", filename)
+				fmt.Fprintln(w, err.Error())
 			}
 			for _, resource := range loaded.Resources {
 				v, err := assertion.SearchData(searchExpression, resource.Properties)
 				if err != nil {
-					fmt.Println(err)
+					fmt.Fprintln(w, err)
 				} else {
 					s, err := assertion.JSONStringify(v)
 					if err != nil {
-						fmt.Println(err)
+						fmt.Fprintln(w, err)
 					} else {
-						fmt.Printf("%s (%s): %s\n", resource.ID, resource.Type, s)
+						fmt.Fprintf(w, "%s (%s): %s\n", resource.ID, resource.Type, s)
 					}
 				}
 			}

diff --git a/linter/linter.go b/linter/linter.go
@@ -3,13 +3,14 @@ package linter
 import (
 	"fmt"
 	"github.com/stelligent/config-lint/assertion"
+	"io"
 )
 
 type (
 	// Linter provides the interface for all supported linters
 	Linter interface {
 		Validate(ruleSet assertion.RuleSet, options Options) (assertion.ValidationReport, error)
-		Search(ruleSet assertion.RuleSet, searchExpression string)
+		Search(ruleSet assertion.RuleSet, searchExpression string, w io.Writer)
 	}
 
 	// Options configures what resources will be linted