State constants

Author: tobio

internal/elasticsearch/ml/datafeed/delete.go

@@ -54,7 +54,7 @@ func (r *datafeedResource) maybeStopDatafeed(ctx context.Context, datafeedId str
 	}
 
 	// If the datafeed is not running, nothing to stop
-	if *currentState != "started" && *currentState != "starting" {
+	if *currentState != StateStarted && *currentState != StateStarting {
 		return false, diags
 	}
 
@@ -66,7 +66,7 @@ func (r *datafeedResource) maybeStopDatafeed(ctx context.Context, datafeedId str
 	}
 
 	// Wait for the datafeed to reach stopped state
-	_, waitDiags := WaitForDatafeedState(ctx, r.client, datafeedId, "stopped")
+	_, waitDiags := WaitForDatafeedState(ctx, r.client, datafeedId, StateStopped)
 	diags.Append(waitDiags...)
 	if diags.HasError() {
 		return true, diags

internal/elasticsearch/ml/datafeed/state_utils.go

@@ -12,8 +12,16 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 )
 
+type State string
+
+const (
+	StateStopped  State = "stopped"
+	StateStarted  State = "started"
+	StateStarting State = "starting"
+)
+
 // GetDatafeedState returns the current state of a datafeed
-func GetDatafeedState(ctx context.Context, client *clients.ApiClient, datafeedId string) (*string, diag.Diagnostics) {
+func GetDatafeedState(ctx context.Context, client *clients.ApiClient, datafeedId string) (*State, diag.Diagnostics) {
 	statsResponse, diags := elasticsearch.GetDatafeedStats(ctx, client, datafeedId)
 	if diags.HasError() {
 		return nil, diags
@@ -23,18 +31,19 @@ func GetDatafeedState(ctx context.Context, client *clients.ApiClient, datafeedId
 		return nil, nil
 	}
 
-	return &statsResponse.State, nil
+	state := State(statsResponse.State)
+	return &state, nil
 }
 
-var terminalDatafeedStates = map[string]struct{}{
-	"stopped": {},
-	"started": {},
+var terminalDatafeedStates = map[State]struct{}{
+	StateStopped: {},
+	StateStarted: {},
 }
 
 var errDatafeedInUndesiredState = errors.New("datafeed stuck in undesired state")
 
 // WaitForDatafeedState waits for a datafeed to reach the desired state
-func WaitForDatafeedState(ctx context.Context, client *clients.ApiClient, datafeedId, desiredState string) (bool, diag.Diagnostics) {
+func WaitForDatafeedState(ctx context.Context, client *clients.ApiClient, datafeedId string, desiredState State) (bool, diag.Diagnostics) {
 	stateChecker := func(ctx context.Context) (bool, error) {
 		currentState, diags := GetDatafeedState(ctx, client, datafeedId)
 		if diags.HasError() {

internal/elasticsearch/ml/datafeed/update.go

@@ -61,7 +61,7 @@ func (r *datafeedResource) update(ctx context.Context, req resource.UpdateReques
 		}
 
 		// Wait for the datafeed to reach started state
-		_, waitDiags := WaitForDatafeedState(ctx, r.client, datafeedId, "started")
+		_, waitDiags := WaitForDatafeedState(ctx, r.client, datafeedId, StateStarted)
 		resp.Diagnostics.Append(waitDiags...)
 		if resp.Diagnostics.HasError() {
 			return

internal/elasticsearch/ml/datafeed_state/delete.go

@@ -39,7 +39,7 @@ func (r *mlDatafeedStateResource) Delete(ctx context.Context, req resource.Delet
 	}
 
 	// If the datafeed is started, stop it when deleting the resource
-	if *currentState == "started" {
+	if *currentState == datafeed.StateStarted {
 		tflog.Info(ctx, fmt.Sprintf("Stopping ML datafeed %s during delete", datafeedId))
 
 		// Parse timeout duration
@@ -57,7 +57,7 @@ func (r *mlDatafeedStateResource) Delete(ctx context.Context, req resource.Delet
 		}
 
 		// Wait for the datafeed to stop
-		_, diags := datafeed.WaitForDatafeedState(ctx, client, datafeedId, "stopped")
+		_, diags := datafeed.WaitForDatafeedState(ctx, client, datafeedId, datafeed.StateStopped)
 		resp.Diagnostics.Append(diags...)
 		if resp.Diagnostics.HasError() {
 			return

internal/elasticsearch/ml/datafeed_state/read.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients"
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients/elasticsearch"
+	"github.com/elastic/terraform-provider-elasticstack/internal/elasticsearch/ml/datafeed"
 	"github.com/hashicorp/terraform-plugin-framework-timetypes/timetypes"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
@@ -55,7 +56,7 @@ func (r *mlDatafeedStateResource) read(ctx context.Context, data MLDatafeedState
 	// Update the data with current information
 	data.State = types.StringValue(datafeedStats.State)
 
-	if datafeedStats.State == "started" {
+	if datafeed.State(datafeedStats.State) == datafeed.StateStarted {
 		if datafeedStats.RunningState == nil {
 			diags.AddWarning("Running state was empty for a started datafeed", "The Elasticsearch API returned an empty running state for a Datafeed which was successfully started. Ignoring start and end response values.")
 		}

internal/elasticsearch/ml/datafeed_state/schema.go

@@ -5,6 +5,7 @@ import (
 	_ "embed"
 	"regexp"
 
+	"github.com/elastic/terraform-provider-elasticstack/internal/elasticsearch/ml/datafeed"
 	"github.com/elastic/terraform-provider-elasticstack/internal/utils/customtypes"
 	"github.com/hashicorp/terraform-plugin-framework-timeouts/resource/timeouts"
 	"github.com/hashicorp/terraform-plugin-framework-timetypes/timetypes"
@@ -56,7 +57,7 @@ func GetSchema() schema.Schema {
 				MarkdownDescription: "The desired state for the ML datafeed. Valid values are `started` and `stopped`.",
 				Required:            true,
 				Validators: []validator.String{
-					stringvalidator.OneOf("started", "stopped"),
+					stringvalidator.OneOf(string(datafeed.StateStarted), string(datafeed.StateStopped)),
 				},
 			},
 			"force": schema.BoolAttribute{

internal/elasticsearch/ml/datafeed_state/update.go

@@ -140,9 +140,9 @@ func (r *mlDatafeedStateResource) update(ctx context.Context, plan tfsdk.Plan, s
 }
 
 // performStateTransition handles the ML datafeed state transition process
-func (r *mlDatafeedStateResource) performStateTransition(ctx context.Context, client *clients.ApiClient, data MLDatafeedStateData, currentState string) (bool, diag.Diagnostics) {
+func (r *mlDatafeedStateResource) performStateTransition(ctx context.Context, client *clients.ApiClient, data MLDatafeedStateData, currentState datafeed.State) (bool, diag.Diagnostics) {
 	datafeedId := data.DatafeedId.ValueString()
-	desiredState := data.State.ValueString()
+	desiredState := datafeed.State(data.State.ValueString())
 	force := data.Force.ValueBool()
 
 	// Parse timeout duration
@@ -159,7 +159,7 @@ func (r *mlDatafeedStateResource) performStateTransition(ctx context.Context, cl
 
 	// Initiate the state change
 	switch desiredState {
-	case "started":
+	case datafeed.StateStarted:
 		start, diags := data.GetStartAsString()
 		if diags.HasError() {
 			return false, diags
@@ -175,7 +175,7 @@ func (r *mlDatafeedStateResource) performStateTransition(ctx context.Context, cl
 		if diags.HasError() {
 			return false, diags
 		}
-	case "stopped":
+	case datafeed.StateStopped:
 		if diags := elasticsearch.StopDatafeed(ctx, client, datafeedId, force, timeout); diags.HasError() {
 			return false, diags
 		}