feat: extend matching

alingse · Jul 16, 2022 · 52ca441 · 52ca441
1 parent 6114a44
commit 52ca441
Show file tree

Hide file tree

Showing 12 changed files with 305 additions and 264 deletions.
diff --git a/asasalint.go b/asasalint.go
@@ -1,10 +1,13 @@
 package asasalint
 
 import (
+	"bytes"
 	"fmt"
 	"go/ast"
+	"go/printer"
 	"go/token"
 	"go/types"
+	"log"
 	"regexp"
 	"strings"
 
@@ -13,7 +16,7 @@ import (
 	"golang.org/x/tools/go/ast/inspector"
 )
 
-const BuiltinExclusions = `^(Print|Fprint|Sprint|Fatal|Panic|Error|Warn|Warning|Info|Debug)(|f|ln)$`
+const BuiltinExclusions = `^(fmt|log|logger)\.(Print|Fprint|Sprint|Fatal|Panic|Error|Warn|Warning|Info|Debug)(|f|ln)$`
 
 type LinterSetting struct {
 	Exclude             []string
@@ -91,7 +94,11 @@ func (a *analyzer) AsCheckVisitor(pass *analysis.Pass) func(ast.Node) {
 			return
 		}
 
-		fnName := getFuncName(caller)
+		fnName, err := getFuncName(pass.Fset, caller)
+		if err != nil {
+			log.Println(err)
+			return
+		}
 
 		for _, exclude := range a.excludes {
 			if exclude.MatchString(fnName) {
@@ -126,15 +133,13 @@ func (a *analyzer) AsCheckVisitor(pass *analysis.Pass) func(ast.Node) {
 	}
 }
 
-func getFuncName(caller *ast.CallExpr) string {
-	switch n := caller.Fun.(type) {
-	case *ast.Ident:
-		return n.Name
-	case *ast.SelectorExpr:
-		return n.Sel.Name
-	default:
-		return ""
+func getFuncName(fset *token.FileSet, caller *ast.CallExpr) (string, error) {
+	buf := new(bytes.Buffer)
+	if err := printer.Fprint(buf, fset, caller.Fun); err != nil {
+		return "", fmt.Errorf("unable to print node at %s: %w", fset.Position(caller.Fun.Pos()), err)
 	}
+
+	return buf.String(), nil
 }
 
 func isSliceAnyVariadicFuncType(typ types.Type) (r bool) {

diff --git a/asasalint_test.go b/asasalint_test.go
@@ -54,33 +54,69 @@ func TestIsSliceAnyVariadicFuncType(t *testing.T) {
 }
 
 func TestGetFuncName(t *testing.T) {
-	src := `package p
+	testCases := []struct {
+		desc     string
+		src      string
+		expected string
+	}{
+		{
+			desc: "function",
+			src: `package p
 func hello(a int, b ...any) {}
 func hello2(a int, b int) { hello(a, b)}
+`,
+			expected: "hello",
+		},
+		{
+			desc: "method",
+			src: `package p
 type A struct {}
-func (a *A) hello(a int, b ...any) {
-	hello(a, b...)
-}
+func (a *A) hello(a int, b ...any) {}
 func (a *A) hello2(a int, b int) {
 	a.hello(a, b)
 }
-`
-	fset := token.NewFileSet()
-	f, err := parser.ParseFile(fset, "src.go", src, 0)
-	if err != nil {
-		panic(err)
+`,
+			expected: "a.hello",
+		},
+		{
+			desc: "function inside a method",
+			src: `package p
+type A struct {}
+func (a *A) hello(a int, b ...any) {
+	hello(a, b...)
+}
+`,
+			expected: "hello",
+		},
 	}
 
-	ast.Inspect(f, func(n ast.Node) bool {
-		switch x := n.(type) {
-		case *ast.CallExpr:
-			s := getFuncName(x)
-			if s != "hello" {
-				t.Errorf("getFuncName(%#v) = %v, want hello", x.Fun, s)
+	for _, test := range testCases {
+		test := test
+		t.Run(test.desc, func(t *testing.T) {
+			t.Parallel()
+
+			fset := token.NewFileSet()
+			f, err := parser.ParseFile(fset, "src.go", test.src, 0)
+			if err != nil {
+				panic(err)
 			}
-		}
-		return true
-	})
+
+			ast.Inspect(f, func(n ast.Node) bool {
+				switch x := n.(type) {
+				case *ast.CallExpr:
+					s, err := getFuncName(fset, x)
+					if err != nil {
+						t.Fatal(err)
+					}
+
+					if s != test.expected {
+						t.Errorf("%s: got %s, want %s", fset.Position(x.Fun.Pos()), s, test.expected)
+					}
+				}
+				return true
+			})
+		})
+	}
 }
 
 func TestAnalyzer(t *testing.T) {

diff --git a/testdata/src/basic/logger.go b/testdata/src/basic/logger.go
@@ -34,38 +34,38 @@ type Logger interface {
 	Panicln(args ...interface{})
 }
 
-func fromLogger(l Logger) {
+func fromLogger(logger Logger) {
 	var a = []any{1, 2, 3}
 
-	l.Debug(a)
-	l.Debugf("%v", a)
-	l.Debugln(a)
+	logger.Debug(a)
+	logger.Debugf("%v", a)
+	logger.Debugln(a)
 
-	l.Info(a)
-	l.Infof("%v", a)
-	l.Infoln(a)
+	logger.Info(a)
+	logger.Infof("%v", a)
+	logger.Infoln(a)
 
-	l.Print(a)
-	l.Printf("%v", a)
-	l.Println(a)
+	logger.Print(a)
+	logger.Printf("%v", a)
+	logger.Println(a)
 
-	l.Warn(a)
-	l.Warnf("%v", a)
-	l.Warnln(a)
+	logger.Warn(a)
+	logger.Warnf("%v", a)
+	logger.Warnln(a)
 
-	l.Warning(a)
-	l.Warningf("%v", a)
-	l.Warningln(a)
+	logger.Warning(a)
+	logger.Warningf("%v", a)
+	logger.Warningln(a)
 
-	l.Error(a)
-	l.Errorf("%v", a)
-	l.Errorln(a)
+	logger.Error(a)
+	logger.Errorf("%v", a)
+	logger.Errorln(a)
 
-	l.Fatal(a)
-	l.Fatalf("%v", a)
-	l.Fatalln(a)
+	logger.Fatal(a)
+	logger.Fatalf("%v", a)
+	logger.Fatalln(a)
 
-	l.Panic(a)
-	l.Panicf("%v", a)
-	l.Panicln(a)
+	logger.Panic(a)
+	logger.Panicf("%v", a)
+	logger.Panicln(a)
 }
diff --git a/testdata/src/basic/logger_test.go b/testdata/src/basic/logger_test.go
@@ -3,39 +3,39 @@ package main
 import "testing"
 
 func TestLogger(t *testing.T) {
-	var l Logger
+	var logger Logger
 
 	var a = []any{1, 2, 3}
 
-	l.Debug(a)
-	l.Debugf("%v", a)
-	l.Debugln(a)
+	logger.Debug(a)
+	logger.Debugf("%v", a)
+	logger.Debugln(a)
 
-	l.Info(a)
-	l.Infof("%v", a)
-	l.Infoln(a)
+	logger.Info(a)
+	logger.Infof("%v", a)
+	logger.Infoln(a)
 
-	l.Print(a)
-	l.Printf("%v", a)
-	l.Println(a)
+	logger.Print(a)
+	logger.Printf("%v", a)
+	logger.Println(a)
 
-	l.Warn(a)
-	l.Warnf("%v", a)
-	l.Warnln(a)
+	logger.Warn(a)
+	logger.Warnf("%v", a)
+	logger.Warnln(a)
 
-	l.Warning(a)
-	l.Warningf("%v", a)
-	l.Warningln(a)
+	logger.Warning(a)
+	logger.Warningf("%v", a)
+	logger.Warningln(a)
 
-	l.Error(a)
-	l.Errorf("%v", a)
-	l.Errorln(a)
+	logger.Error(a)
+	logger.Errorf("%v", a)
+	logger.Errorln(a)
 
-	l.Fatal(a)
-	l.Fatalf("%v", a)
-	l.Fatalln(a)
+	logger.Fatal(a)
+	logger.Fatalf("%v", a)
+	logger.Fatalln(a)
 
-	l.Panic(a)
-	l.Panicf("%v", a)
-	l.Panicln(a)
+	logger.Panic(a)
+	logger.Panicf("%v", a)
+	logger.Panicln(a)
 }
diff --git a/testdata/src/custom/logger.go b/testdata/src/custom/logger.go
@@ -34,38 +34,38 @@ type Logger interface {
 	Panicln(args ...interface{})
 }
 
-func fromLogger(l Logger) {
+func fromLogger(logger Logger) {
 	var a = []any{1, 2, 3}
 
-	l.Debug(a)
-	l.Debugf("%v", a)
-	l.Debugln(a)
+	logger.Debug(a)
+	logger.Debugf("%v", a)
+	logger.Debugln(a)
 
-	l.Info(a)
-	l.Infof("%v", a)
-	l.Infoln(a)
+	logger.Info(a)
+	logger.Infof("%v", a)
+	logger.Infoln(a)
 
-	l.Print(a)
-	l.Printf("%v", a)
-	l.Println(a)
+	logger.Print(a)
+	logger.Printf("%v", a)
+	logger.Println(a)
 
-	l.Warn(a)
-	l.Warnf("%v", a)
-	l.Warnln(a)
+	logger.Warn(a)
+	logger.Warnf("%v", a)
+	logger.Warnln(a)
 
-	l.Warning(a)
-	l.Warningf("%v", a)
-	l.Warningln(a)
+	logger.Warning(a)
+	logger.Warningf("%v", a)
+	logger.Warningln(a)
 
-	l.Error(a)
-	l.Errorf("%v", a)
-	l.Errorln(a)
+	logger.Error(a)
+	logger.Errorf("%v", a)
+	logger.Errorln(a)
 
-	l.Fatal(a)
-	l.Fatalf("%v", a)
-	l.Fatalln(a)
+	logger.Fatal(a)
+	logger.Fatalf("%v", a)
+	logger.Fatalln(a)
 
-	l.Panic(a)
-	l.Panicf("%v", a)
-	l.Panicln(a)
+	logger.Panic(a)
+	logger.Panicf("%v", a)
+	logger.Panicln(a)
 }