Allow GO build flags to be defined so that we can vet code that is under a build tag. (#10)

Co-authored-by: James FitzGerald <[email protected]>

Author: james-fitzgerald

main.go

@@ -44,6 +44,7 @@ func (s *SQLVet) Vet() {
 			Schema: s.Schema,
 		},
 		s.ProjectRoot,
+		s.Cfg.BuildFlags,
 		s.Cfg.SqlFuncMatchers,
 	)
 	if err != nil {

pkg/config/config.go

@@ -14,6 +14,7 @@ import (
 type Config struct {
 	DbEngine        string               `toml:"db_engine"`
 	SchemaPath      string               `toml:"schema_path"`
+	BuildFlags      string               `toml:"build_flags"`
 	SqlFuncMatchers []vet.SqlFuncMatcher `toml:"sqlfunc_matchers"`
 }
 

pkg/vet/gosource.go

@@ -223,7 +223,7 @@ func getMatchers(extraMatchers []SqlFuncMatcher) []*SqlFuncMatcher {
 	return matchers
 }
 
-func loadGoPackages(dir string) ([]*packages.Package, error) {
+func loadGoPackages(dir string, buildFlags string) ([]*packages.Package, error) {
 	cfg := &packages.Config{
 		Mode: packages.NeedName |
 			packages.NeedFiles |
@@ -235,6 +235,9 @@ func loadGoPackages(dir string) ([]*packages.Package, error) {
 		Dir: dir,
 		Env: append(os.Environ(), "GO111MODULE=auto"),
 	}
+	if buildFlags != "" {
+		cfg.BuildFlags = strings.Split(buildFlags, " ")
+	}
 	dirAbs, err := filepath.Abs(dir)
 	if err != nil {
 		return nil, fmt.Errorf("Invalid path: %w", err)
@@ -484,13 +487,13 @@ func getSortedIgnoreNodes(pkgs []*packages.Package) []ast.Node {
 	return ignoreNodes
 }
 
-func CheckDir(ctx VetContext, dir string, extraMatchers []SqlFuncMatcher) ([]*QuerySite, error) {
+func CheckDir(ctx VetContext, dir, buildFlags string, extraMatchers []SqlFuncMatcher) ([]*QuerySite, error) {
 	_, err := os.Stat(filepath.Join(dir, "go.mod"))
 	if os.IsNotExist(err) {
 		return nil, errors.New("sqlvet only supports projects using go modules for now.")
 	}
 
-	pkgs, err := loadGoPackages(dir)
+	pkgs, err := loadGoPackages(dir, buildFlags)
 	if err != nil {
 		return nil, err
 	}
@@ -539,6 +542,10 @@ func CheckDir(ctx VetContext, dir string, extraMatchers []SqlFuncMatcher) ([]*Qu
 		BuildCallGraph: true,
 	})
 
+	if err != nil {
+		return nil, err
+	}
+
 	queries := []*QuerySite{}
 
 	cg := anaRes.CallGraph

pkg/vet/gosource_test.go

@@ -61,7 +61,7 @@ func main() {
 `), 0644)
 	assert.NoError(t, err)
 
-	_, err = vet.CheckDir(vet.VetContext{}, dir, nil)
+	_, err = vet.CheckDir(vet.VetContext{}, dir, "", nil)
 	assert.Error(t, err)
 }
 
@@ -105,7 +105,7 @@ func main() {
 	err := ioutil.WriteFile(fpath, source, 0644)
 	assert.NoError(t, err)
 
-	queries, err := vet.CheckDir(vet.VetContext{}, dir, nil)
+	queries, err := vet.CheckDir(vet.VetContext{}, dir, "", nil)
 	assert.NoError(t, err)
 	assert.Equal(t, 0, len(queries))
 }
@@ -162,7 +162,7 @@ func main() {
 	err := ioutil.WriteFile(fpath, source, 0644)
 	assert.NoError(t, err)
 
-	queries, err := vet.CheckDir(vet.VetContext{}, dir, nil)
+	queries, err := vet.CheckDir(vet.VetContext{}, dir, "", nil)
 	if err != nil {
 		t.Fatalf("Failed to load package: %s", err.Error())
 		return
@@ -214,7 +214,7 @@ func main() {
 	os.Chdir(parentDir)
 	defer os.Chdir(cwd)
 
-	queries, err := vet.CheckDir(vet.VetContext{}, filepath.Base(dir), nil)
+	queries, err := vet.CheckDir(vet.VetContext{}, filepath.Base(dir), "", nil)
 	if err != nil {
 		t.Fatalf("Failed to load package: %s", err.Error())
 		return
@@ -258,7 +258,7 @@ func main() {
 	err := ioutil.WriteFile(fpath, source, 0644)
 	assert.NoError(t, err)
 
-	queries, err := vet.CheckDir(vet.VetContext{}, dir, nil)
+	queries, err := vet.CheckDir(vet.VetContext{}, dir, "", nil)
 	if err != nil {
 		t.Fatalf("Failed to load package: %s", err.Error())
 		return
@@ -284,3 +284,33 @@ func main() {
 	assert.Equal(t, "SELECT 2 FROM foo WHERE id=$1 OR value=$1", queries[3].Query)
 	assert.Equal(t, 1, queries[3].ParameterArgCount)
 }
+
+func (s *GoSourceTests) SubTestBuildFlags(t *testing.T, fixtures struct {
+	TmpDir string `fixture:"GoSourceTmpDir"`
+}) {
+	dir := fixtures.TmpDir
+
+	source := []byte(`
+//+build myBuildTag
+
+package main
+
+import (
+	"fmt"
+)
+
+func main() {
+	fmt.Printf("Hello World\n")
+}
+`)
+
+	fpath := filepath.Join(dir, "main.go")
+	err := ioutil.WriteFile(fpath, source, 0644)
+	assert.NoError(t, err)
+
+	_, err = vet.CheckDir(vet.VetContext{}, dir, "", nil)
+	assert.Error(t, err)
+
+	_, err = vet.CheckDir(vet.VetContext{}, dir, "-tags myBuildTag", nil)
+	assert.NoError(t, err)
+}