Merge pull request #815 from timofurrer/feature/align-to-tf-scaffold

Change provider structure to best practices from terraform-provider-scaffolding project

Author: timofurrer

.github/labeler-pr-triage.yml

@@ -16,14 +16,14 @@ linter:
 
 provider:
   - '.go-version'
-  - 'gitlab/**/*'
+  - 'internal/provider/**/*'
   - 'main.go'
 
 resource:
-  - 'gitlab/resource_*.go'
+  - 'internal/provider/resource_*.go'
 
 data-source:
-  - 'gitlab/data_source_*.go'
+  - 'internal/provider/data_source_*.go'
 
 tests:
   - '**/*_test.go'

GNUmakefile

@@ -3,6 +3,7 @@ default: reviewable
 reviewable: build fmt generate test ## Run before committing.
 
 GOBIN = $(shell pwd)/bin
+PROVIDER_SRC_DIR := ./internal/provider
 
 build: ## Build the provider binary.
 	go mod tidy
@@ -17,7 +18,7 @@ TESTARGS += -test.run $(RUN)
 endif
 
 test: ## Run unit tests.
-	go test $(TESTARGS) ./gitlab
+	go test $(TESTARGS) $(PROVIDER_SRC_DIR)
 
 TFPROVIDERLINTX_CHECKS = -XAT001=false -XR003=false -XS002=false
 
@@ -68,7 +69,7 @@ testacc-down: ## Teardown a GitLab instance.
 	docker-compose down
 
 testacc: ## Run acceptance tests against a GitLab instance.
-	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test -v ./gitlab $(TESTARGS) -timeout 40m
+	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test -v $(PROVIDER_SRC_DIR) $(TESTARGS) -timeout 40m
 
 # TOOLS
 # Tool dependencies are installed into a project-local /bin folder.

gitlab/provider.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"github.com/xanzy/go-gitlab"

gitlab/provider_test.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"crypto/tls"

gitlab/access_level_helpers.go renamed to internal/provider/access_level_helpers.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"fmt"

gitlab/config.go renamed to internal/provider/config.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"context"
@@ -10,7 +10,7 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabGroup() *schema.Resource {
+var _ = registerDataSource("gitlab_group", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provide details about a specific group in the gitlab provider.\n\n" +
 			"> **Note**: exactly one of group_id or full_path must be provided.",
@@ -93,7 +93,7 @@ func dataSourceGitlabGroup() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabGroupRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)

gitlab/custom_attribute_helper.go renamed to internal/provider/custom_attribute_helper.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"context"
@@ -13,7 +13,7 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabGroupMembership() *schema.Resource {
+var _ = registerDataSource("gitlab_group_membership", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provide details about a list of group members in the gitlab provider. The results include id, username, name and more about the requested members.\n\n" +
 			"> **Note**: exactly one of group_id or full_path must be provided.",
@@ -96,7 +96,7 @@ func dataSourceGitlabGroupMembership() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabGroupMembershipRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)

gitlab/data_source_gitlab_group.go renamed to internal/provider/data_source_gitlab_group.go

@@ -1,4 +1,4 @@
-package gitlab
+package provider
 
 import (
 	"fmt"
@@ -12,8 +12,8 @@ func TestAccDataSourceGitlabMembership_basic(t *testing.T) {
 	rInt := acctest.RandInt()
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:  func() { testAccPreCheck(t) },
-		Providers: testAccProviders,
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			// Create the group and one member
 			{