Add cli option to group reporter output. Closes #38

README.md

@@ -46,7 +46,7 @@ There are several ways to install the config file validator tool
 
 We offer alpine, ubuntu, and scratch containers
 
-#### Apline 
+#### Apline
 
 ```
 docker pull ghcr.io/boeing/config-file-validator:v1.5.0
@@ -103,10 +103,13 @@ optional flags:
     	Subdirectories to exclude when searching for configuration files
   -exclude-file-types string
     	A comma separated list of file types to ignore
+  -groupby string
+        Group the output by filetype, pass/fail, or directory
   -reporter string
     	Format of the printed report. Options are standard and json (default "standard")
   -version
     	Version prints the release version of validator
+
 ```
 
 ### Examples
@@ -130,7 +133,7 @@ validator /path/to/search /another/path/to/search
 Exclude subdirectories in the search path
 
 ```
-validator --exclude-dirs=/path/to/search/tests /path/to/search 
+validator --exclude-dirs=/path/to/search/tests /path/to/search
 ```
 
 ![Exclude Dirs Run](./img/exclude_dirs.png)
@@ -145,7 +148,7 @@ validator --exclude-file-types=json /path/to/search
 ![Exclude File Types Run](./img/exclude_file_types.png)
 
 #### Customize recursion depth
-By default there is no recursion limit. If desired, the recursion depth can be set to an integer value. If depth is set to `0` recursion will be disabled and only the files in the search path will be validated. 
+By default there is no recursion limit. If desired, the recursion depth can be set to an integer value. If depth is set to `0` recursion will be disabled and only the files in the search path will be validated.
 
 ```
 validator --depth=0 /path/to/search
@@ -162,6 +165,14 @@ validator --reporter=json /path/to/search
 
 ![Exclude File Types Run](./img/custom_reporter.png)
 
+### Group report output
+Group the report output by file type, directory, or pass/fail. Supports one or more groupings.
+
+```
+validator -groupby filetype
+validator -groupby directory,pass/fail
+```
+
 
 #### Container Run
 ```
@@ -242,4 +253,4 @@ docker build . -t config-file-validator:v1.5.0
 We welcome contributions! Please refer to our [contributing guide](/CONTRIBUTING.md)
 
 ## License
-The Config File Validator is released under the [Apache 2.0](/LICENSE) License
+The Config File Validator is released under the [Apache 2.0](/LICENSE) License

cmd/validator/validator.go

@@ -31,6 +31,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"slices"
 	"strings"
 
 	configfilevalidator "github.com/Boeing/config-file-validator"
@@ -46,6 +47,7 @@ type validatorConfig struct {
 	reportType       *string
 	depth            *int
 	versionQuery     *bool
+	groupOutput      *string
 }
 
 // Custom Usage function to cover
@@ -71,6 +73,7 @@ func getFlags() (validatorConfig, error) {
 	excludeFileTypesPtr := flag.String("exclude-file-types", "", "A comma separated list of file types to ignore")
 	depthPtr := flag.Int("depth", 0, "Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal")
 	versionPtr := flag.Bool("version", false, "Version prints the release version of validator")
+	groupOutputPtr := flag.String("groupby", "", "Group output by file type, directory, pass/fail")
 	flag.Parse()
 
 	searchPaths := make([]string, 0)
@@ -96,13 +99,28 @@ func getFlags() (validatorConfig, error) {
 		return validatorConfig{}, errors.New("Wrong parameter value for depth, value cannot be negative")
 	}
 
+    groupByCleanString := cleanString("groupby")
+    groupByUserInput := strings.Split(groupByCleanString, ",")
+    groupByAllowedValues := []string{"filetype", "directory", "pass/fail"}
+
+	if groupOutputPtr != nil && isFlagSet("groupby") {
+		for _, groupBy := range groupByUserInput {
+			if !slices.Contains(groupByAllowedValues, groupBy) {
+				fmt.Println("Wrong parameter value for groupby, only supports filetype, directory, pass/fail")
+				flag.Usage()
+				return validatorConfig{}, errors.New("Wrong parameter value for groupby, only supports filetype, directory, pass/fail")
+			}
+		}
+	}
+
 	config := validatorConfig{
 		searchPaths,
 		excludeDirsPtr,
 		excludeFileTypesPtr,
 		reportTypePtr,
 		depthPtr,
 		versionPtr,
+		groupOutputPtr,
 	}
 
 	return config, nil
@@ -132,6 +150,16 @@ func getReporter(reportType *string) reporter.Reporter {
 	}
 }
 
