formatter: support require only and suite only packages (#188)

* formatter: support require only and suite only packages

* self-review fixes

analyzer/analyzer_test.go

@@ -53,6 +53,20 @@ func TestTestifyLint(t *testing.T) {
 				"expected-actual.pattern": "goldenValue",
 			},
 		},
+		{
+			dir: "formatter-issue170",
+			flags: map[string]string{
+				"disable-all": "true",
+				"enable":      checkers.NewFormatter().Name(),
+			},
+		},
+		{
+			dir: "formatter-issue170-suite",
+			flags: map[string]string{
+				"disable-all": "true",
+				"enable":      checkers.NewFormatter().Name(),
+			},
+		},
 		{
 			dir: "formatter-not-defaults",
 			flags: map[string]string{

analyzer/testdata/src/formatter-issue170-suite/suie_only_test.go

@@ -0,0 +1,24 @@
+package formatterissue170
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+func TestFormatter(t *testing.T) {
+	suite.Run(t, new(FormatterSuite))
+}
+
+type FormatterSuite struct {
+	suite.Suite
+}
+
+func (s *FormatterSuite) TestFormatter() {
+	s.True(false, fmt.Sprintf("expected %v, got %v", true, false)) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}
+
+func (s FormatterSuite) TestFormatterValueRecv() {
+	s.False(true, fmt.Sprintf("expected %v, got %v", true, false)) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}

analyzer/testdata/src/formatter-issue170-suite/suie_only_test.go.golden

@@ -0,0 +1,24 @@
+package formatterissue170
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+func TestFormatter(t *testing.T) {
+	suite.Run(t, new(FormatterSuite))
+}
+
+type FormatterSuite struct {
+	suite.Suite
+}
+
+func (s *FormatterSuite) TestFormatter() {
+	s.True(false, "expected %v, got %v", true, false) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}
+
+func (s FormatterSuite) TestFormatterValueRecv() {
+	s.False(true, "expected %v, got %v", true, false) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}

analyzer/testdata/src/formatter-issue170/require_only_test.go

@@ -0,0 +1,12 @@
+package formatterissue170
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestFormatter(t *testing.T) {
+	require.True(t, false, fmt.Sprintf("expected %v, got %v", true, false)) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}

analyzer/testdata/src/formatter-issue170/require_only_test.go.golden

@@ -0,0 +1,12 @@
+package formatterissue170
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestFormatter(t *testing.T) {
+	require.True(t, false, "expected %v, got %v", true, false) // want "formatter: remove unnecessary fmt\\.Sprintf"
+}

internal/checkers/formatter.go

@@ -60,7 +60,7 @@ func (checker Formatter) Check(pass *analysis.Pass, call *CallMeta) (result *ana
 }
 
 func (checker Formatter) checkNotFmtAssertion(pass *analysis.Pass, call *CallMeta) *analysis.Diagnostic {
-	msgAndArgsPos, ok := isPrintfLikeCall(pass, call, call.Fn.Signature)
+	msgAndArgsPos, ok := isPrintfLikeCall(pass, call)
 	if !ok {
 		return nil
 	}
@@ -121,21 +121,51 @@ func (checker Formatter) checkFmtAssertion(pass *analysis.Pass, call *CallMeta)
 	return result
 }
 
-func isPrintfLikeCall(pass *analysis.Pass, call *CallMeta, sig *types.Signature) (int, bool) {
-	msgAndArgsPos := getMsgAndArgsPosition(sig)
+func isPrintfLikeCall(pass *analysis.Pass, call *CallMeta) (int, bool) {
+	msgAndArgsPos := getMsgAndArgsPosition(call.Fn.Signature)
 	if msgAndArgsPos < 0 {
 		return -1, false
 	}
 
-	fmtFn := analysisutil.ObjectOf(pass.Pkg, testify.AssertPkgPath, call.Fn.Name+"f")
-	if fmtFn == nil {
-		// NOTE(a.telyshev): No formatted analogue of assertion.
+	if !assertHasFormattedAnalogue(pass, call) {
 		return -1, false
 	}
 
 	return msgAndArgsPos, len(call.ArgsRaw) > msgAndArgsPos
 }
 
+func assertHasFormattedAnalogue(pass *analysis.Pass, call *CallMeta) bool {
+	if fn := analysisutil.ObjectOf(pass.Pkg, testify.AssertPkgPath, call.Fn.Name+"f"); fn != nil {
+		return true
+	}
+
+	if fn := analysisutil.ObjectOf(pass.Pkg, testify.RequirePkgPath, call.Fn.Name+"f"); fn != nil {
+		return true
+	}
+
+	recv := call.Fn.Signature.Recv()
+	if recv == nil {
+		return false
+	}
+
+	recvT := recv.Type()
+	if ptr, ok := recv.Type().(*types.Pointer); ok {
+		recvT = ptr.Elem()
+	}
+
+	suite, ok := recvT.(*types.Named)
+	if !ok {
+		return false
+	}
+	for i := 0; i < suite.NumMethods(); i++ {
+		if suite.Method(i).Name() == call.Fn.Name+"f" {
+			return true
+		}
+	}
+
+	return false
+}
+
 func getMsgAndArgsPosition(sig *types.Signature) int {
 	params := sig.Params()
 	if params.Len() < 1 {