Merge pull request #1045 from armsnyder/acceptance-tags

Remove test boilerplate by adding build tag

Author: timofurrer

.github/workflows/pr-lint.yml

@@ -28,7 +28,6 @@ jobs:
       matrix:
         target:
           - lint-golangci
-          - lint-tfprovider
           - lint-examples-tf
           - lint-examples-sh
           - lint-generated

.github/workflows/push.yml

@@ -40,7 +40,6 @@ jobs:
       matrix:
         target:
           - lint-golangci
-          - lint-tfprovider
           - lint-examples-tf
           - lint-examples-sh
           - lint-generated

.golangci.yml

@@ -4,10 +4,16 @@ run:
   timeout: 3m
 
 linters-settings:
+  custom:
+    tfproviderlint:
+      path: ./bin/tfproviderlint-plugin.so
+      description: "Terraform Provider Lint Tool"
+      original-url: https://github.com/bflad/tfproviderlint
   errcheck:
     exclude: errcheck_excludes.txt
 
 linters:
   enable:
     - gofmt
     - govet
+    - tfproviderlint

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
-  "go.testEnvVars": {
-    "TF_ACC": "1",
-    "GITLAB_TOKEN": "ACCTEST1234567890123",
-    "GITLAB_BASE_URL": "http://127.0.0.1:8080"
-  },
-  "go.testFlags": ["-count=1", "-v", "-timeout=30m"]
+    "go.testEnvVars": {
+        "TF_ACC": "1",
+        "GITLAB_TOKEN": "ACCTEST1234567890123",
+        "GITLAB_BASE_URL": "http://127.0.0.1:8080"
+    },
+    "go.testFlags": ["-count=1", "-v", "-tags=acceptance", "-tags=acceptance"]
 }

GNUmakefile

@@ -21,20 +21,14 @@ endif
 test: ## Run unit tests.
 	go test $(TESTARGS) $(PROVIDER_SRC_DIR)
 
-TFPROVIDERLINTX_CHECKS = -XAT001=false -XR003=false -XS002=false
-
-fmt: tool-golangci-lint tool-tfproviderlintx tool-terraform tool-shfmt ## Format files and fix issues.
+fmt: tool-golangci-lint tool-terraform tool-shfmt tfproviderlint-plugin ## Format files and fix issues.
 	gofmt -w -s .
-	$(GOBIN)/golangci-lint run --fix
-	$(GOBIN)/tfproviderlintx $(TFPROVIDERLINTX_CHECKS) --fix ./...
+	$(GOBIN)/golangci-lint run --build-tags acceptance --fix
 	$(GOBIN)/terraform fmt -recursive -list ./examples
 	$(GOBIN)/shfmt -l -s -w ./examples
 
-lint-golangci: tool-golangci-lint ## Run golangci-lint linter (same as fmt but without modifying files).
-	$(GOBIN)/golangci-lint run
-
-lint-tfprovider: tool-tfproviderlintx ## Run tfproviderlintx linter (same as fmt but without modifying files).
-	$(GOBIN)/tfproviderlintx $(TFPROVIDERLINTX_CHECKS) ./...
+lint-golangci: tool-golangci-lint tfproviderlint-plugin ## Run golangci-lint linter (same as fmt but without modifying files).
+	$(GOBIN)/golangci-lint run --build-tags acceptance
 
 lint-examples-tf: tool-terraform ## Run terraform linter on examples (same as fmt but without modifying files).
 	$(GOBIN)/terraform fmt -recursive -check ./examples
@@ -73,7 +67,7 @@ testacc-down: ## Teardown a GitLab instance.
 	docker-compose down --volumes
 
 testacc: ## Run acceptance tests against a GitLab instance.
-	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test -v $(PROVIDER_SRC_DIR) $(TESTARGS) -timeout 40m
+	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test --tags acceptance -v $(PROVIDER_SRC_DIR) $(TESTARGS) -timeout 40m
 
 certs: ## Generate certs for the GitLab container registry
 	mkdir -p certs