+// cleanString takes a command string and a split string
+// and returns a cleaned string
+func cleanString(command string) string {
+	cleanedString := flag.Lookup(command).Value.String()
+	cleanedString = strings.ToLower(cleanedString)
+	cleanedString = strings.TrimSpace(cleanedString)
+
+	return cleanedString
+}
+
 func mainInit() int {
 	validatorConfig, err := getFlags()
 	if err != nil {
@@ -149,6 +177,10 @@ func mainInit() int {
 	reporter := getReporter(validatorConfig.reportType)
 	excludeFileTypes := strings.Split(*validatorConfig.excludeFileTypes, ",")
 
+	// since the group output is a comma separated string
+	// it needs to be split into a slice of strings
+	groupOutput := strings.Split(*validatorConfig.groupOutput, ",")
+
 	fsOpts := []finder.FSFinderOptions{finder.WithPathRoots(validatorConfig.searchPaths...),
 		finder.WithExcludeDirs(excludeDirs),
 		finder.WithExcludeFileTypes(excludeFileTypes)}
@@ -164,6 +196,7 @@ func mainInit() int {
 	cli := cli.Init(
 		cli.WithReporter(reporter),
 		cli.WithFinder(fileSystemFinder),
+		cli.WithGroupOutput(groupOutput),
 	)
 
 	// Run the config file validation

cmd/validator/validator_test.go

@@ -24,6 +24,8 @@ func Test_flags(t *testing.T) {
 		{"exclude file types set", []string{"--exclude-file-types=json", "."}, 0},
 		{"multiple paths", []string{"../../test/fixtures/subdir/good.json", "../../test/fixtures/good.json"}, 0},
 		{"version", []string{"--version"}, 0},
+        {"incorrect group", []string{"-groupby=badgroup", "."}, 1},
+        {"correct group", []string{"-groupby=directory", "."}, 0},
 	}
 	for _, tc := range cases {
 		// this call is required because otherwise flags panics,

pkg/cli/cli.go

@@ -8,6 +8,8 @@ import (
 	"github.com/Boeing/config-file-validator/pkg/reporter"
 )
 
+var GroupOutput []string
+
 type CLI struct {
 	// FileFinder interface to search for the files
 	// in the SearchPath
@@ -36,6 +38,12 @@ func WithReporter(reporter reporter.Reporter) CLIOption {
 	}
 }
 
+func WithGroupOutput(groupOutput []string) CLIOption {
+	return func(c *CLI) {
+		GroupOutput = groupOutput
+	}
+}
+
 // Initialize the CLI object
 func Init(opts ...CLIOption) *CLI {
 	defaultFsFinder := finder.FileSystemFinderInit()
@@ -88,6 +96,10 @@ func (c CLI) Run() (int, error) {
 		reports = append(reports, report)
 	}
 
+	// Group the output if the user specified a group by option
+	if len(GroupOutput) > 0 {
+		reports = GroupBy(reports, GroupOutput)
+	}
 	c.Reporter.Print(reports)
 
 	if errorFound {

pkg/cli/cli_test.go

@@ -10,6 +10,7 @@ import (
 func Test_CLI(t *testing.T) {
 	searchPath := "../../test"
 	excludeDirs := []string{"subdir", "subdir2"}
+    groupBy := []string{}
 	stdoutReporter := reporter.StdoutReporter{}
 
 	fsFinder := finder.FileSystemFinderInit(
@@ -19,6 +20,7 @@ func Test_CLI(t *testing.T) {
 	cli := Init(
 		WithFinder(fsFinder),
 		WithReporter(stdoutReporter),
+        WithGroupOutput(groupBy),
 	)
 	exitStatus, err := cli.Run()
 
@@ -70,3 +72,29 @@ func Test_CLIBadPath(t *testing.T) {
 		t.Errorf("Exit status was not 1")
 	}
 }
+
+func Test_CLIWithGroup(t *testing.T) {
+    searchPath := "../../test"
+    excludeDirs := []string{"subdir", "subdir2"}
+    groupOutput := []string{"pass/fail", "directory", "filetype"}
+    stdoutReporter := reporter.StdoutReporter{}
+
+    fsFinder := finder.FileSystemFinderInit(
+        finder.WithPathRoots(searchPath),
+        finder.WithExcludeDirs(excludeDirs),
+    )
+    cli := Init(
+        WithFinder(fsFinder),
+        WithReporter(stdoutReporter),
+        WithGroupOutput(groupOutput),
+    )
+    exitStatus, err := cli.Run()
+
+    if err != nil {
+        t.Errorf("An error was returned: %v", err)
+    }
+
+    if exitStatus != 0 {
+        t.Errorf("Exit status was not 0")
+    }
+}

pkg/cli/group_output.go

@@ -0,0 +1,94 @@
+package cli
+
+import (
+	"strings"
+
+	"github.com/Boeing/config-file-validator/pkg/reporter"
+)
+
+// Group Files by File Type
+func GroupByFile(reports []reporter.Report) []reporter.Report {
+	mapFiles := make(map[string][]reporter.Report)
+	reportByFile := []reporter.Report{}
+
+	for _, report := range reports {
+		fileType := strings.Split(report.FileName, ".")[1]
+		if mapFiles[fileType] == nil {
+			mapFiles[fileType] = []reporter.Report{report}
+		} else {
+			mapFiles[fileType] = append(mapFiles[fileType], report)
+		}
+	}
+
+	for _, reports := range mapFiles {
+		reportByFile = append(reportByFile, reports...)
+	}
+
+	return reportByFile
+}
+
+// Group Files by Pass/Fail
+func GroupByPassFail(reports []reporter.Report) []reporter.Report {
+	mapFiles := make(map[string][]reporter.Report)
+	reportByPassOrFail := []reporter.Report{}
+
+	for _, report := range reports {
+		if report.IsValid {
+			if mapFiles["pass"] == nil {
+				mapFiles["pass"] = []reporter.Report{report}
+			} else {
+				mapFiles["pass"] = append(mapFiles["pass"], report)
+			}
+		} else {
+			if mapFiles["fail"] == nil {
+				mapFiles["fail"] = []reporter.Report{report}
+			} else {
+				mapFiles["fail"] = append(mapFiles["fail"], report)
+			}
+		}
+	}
+
+	for _, reports := range mapFiles {
+		reportByPassOrFail = append(reportByPassOrFail, reports...)
+	}
+
+	return reportByPassOrFail
+}
+
+// Group Files by Directory
+func GroupByDirectory(reports []reporter.Report) []reporter.Report {
+	mapFiles := make(map[string][]reporter.Report)
+	reportByDirectory := []reporter.Report{}
+
+	for _, report := range reports {
+		directoryPaths := strings.Split(report.FilePath, "/")
+        directory := directoryPaths[len(directoryPaths)-2]
+		if mapFiles[directory] == nil {
+			mapFiles[directory] = []reporter.Report{report}
+		} else {
+			mapFiles[directory] = append(mapFiles[directory], report)
+		}
+	}
+
+	for _, reports := range mapFiles {
+		reportByDirectory = append(reportByDirectory, reports...)
+	}
+
+	return reportByDirectory
+}
+
+func GroupBy(reports []reporter.Report, groupBy []string) []reporter.Report {
+    // Iterate through groupBy in reverse order
+    // This will make the first command the primary grouping
+    for i := len(groupBy)-1; i >= 0; i--  {
+		switch groupBy[i] {
+		case "pass/fail":
+			reports = GroupByPassFail(reports)
+		case "filetype":
+			reports = GroupByFile(reports)
+		case "directory":
+			reports = GroupByDirectory(reports)
+		}
+	}
+	return reports
+}

pkg/finder/fsfinder.go

@@ -55,7 +55,6 @@ func WithDepth(depthVal int) FSFinderOptions {
 		fsf.Depth = &depthVal
 	}
 }
-
 func FileSystemFinderInit(opts ...FSFinderOptions) *FileSystemFinder {
 	var defaultExludeDirs []string
 	defaultPathRoots := []string{"."}

test/fixtures/subdir2/bad.properties

@@ -23,7 +23,7 @@ multiline = This line \
 continues
 # If you want your value to include a \, it should be escaped by another \.
 path = c:\\wiki\\templates
-# This means that if the number of \ at the end of the line is even, the next line is not included in the value. 
+# This means that if the number of \ at the end of the line is even, the next line is not included in the value.
 # In the following example, the value for "evenKey" is "This is on one line\".
 evenKey = This is on one line\\
 # This line is a normal comment and is not included in the value for "evenKey"
@@ -45,4 +45,4 @@ encodedHelloInJapanese = \u3053\u3093\u306b\u3061\u306f
 # But with more modern file encodings like UTF-8, you can directly use supported characters.
 helloInJapanese = こんにちは
 # Circular Dependency
-key = ${key}
+key = ${key}

test/fixtures/subdir2/good.ini

@@ -0,0 +1,8 @@
+[Version]
+First=name
+second=value
+
+[Empty]
+
+[Last]
+1=2

test/fixtures/subdir2/good.json

@@ -0,0 +1,5 @@
+{
+    "test": {
+        "name": "test"
+    }
+}