#5: remove hidden files from discovery (#16)

#5: remove hidden files from discovery

Author: iignatevich

pkg/action/discover.go

@@ -40,9 +40,12 @@ var actionsSubdir = strings.Join([]string{"", actionsDirname, ""}, string(filepa
 
 func (ad *yamlDiscovery) isValid(path string, d fs.DirEntry) bool {
 	i := strings.LastIndex(path, actionsSubdir)
-	return !d.IsDir() &&
-		i != -1 &&
-		strings.Count(path[i+len(actionsSubdir):], string(filepath.Separator)) == 1 && // Nested actions are not allowed.
+
+	if d.IsDir() || i == -1 || isHidden(path) {
+		return false
+	}
+
+	return strings.Count(path[i+len(actionsSubdir):], string(filepath.Separator)) == 1 && // Nested actions are not allowed.
 		ad.targetRgx.MatchString(d.Name())
 }
 
@@ -52,11 +55,19 @@ func (ad *yamlDiscovery) findFiles() chan string {
 	ch := make(chan string, 10)
 	go func() {
 		err := fs.WalkDir(ad.fs, ".", func(path string, d fs.DirEntry, err error) error {
-			if err == nil && ad.isValid(path, d) {
+			if err != nil {
+				return err
+			}
+
+			if d.IsDir() && isHidden(path) {
+				return fs.SkipDir
+			}
+
+			if ad.isValid(path, d) {
 				ch <- path
 			}
 
-			return err
+			return nil
 		})
 
 		if err != nil {

pkg/action/discover_test.go

@@ -87,6 +87,7 @@ func Test_Discover_isValid(t *testing.T) {
 		{"incorrect filename prefix", "1/2/actions/3/myaction.yaml", false},   // Incorrect prefix.
 		{"incorrect filename suffix", "1/2/actions/3/action.yaml.bkp", false}, // Incorrect suffix.
 		{"incorrect path", "1/2/3/action.yaml", false},                        // File not inside an "actions" directory.
+		{"incorrect hidden path", ".1/2/actions/3/action.yml", false},         // Invalid hidden directory
 		{"nested action", "1/2/actions/3/4/5/action.yaml", false},             // There is a deeper nesting in actions directory.
 		{"root action", "actions/verb/action.yaml", false},                    // Actions are located in root.
 		{"dir", "1/2/actions/3", false},                                       // A directory is given.

pkg/action/discover_unix.go

@@ -0,0 +1,19 @@
+//go:build !windows
+// +build !windows
+
+package action
+
+import (
+	"path/filepath"
+)
+
+func isHidden(path string) bool {
+	pathList := filepath.SplitList(path)
+	for _, v := range pathList {
+		if len(v) > 1 && v[0:1] == "." {
+			return true
+		}
+	}
+
+	return false
+}

pkg/action/discover_windows.go

@@ -0,0 +1,26 @@
+// Package action provides implementations of discovering and running actions.
+package action
+
+import (
+	"path/filepath"
+	"syscall"
+)
+
+func isHidden(path string) bool {
+	absPath, err := filepath.Abs(path)
+	if err != nil {
+		return false
+	}
+
+	pointer, err := syscall.UTF16PtrFromString(`\\?\` + absPath)
+	if err != nil {
+		return false
+	}
+
+	attributes, err := syscall.GetFileAttributes(pointer)
+	if err != nil {
+		return false
+	}
+
+	return attributes&syscall.FILE_ATTRIBUTE_HIDDEN != 0
+}