Datasource: Use UID instead of numerical ID (#1468)

* Datasource: Use UID instead of numerical ID
The numerical ID is deprecated since v9. Let's remove it on next major version

* Fix ML tests

Author: julienduchesne

docs/data-sources/data_source.md

@@ -50,6 +50,7 @@ data "grafana_data_source" "from_uid" {
 
 ### Optional
 
+- `id` (String, Deprecated) Deprecated: Use `uid` instead of `id`
 - `name` (String)
 - `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `uid` (String)
@@ -60,7 +61,6 @@ data "grafana_data_source" "from_uid" {
 - `basic_auth_enabled` (Boolean) Whether to enable basic auth for the data source.
 - `basic_auth_username` (String) Basic auth username.
 - `database_name` (String) (Required by some data source types) The name of the database to use on the selected data source server.
-- `id` (String) The ID of this resource.
 - `is_default` (Boolean) Whether to set the data source as default. This should only be `true` to a single data source.
 - `json_data_encoded` (String) Serialized JSON string containing the json data. This attribute can be used to pass configuration options to the data source. To figure out what options a datasource has available, see its docs or inspect the network data when saving it from the Grafana UI. Note that keys in this map are usually camelCased.
 - `type` (String) The data source type. Must be one of the supported data source keywords.

docs/resources/data_source_permission.md

@@ -47,7 +47,7 @@ resource "grafana_service_account" "sa" {
 }
 
 resource "grafana_data_source_permission" "fooPermissions" {
-  datasource_id = grafana_data_source.foo.id
+  datasource_uid = grafana_data_source.foo.uid
   permissions {
     team_id    = grafana_team.team.id
     permission = "Edit"
@@ -70,12 +70,10 @@ resource "grafana_data_source_permission" "fooPermissions" {
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
-
-- `datasource_id` (String) ID of the datasource to apply permissions to.
-
 ### Optional
 
+- `datasource_id` (String, Deprecated) Deprecated: Use `datasource_uid` instead.
+- `datasource_uid` (String) UID of the datasource to apply permissions to.
 - `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `permissions` (Block Set) The permission items to add/update. Items that are omitted from the list will be removed. (see [below for nested schema](#nestedblock--permissions))
 

examples/resources/grafana_data_source_permission/resource.tf

@@ -30,7 +30,7 @@ resource "grafana_service_account" "sa" {
 }
 
 resource "grafana_data_source_permission" "fooPermissions" {
-  datasource_id = grafana_data_source.foo.id
+  datasource_uid = grafana_data_source.foo.uid
   permissions {
     team_id    = grafana_team.team.id
     permission = "Edit"

examples/resources/grafana_machine_learning_job/datasource_uid_job.tf

@@ -1,3 +1,22 @@
+resource "grafana_data_source" "foo" {
+  type                = "prometheus"
+  name                = "prometheus-ds-test"
+  uid                 = "prometheus-ds-test-uid"
+  url                 = "https://my-instance.com"
+  basic_auth_enabled  = true
+  basic_auth_username = "username"
+
+  json_data_encoded = jsonencode({
+    httpMethod        = "POST"
+    prometheusType    = "Mimir"
+    prometheusVersion = "2.4.0"
+  })
+
+  secure_json_data_encoded = jsonencode({
+    basicAuthPassword = "password"
+  })
+}
+
 resource "grafana_machine_learning_holiday" "test_holiday" {
   name = "Test Holiday"
   custom_periods {
@@ -11,7 +30,7 @@ resource "grafana_machine_learning_job" "test_job" {
   name            = "Test Job"
   metric          = "tf_test_job"
   datasource_type = "prometheus"
-  datasource_id   = 10
+  datasource_uid  = grafana_data_source.foo.uid
   query_params = {
     expr = "grafanacloud_grafana_instance_active_user_count"
   }

examples/resources/grafana_machine_learning_job/holidays_job.tf

@@ -1,8 +1,27 @@
+resource "grafana_data_source" "foo" {
+  type                = "prometheus"
+  name                = "prometheus-ds-test"
+  uid                 = "prometheus-ds-test-uid"
+  url                 = "https://my-instance.com"
+  basic_auth_enabled  = true
+  basic_auth_username = "username"
+
+  json_data_encoded = jsonencode({
+    httpMethod        = "POST"
+    prometheusType    = "Mimir"
+    prometheusVersion = "2.4.0"
+  })
+
+  secure_json_data_encoded = jsonencode({
+    basicAuthPassword = "password"
+  })
+}
+
 resource "grafana_machine_learning_job" "test_job" {
   name            = "Test Job"
   metric          = "tf_test_job"
   datasource_type = "prometheus"
-  datasource_id   = 10
+  datasource_uid  = grafana_data_source.foo.uid
   query_params = {
     expr = "grafanacloud_grafana_instance_active_user_count"
   }

examples/resources/grafana_machine_learning_job/job.tf

@@ -1,8 +1,27 @@
+resource "grafana_data_source" "foo" {
+  type                = "prometheus"
+  name                = "prometheus-ds-test"
+  uid                 = "prometheus-ds-test-uid"
+  url                 = "https://my-instance.com"
+  basic_auth_enabled  = true
+  basic_auth_username = "username"
+
+  json_data_encoded = jsonencode({
+    httpMethod        = "POST"
+    prometheusType    = "Mimir"
+    prometheusVersion = "2.4.0"
+  })
+
+  secure_json_data_encoded = jsonencode({
+    basicAuthPassword = "password"
+  })
+}
+
 resource "grafana_machine_learning_job" "test_job" {
   name            = "Test Job"
   metric          = "tf_test_job"
   datasource_type = "prometheus"
-  datasource_uid  = "grafanacloud-usage"
+  datasource_uid  = grafana_data_source.foo.uid
   query_params = {
     expr = "grafanacloud_grafana_instance_active_user_count"
   }

examples/resources/grafana_machine_learning_job/tuned_job.tf

@@ -113,16 +113,16 @@ var (
 		},
 	)
 	datasourceCheckExists = newCheckExistsHelper(
-		func(d *models.DataSource) string { return strconv.FormatInt(d.ID, 10) },
-		func(client *goapi.GrafanaHTTPAPI, id string) (*models.DataSource, error) {
-			resp, err := client.Datasources.GetDataSourceByID(id)
+		func(d *models.DataSource) string { return d.UID },
+		func(client *goapi.GrafanaHTTPAPI, uid string) (*models.DataSource, error) {
+			resp, err := client.Datasources.GetDataSourceByUID(uid)
 			return payloadOrError(resp, err)
 		},
 	)
 	datasourcePermissionsCheckExists = newCheckExistsHelper(
 		datasourceCheckExists.getIDFunc, // We use the DS as the reference
-		func(client *goapi.GrafanaHTTPAPI, id string) (*models.DataSource, error) {
-			ds, err := datasourceCheckExists.getResourceFunc(client, id)
+		func(client *goapi.GrafanaHTTPAPI, uid string) (*models.DataSource, error) {
+			ds, err := datasourceCheckExists.getResourceFunc(client, uid)
 			if err != nil {
 				return nil, err
 			}

internal/resources/grafana/common_check_exists_test.go

@@ -2,6 +2,7 @@ package grafana
 
 import (
 	"context"
+	"strconv"
 
 	"github.com/grafana/grafana-openapi-client-go/models"
 	"github.com/grafana/terraform-provider-grafana/v2/internal/common"
@@ -20,6 +21,8 @@ func datasourceDatasource() *schema.Resource {
 				Optional:     true,
 				Computed:     true,
 				AtLeastOneOf: []string{"id", "name", "uid"},
+				Deprecated:   "Use `uid` instead of `id`",
+				Description:  "Deprecated: Use `uid` instead of `id`",
 			},
 			"name": {
 				Type:         schema.TypeString,
@@ -49,7 +52,11 @@ func datasourceDatasourceRead(ctx context.Context, d *schema.ResourceData, meta
 		resp, err = client.Datasources.GetDataSourceByName(name.(string))
 	} else if id, ok := d.GetOk("id"); ok {
 		_, idStr := SplitOrgResourceID(id.(string))
-		resp, err = client.Datasources.GetDataSourceByID(idStr)
+		if _, parseErr := strconv.ParseInt(idStr, 10, 64); parseErr == nil {
+			resp, err = client.Datasources.GetDataSourceByID(idStr) // TODO: Remove on next major release
+		} else {
+			resp, err = client.Datasources.GetDataSourceByUID(idStr)
+		}
 	} else if uid, ok := d.GetOk("uid"); ok {
 		resp, err = client.Datasources.GetDataSourceByUID(uid.(string))
 	}

internal/resources/grafana/data_source_data_source.go

@@ -13,6 +13,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/structure"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 
+	goapi "github.com/grafana/grafana-openapi-client-go/client"
 	"github.com/grafana/grafana-openapi-client-go/models"
 	"github.com/grafana/terraform-provider-grafana/v2/internal/common"
 )
@@ -194,8 +195,7 @@ func CreateDataSource(ctx context.Context, d *schema.ResourceData, meta interfac
 		return diag.FromErr(err)
 	}
 
-	// TODO: Switch to UID
-	d.SetId(MakeOrgResourceID(orgID, resp.Payload.Datasource.ID))
+	d.SetId(MakeOrgResourceID(orgID, resp.Payload.Datasource.UID))
 	return ReadDataSource(ctx, d, meta)
 }
 
@@ -222,7 +222,7 @@ func UpdateDataSource(ctx context.Context, d *schema.ResourceData, meta interfac
 		User:            dataSource.User,
 		WithCredentials: dataSource.WithCredentials,
 	}
-	_, err = client.Datasources.UpdateDataSourceByID(idStr, &body)
+	_, err = client.Datasources.UpdateDataSourceByUID(idStr, &body)
 
 	return diag.FromErr(err)
 }
@@ -231,34 +231,25 @@ func UpdateDataSource(ctx context.Context, d *schema.ResourceData, meta interfac
 func ReadDataSource(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client, _, idStr := OAPIClientFromExistingOrgResource(meta, d.Id())
 
-	var resp interface{ GetPayload() *models.DataSource }
-	var err error
-	// Support both numerical and UID IDs, so that we can import an existing datasource with either.
-	// Following the read, it's normalized to a numerical ID.
-	if _, parseErr := strconv.ParseInt(idStr, 10, 64); parseErr == nil {
-		resp, err = client.Datasources.GetDataSourceByID(idStr)
-	} else {
-		resp, err = client.Datasources.GetDataSourceByUID(idStr)
-	}
-
+	ds, err := getDatasourceByUIDOrID(client, idStr)
 	if err, shouldReturn := common.CheckReadError("datasource", d, err); shouldReturn {
 		return err
 	}
 
-	return datasourceToState(d, resp.GetPayload())
+	return datasourceToState(d, ds)
 }
 
 // DeleteDataSource deletes a Grafana datasource
 func DeleteDataSource(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client, _, idStr := OAPIClientFromExistingOrgResource(meta, d.Id())
 
-	_, err := client.Datasources.DeleteDataSourceByID(idStr)
+	_, err := client.Datasources.DeleteDataSourceByUID(idStr)
 	diag, _ := common.CheckReadError("datasource", d, err)
 	return diag
 }
 
 func datasourceToState(d *schema.ResourceData, dataSource *models.DataSource) diag.Diagnostics {
-	d.SetId(MakeOrgResourceID(dataSource.OrgID, dataSource.ID))
+	d.SetId(MakeOrgResourceID(dataSource.OrgID, dataSource.UID))
 	d.Set("access_mode", dataSource.Access)
 	d.Set("database_name", dataSource.Database)
 	d.Set("is_default", dataSource.IsDefault)
@@ -397,3 +388,23 @@ func removeHeadersFromJSONData(input map[string]interface{}) (map[string]interfa
 
 	return jsonData, headers
 }
+
+// Support both numerical and UID IDs, so that we can import an existing datasource with either.
+// Following the read, it's normalized to a UID.
+// TODO: Remove on next major version
+func getDatasourceByUIDOrID(client *goapi.GrafanaHTTPAPI, id string) (*models.DataSource, error) {
+	var resp interface{ GetPayload() *models.DataSource }
+	var err error
+
+	if _, parseErr := strconv.ParseInt(id, 10, 64); parseErr == nil {
+		resp, err = client.Datasources.GetDataSourceByID(id)
+	} else {
+		resp, err = client.Datasources.GetDataSourceByUID(id)
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	return resp.GetPayload(), nil
+}