Feature: Exclude file types (#35)

* add exclude file types argument

* add gitignore

* add exclude logic

* add tests

* Update pkg/finder/fsfinder.go

Co-authored-by: Jamie Davidson <[email protected]>

* fix tab to spaces indentation

---------

Co-authored-by: Jamie Davidson <[email protected]>

.gitignore

@@ -14,3 +14,4 @@ cmd/validator/validator
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+.vscode

cmd/validator/validator.go

@@ -10,9 +10,11 @@ Usage:
 
 The flags are:
     -exclude-dirs string
-    	Subdirectories to exclude when searching for configuration files
-	-reporter string
-		Format of printed report. Currently supports standard, JSON.
+        Subdirectories to exclude when searching for configuration files.
+    -reporter string
+        Format of printed report. Currently supports standard, JSON.
+    -exclude-file-types string
+        A comma separated list of file types to ignore.
 */
 
 package main
@@ -31,9 +33,10 @@ import (
 )
 
 type validatorConfig struct {
-	searchPath  string
-	excludeDirs *string
-	reportType  *string
+	searchPath       string
+	excludeDirs      *string
+	excludeFileTypes *string
+	reportType       *string
 }
 
 // Custom Usage function to cover
@@ -56,6 +59,7 @@ func getFlags() (validatorConfig, error) {
 	flag.Usage = validatorUsage
 	excludeDirsPtr := flag.String("exclude-dirs", "", "Subdirectories to exclude when searching for configuration files")
 	reportTypePtr := flag.String("reporter", "standard", "Format of the printed report. Options are standard and json")
+	excludeFileTypesPtr := flag.String("exclude-file-types", "", "A comma separated list of file types to ignore")
 	flag.Parse()
 
 	var searchPath string
@@ -79,6 +83,7 @@ func getFlags() (validatorConfig, error) {
 	config := validatorConfig{
 		searchPath,
 		excludeDirsPtr,
+		excludeFileTypesPtr,
 		reportTypePtr,
 	}
 
@@ -107,11 +112,13 @@ func mainInit() int {
 	// it needs to be split into a slice of strings
 	excludeDirs := strings.Split(*validatorConfig.excludeDirs, ",")
 	reporter := getReporter(validatorConfig.reportType)
+	excludeFileTypes := strings.Split(*validatorConfig.excludeFileTypes, ",")
 
 	// Initialize a file system finder
 	fileSystemFinder := finder.FileSystemFinderInit(
 		finder.WithPathRoot(searchPath),
 		finder.WithExcludeDirs(excludeDirs),
+		finder.WithExcludeFileTypes(excludeFileTypes),
 	)
 
 	// Initialize the CLI

cmd/validator/validator_test.go

@@ -17,10 +17,11 @@ func Test_flags(t *testing.T) {
 		Args         []string
 		ExpectedExit int
 	}{
-		{"flags set", []string{"--exclude-dirs=subdir", "--reporter=json", "."}, 0},
-		{"flags set", []string{"--exclude-dirs=subdir", "--reporter=junit", "."}, 1},
-		{"flags set", []string{"/path/does/not/exit"}, 1},
 		{"blank", []string{}, 0},
+		{"flags set, json reporter", []string{"--exclude-dirs=subdir", "--reporter=json", "."}, 0},
+		{"flags set, junit reported", []string{"--exclude-dirs=subdir", "--reporter=junit", "."}, 1},
+		{"bad path", []string{"/path/does/not/exit"}, 1},
+		{"exclude file types set", []string{"--exclude-file-types=json", "."}, 0},
 	}
 	for _, tc := range cases {
 		// this call is required because otherwise flags panics,

pkg/finder/finder_test.go

@@ -1,9 +1,11 @@
 package finder
 
 import (
+	"fmt"
+	"testing"
+
 	"github.com/Boeing/config-file-validator/pkg/filetype"
 	"github.com/Boeing/config-file-validator/pkg/validator"
-	"testing"
 )
 
 func Test_fsFinder(t *testing.T) {
@@ -40,6 +42,24 @@ func Test_fsFinderExcludeDirs(t *testing.T) {
 	}
 }
 
+func Test_fsFinderExcludeFileTypes(t *testing.T) {
+	fsFinder := FileSystemFinderInit(
+		WithPathRoot("../../test/fixtures/exclude-file-types"),
+		WithExcludeFileTypes([]string{"json"}),
+	)
+
+	files, err := fsFinder.Find()
+
+	if len(files) != 1 {
+		fmt.Println(files)
+		t.Errorf("Wrong amount of files, expected 1 got %d", len(files))
+	}
+
+	if err != nil {
+		t.Errorf("Unable to find files")
+	}
+}
+
 func Test_fsFinderCustomTypes(t *testing.T) {
 	jsonFileType := filetype.FileType{
 		Name:       "json",

pkg/finder/fsfinder.go

@@ -1,16 +1,19 @@
 package finder
 
 import (
-	"github.com/Boeing/config-file-validator/pkg/filetype"
 	"io/fs"
 	"os"
 	"path/filepath"
+	"strings"
+
+	"github.com/Boeing/config-file-validator/pkg/filetype"
 )
 
 type FileSystemFinder struct {
-	PathRoot    string
-	FileTypes   []filetype.FileType
-	ExcludeDirs []string
+	PathRoot         string
+	FileTypes        []filetype.FileType
+	ExcludeDirs      []string
+	ExcludeFileTypes []string
 }
 
 type FSFinderOptions func(*FileSystemFinder)
@@ -36,6 +39,13 @@ func WithExcludeDirs(excludeDirs []string) FSFinderOptions {
 	}
 }
 
+// WithExcludeFileTypes adds excluded file types to FSFinder.
+func WithExcludeFileTypes(types []string) FSFinderOptions {
+	return func(fsf *FileSystemFinder) {
+		fsf.ExcludeFileTypes = types
+	}
+}
+
 func FileSystemFinderInit(opts ...FSFinderOptions) *FileSystemFinder {
 	var defaultExludeDirs []string
 	defaultPathRoot := "."
@@ -78,14 +88,16 @@ func (fsf FileSystemFinder) Find() ([]FileMetadata, error) {
 			}
 
 			if !dirEntry.IsDir() {
-				walkFileExtension := filepath.Ext(path)
+				// filepath.Ext() returns the extension name with a dot so it
+				// needs to be removed.
+				walkFileExtension := strings.TrimPrefix(filepath.Ext(path), ".")
+				if fsf.isExtensionExcluded(walkFileExtension) {
+					return nil
+				}
 
 				for _, fileType := range fsf.FileTypes {
 					for _, extension := range fileType.Extensions {
-						// filepath.Ext() returns the extension name with a dot
-						// so it needs to be prepended to the FileType extension
-						// in order to match
-						if ("." + extension) == walkFileExtension {
+						if extension == walkFileExtension {
 							fileMetadata := FileMetadata{dirEntry.Name(), path, fileType}
 							matchingFiles = append(matchingFiles, fileMetadata)
 						}
@@ -102,3 +114,15 @@ func (fsf FileSystemFinder) Find() ([]FileMetadata, error) {
 
 	return matchingFiles, nil
 }
+
+// isExtensionExcluded returns true if extension exists in exclude list.
+// TODO: refactor to slices.Contains when project will be updated to go 1.21.
+func (fsf FileSystemFinder) isExtensionExcluded(ext string) bool {
+	for _, typ := range fsf.ExcludeFileTypes {
+		if typ == ext {
+			return true
+		}
+	}
+
+	return false
+}

test/fixtures/exclude-file-types/excluded.json

@@ -0,0 +1 @@
+{}