@@ -85,9 +79,6 @@ certs: ## Generate certs for the GitLab container registry
 tool-golangci-lint:
 	@$(call install-tool, github.com/golangci/golangci-lint/cmd/golangci-lint)
 
-tool-tfproviderlintx:
-	@$(call install-tool, github.com/bflad/tfproviderlint/cmd/tfproviderlintx)
-
 tool-tfplugindocs:
 	@$(call install-tool, github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs)
 
@@ -110,4 +101,7 @@ tool-terraform:
 	@[ -f $(GOBIN)/terraform ] || { mkdir -p tmp; cd tmp; rm -rf terraform; git clone --branch $(TERRAFORM_VERSION) --depth 1 https://github.com/hashicorp/terraform.git; cd terraform; GOBIN=$(GOBIN) go install; cd ..; rm -rf terraform; }
 
 clean: testacc-down
-	@rm -rf certs/
+	@rm -rf certs/
+
+tfproviderlint-plugin:
+	@cd tools && go build -buildmode=plugin -o $(GOBIN)/tfproviderlint-plugin.so ./cmd/tfproviderlint-plugin

internal/provider/data_source_gitlab_branch_test.go

@@ -1,3 +1,6 @@
+//go:build acceptance
+// +build acceptance
+
 package provider
 
 import (
@@ -11,10 +14,8 @@ import (
 
 func TestAccDataGitlabBranch_basic(t *testing.T) {
 	rInt := acctest.RandInt()
-	testAccCheck(t)
 	project := testAccCreateProject(t)
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			{

internal/provider/data_source_gitlab_group_membership_test.go

@@ -1,3 +1,6 @@
+//go:build acceptance
+// +build acceptance
+
 package provider
 
 import (
@@ -12,7 +15,6 @@ func TestAccDataSourceGitlabMembership_basic(t *testing.T) {
 	rInt := acctest.RandInt()
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			// Create the group and one member
@@ -45,16 +47,13 @@ func TestAccDataSourceGitlabMembership_basic(t *testing.T) {
 }
 
 func TestAccDataSourceGitlabMembership_pagination(t *testing.T) {
-	testAccCheck(t)
-
 	userCount := 21
 
 	group := testAccCreateGroups(t, 1)[0]
 	users := testAccCreateUsers(t, userCount)
 	testAccAddGroupMembers(t, group.ID, users)
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			{

internal/provider/data_source_gitlab_group_test.go

@@ -1,3 +1,6 @@
+//go:build acceptance
+// +build acceptance
+
 package provider
 
 import (
@@ -13,7 +16,6 @@ func TestAccDataSourceGitlabGroup_basic(t *testing.T) {
 	rString := fmt.Sprintf("%s", acctest.RandString(5)) // nolint // TODO: Resolve this golangci-lint issue: S1025: the argument is already a string, there's no need to use fmt.Sprintf (gosimple)
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			// Get group using its ID

internal/provider/data_source_gitlab_group_variable_test.go

@@ -1,3 +1,6 @@
+//go:build acceptance
+// +build acceptance
+
 package provider
 
 import (
@@ -9,12 +12,9 @@ import (
 )
 
 func TestAccDataSourceGitlabGroupVariable_basic(t *testing.T) {
-	testAccCheck(t)
-
 	testGroup := testAccCreateGroups(t, 1)[0]
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			{

internal/provider/data_source_gitlab_group_variables_test.go

@@ -1,3 +1,6 @@
+//go:build acceptance
+// +build acceptance
+
 package provider
 
 import (
@@ -9,16 +12,13 @@ import (
 )
 
 func TestAccDataSourceGitlabGroupVariables_basic(t *testing.T) {
-	testAccCheck(t)
-
 	testGroup := testAccCreateGroups(t, 1)[0]
 	testVariables := make([]*gitlab.GroupVariable, 0)
 	for i := 0; i < 25; i++ {
 		testVariables = append(testVariables, testAccCreateGroupVariable(t, testGroup.ID))
 	}
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:          func() { testAccPreCheck(t) },
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			{