Convert k6 project IDs to string

fornfrey · fornfrey · commit d1a01f7f97dd · 2025-06-05T15:08:24.000+01:00
diff --git a/docs/resources/k6_project.md b/docs/resources/k6_project.md
@@ -29,7 +29,7 @@ resource "grafana_k6_project" "test_project" {
 
 - `created` (String) The date when the project was created.
 - `grafana_folder_uid` (String) The Grafana folder uid.
-- `id` (Number) Numeric identifier of the project.
+- `id` (String) Numeric identifier of the project.
 - `is_default` (Boolean) Use this project as default for running tests when no explicit project identifier is provided.
 - `updated` (String) The date when the project was last updated.
 
diff --git a/internal/resources/k6/resource_project.go b/internal/resources/k6/resource_project.go
@@ -19,13 +19,14 @@ import (
 
 // Ensure the implementation satisfies the expected interfaces.
 var (
-	_ resource.ResourceWithConfigure   = (*projectResource)(nil)
-	_ resource.ResourceWithImportState = (*projectResource)(nil)
+	_ resource.ResourceWithConfigure    = (*projectResource)(nil)
+	_ resource.ResourceWithImportState  = (*projectResource)(nil)
+	_ resource.ResourceWithUpgradeState = (*projectResource)(nil)
 )
 
 var (
 	resourceProjectName = "grafana_k6_project"
-	resourceProjectID   = common.NewResourceID(common.IntIDField("id"))
+	resourceProjectID   = common.NewResourceID(common.StringIDField("id"))
 )
 
 func resourceProject() *common.Resource {
@@ -38,7 +39,7 @@ func resourceProject() *common.Resource {
 }
 
 // projectResourceModel maps the resource schema data.
-type projectResourceModel struct {
+type projectResourceModelV0 struct {
 	ID               types.Int32  `tfsdk:"id"`
 	Name             types.String `tfsdk:"name"`
 	IsDefault        types.Bool   `tfsdk:"is_default"`
@@ -47,6 +48,15 @@ type projectResourceModel struct {
 	Updated          types.String `tfsdk:"updated"`
 }
 
+type projectResourceModelV1 struct {
+	ID               types.String `tfsdk:"id"`
+	Name             types.String `tfsdk:"name"`
+	IsDefault        types.Bool   `tfsdk:"is_default"`
+	GrafanaFolderUID types.String `tfsdk:"grafana_folder_uid"`
+	Created          types.String `tfsdk:"created"`
+	Updated          types.String `tfsdk:"updated"`
+}
+
 // projectResource is the resource implementation.
 type projectResource struct {
 	basePluginFrameworkResource
@@ -62,7 +72,7 @@ func (r *projectResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 	resp.Schema = schema.Schema{
 		Description: "Manages a k6 project.",
 		Attributes: map[string]schema.Attribute{
-			"id": schema.Int32Attribute{
+			"id": schema.StringAttribute{
 				Description: "Numeric identifier of the project.",
 				Computed:    true,
 			},
@@ -87,13 +97,64 @@ func (r *projectResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 				Computed:    true,
 			},
 		},
+		Version: 1,
+	}
+}
+
+func (r *projectResource) UpgradeState(ctx context.Context) map[int64]resource.StateUpgrader {
+	return map[int64]resource.StateUpgrader{
+		0: {
+			PriorSchema: &schema.Schema{
+				Attributes: map[string]schema.Attribute{
+					"id": schema.Int32Attribute{
+						Computed: true,
+					},
+					"name": schema.StringAttribute{
+						Required: true,
+					},
+					"is_default": schema.BoolAttribute{
+						Computed: true,
+					},
+					"grafana_folder_uid": schema.StringAttribute{
+						Computed: true,
+					},
+					"created": schema.StringAttribute{
+						Computed: true,
+					},
+					"updated": schema.StringAttribute{
+						Computed: true,
+					},
+				},
+			},
+			StateUpgrader: func(ctx context.Context, req resource.UpgradeStateRequest, resp *resource.UpgradeStateResponse) {
+				// Convert int32 ID to string ID
+				var priorStateData projectResourceModelV0
+				diags := req.State.Get(ctx, &priorStateData)
+				resp.Diagnostics.Append(diags...)
+				if resp.Diagnostics.HasError() {
+					return
+				}
+
+				upgradedStateData := projectResourceModelV1{
+					ID:               types.StringValue(strconv.Itoa(int(priorStateData.ID.ValueInt32()))),
+					Name:             priorStateData.Name,
+					IsDefault:        priorStateData.IsDefault,
+					GrafanaFolderUID: priorStateData.GrafanaFolderUID,
+					Created:          priorStateData.Created,
+					Updated:          priorStateData.Updated,
+				}
+
+				diags = resp.State.Set(ctx, upgradedStateData)
+				resp.Diagnostics.Append(diags...)
+			},
+		},
 	}
 }
 
 // Create creates the resource and sets the Terraform state on success.
 func (r *projectResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	// Retrieve values from plan
-	var plan projectResourceModel
+	var plan projectResourceModelV1
 	diags := req.Plan.Get(ctx, &plan)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
@@ -119,7 +180,7 @@ func (r *projectResource) Create(ctx context.Context, req resource.CreateRequest
 	}
 
 	// Map response body to schema and populate Computed attribute values
-	plan.ID = types.Int32Value(p.GetId())
+	plan.ID = types.StringValue(strconv.Itoa(int(p.GetId())))
 	plan.Name = types.StringValue(p.GetName())
 	plan.IsDefault = types.BoolValue(p.GetIsDefault())
 	plan.GrafanaFolderUID = handleGrafanaFolderUID(p.GrafanaFolderUid)
@@ -137,15 +198,31 @@ func (r *projectResource) Create(ctx context.Context, req resource.CreateRequest
 // Read retrieves the resource information.
 func (r *projectResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
 	// Get current state
-	var state projectResourceModel
+	var state projectResourceModelV1
 	diags := req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
+	// If the ID is empty, we cannot read the resource.
+	// This is required for crossplane to work, but it never happens in Terraform in practice.
+	if state.ID.IsNull() || state.ID.IsUnknown() || state.ID.ValueString() == "" {
+		resp.State.RemoveResource(ctx)
+		return
+	}
+
 	ctx = context.WithValue(ctx, k6.ContextAccessToken, r.config.Token)
-	k6Req := r.client.ProjectsAPI.ProjectsRetrieve(ctx, state.ID.ValueInt32()).
+	projectID, err := strconv.ParseInt(state.ID.ValueString(), 10, 32)
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error parsing project ID",
+			"Could not parse project ID '"+state.ID.ValueString()+"': "+err.Error(),
+		)
+		return
+	}
+
+	k6Req := r.client.ProjectsAPI.ProjectsRetrieve(ctx, int32(projectID)).
 		XStackId(r.config.StackID)
 
 	p, httpResp, err := k6Req.Execute()
@@ -158,13 +235,13 @@ func (r *projectResource) Read(ctx context.Context, req resource.ReadRequest, re
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Error reading k6 project",
-			"Could not read k6 project with id "+strconv.Itoa(int(state.ID.ValueInt32()))+": "+err.Error(),
+			"Could not read k6 project with id "+state.ID.ValueString()+": "+err.Error(),
 		)
 		return
 	}
 
 	// Overwrite items with refreshed state
-	state.ID = types.Int32Value(p.GetId())
+	state.ID = types.StringValue(strconv.Itoa(int(p.GetId())))
 	state.Name = types.StringValue(p.GetName())
 	state.IsDefault = types.BoolValue(p.GetIsDefault())
 	state.GrafanaFolderUID = handleGrafanaFolderUID(p.GrafanaFolderUid)
@@ -182,54 +259,64 @@ func (r *projectResource) Read(ctx context.Context, req resource.ReadRequest, re
 // Update updates the resource and sets the updated Terraform state on success.
 func (r *projectResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
 	// Retrieve values from plan
-	var plan projectResourceModel
+	var plan projectResourceModelV1
 	diags := req.Plan.Get(ctx, &plan)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
 	// Get current state to retrieve the ID
-	var state projectResourceModel
+	var state projectResourceModelV1
 	diags = req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
+	intID, err := strconv.ParseInt(state.ID.ValueString(), 10, 32)
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error parsing project ID",
+			"Could not parse project ID '"+state.ID.ValueString()+"': "+err.Error(),
+		)
+		return
+	}
+	projectID := int32(intID)
+
 	// Generate API request body from plan
 	toUpdate := k6.NewPatchProjectApiModel(plan.Name.ValueString())
 
 	ctx = context.WithValue(ctx, k6.ContextAccessToken, r.config.Token)
-	updateReq := r.client.ProjectsAPI.ProjectsPartialUpdate(ctx, state.ID.ValueInt32()).
+	updateReq := r.client.ProjectsAPI.ProjectsPartialUpdate(ctx, projectID).
 		PatchProjectApiModel(toUpdate).
 		XStackId(r.config.StackID)
 
 	// Update the project
-	_, err := updateReq.Execute()
+	_, err = updateReq.Execute()
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Error updating k6 project",
-			"Could not update k6 project with id "+strconv.Itoa(int(state.ID.ValueInt32()))+": "+err.Error(),
+			"Could not update k6 project with id "+state.ID.ValueString()+": "+err.Error(),
 		)
 		return
 	}
 
 	// Update resource state with updated items and timestamp
-	fetchReq := r.client.ProjectsAPI.ProjectsRetrieve(ctx, state.ID.ValueInt32()).
+	fetchReq := r.client.ProjectsAPI.ProjectsRetrieve(ctx, projectID).
 		XStackId(r.config.StackID)
 
 	p, _, err := fetchReq.Execute()
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Error reading k6 project",
-			"Could not read k6 project with id "+strconv.Itoa(int(state.ID.ValueInt32()))+": "+err.Error(),
+			"Could not read k6 project with id "+state.ID.ValueString()+": "+err.Error(),
 		)
 		return
 	}
 
 	// Overwrite items with refreshed state
-	plan.ID = types.Int32Value(p.GetId())
+	plan.ID = types.StringValue(strconv.Itoa(int(p.GetId())))
 	plan.Name = types.StringValue(p.GetName())
 	plan.IsDefault = types.BoolValue(p.GetIsDefault())
 	plan.GrafanaFolderUID = handleGrafanaFolderUID(p.GrafanaFolderUid)
@@ -246,44 +333,39 @@ func (r *projectResource) Update(ctx context.Context, req resource.UpdateRequest
 // Delete deletes the resource and removes the Terraform state on success.
 func (r *projectResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
 	// Retrieve values from state
-	var state projectResourceModel
+	var state projectResourceModelV1
 	diags := req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
+	intID, err := strconv.ParseInt(state.ID.ValueString(), 10, 32)
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error parsing project ID",
+			"Could not parse project ID '"+state.ID.ValueString()+"': "+err.Error(),
+		)
+		return
+	}
+	projectID := int32(intID)
+
 	// Delete existing project
 	ctx = context.WithValue(ctx, k6.ContextAccessToken, r.config.Token)
-	deleteReq := r.client.ProjectsAPI.ProjectsDestroy(ctx, state.ID.ValueInt32()).
+	deleteReq := r.client.ProjectsAPI.ProjectsDestroy(ctx, projectID).
 		XStackId(r.config.StackID)
 
-	_, err := deleteReq.Execute()
+	_, err = deleteReq.Execute()
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Error deleting k6 project",
-			"Could not delete k6 project with id "+strconv.Itoa(int(state.ID.ValueInt32()))+": "+err.Error(),
+			"Could not delete k6 project with id "+state.ID.ValueString()+": "+err.Error(),
 		)
 	}
 }
 
 func (r *projectResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
-	id, err := strconv.ParseInt(req.ID, 10, 32)
-	if err != nil {
-		resp.Diagnostics.AddError(
-			"Error importing k6 project",
-			"Could not parse k6 project id "+req.ID+": "+err.Error(),
-		)
-		return
-	}
-
-	resp.State.SetAttribute(ctx, path.Root("id"), types.Int32Value(int32(id)))
-
-	readReq := resource.ReadRequest{State: resp.State}
-	readResp := resource.ReadResponse{State: resp.State}
-
-	r.Read(ctx, readReq, &readResp)
-	resp.Diagnostics.Append(readResp.Diagnostics...)
+	resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
 }
 
 // listProjects retrieves the list ids of all the existing projects.
