Feat/dedicated server installation import (#313)

* fix(dockerfile): resolve corepack issue in node image

* refactor(reportError): make reportError public for external use

* feat(import, timeout): add dedicated_server_installation import and applied timeout to 1 hour

---------

Co-authored-by: Imtiaz Ahmed <i.ahmed@global.leaseweb.com>

Author: imtiazPabel

docker/node/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:jod-slim@sha256:35531c52ce27b6575d69755c73e65d4468dba93a25644eed56dc12879cae9213
+FROM node:jod-slim@sha256:91be66fb4214c9449836550cf4c3524489816fcc29455bf42d968e8e87cfa5f2
 
 RUN corepack enable \
     && corepack prepare pnpm@latest-9 --activate \

docs/resources/dedicated_server_installation.md

@@ -85,3 +85,11 @@ Optional:
   - *HW*
   - *SW*
   - *NONE*
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import leaseweb_dedicated_server_installation.test 12345678
+```

examples/resources/leaseweb_dedicated_server_installation/import.sh

@@ -0,0 +1 @@
+terraform import leaseweb_dedicated_server_installation.test 12345678

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/hashicorp/terraform-plugin-go v0.26.0
 	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-testing v1.11.0
-	github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.3
+	github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.4
 	github.com/leaseweb/leaseweb-go-sdk/dns v1.1.0
 	github.com/leaseweb/leaseweb-go-sdk/ipmgmt v1.0.0
 	github.com/leaseweb/leaseweb-go-sdk/publiccloud v0.0.2

go.sum

@@ -112,8 +112,12 @@ github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfn
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.2 h1:WYJMnr0UNeb8v5wVfDqVNQXcfpTGbUMXVufARi/MV90=
+github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.2/go.mod h1:D/dX8az1mr8VKxIRL1jrg6wR+vReaF45kp06R2VnvmA=
 github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.3 h1:2gQyn0DkGn9iQaxcYCvIrXogogV2RgSfY33w7qq1tog=
 github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.3/go.mod h1:D/dX8az1mr8VKxIRL1jrg6wR+vReaF45kp06R2VnvmA=
+github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.4 h1:1xeAgn/yAtF2Z34FUExI0FmR9SzRIkXTeYSDuyZc3iU=
+github.com/leaseweb/leaseweb-go-sdk/dedicatedserver/v2 v2.0.4/go.mod h1:D/dX8az1mr8VKxIRL1jrg6wR+vReaF45kp06R2VnvmA=
 github.com/leaseweb/leaseweb-go-sdk/dns v1.1.0 h1:Ev5xjXlYunGV+cjY2eem5TuC3OXCFujY8Efk/n0YcME=
 github.com/leaseweb/leaseweb-go-sdk/dns v1.1.0/go.mod h1:ntxqh2fT7XDwjPLNsWtq6tTjwjL/75llxnbzEZvvzIo=
 github.com/leaseweb/leaseweb-go-sdk/ipmgmt v1.0.0 h1:R+ZC7t3vtAoeRxSH3KcsR8vNF5NgaXy606vobn++cdU=

internal/provider/dedicatedserver/installation_resource.go

@@ -3,12 +3,17 @@ package dedicatedserver
 import (
 	"context"
 	"encoding/base64"
+	"errors"
+	"fmt"
 	"strings"
+	"time"
 
 	"github.com/cenkalti/backoff/v5"
 	"github.com/hashicorp/terraform-plugin-framework-validators/int32validator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier"
@@ -24,8 +29,8 @@ import (
 )
 
 var (
-	_ resource.Resource              = &installationResource{}
-	_ resource.ResourceWithConfigure = &installationResource{}
+	_ resource.ResourceWithConfigure   = &installationResource{}
+	_ resource.ResourceWithImportState = &installationResource{}
 )
 
 func NewInstallationResource() resource.Resource {
@@ -326,94 +331,72 @@ func (i *installationResource) Create(
 	}
 
 	serverID := plan.DedicatedServerID.ValueString()
-	result, response, err := i.DedicatedserverAPI.InstallOperatingSystem(ctx, serverID).
+	job, response, err := i.DedicatedserverAPI.InstallOperatingSystem(ctx, serverID).
 		InstallOperatingSystemOpts(*opts).Execute()
 	if err != nil {
 		utils.SdkError(ctx, &resp.Diagnostics, err, response)
 		return
 	}
 
-	payload := result.GetPayload()
-	plan.ID = types.StringValue(result.GetUuid())
-	plan.Device = types.StringValue(payload.GetDevice())
-	plan.Timezone = types.StringValue(payload.GetTimezone())
-	plan.PowerCycle = types.BoolValue(payload.GetPowerCycle())
-
-	partitionAttributeTypes := map[string]attr.Type{
-		"filesystem": types.StringType,
-		"mountpoint": types.StringType,
-		"size":       types.StringType,
-	}
-
-	// Preparing and converting partitions into types.Object to store in the state
-	var partitionsObjects []attr.Value
-	for _, p := range payload.GetPartitions() {
-		partition := partitionsResourceModel{
-			Filesystem: types.StringValue(p.GetFilesystem()),
-			Mountpoint: types.StringValue(p.GetMountpoint()),
-			Size:       types.StringValue(p.GetSize()),
-		}
-
-		partitionObj, diags := types.ObjectValueFrom(
-			ctx,
-			partitionAttributeTypes,
-			partition,
-		)
-		if diags.HasError() {
-			resp.Diagnostics.Append(diags...)
-			return
-		}
-
-		partitionsObjects = append(partitionsObjects, partitionObj)
+	err = i.waitForJobCompletion(serverID, job.GetUuid(), ctx, resp)
+	if err != nil {
+		utils.ReportError(err.Error(), &resp.Diagnostics)
+		return
 	}
 
-	// Convert the slice of partition objects to a types.List and store it in the plan
-	partitionsList, diags := types.ListValueFrom(
-		ctx,
-		types.ObjectType{
-			AttrTypes: partitionAttributeTypes,
-		},
-		partitionsObjects,
-	)
-	if diags.HasError() {
-		resp.Diagnostics.Append(diags...)
+	diags := i.syncResourceModelWithSDK(&plan, *job, ctx)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
 		return
 	}
-	plan.Partitions = partitionsList
 
-	pollJobStatus := func() (string, error) {
-		return getJobStatus(serverID, result.GetUuid(), i, ctx, resp)
-	}
+	resp.Diagnostics.Append(resp.State.Set(ctx, plan)...)
+}
 
-	_, err = backoff.Retry(context.TODO(), pollJobStatus, backoff.WithBackOff(backoff.NewExponentialBackOff()))
-	if err != nil {
-		utils.GeneralError(&resp.Diagnostics, ctx, err)
+func (i *installationResource) ImportState(
+	ctx context.Context,
+	req resource.ImportStateRequest,
+	resp *resource.ImportStateResponse,
+) {
+	// Retrieve import ID and save to id attribute
+	resource.ImportStatePassthroughID(ctx, path.Root("dedicated_server_id"), req, resp)
+}
+
+func (i *installationResource) Read(
+	ctx context.Context,
+	req resource.ReadRequest,
+	resp *resource.ReadResponse,
+) {
+	var state installationResourceModel
+	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
+	if resp.Diagnostics.HasError() {
+		return
 	}
 
-	resp.Diagnostics.Append(resp.State.Set(ctx, plan)...)
-}
+	serverID := state.DedicatedServerID.ValueString()
 
-func getJobStatus(serverID string, jobID string, i *installationResource, ctx context.Context, resp *resource.CreateResponse) (string, error) {
-	request := i.DedicatedserverAPI.GetJob(ctx, serverID, jobID)
+	result, response, err := i.DedicatedserverAPI.GetJobList(ctx, serverID).
+		Offset(0).Limit(1).Type_("install").Status("FINISHED").Execute()
 
-	result, response, err := request.Execute()
 	if err != nil {
 		utils.SdkError(ctx, &resp.Diagnostics, err, response)
+		return
 	}
 
-	status := result.GetStatus()
-	if status != "FINISHED" {
-		return "", backoff.RetryAfter(30)
+	jobs := result.GetJobs()
+
+	if len(jobs) == 0 {
+		utils.ReportError(fmt.Sprintf("No installation jobs found for server %s", serverID), &resp.Diagnostics)
+		return
 	}
 
-	return status, nil
-}
+	diags := i.syncResourceModelWithSDK(&state, jobs[0], ctx)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
-func (i *installationResource) Read(
-	_ context.Context,
-	_ resource.ReadRequest,
-	_ *resource.ReadResponse,
-) {
+	resp.Diagnostics.Append(resp.State.Set(ctx, state)...)
 }
 
 func (i *installationResource) Update(
@@ -429,3 +412,92 @@ func (i *installationResource) Delete(
 	_ *resource.DeleteResponse,
 ) {
 }
+
+// isJobFinished checks if the job status is "FINISHED".
+func (i *installationResource) isJobFinished(serverID, jobID string, ctx context.Context, resp *resource.CreateResponse) bool {
+	// Fetch the job status
+	result, response, err := i.DedicatedserverAPI.GetJob(ctx, serverID, jobID).Execute()
+	if err != nil {
+		utils.SdkError(ctx, &resp.Diagnostics, err, response)
+		return false // Return false indicating the status couldn't be fetched
+	}
+
+	// Return true if the job status is finished
+	return result.GetStatus() == "FINISHED"
+}
+
+// waitForJobCompletion handles polling with retry and timeout.
+func (i *installationResource) waitForJobCompletion(serverID, jobID string, ctx context.Context, resp *resource.CreateResponse) error {
+	// Create a constant backoff with a 30-second retry interval
+	bo := backoff.NewConstantBackOff(30 * time.Second)
+
+	// Set the retry limit to 120 retries (60 minutes total)
+	retryCount := 0
+	maxRetries := 120
+
+	// Start polling and retrying
+	for {
+		if retryCount >= maxRetries {
+			return errors.New("timed out waiting for job to finish after 60 minutes")
+		}
+
+		// Call the function to check if the job is finished
+		if i.isJobFinished(serverID, jobID, ctx, resp) {
+			// Job is finished, exit the loop
+			return nil
+		}
+
+		// Sleep for the backoff interval before retrying
+		time.Sleep(bo.NextBackOff())
+		retryCount++
+	}
+}
+
+func (i *installationResource) syncResourceModelWithSDK(
+	state *installationResourceModel,
+	job dedicatedserver.ServerJob,
+	ctx context.Context,
+) diag.Diagnostics {
+	var diags diag.Diagnostics
+	payload := job.GetPayload()
+	state.ID = types.StringValue(job.GetUuid())
+	state.Device = types.StringValue(payload.GetDevice())
+	state.OperatingSystemID = types.StringValue(payload.GetOperatingSystemId())
+	state.PowerCycle = types.BoolValue(payload.GetPowerCycle())
+	state.Timezone = types.StringValue(payload.GetTimezone())
+
+	partitionAttributeTypes := map[string]attr.Type{
+		"filesystem": types.StringType,
+		"mountpoint": types.StringType,
+		"size":       types.StringType,
+	}
+
+	// Preparing and converting partitions into types.Object to store in the state
+	var partitionsObjects []attr.Value
+	for _, p := range payload.GetPartitions() {
+		partition := partitionsResourceModel{
+			Filesystem: types.StringValue(p.GetFilesystem()),
+			Mountpoint: types.StringValue(p.GetMountpoint()),
+			Size:       types.StringValue(p.GetSize()),
+		}
+
+		partitionObj, partitionDiags := types.ObjectValueFrom(ctx, partitionAttributeTypes, partition)
+		diags.Append(partitionDiags...)
+		partitionsObjects = append(partitionsObjects, partitionObj)
+	}
+
+	// Convert the slice of partition objects to a types.List and store it in the plan
+	partitionsList, listDiags := types.ListValueFrom(ctx, types.ObjectType{AttrTypes: partitionAttributeTypes}, partitionsObjects)
+	diags.Append(listDiags...)
+	state.Partitions = partitionsList
+
+	if state.Raid.IsNull() || state.Raid.IsUnknown() {
+		state.Raid = types.ObjectNull(map[string]attr.Type{
+			"level":           types.Int64Type,
+			"number_of_disks": types.Int64Type,
+			"type":            types.StringType,
+		})
+	}
+
+	return diags
+}

internal/provider/provider_test.go

@@ -1465,6 +1465,14 @@ func TestAccDedicatedServerInstallationResource(t *testing.T) {
 							),
 						),
 					},
+					{
+						ResourceName:                         "leaseweb_dedicated_server_installation.test",
+						ImportState:                          true,
+						ImportStateVerify:                    true,
+						ImportStateId:                        "12345",
+						ImportStateVerifyIdentifierAttribute: "dedicated_server_id",
+						ImportStateVerifyIgnore:              []string{"callback_url", "control_panel_id", "hostname", "password", "ssh_keys", "post_install_script", "raid"},
+					},
 				},
 			})
 		})

internal/utils/error.go

@@ -22,7 +22,7 @@ func GeneralError(diags *diag.Diagnostics, ctx context.Context, err error) {
 	if err != nil {
 		logDebug(err.Error(), ctx)
 	}
-	reportError(defaultErrMsg, diags)
+	ReportError(defaultErrMsg, diags)
 }
 
 // ImportOnlyError should be used in resource Read() functions for resources that can only be imported.
@@ -57,13 +57,13 @@ func SdkError(
 
 	if err == nil {
 		logDebug("No error detail found.", ctx)
-		reportError(defaultErrMsg, diags)
+		ReportError(defaultErrMsg, diags)
 		return
 	}
 
 	// Without a response we only need to handle the error.
 	if resp == nil {
-		reportError(err.Error(), diags)
+		ReportError(err.Error(), diags)
 		return
 	}
 
@@ -81,12 +81,12 @@ func SdkError(
 	// For certain http responses we don't need to analyze the response body.
 	if resp.StatusCode == 504 {
 		logDebug(fmt.Sprintf("server response: %v", resp.Body), ctx)
-		reportError("The server took too long to respond.", diags)
+		ReportError("The server took too long to respond.", diags)
 		return
 	}
 	if resp.StatusCode == 404 {
 		logDebug(fmt.Sprintf("server response: %v", resp.Body), ctx)
-		reportError("Resource not found.", diags)
+		ReportError("Resource not found.", diags)
 		return
 	}
 
@@ -103,7 +103,7 @@ func SdkError(
 			fmt.Sprintf("error decoding HTTP response body: %v", err),
 			ctx,
 		)
-		reportError(defaultErrMsg, diags)
+		ReportError(defaultErrMsg, diags)
 		return
 	}
 
@@ -116,7 +116,7 @@ func SdkError(
 	}
 
 	if len(errorResponse.ErrorMessage) > 0 {
-		reportError(errorResponse.ErrorMessage, diags)
+		ReportError(errorResponse.ErrorMessage, diags)
 		return
 	}
 
@@ -190,7 +190,7 @@ func logDebug(details string, ctx context.Context) {
 	tflog.Debug(ctx, fmt.Sprintf("Details: %v", details))
 }
 
-func reportError(details string, diags *diag.Diagnostics) {
+func ReportError(details string, diags *diag.Diagnostics) {
 	diags.AddError(errTitle, details)
 }
 

internal/utils/error_test.go

@@ -653,7 +653,7 @@ func ExampleUnexpectedImportIdentifierError() {
 func Test_writeSDKOutput(t *testing.T) {
 	diags := diag.Diagnostics{}
 
-	reportError("tralala", &diags)
+	ReportError("tralala", &diags)
 
 	assert.Len(t, diags.Errors(), 1)
 	assert.Equal(t, errTitle, diags.Errors()[0].Summary())