snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

tools/mattermost-govet/errorAssertions/errorAssertions.go

@@ -0,0 +1,71 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package errorAssertions
+
+import (
+	"go/ast"
+
+	"github.com/mattermost/mattermost/tools/mattermost-govet/util"
+	"golang.org/x/tools/go/analysis"
+)
+
+var (
+	appErrorType = util.AppErrType
+)
+
+var Analyzer = &analysis.Analyzer{
+	Name: "errorAssertions",
+	Doc:  "check for (require/assert).Nil/NotNil(t, error)",
+	Run:  run,
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	checks := []struct {
+		AssertionName     string
+		ForbiddenTypeName string
+		ExpectedAssertion string
+	}{
+		{"Nil", "error", "NoError"},
+		{"NotNil", "error", "Error"},
+		{"Nilf", "error", "NoErrorf"},
+		{"NotNilf", "error", "Errorf"},
+		{"Error", appErrorType, "NotNil"},
+		{"NoError", appErrorType, "Nil"},
+		{"Errorf", appErrorType, "NotNilf"},
+		{"NoErrorf", appErrorType, "Nilf"},
+	}
+
+	for _, file := range pass.Files {
+		ast.Inspect(file, func(node ast.Node) bool {
+			switch x := node.(type) {
+			case *ast.CallExpr:
+				callExpr, _ := node.(*ast.CallExpr)
+				fun, ok := x.Fun.(*ast.SelectorExpr)
+				if !ok {
+					return true
+				}
+
+				idnt, ok := fun.X.(*ast.Ident)
+				if !ok {
+					return true
+				}
+
+				if (idnt.Name == "require" || idnt.Name == "assert") && len(callExpr.Args) > 1 {
+					for _, check := range checks {
+						if fun.Sel.Name == check.AssertionName {
+							if typeAndValue, ok := pass.TypesInfo.Types[callExpr.Args[1]]; ok && typeAndValue.Type.String() == check.ForbiddenTypeName {
+								pass.Reportf(callExpr.Pos(), "calling %s.%s on %s, please use %s.%s instead", idnt.Name, check.AssertionName, check.ForbiddenTypeName, idnt.Name, check.ExpectedAssertion)
+								return false
+							}
+						}
+					}
+				}
+
+				return true
+			}
+			return true
+		})
+	}
+	return nil, nil
+}

tools/mattermost-govet/errorAssertions/errorAssertions_test.go

@@ -0,0 +1,16 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package errorAssertions
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func Test(t *testing.T) {
+	appErrorType = "*model.AppError"
+	testdata := analysistest.TestData()
+	analysistest.Run(t, testdata, Analyzer, "model", "assert", "errorAssertions")
+}

tools/mattermost-govet/errorAssertions/testdata/src/assert/assert.go

@@ -0,0 +1,14 @@
+package require
+
+import (
+	"testing"
+)
+
+func Error(t *testing.T, err error, msgAndArgs ...interface{})                  {}
+func Errorf(t *testing.T, err error, msg string, args ...interface{})           {}
+func NoError(t *testing.T, err error, msgAndArgs ...interface{})                {}
+func NoErrorf(t *testing.T, err error, msg string, args ...interface{})         {}
+func Nil(t *testing.T, object interface{}, msgAndArgs ...interface{})           {}
+func NotNil(t *testing.T, object interface{}, msgAndArgs ...interface{})        {}
+func Nilf(t *testing.T, object interface{}, msg string, args ...interface{})    {}
+func NotNilf(t *testing.T, object interface{}, msg string, args ...interface{}) {}

tools/mattermost-govet/errorAssertions/testdata/src/errorAssertions/errorassertions.go

