Self-contained grafana package (#1420)

Last one This moves the mapping of resources and client validation to the SM package. This will make it easier to support TF code generation + upgrade to the new TF plugin framework
grafana · Mar 14, 2024 · bd938ad · bd938ad
1 parent 272030b
commit bd938ad
Show file tree

Hide file tree

Showing 44 changed files with 153 additions and 180 deletions.
diff --git a/internal/provider/legacy_provider.go b/internal/provider/legacy_provider.go
@@ -34,64 +34,6 @@ func init() {
 // Provider returns a terraform-provider-sdk2 provider.
 // This is the deprecated way of creating a provider, and should only be used for legacy resources.
 func Provider(version string) *schema.Provider {
-	var (
-		// Resources that require the Grafana client to exist.
-		grafanaClientResources = addCreateReadResourcesMetadataValidation(
-			readGrafanaClientValidation,
-			createGrafanaClientValidation,
-			map[string]*schema.Resource{
-				// Grafana
-				"grafana_annotation":                 grafana.ResourceAnnotation(),
-				"grafana_api_key":                    grafana.ResourceAPIKey(),
-				"grafana_contact_point":              grafana.ResourceContactPoint(),
-				"grafana_dashboard":                  grafana.ResourceDashboard(),
-				"grafana_dashboard_public":           grafana.ResourcePublicDashboard(),
-				"grafana_dashboard_permission":       grafana.ResourceDashboardPermission(),
-				"grafana_data_source":                grafana.ResourceDataSource(),
-				"grafana_data_source_permission":     grafana.ResourceDatasourcePermission(),
-				"grafana_folder":                     grafana.ResourceFolder(),
-				"grafana_folder_permission":          grafana.ResourceFolderPermission(),
-				"grafana_library_panel":              grafana.ResourceLibraryPanel(),
-				"grafana_message_template":           grafana.ResourceMessageTemplate(),
-				"grafana_mute_timing":                grafana.ResourceMuteTiming(),
-				"grafana_notification_policy":        grafana.ResourceNotificationPolicy(),
-				"grafana_organization":               grafana.ResourceOrganization(),
-				"grafana_organization_preferences":   grafana.ResourceOrganizationPreferences(),
-				"grafana_playlist":                   grafana.ResourcePlaylist(),
-				"grafana_report":                     grafana.ResourceReport(),
-				"grafana_role":                       grafana.ResourceRole(),
-				"grafana_role_assignment":            grafana.ResourceRoleAssignment(),
-				"grafana_rule_group":                 grafana.ResourceRuleGroup(),
-				"grafana_team":                       grafana.ResourceTeam(),
-				"grafana_team_external_group":        grafana.ResourceTeamExternalGroup(),
-				"grafana_service_account_token":      grafana.ResourceServiceAccountToken(),
-				"grafana_service_account":            grafana.ResourceServiceAccount(),
-				"grafana_service_account_permission": grafana.ResourceServiceAccountPermission(),
-				"grafana_sso_settings":               grafana.ResourceSSOSettings(),
-				"grafana_user":                       grafana.ResourceUser(),
-			})
-
-		// Datasources that require the Grafana client to exist.
-		grafanaClientDatasources = addCreateReadResourcesMetadataValidation(
-			readGrafanaClientValidation,
-			createGrafanaClientValidation,
-			map[string]*schema.Resource{
-				"grafana_dashboard":                grafana.DatasourceDashboard(),
-				"grafana_dashboards":               grafana.DatasourceDashboards(),
-				"grafana_data_source":              grafana.DatasourceDatasource(),
-				"grafana_folder":                   grafana.DatasourceFolder(),
-				"grafana_folders":                  grafana.DatasourceFolders(),
-				"grafana_library_panel":            grafana.DatasourceLibraryPanel(),
-				"grafana_user":                     grafana.DatasourceUser(),
-				"grafana_users":                    grafana.DatasourceUsers(),
-				"grafana_role":                     grafana.DatasourceRole(),
-				"grafana_service_account":          grafana.DatasourceServiceAccount(),
-				"grafana_team":                     grafana.DatasourceTeam(),
-				"grafana_organization":             grafana.DatasourceOrganization(),
-				"grafana_organization_preferences": grafana.DatasourceOrganizationPreferences(),
-			})
-	)
-
 	p := &schema.Provider{
 		Schema: map[string]*schema.Schema{
 			"url": {
@@ -210,7 +152,7 @@ func Provider(version string) *schema.Provider {
 		},
 
 		ResourcesMap: mergeResourceMaps(
-			grafanaClientResources,
+			grafana.ResourcesMap,
 			machinelearning.ResourcesMap,
 			slo.ResourcesMap,
 			syntheticmonitoring.ResourcesMap,
@@ -219,7 +161,7 @@ func Provider(version string) *schema.Provider {
 		),
 
 		DataSourcesMap: mergeResourceMaps(
-			grafanaClientDatasources,
+			grafana.DatasourcesMap,
 			machinelearning.DatasourcesMap,
 			slo.DatasourcesMap,
 			syntheticmonitoring.DatasourcesMap,

diff --git a/internal/provider/legacy_provider_validation.go b/internal/provider/legacy_provider_validation.go
diff --git a/internal/resources/grafana/data_source_dashboard.go b/internal/resources/grafana/data_source_dashboard.go
@@ -11,7 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceDashboard() *schema.Resource {
+func datasourceDashboard() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/)

diff --git a/internal/resources/grafana/data_source_dashboards.go b/internal/resources/grafana/data_source_dashboards.go
@@ -11,7 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceDashboards() *schema.Resource {
+func datasourceDashboards() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Datasource for retrieving all dashboards. Specify list of folder IDs to search in for dashboards.

diff --git a/internal/resources/grafana/data_source_data_source.go b/internal/resources/grafana/data_source_data_source.go
@@ -9,11 +9,11 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceDatasource() *schema.Resource {
+func datasourceDatasource() *schema.Resource {
 	return &schema.Resource{
 		Description: "Get details about a Grafana Datasource querying by either name, uid or ID",
 		ReadContext: datasourceDatasourceRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceDataSource(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceDataSource(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 			"id": {
 				Type:         schema.TypeString,

diff --git a/internal/resources/grafana/data_source_folder.go b/internal/resources/grafana/data_source_folder.go
@@ -11,14 +11,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceFolder() *schema.Resource {
+func datasourceFolder() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/folder/)
 `,
 		ReadContext: dataSourceFolderRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceFolder(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceFolder(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 			"title": {
 				Type:        schema.TypeString,

diff --git a/internal/resources/grafana/data_source_folders.go b/internal/resources/grafana/data_source_folders.go
@@ -10,7 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceFolders() *schema.Resource {
+func datasourceFolders() *schema.Resource {
 	return &schema.Resource{
 		ReadContext: readFolders,
 		Importer: &schema.ResourceImporter{

diff --git a/internal/resources/grafana/data_source_library_panel.go b/internal/resources/grafana/data_source_library_panel.go
@@ -8,11 +8,11 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceLibraryPanel() *schema.Resource {
+func datasourceLibraryPanel() *schema.Resource {
 	return &schema.Resource{
 		Description: "Data source for retrieving a single library panel by name or uid.",
 		ReadContext: dataSourceLibraryPanelRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceLibraryPanel(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceLibraryPanel(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 			"name": {
 				Type:        schema.TypeString,

diff --git a/internal/resources/grafana/data_source_organization.go b/internal/resources/grafana/data_source_organization.go
@@ -10,7 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceOrganization() *schema.Resource {
+func datasourceOrganization() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/administration/organization-management/)

diff --git a/internal/resources/grafana/data_source_organization_preferences.go b/internal/resources/grafana/data_source_organization_preferences.go
@@ -9,14 +9,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceOrganizationPreferences() *schema.Resource {
+func datasourceOrganizationPreferences() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/administration/organization-management/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/preferences/#get-current-org-prefs)
 `,
 		ReadContext: dataSourceOrganizationPreferencesRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceOrganizationPreferences(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceOrganizationPreferences(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 		}),
 	}

diff --git a/internal/resources/grafana/data_source_role.go b/internal/resources/grafana/data_source_role.go
@@ -9,7 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceRole() *schema.Resource {
+func datasourceRole() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 **Note:** This resource is available only with Grafana Enterprise 8.+.
@@ -18,7 +18,7 @@ func DatasourceRole() *schema.Resource {
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/access_control/)
 `,
 		ReadContext: dataSourceRoleRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceRole(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceRole(), map[string]*schema.Schema{
 			"name": {
 				Type:        schema.TypeString,
 				Required:    true,

diff --git a/internal/resources/grafana/data_source_service_account.go b/internal/resources/grafana/data_source_service_account.go
@@ -12,14 +12,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceServiceAccount() *schema.Resource {
+func datasourceServiceAccount() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 		* [Official documentation](https://grafana.com/docs/grafana/latest/administration/service-accounts/)
 		* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api)
 `,
-		ReadContext: DatasourceServiceAccountRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceServiceAccount(), map[string]*schema.Schema{
+		ReadContext: datasourceServiceAccountRead,
+		Schema: common.CloneResourceSchemaForDatasource(resourceServiceAccount(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 			"name": {
 				Type:        schema.TypeString,
@@ -30,7 +30,7 @@ func DatasourceServiceAccount() *schema.Resource {
 	}
 }
 
-func DatasourceServiceAccountRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+func datasourceServiceAccountRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client, orgID := OAPIClientFromNewOrgResource(meta, d)
 	name := d.Get("name").(string)
 	sa, err := findServiceAccountByName(client, name)

diff --git a/internal/resources/grafana/data_source_team.go b/internal/resources/grafana/data_source_team.go
@@ -9,14 +9,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceTeam() *schema.Resource {
+func datasourceTeam() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/administration/team-management/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/team/)
 `,
 		ReadContext: dataSourceTeamRead,
-		Schema: common.CloneResourceSchemaForDatasource(ResourceTeam(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(resourceTeam(), map[string]*schema.Schema{
 			"org_id": orgIDAttribute(),
 			"name": {
 				Type:        schema.TypeString,

diff --git a/internal/resources/grafana/data_source_user.go b/internal/resources/grafana/data_source_user.go
@@ -9,7 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceUser() *schema.Resource {
+func datasourceUser() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 * [Official documentation](https://grafana.com/docs/grafana/latest/administration/user-management/server-user-management/)

diff --git a/internal/resources/grafana/data_source_users.go b/internal/resources/grafana/data_source_users.go
@@ -10,7 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func DatasourceUsers() *schema.Resource {
+func datasourceUsers() *schema.Resource {
 	return &schema.Resource{
 		ReadContext: readUsers,
 		Importer: &schema.ResourceImporter{

diff --git a/internal/resources/grafana/resource_alerting_contact_point.go b/internal/resources/grafana/resource_alerting_contact_point.go
@@ -44,7 +44,7 @@ var notifiers = []notifier{
 	wecomNotifier{},
 }
 
-func ResourceContactPoint() *schema.Resource {
+func resourceContactPoint() *schema.Resource {
 	resource := &schema.Resource{
 		Description: `
 Manages Grafana Alerting contact points.

diff --git a/internal/resources/grafana/resource_alerting_message_template.go b/internal/resources/grafana/resource_alerting_message_template.go
@@ -15,7 +15,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func ResourceMessageTemplate() *schema.Resource {
+func resourceMessageTemplate() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Manages Grafana Alerting message templates.

diff --git a/internal/resources/grafana/resource_alerting_mute_timing.go b/internal/resources/grafana/resource_alerting_mute_timing.go
@@ -13,7 +13,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func ResourceMuteTiming() *schema.Resource {
+func resourceMuteTiming() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Manages Grafana Alerting mute timings.

diff --git a/internal/resources/grafana/resource_alerting_notification_policy.go b/internal/resources/grafana/resource_alerting_notification_policy.go
@@ -16,7 +16,7 @@ import (
 	"github.com/grafana/terraform-provider-grafana/internal/common"
 )
 
-func ResourceNotificationPolicy() *schema.Resource {
+func resourceNotificationPolicy() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Sets the global notification policy for Grafana.

diff --git a/internal/resources/grafana/resource_alerting_rule_group.go b/internal/resources/grafana/resource_alerting_rule_group.go
@@ -19,7 +19,7 @@ import (
 	"github.com/grafana/terraform-provider-grafana/internal/common"
 )
 
-func ResourceRuleGroup() *schema.Resource {
+func resourceRuleGroup() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Manages Grafana Alerting rule groups.

diff --git a/internal/resources/grafana/resource_annotation.go b/internal/resources/grafana/resource_annotation.go
@@ -12,7 +12,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
-func ResourceAnnotation() *schema.Resource {
+func resourceAnnotation() *schema.Resource {
 	return &schema.Resource{
 
 		Description: `

diff --git a/internal/resources/grafana/resource_api_key.go b/internal/resources/grafana/resource_api_key.go
@@ -12,7 +12,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
-func ResourceAPIKey() *schema.Resource {
+func resourceAPIKey() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 Manages Grafana API Keys.