Implement partitiontest_linter

.golangci.yml

@@ -1,13 +1,14 @@
 run:
   timeout: 5m
-  tests: false
+  tests: true
 
 linters:
   enable:
     - golint
     - misspell
     - govet
     - ineffassign
+    - partitiontest
 
   disable:
     - deadcode
@@ -19,6 +20,11 @@ linters:
     - varcheck
 
 linters-settings:
+  custom:
+    partitiontest:
+      path: cmd/partitiontest_linter/plugin.so
+      description: This custom linter checks files that end in '_test.go', specifically functions that start with 'Test' and have testing argument, for a line 'partitiontest.ParitionTest(<testing arg>)'
+      original-url: github.com/algorand/go-algorand/cmd/partitiontest_linter
 #  govet:
 #    check-shadowing: true
 

Makefile

@@ -322,3 +322,8 @@ include ./scripts/release/mule/Makefile.mule
 
 archive:
 	aws s3 cp tmp/node_pkgs s3://algorand-internal/channel/$(CHANNEL)/$(FULLBUILDNUMBER) --recursive --exclude "*" --include "*$(FULLBUILDNUMBER)*"
+
+build_custom_linters:
+	cd cmd/partitiontest_linter/
+	go build -buildmode=plugin -trimpath plugin/plugin.go
+	cd -

cmd/partitiontest_linter/go.mod

@@ -0,0 +1,5 @@
+module github.com/algorand/go-algorand/cmd/partitiontest_linter
+
+go 1.16
+
+require golang.org/x/tools v0.1.3

cmd/partitiontest_linter/go.sum

@@ -0,0 +1,27 @@
+github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo=
+golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210510120138-977fb7262007 h1:gG67DSER+11cZvqIMb8S8bt0vZtiN6xWYARwirrOSfE=
+golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.3 h1:L69ShwSZEyCsLKoAxDKeMvLDZkumEe8gXUZAjab0tX8=
+golang.org/x/tools v0.1.3/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

cmd/partitiontest_linter/linter.go

@@ -0,0 +1,132 @@
+// Copyright (C) 2019-2021 Algorand, Inc.
+// This file is part of go-algorand
+//
+// go-algorand is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// go-algorand is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.
+
+package linter
+
+import (
+	"go/ast"
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+)
+
+const packageName string = "partitiontest"
+const functionName string = "PartitionTest"
+const fileNameSuffix string = "_test.go"
+const functionNamePrefix string = "Test"
+const parameterType string = "T"
+
+// Analyzer initilization
+var Analyzer = &analysis.Analyzer{
+	Name: "lint",
+	Doc:  "This custom linter checks inside files that end in '_test.go', and inside functions that start with 'Test' and have testing argument, for a line 'partitiontest.ParitionTest(<testing arg>)'",
+	Run:  run,
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	for _, f := range pass.Files {
+		currentFileName := pass.Fset.File(f.Pos()).Name()
+		if !strings.HasSuffix(currentFileName, fileNameSuffix) {
+			continue
+		}
+		for _, decl := range f.Decls {
+			fn, ok := decl.(*ast.FuncDecl)
+			if !ok || fn.Recv != nil {
+				// Ignore non-functions or functions with receivers.
+				continue
+			}
+
+			// Check that function name starts with "Test"
+			if !strings.HasPrefix(fn.Name.Name, functionNamePrefix) {
+				continue
+			}
+
+			if !isTestParameterInFunction(fn.Type.Params.List[0].Type, parameterType) {
+				continue
+			}
+			if !isSearchLineInFunction(fn) {
+				pass.Reportf(fn.Pos(), "%s function is missing %s.%s(<%s type parameter>)", fn.Name.Name, packageName, functionName, parameterType)
+			}
+
+		}
+	}
+	return nil, nil
+}
+
+func isTestParameterInFunction(typ ast.Expr, wantType string) bool {
+	ptr, ok := typ.(*ast.StarExpr)
+	if !ok {
+		// Not a pointer.
+		return false
+	}
+
+	if name, ok := ptr.X.(*ast.Ident); ok {
+		return name.Name == wantType
+	}
+	if sel, ok := ptr.X.(*ast.SelectorExpr); ok {
+		return sel.Sel.Name == wantType
+	}
+	return false
+}
+
+func isSearchLineInFunction(fn *ast.FuncDecl) bool {
+	for _, oneline := range fn.Body.List {
+		if exprStmt, ok := oneline.(*ast.ExprStmt); ok {
+			if call, ok := exprStmt.X.(*ast.CallExpr); ok {
+				if fun, ok := call.Fun.(*ast.SelectorExpr); ok {
+					if !doesPackageNameMatch(fun) {
+						continue
+					}
+					if !doesFunctionNameMatch(fun) {
+						continue
+					}
+				}
+
+				if !doesParameterNameMatch(call, fn) {
+					continue
+				}
+
+				return true
+			}
+		}
+	}
+	return false
+}
+
+func doesPackageNameMatch(fun *ast.SelectorExpr) bool {
+	if packageobject, ok := fun.X.(*ast.Ident); ok {
+		if packageobject.Name == packageName {
+			return true
+		}
+	}
+	return false
+}
+
+func doesFunctionNameMatch(fun *ast.SelectorExpr) bool {
+	return fun.Sel.Name == functionName
+}
+
+func doesParameterNameMatch(call *ast.CallExpr, fn *ast.FuncDecl) bool {
+	for _, oneArg := range call.Args {
+
+		if realArg, ok := oneArg.(*ast.Ident); ok {
+			if realArg.Obj.Name == fn.Type.Params.List[0].Names[0].Obj.Name {
+				return true
+			}
+		}
+	}
+	return false
+}