diff --git a/internal/resources/k6/resource_project_test.go b/internal/resources/k6/resource_project_test.go
@@ -97,6 +97,47 @@ func TestAccProject_basic(t *testing.T) {
 	})
 }
 
+func TestAccProject_StateUpgrade(t *testing.T) {
+	testutils.CheckCloudInstanceTestsEnabled(t)
+
+	var project k6.ProjectApiModel
+
+	projectName := "Terraform Test Project " + acctest.RandString(8)
+
+	resource.ParallelTest(t, resource.TestCase{
+		CheckDestroy: resource.ComposeTestCheckFunc(
+			projectCheckExists.destroyed(&project),
+		),
+		Steps: []resource.TestStep{
+			{
+				Config: testutils.TestAccExampleWithReplace(t, "resources/grafana_k6_project/resource.tf", map[string]string{
+					"Terraform Test Project": projectName,
+				}),
+				ExternalProviders: map[string]resource.ExternalProvider{
+					"grafana": {
+						Source:            "grafana/grafana",
+						VersionConstraint: "<=3.25.2",
+					},
+				},
+				Check: projectCheckExists.exists("grafana_k6_project.test_project", &project),
+			},
+			// Test apply updates the TF state to the latest schema but the resource is unchanged
+			{
+				ProtoV5ProviderFactories: testutils.ProtoV5ProviderFactories,
+				Config: testutils.TestAccExampleWithReplace(t, "resources/grafana_k6_project/resource.tf", map[string]string{
+					"Terraform Test Project": projectName,
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccProjectUnchangedAttr("grafana_k6_project.test_project", "id", func() string { return strconv.Itoa(int(project.GetId())) }),
+					testAccProjectUnchangedAttr("grafana_k6_project.test_project", "name", func() string { return projectName }),
+					testAccProjectUnchangedAttr("grafana_k6_project.test_project", "grafana_folder_uid", project.GetGrafanaFolderUid),
+					testAccProjectUnchangedAttr("grafana_k6_project.test_project", "created", func() string { return project.GetCreated().Truncate(time.Microsecond).Format(time.RFC3339Nano) }),
+					testAccProjectUnchangedAttr("grafana_k6_project.test_project", "updated", func() string { return project.GetUpdated().Truncate(time.Microsecond).Format(time.RFC3339Nano) }),
+				),
+			},
+		},
+	})
+}
 func testAccProjectUnchangedAttr(resName, attrName string, oldValueGetter func() string) resource.TestCheckFunc {
 	return resource.TestCheckResourceAttrWith(resName, attrName, func(newVal string) error {
 		if oldValue := oldValueGetter(); oldValue != newVal {
