Refactor: Decentralized resources

Author: armsnyder

internal/provider/data_source_gitlab_group.go

@@ -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)

internal/provider/data_source_gitlab_group_membership.go

@@ -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)

internal/provider/data_source_gitlab_project.go

@@ -12,7 +12,7 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabProject() *schema.Resource {
+var _ = registerDataSource("gitlab_project", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provide details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.",
 
@@ -201,7 +201,7 @@ func dataSourceGitlabProject() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabProjectRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)

internal/provider/data_source_gitlab_project_protected_branch.go

@@ -11,7 +11,7 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabProjectProtectedBranch() *schema.Resource {
+var _ = registerDataSource("gitlab_project_protected_branch", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provides details about a specific protected branch in a given project.",
 
@@ -48,7 +48,7 @@ func dataSourceGitlabProjectProtectedBranch() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabProjectProtectedBranchSchemaAccessLevels() *schema.Schema {
 	return &schema.Schema{

internal/provider/data_source_gitlab_project_protected_branches.go

@@ -11,7 +11,7 @@ import (
 	"github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabProjectProtectedBranches() *schema.Resource {
+var _ = registerDataSource("gitlab_project_protected_branches", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provides details about all protected branches in a given project.",
 
@@ -55,7 +55,7 @@ func dataSourceGitlabProjectProtectedBranches() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 type stateProtectedBranch struct {
 	ID                        int                            `json:"id,omitempty" mapstructure:"id,omitempty"`

internal/provider/data_source_gitlab_projects.go

@@ -171,7 +171,7 @@ func flattenProjects(projects []*gitlab.Project) (values []map[string]interface{
 	return values
 }
 
-func dataSourceGitlabProjects() *schema.Resource {
+var _ = registerDataSource("gitlab_projects", func() *schema.Resource {
 	// lintignore: S024 // TODO: Resolve this tfproviderlint issue
 	return &schema.Resource{
 		Description: "Provide details about a list of projects in the Gitlab provider. Listing all projects and group projects with [project filtering](https://docs.gitlab.com/ee/api/projects.html#list-user-projects) or [group project filtering](https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects) is supported.\n\n" +
@@ -776,7 +776,7 @@ func dataSourceGitlabProjects() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 // CRUD methods
 

internal/provider/data_source_gitlab_user.go

@@ -11,7 +11,7 @@ import (
 	gitlab "github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabUser() *schema.Resource {
+var _ = registerDataSource("gitlab_user", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provide details about a specific user in the gitlab provider. Especially the ability to lookup the id for linking to other resources.\n\n" +
 			"-> Some attributes might not be returned depending on if you're an admin or not. Please refer to [Gitlab documentation](https://docs.gitlab.com/ce/api/users.html#single-user) for more details.",
@@ -170,7 +170,7 @@ func dataSourceGitlabUser() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabUserRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)

internal/provider/data_source_gitlab_users.go

@@ -13,7 +13,7 @@ import (
 	gitlab "github.com/xanzy/go-gitlab"
 )
 
-func dataSourceGitlabUsers() *schema.Resource {
+var _ = registerDataSource("gitlab_users", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "Provide details about a list of users in the gitlab provider. The results include id, username, email, name and more about the requested users. Users can also be sorted and filtered using several options.\n\n" +
 			"**NOTE**: Some available options require administrator privileges. Please visit [Gitlab API documentation][users_for_admins] for more information.",
@@ -212,7 +212,7 @@ func dataSourceGitlabUsers() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func dataSourceGitlabUsersRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)

internal/provider/provider.go

@@ -9,6 +9,19 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
+var (
+	allDataSources = make(map[string]func() *schema.Resource)
+	allResources   = make(map[string]func() *schema.Resource)
+)
+
+// registerDataSource may be called during package initialization to register a new data source with
+// the provider.
+var registerDataSource = makeRegisterResourceFunc(allDataSources, "data source")
+
+// registerResource may be called during package initialization to register a new resource with the
+// provider.
+var registerResource = makeRegisterResourceFunc(allResources, "resource")
+
 func init() {
 	// Set descriptions to support markdown syntax, this will be used in document generation
 	// and the language server.
@@ -70,61 +83,8 @@ func New(version string) func() *schema.Provider {
 				},
 			},
 
-			DataSourcesMap: map[string]*schema.Resource{
-				"gitlab_group":                      dataSourceGitlabGroup(),
-				"gitlab_group_membership":           dataSourceGitlabGroupMembership(),
-				"gitlab_project":                    dataSourceGitlabProject(),
-				"gitlab_project_protected_branch":   dataSourceGitlabProjectProtectedBranch(),
-				"gitlab_project_protected_branches": dataSourceGitlabProjectProtectedBranches(),
-				"gitlab_projects":                   dataSourceGitlabProjects(),
-				"gitlab_user":                       dataSourceGitlabUser(),
-				"gitlab_users":                      dataSourceGitlabUsers(),
-			},
-
-			ResourcesMap: map[string]*schema.Resource{
-				"gitlab_branch_protection":          resourceGitlabBranchProtection(),
-				"gitlab_tag_protection":             resourceGitlabTagProtection(),
-				"gitlab_group":                      resourceGitlabGroup(),
-				"gitlab_group_custom_attribute":     resourceGitlabGroupCustomAttribute(),
-				"gitlab_project":                    resourceGitlabProject(),
-				"gitlab_project_custom_attribute":   resourceGitlabProjectCustomAttribute(),
-				"gitlab_label":                      resourceGitlabLabel(),
-				"gitlab_managed_license":            resourceGitlabManagedLicense(),
-				"gitlab_group_label":                resourceGitlabGroupLabel(),
-				"gitlab_pipeline_schedule":          resourceGitlabPipelineSchedule(),
-				"gitlab_pipeline_schedule_variable": resourceGitlabPipelineScheduleVariable(),
-				"gitlab_pipeline_trigger":           resourceGitlabPipelineTrigger(),
-				"gitlab_project_hook":               resourceGitlabProjectHook(),
-				"gitlab_deploy_key":                 resourceGitlabDeployKey(),
-				"gitlab_deploy_key_enable":          resourceGitlabDeployEnableKey(),
-				"gitlab_deploy_token":               resourceGitlabDeployToken(),
-				"gitlab_user":                       resourceGitlabUser(),
-				"gitlab_user_custom_attribute":      resourceGitlabUserCustomAttribute(),
-				"gitlab_project_membership":         resourceGitlabProjectMembership(),
-				"gitlab_group_membership":           resourceGitlabGroupMembership(),
-				"gitlab_project_variable":           resourceGitlabProjectVariable(),
-				"gitlab_group_variable":             resourceGitlabGroupVariable(),
-				"gitlab_project_access_token":       resourceGitlabProjectAccessToken(),
-				"gitlab_project_cluster":            resourceGitlabProjectCluster(),
-				"gitlab_service_slack":              resourceGitlabServiceSlack(),
-				"gitlab_service_jira":               resourceGitlabServiceJira(),
-				"gitlab_service_microsoft_teams":    resourceGitlabServiceMicrosoftTeams(),
-				"gitlab_service_github":             resourceGitlabServiceGithub(),
-				"gitlab_service_pipelines_email":    resourceGitlabServicePipelinesEmail(),
-				"gitlab_project_share_group":        resourceGitlabProjectShareGroup(),
-				"gitlab_group_cluster":              resourceGitlabGroupCluster(),
-				"gitlab_group_ldap_link":            resourceGitlabGroupLdapLink(),
-				"gitlab_instance_cluster":           resourceGitlabInstanceCluster(),
-				"gitlab_project_mirror":             resourceGitlabProjectMirror(),
-				"gitlab_project_level_mr_approvals": resourceGitlabProjectLevelMRApprovals(),
-				"gitlab_project_approval_rule":      resourceGitlabProjectApprovalRule(),
-				"gitlab_instance_variable":          resourceGitlabInstanceVariable(),
-				"gitlab_project_freeze_period":      resourceGitlabProjectFreezePeriod(),
-				"gitlab_group_share_group":          resourceGitlabGroupShareGroup(),
-				"gitlab_project_badge":              resourceGitlabProjectBadge(),
-				"gitlab_group_badge":                resourceGitlabGroupBadge(),
-				"gitlab_repository_file":            resourceGitLabRepositoryFile(),
-			},
+			DataSourcesMap: resourceFactoriesToMap(allDataSources),
+			ResourcesMap:   resourceFactoriesToMap(allResources),
 		}
 
 		provider.ConfigureContextFunc = configure(version, provider)
@@ -156,3 +116,35 @@ func configure(version string, p *schema.Provider) func(context.Context, *schema
 		return client, nil
 	}
 }
+
+func makeRegisterResourceFunc(factories map[string]func() *schema.Resource, resourceType string) func(name string, fn func() *schema.Resource) interface{} {
+	// lintignore: R009 // panic() during package initialization is ok
+	return func(name string, fn func() *schema.Resource) interface{} {
+		if strings.ToLower(name) != name {
+			panic(fmt.Sprintf("cannot register %s %q: name must be lowercase", resourceType, name))
+		}
+
+		const wantPrefix = "gitlab_"
+		if !strings.HasPrefix(name, wantPrefix) {
+			panic(fmt.Sprintf("cannot register %s %q: name must begin with %q", resourceType, name, wantPrefix))
+		}
+
+		if _, exists := factories[name]; exists {
+			panic(fmt.Sprintf("cannot register %s %q: a %s with the same name already exists", resourceType, name, resourceType))
+		}
+
+		factories[name] = fn
+
+		return nil
+	}
+}
+
+func resourceFactoriesToMap(factories map[string]func() *schema.Resource) map[string]*schema.Resource {
+	resourcesMap := make(map[string]*schema.Resource)
+
+	for name, fn := range factories {
+		resourcesMap[name] = fn()
+	}
+
+	return resourcesMap
+}

internal/provider/resource_gitlab_branch_protection.go

@@ -39,7 +39,7 @@ var (
 	}
 )
 
-func resourceGitlabBranchProtection() *schema.Resource {
+var _ = registerResource("gitlab_branch_protection", func() *schema.Resource {
 	return &schema.Resource{
 		Description: "This resource allows you to protect a specific branch by an access level so that the user with less access level cannot Merge/Push to the branch.\n\n" +
 			"-> The `allowed_to_push`, `allowed_to_merge` and `code_owner_approval_required` arguments require a GitLab Premium account or above.  Please refer to [Gitlab API documentation](https://docs.gitlab.com/ee/api/protected_branches.html) for further information.",
@@ -93,7 +93,7 @@ func resourceGitlabBranchProtection() *schema.Resource {
 			},
 		},
 	}
-}
+})
 
 func resourceGitlabBranchProtectionCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)