cmd/partitiontest_linter/linter_test.go

@@ -0,0 +1,27 @@
+// Copyright (C) 2019-2021 Algorand, Inc.
+// This file is part of go-algorand
+//
+// go-algorand is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// go-algorand is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.
+
+package linter
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func TestAll(t *testing.T) {
+	analysistest.Run(t, analysistest.TestData(), Analyzer)
+}

cmd/partitiontest_linter/plugin/plugin.go

@@ -0,0 +1,39 @@
+// Copyright (C) 2019-2021 Algorand, Inc.
+// This file is part of go-algorand
+//
+// go-algorand is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// go-algorand is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.
+
+package main
+
+import (
+	linter "github.com/algorand/go-algorand/cmd/partitiontest_linter"
+	"golang.org/x/tools/go/analysis"
+	"golang.org/x/tools/go/analysis/singlechecker"
+)
+
+type analyzerPlugin struct{}
+
+// This must be implemented
+func (*analyzerPlugin) GetAnalyzers() []*analysis.Analyzer {
+	return []*analysis.Analyzer{
+		linter.Analyzer,
+	}
+}
+
+// This must be defined and named 'AnalyzerPlugin'
+var AnalyzerPlugin analyzerPlugin
+
+func main() {
+	singlechecker.Main(linter.Analyzer)
+}

cmd/partitiontest_linter/testdata/linter_testdata_test.go

@@ -0,0 +1,73 @@
+// Copyright (C) 2019-2021 Algorand, Inc.
+// This file is part of go-algorand
+//
+// go-algorand is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// go-algorand is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.
+
+/*
+This file is input file for analyzer_test.go
+That's why we are using relative path in import below
+It is also why we named this file _test.go, since linter only looks at files that end in _test.go
+*/
+
+package linter_testdata
+
+import (
+	"testing"
+
+	"../../../test/partitiontest"
+)
+
+func notTestFunction() {}
+
+func notTestFunctionWithWrongParam(t string) {}
+
+func notTestFunctionWithCorrectParam(t *testing.T) {}
+
+func notTestFunctionWithCorrectParamCorrectLine(t *testing.T) {
+	partitiontest.PartitionTest(t)
+}
+
+func notTestFunctionWithCorrectParamWrongLine(t *testing.T) {
+	println("something")
+}
+
+func TestFunctionWithCorrectParamOnly(t *testing.T) {} // want "function is missing partitiontest.PartitionTest"
+
+func TestFunctionWithCorrectParamCorrectLine(t *testing.T) {
+	partitiontest.PartitionTest(t)
+}
+
+func TestFunctionWithCorrectParamBadLine(t *testing.T) { // want "function is missing partitiontest.PartitionTest"
+	println("something")
+}
+
+func TestFunctionWithDifferentName(n *testing.T) {
+	partitiontest.PartitionTest(n)
+}
+
+func TestFunctionWithCorrectParamNotFirstCorrectLine(t *testing.T) {
+	println("something")
+	partitiontest.PartitionTest(t)
+}
+
+func TestFunctionWithCorrectParamNotLastCorrectLine(t *testing.T) {
+	partitiontest.PartitionTest(t)
+	println("something")
+}
+
+func TestFunctionWithCorrectParamMiddleCorrectLine(t *testing.T) {
+	println("something")
+	partitiontest.PartitionTest(t)
+	println("something")
+}