@@ -0,0 +1,51 @@
+package errorAssertions
+
+import (
+	"testing"
+
+	"assert"
+	"model"
+	"require"
+)
+
+func TestError(t *testing.T) {
+	var err error
+	assert.Error(t, err)
+	assert.Errorf(t, err, "%s", "foo")
+	assert.NoError(t, err)
+	assert.NoErrorf(t, err, "%s", "foo")
+	assert.Nil(t, err)                  // want `calling assert.Nil on error, please use assert.NoError instead`
+	assert.Nilf(t, err, "%s", "foo")    // want `calling assert.Nilf on error, please use assert.NoErrorf instead`
+	assert.NotNil(t, err)               // want `calling assert.NotNil on error, please use assert.Error instead`
+	assert.NotNilf(t, err, "%s", "foo") // want `calling assert.NotNilf on error, please use assert.Errorf instead`
+
+	require.Error(t, err)
+	require.Errorf(t, err, "%s", "foo")
+	require.NoError(t, err)
+	require.NoErrorf(t, err, "%s", "foo")
+	require.Nil(t, err)                  // want `calling require.Nil on error, please use require.NoError instead`
+	require.Nilf(t, err, "%s", "foo")    // want `calling require.Nilf on error, please use require.NoErrorf instead`
+	require.NotNil(t, err)               // want `calling require.NotNil on error, please use require.Error instead`
+	require.NotNilf(t, err, "%s", "foo") // want `calling require.NotNilf on error, please use require.Errorf instead`
+}
+
+func TestModelAppError(t *testing.T) {
+	var appErr *model.AppError
+	assert.Error(t, appErr)                 // want `calling assert.Error on \*model.AppError, please use assert.NotNil instead`
+	assert.Errorf(t, appErr, "%s", "foo")   // want `calling assert.Errorf on \*model.AppError, please use assert.NotNilf instead`
+	assert.NoError(t, appErr)               // want `calling assert.NoError on \*model.AppError, please use assert.Nil instead`
+	assert.NoErrorf(t, appErr, "%s", "foo") // want `calling assert.NoErrorf on \*model.AppError, please use assert.Nilf instead`
+	assert.Nil(t, appErr)
+	assert.Nilf(t, appErr, "%s", "foo")
+	assert.NotNil(t, appErr)
+	assert.NotNilf(t, appErr, "%s", "foo")
+
+	require.Error(t, appErr)                 // want `calling require.Error on \*model.AppError, please use require.NotNil instead`
+	require.Errorf(t, appErr, "%s", "foo")   // want `calling require.Errorf on \*model.AppError, please use require.NotNilf instead`
+	require.NoError(t, appErr)               // want `calling require.NoError on \*model.AppError, please use require.Nil instead`
+	require.NoErrorf(t, appErr, "%s", "foo") // want `calling require.NoErrorf on \*model.AppError, please use require.Nilf instead`
+	require.Nil(t, appErr)
+	require.Nilf(t, appErr, "%s", "foo")
+	require.NotNil(t, appErr)
+	require.NotNilf(t, appErr, "%s", "foo")
+}

tools/mattermost-govet/errorAssertions/testdata/src/model/model.go

@@ -0,0 +1,7 @@
+package model
+
+type AppError struct{}
+
+func (a *AppError) Error() string {
+	return "an error"
+}

tools/mattermost-govet/errorAssertions/testdata/src/require/require.go

@@ -0,0 +1,14 @@
+package assert
+
+import (
+	"testing"
+)
+
+func Error(t *testing.T, err error, msgAndArgs ...interface{})                  {}
+func Errorf(t *testing.T, err error, msg string, args ...interface{})           {}
+func NoError(t *testing.T, err error, msgAndArgs ...interface{})                {}
+func NoErrorf(t *testing.T, err error, msg string, args ...interface{})         {}
+func Nil(t *testing.T, object interface{}, msgAndArgs ...interface{})           {}
+func NotNil(t *testing.T, object interface{}, msgAndArgs ...interface{})        {}
+func Nilf(t *testing.T, object interface{}, msg string, args ...interface{})    {}
+func NotNilf(t *testing.T, object interface{}, msg string, args ...interface{}) {}