Go: Fix buggy FindAllFilesWithName implementation

go/extractor/configurebaseline/configurebaseline.go

@@ -3,24 +3,12 @@ package configurebaseline
 import (
 	"encoding/json"
 	"io/fs"
-	"os"
 	"path"
 	"path/filepath"
 
 	"github.com/github/codeql-go/extractor/util"
 )
 
-func fileExists(path string) bool {
-	stat, err := os.Stat(path)
-	return err == nil && stat.Mode().IsRegular()
-}
-
-// Decides if `dirPath` is a vendor directory by testing whether it is called `vendor`
-// and contains a `modules.txt` file.
-func isGolangVendorDirectory(dirPath string) bool {
-	return filepath.Base(dirPath) == "vendor" && fileExists(filepath.Join(dirPath, "modules.txt"))
-}
-
 type BaselineConfig struct {
 	PathsIgnore []string `json:"paths-ignore"`
 }
@@ -38,7 +26,7 @@ func GetConfigBaselineAsJSON(rootDir string) ([]byte, error) {
 				// it will not be extracted either.
 				return nil
 			}
-			if isGolangVendorDirectory(dirPath) {
+			if util.IsGolangVendorDirectory(dirPath) {
 				// Note that CodeQL expects a forward-slash-separated path, even on Windows.
 				vendorDirs = append(vendorDirs, path.Join(filepath.ToSlash(dirPath), "**"))
 				return filepath.SkipDir

go/extractor/project/project.go

@@ -184,12 +184,12 @@ func RemoveTemporaryExtractorFiles() {
 
 // Find all go.work files in the working directory and its subdirectories
 func findGoWorkFiles() []string {
-	return util.FindAllFilesWithName(".", "go.work", "vendor")
+	return util.FindAllFilesWithName(".", "go.work", util.SkipVendorChecks...)
 }
 
 // Find all go.mod files in the specified directory and its subdirectories
 func findGoModFiles(root string) []string {
-	return util.FindAllFilesWithName(root, "go.mod", "vendor")
+	return util.FindAllFilesWithName(root, "go.mod", util.SkipVendorChecks...)
 }
 
 // A regular expression for the Go toolchain version syntax.
@@ -547,8 +547,8 @@ func startsWithAnyOf(str string, prefixes []string) bool {
 // Finds Go workspaces in the current working directory.
 func GetWorkspaceInfo(emitDiagnostics bool) []GoWorkspace {
 	bazelPaths := slices.Concat(
-		util.FindAllFilesWithName(".", "BUILD", "vendor"),
-		util.FindAllFilesWithName(".", "BUILD.bazel", "vendor"),
+		util.FindAllFilesWithName(".", "BUILD", util.SkipVendorChecks...),
+		util.FindAllFilesWithName(".", "BUILD.bazel", util.SkipVendorChecks...),
 	)
 	if len(bazelPaths) > 0 {
 		// currently not supported

go/extractor/util/util.go

@@ -152,15 +152,24 @@ func FindGoFiles(root string) bool {
 	return found
 }
 
-func FindAllFilesWithName(root string, name string, dirsToSkip ...string) []string {
+// The type of check function used by `FindAllFilesWithName` to decide whether to skip the directory named by `path`.
+type FindAllFilesWithNameSkipCheck func(path string) bool
+
+// Commonly we only want to skip `vendor` directories in `FindAllFilesWithName`. This array is a suitable
+// argument for `dirsToSkip` which skips `vendor` directories.
+var SkipVendorChecks = []FindAllFilesWithNameSkipCheck{IsGolangVendorDirectory}
+
+// Returns an array of all files matching `name` within the path at `root`.
+// The `dirsToSkip` array contains check functions used to decide which directories to skip.
+func FindAllFilesWithName(root string, name string, dirsToSkip ...FindAllFilesWithNameSkipCheck) []string {
 	paths := make([]string, 0, 1)
 	filepath.WalkDir(root, func(path string, d fs.DirEntry, err error) error {
 		if err != nil {
 			return err
 		}
 		if d.IsDir() {
 			for _, dirToSkip := range dirsToSkip {
-				if path == dirToSkip {
+				if dirToSkip(path) {
 					return filepath.SkipDir
 				}
 			}
@@ -287,3 +296,15 @@ func getImportPathFromRepoURL(repourl string) string {
 	path = regexp.MustCompile(`^/+|\.git$`).ReplaceAllString(path, "")
 	return host + "/" + path
 }
+
+// Decides if `path` refers to a file that exists.
+func fileExists(path string) bool {
+	stat, err := os.Stat(path)
+	return err == nil && stat.Mode().IsRegular()
+}
+
+// Decides if `dirPath` is a vendor directory by testing whether it is called `vendor`
+// and contains a `modules.txt` file.
+func IsGolangVendorDirectory(dirPath string) bool {
+	return filepath.Base(dirPath) == "vendor" && fileExists(filepath.Join(dirPath, "modules.txt"))
+}

go/ql/integration-tests/mixed-layout/src/module/vendor/modules.txt

@@ -0,0 +1,3 @@
+# example.com/test v0.1.0
+## explicit; go 1.14
+example.com/test

go/ql/integration-tests/mixed-layout/src/workspace/go.work.sum

@@ -0,0 +1,3 @@
+golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
+golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=