passes: Support ignore comments in AT004, AT005, AT006, and AT007 (#103)

CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.11.0
+
+ENHANCEMENTS
+
+* passes/AT004: Support ignore comments
+* passes/AT005: Support ignore comments
+* passes/AT006: Support ignore comments
+* passes/AT007: Support ignore comments
+
 # v0.10.0
 
 BREAKING CHANGES

passes/AT004/AT004.go

@@ -7,6 +7,7 @@ import (
 	"go/token"
 	"strings"
 
+	"github.com/bflad/tfproviderlint/passes/commentignore"
 	"golang.org/x/tools/go/analysis"
 	"golang.org/x/tools/go/analysis/passes/inspect"
 	"golang.org/x/tools/go/ast/inspector"
@@ -21,13 +22,17 @@ be handled outside individual test configurations (e.g. environment variables).`
 const analyzerName = "AT004"
 
 var Analyzer = &analysis.Analyzer{
-	Name:     analyzerName,
-	Doc:      Doc,
-	Requires: []*analysis.Analyzer{inspect.Analyzer},
-	Run:      run,
+	Name: analyzerName,
+	Doc:  Doc,
+	Requires: []*analysis.Analyzer{
+		commentignore.Analyzer,
+		inspect.Analyzer,
+	},
+	Run: run,
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
+	ignorer := pass.ResultOf[commentignore.Analyzer].(*commentignore.Ignorer)
 	inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
 
 	nodeFilter := []ast.Node{
@@ -36,6 +41,10 @@ func run(pass *analysis.Pass) (interface{}, error) {
 	inspect.Preorder(nodeFilter, func(n ast.Node) {
 		x := n.(*ast.BasicLit)
 
+		if ignorer.ShouldIgnore(analyzerName, x) {
+			return
+		}
+
 		if x.Kind != token.STRING {
 			return
 		}

passes/AT004/testdata/src/a/a.go

@@ -18,35 +18,6 @@ func f() {
 		},
 	}
 
-	/*
-		Skipping for now since there does not seem to be a way to
-		correctly add the want comment for multiline string literals
-
-		_ = resource.TestCase{
-			Steps: []resource.TestStep{
-				{
-					Config: configWithProvider1,
-				},
-			},
-		}
-
-		_ = resource.TestCase{
-			Steps: []resource.TestStep{
-				{
-					Config: configWithProvider2,
-				},
-			},
-		}
-
-		_ = resource.TestCase{
-			Steps: []resource.TestStep{
-				{
-					Config: configWithProvider3(),
-				},
-			},
-		}
-	*/
-
 	_ = resource.TestCase{
 		Steps: []resource.TestStep{
 			{
@@ -55,30 +26,6 @@ func f() {
 		},
 	}
 
-	_ = resource.TestCase{
-		Steps: []resource.TestStep{
-			{
-				Config: configWithoutProvider1,
-			},
-		},
-	}
-
-	_ = resource.TestCase{
-		Steps: []resource.TestStep{
-			{
-				Config: configWithoutProvider2,
-			},
-		},
-	}
-
-	_ = resource.TestCase{
-		Steps: []resource.TestStep{
-			{
-				Config: configWithoutProvider3(),
-			},
-		},
-	}
-
 	resource.Test(t, resource.TestCase{
 		Steps: []resource.TestStep{
 			{
@@ -96,30 +43,48 @@ func f() {
 	})
 }
 
-/*
-Skipping for now since there does not seem to be a way to
-correctly add the want comment for multiline string literals
-
-const configWithProvider1 = `
+const configWithProvider1 = /* want "provider declaration should be omitted" */ `
 provider "aws" {
   region = "us-east-1"
 }
 `
 
-var configWithProvider2 = `
+var configWithProvider2 = /* want "provider declaration should be omitted" */ `
 provider "aws" {
   region = "us-east-1"
 }
 `
 
 func configWithProvider3() string {
+	return fmt.Sprintf( /* want "provider declaration should be omitted" */ `
+provider "aws" {
+  region = "us-east-1"
+}
+`)
+}
+
+//lintignore:AT004
+const configWithProviderIgnored1 = `
+provider "aws" {
+  region = "us-east-1"
+}
+`
+
+//lintignore:AT004
+var configWithProviderIgnored2 = `
+provider "aws" {
+  region = "us-east-1"
+}
+`
+
+func configWithProviderIgnored3() string {
+	//lintignore:AT004
 	return fmt.Sprintf(`
 provider "aws" {
   region = "us-east-1"
 }
 `)
 }
-*/
 
 const configWithoutProvider1 = `
 resource "aws_vpc" {

passes/AT005/AT005.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/bflad/tfproviderlint/helper/terraformtype/helper/resource"
+	"github.com/bflad/tfproviderlint/passes/commentignore"
 	"github.com/bflad/tfproviderlint/passes/testfuncdecl"
 	"golang.org/x/tools/go/analysis"
 )
@@ -23,15 +24,21 @@ var Analyzer = &analysis.Analyzer{
 	Name: analyzerName,
 	Doc:  Doc,
 	Requires: []*analysis.Analyzer{
+		commentignore.Analyzer,
 		testfuncdecl.Analyzer,
 	},
 	Run: run,
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
+	ignorer := pass.ResultOf[commentignore.Analyzer].(*commentignore.Ignorer)
 	testFuncs := pass.ResultOf[testfuncdecl.Analyzer].([]*ast.FuncDecl)
 
 	for _, testFunc := range testFuncs {
+		if ignorer.ShouldIgnore(analyzerName, testFunc) {
+			continue
+		}
+
 		if strings.HasPrefix(testFunc.Name.Name, "TestAcc") {
 			continue
 		}

passes/AT005/testdata/src/a/a.go

@@ -8,6 +8,10 @@ import (
 
 func TestUnitTest(t *testing.T) {}
 
+func TestUnitTest_ResourceUnitTest(t *testing.T) {
+	resource.UnitTest(t, resource.TestCase{})
+}
+
 func TestExampleThing_basic(t *testing.T) { // want "acceptance test function name should begin with TestAcc"
 	resource.Test(t, resource.TestCase{})
 }
@@ -16,6 +20,16 @@ func TestExampleWidget_basic(t *testing.T) { // want "acceptance test function n
 	resource.ParallelTest(t, resource.TestCase{})
 }
 
+//lintignore:AT005
+func TestExampleThing_ignored(t *testing.T) {
+	resource.Test(t, resource.TestCase{})
+}
+
+//lintignore:AT005
+func TestExampleWidget_ignored(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{})
+}
+
 func TestAccExampleThing_basic(t *testing.T) {
 	resource.Test(t, resource.TestCase{})
 }

passes/AT006/AT006.go

@@ -6,6 +6,7 @@ import (
 	"go/ast"
 
 	"github.com/bflad/tfproviderlint/helper/terraformtype/helper/resource"
+	"github.com/bflad/tfproviderlint/passes/commentignore"
 	"github.com/bflad/tfproviderlint/passes/testaccfuncdecl"
 	"golang.org/x/tools/go/analysis"
 )
@@ -21,15 +22,21 @@ var Analyzer = &analysis.Analyzer{
 	Name: analyzerName,
 	Doc:  Doc,
 	Requires: []*analysis.Analyzer{
+		commentignore.Analyzer,
 		testaccfuncdecl.Analyzer,
 	},
 	Run: run,
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
+	ignorer := pass.ResultOf[commentignore.Analyzer].(*commentignore.Ignorer)
 	testFuncs := pass.ResultOf[testaccfuncdecl.Analyzer].([]*ast.FuncDecl)
 
 	for _, testFunc := range testFuncs {
+		if ignorer.ShouldIgnore(analyzerName, testFunc) {
+			continue
+		}
+
 		var resourceTestInvocations int
 
 		ast.Inspect(testFunc.Body, func(n ast.Node) bool {

passes/AT006/testdata/src/a/a.go

@@ -10,6 +10,12 @@ func TestAccExampleThing_single(t *testing.T) {
 	resource.Test(t, resource.TestCase{})
 }
 
+//lintignore:AT006
+func TestAccExampleThing_ignored(t *testing.T) {
+	resource.Test(t, resource.TestCase{})
+	resource.Test(t, resource.TestCase{})
+}
+
 func TestAccExampleThing_multiple(t *testing.T) { // want "acceptance test function should contain only one Test invocation"
 	resource.Test(t, resource.TestCase{})
 	resource.Test(t, resource.TestCase{})

passes/AT007/AT007.go

@@ -6,6 +6,7 @@ import (
 	"go/ast"
 
 	"github.com/bflad/tfproviderlint/helper/terraformtype/helper/resource"
+	"github.com/bflad/tfproviderlint/passes/commentignore"
 	"github.com/bflad/tfproviderlint/passes/testaccfuncdecl"
 	"golang.org/x/tools/go/analysis"
 )
@@ -22,15 +23,21 @@ var Analyzer = &analysis.Analyzer{
 	Name: analyzerName,
 	Doc:  Doc,
 	Requires: []*analysis.Analyzer{
+		commentignore.Analyzer,
 		testaccfuncdecl.Analyzer,
 	},
 	Run: run,
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
+	ignorer := pass.ResultOf[commentignore.Analyzer].(*commentignore.Ignorer)
 	testFuncs := pass.ResultOf[testaccfuncdecl.Analyzer].([]*ast.FuncDecl)
 
 	for _, testFunc := range testFuncs {
+		if ignorer.ShouldIgnore(analyzerName, testFunc) {
+			continue
+		}
+
 		var resourceParallelTestInvocations int
 
 		ast.Inspect(testFunc.Body, func(n ast.Node) bool {

passes/AT007/testdata/src/a/a.go

@@ -10,6 +10,12 @@ func TestAccExampleThing_single(t *testing.T) {
 	resource.ParallelTest(t, resource.TestCase{})
 }
 
+//lintignore:AT007
+func TestAccExampleThing_ignored(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{})
+	resource.ParallelTest(t, resource.TestCase{})
+}
+
 func TestAccExampleThing_multiple(t *testing.T) { // want "acceptance test function should contain only one ParallelTest invocation"
 	resource.ParallelTest(t, resource.TestCase{})
 	resource.ParallelTest(t, resource.TestCase{})

version/version.go

@@ -10,7 +10,7 @@ var (
 	GitCommit string
 
 	// The main version number that is being run at the moment.
-	Version = "0.10.0"
+	Version = "0.11.0"
 
 	// A pre-release marker for the version. If this is "" (empty string)
 	// then it means that it is a final release. Otherwise, this is a pre-release