chore(LH-71991): Add workflow error message (#94)

client/connector/connectoronboarding/create.go

@@ -28,6 +28,7 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 		ctx,
 		UntilConnectorStatusIsActive(ctx, client, *connector.NewReadByNameInput(createInp.Name), &readOutp),
 		retry.NewOptionsBuilder().
+			Message("Waiting for connector to be ACTIVE...").
 			Timeout(15*time.Minute). // usually takes ~3 minutes
 			Retries(-1).
 			Delay(2*time.Second).

client/connector/create.go

@@ -58,7 +58,9 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 	err := retry.Do(
 		ctx,
 		untilCommunicationQueueReady(ctx, client, *NewReadByUidInput(createOutp.Uid)),
-		retry.NewOptionsBuilder().Retries(10).
+		retry.NewOptionsBuilder().
+			Message("Waiting for connector to be created....").
+			Retries(10).
 			Logger(client.Logger).
 			Delay(2*time.Second).
 			EarlyExitOnError(true).

client/device/asa/asaconfig/read.go

@@ -2,6 +2,7 @@ package asaconfig
 
 import (
 	"context"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/statemachine"
 
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/http"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/url"
@@ -12,8 +13,9 @@ type ReadInput struct {
 }
 
 type ReadOutput struct {
-	Uid   string `json:"uid"`
-	State string `json:"state"`
+	Uid                 string               `json:"uid"`
+	State               string               `json:"state"`
+	StateMachineDetails statemachine.Details `json:"stateMachineDetails"`
 }
 
 func NewReadInput(specificUid string) *ReadInput {

client/device/asa/asaconfig/retry.go

@@ -2,7 +2,7 @@ package asaconfig
 
 import (
 	"context"
-	"fmt"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/statemachine"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/statemachine/state"
 	"strings"
 
@@ -30,13 +30,13 @@ func UntilStateDone(ctx context.Context, client http.Client, specificUid string)
 			return true, nil
 		}
 		if strings.EqualFold(readOutp.State, state.ERROR) {
-			return false, fmt.Errorf("workflow ended in ERROR")
+			return false, statemachine.NewWorkflowErrorFromDetails(readOutp.StateMachineDetails)
 		}
 		if strings.EqualFold(readOutp.State, state.BAD_CREDENTIALS) {
-			return false, fmt.Errorf("bad credentials")
+			return false, statemachine.NewWorkflowErrorf("Bad Credentials")
 		}
 		if strings.EqualFold(readOutp.State, state.PRE_WAIT_FOR_USER_TO_UPDATE_CREDS) {
-			return false, fmt.Errorf("bad credentials")
+			return false, statemachine.NewWorkflowErrorf("Bad Credentials")
 		}
 		return false, nil
 	}

client/device/asa/create.go

@@ -14,6 +14,7 @@ import (
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/featureflag"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/user"
 	"strings"
+	"time"
 )
 
 type CreateInput struct {
@@ -129,7 +130,18 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 	client.Logger.Println("waiting for asa config state done")
 
 	// poll until asa config state done
-	err = retry.Do(ctx, asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid), *retry.NewOptionsWithLogger(client.Logger))
+	err = retry.Do(
+		ctx,
+		asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid),
+		retry.NewOptionsBuilder().
+			Message("Waiting for ASA to be created...").
+			Retries(-1).
+			Delay(3*time.Second).
+			EarlyExitOnError(true).
+			Logger(client.Logger).
+			Timeout(3*time.Minute).
+			Build(),
+	)
 
 	// error during polling, but we maybe able to handle it
 	if err != nil {
@@ -206,7 +218,18 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 	// poll until asa config state done
 	client.Logger.Println("waiting for device to reach state done")
 
-	err = retry.Do(ctx, asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid), *retry.NewOptionsWithLogger(client.Logger))
+	err = retry.Do(
+		ctx,
+		asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid),
+		retry.NewOptionsBuilder().
+			Message("Waiting for ASA to be onboarded to CDO...").
+			Retries(-1).
+			Delay(3*time.Second).
+			EarlyExitOnError(true).
+			Logger(client.Logger).
+			Timeout(3*time.Minute).
+			Build(),
+	)
 	if err != nil {
 		return nil, &CreateError{
 			CreatedResourceId: createdResourceId,

client/device/asa/read.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/device/tags"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/devicetype"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/statemachine"
 
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/device"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/http"
@@ -24,11 +25,12 @@ type ReadOutput struct {
 	Host            string          `json:"host"`
 	Tags            tags.Type       `json:"tags"`
 
-	IgnoreCertificate bool   `json:"ignoreCertificate"`
-	ConnectivityState int    `json:"connectivityState,omitempty"`
-	ConnectivityError string `json:"connectivityError,omitempty"`
-	State             string `json:"state"`
-	Status            string `json:"status"`
+	IgnoreCertificate   bool                 `json:"ignoreCertificate"`
+	ConnectivityState   int                  `json:"connectivityState,omitempty"`
+	ConnectivityError   string               `json:"connectivityError,omitempty"`
+	State               string               `json:"state"`
+	Status              string               `json:"status"`
+	StateMachineDetails statemachine.Details `json:"stateMachineDetails"`
 }
 
 func NewReadInput(uid string) *ReadInput {

client/device/asa/retry.go

@@ -3,6 +3,7 @@ package asa
 import (
 	"context"
 	"fmt"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/statemachine"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/statemachine/state"
 	"strings"
 
@@ -29,10 +30,10 @@ func UntilStateDoneAndConnectivityOk(ctx context.Context, client http.Client, ui
 			return true, nil
 		}
 		if strings.EqualFold(readOutp.State, state.ERROR) {
-			return false, fmt.Errorf("workflow ended in ERROR")
+			return false, statemachine.NewWorkflowErrorFromDetails(readOutp.StateMachineDetails)
 		}
 		if strings.EqualFold(readOutp.State, state.BAD_CREDENTIALS) {
-			return false, fmt.Errorf("bad credentials")
+			return false, statemachine.NewWorkflowErrorf("Bad Credentials")
 		}
 		return false, nil
 	}

client/device/asa/update.go

@@ -86,7 +86,17 @@ func Update(ctx context.Context, client http.Client, updateInp UpdateInput) (*Up
 				return nil, err
 			}
 
-			if err := retry.Do(ctx, asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid), retry.DefaultOpts); err != nil {
+			if err := retry.Do(
+				ctx,
+				asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid),
+				retry.NewOptionsBuilder().
+					Message("Waiting for ASA credentials to be updated on CDO...").
+					Retries(retry.DefaultRetries).
+					Delay(retry.DefaultDelay).
+					Timeout(retry.DefaultTimeout).
+					EarlyExitOnError(true).
+					Build(),
+			); err != nil {
 				return nil, err
 			}
 		}
@@ -100,7 +110,17 @@ func Update(ctx context.Context, client http.Client, updateInp UpdateInput) (*Up
 				return nil, err
 			}
 
-			if err := retry.Do(ctx, asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid), retry.DefaultOpts); err != nil {
+			if err := retry.Do(
+				ctx,
+				asaconfig.UntilStateDone(ctx, client, asaReadSpecOutp.SpecificUid),
+				retry.NewOptionsBuilder().
+					Message("Waiting for ASA location to be updated on CDO...").
+					Retries(retry.DefaultRetries).
+					Delay(retry.DefaultDelay).
+					Timeout(retry.DefaultTimeout).
+					EarlyExitOnError(true).
+					Build(),
+			); err != nil {
 				return nil, err
 			}
 		}
@@ -115,7 +135,17 @@ func Update(ctx context.Context, client http.Client, updateInp UpdateInput) (*Up
 		return nil, err
 	}
 
-	if err := retry.Do(ctx, UntilStateDoneAndConnectivityOk(ctx, client, outp.Uid), retry.DefaultOpts); err != nil {
+	if err := retry.Do(
+		ctx,
+		UntilStateDoneAndConnectivityOk(ctx, client, outp.Uid),
+		retry.NewOptionsBuilder().
+			Message("Waiting for ASA to reach connectivity state ONLINE").
+			Retries(retry.DefaultRetries).
+			Delay(retry.DefaultDelay).
+			Timeout(retry.DefaultTimeout).
+			EarlyExitOnError(true).
+			Build(),
+	); err != nil {
 		return nil, err
 	}
 

client/device/cloudfmc/create.go

@@ -78,6 +78,7 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 		ctx,
 		untilApplicationActive(ctx, client),
 		retry.NewOptionsBuilder().
+			Message("Waiting for cdFMC to be created...").
 			Retries(-1).
 			Timeout(30*time.Minute). // usually takes about 15-20 minutes
 			Delay(3*time.Second).

client/device/cloudfmc/fmcconfig/retry.go

@@ -49,6 +49,7 @@ func UntilCreateDeviceRecordSuccess(ctx context.Context, client http.Client, cre
 			ctx,
 			UntilTaskStatusSuccess(ctx, client, readInp),
 			retry.NewOptionsBuilder().
+				Message("Waiting for FMC device record to be created on CDO...").
 				Retries(-1).
 				Logger(client.Logger).
 				Timeout(30*time.Minute). // usually takes ~5 minutes

client/device/cloudftd/cloudftdonboarding/create.go

@@ -126,6 +126,7 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 		ctx,
 		fmcconfig.UntilCreateDeviceRecordSuccess(ctx, client, createDeviceInp, &createOutp),
 		retry.NewOptionsBuilder().
+			Message("Waiting for FTD device record to be created on cdFMC...").
 			Retries(-1).
 			Delay(3*time.Second).
 			Timeout(1*time.Hour). // it can take 15-20 minutes for FTD to come up + 10 minutes to create device record
@@ -166,6 +167,7 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 				Build(),
 		),
 		retry.NewOptionsBuilder().
+			Message("Waiting for FTD to be onboarded to CDO...").
 			Retries(-1).
 			Delay(1*time.Second).
 			Timeout(20*time.Minute). // usually done in less than 5 minutes because we already registered in FTDc

client/device/cloudftd/create.go

@@ -154,7 +154,18 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 
 	// 8. wait for generate command available
 	var metadata Metadata
-	err = retry.Do(ctx, UntilGeneratedCommandAvailable(ctx, client, createOup.Uid, &metadata), *retry.NewOptionsWithLoggerAndRetries(client.Logger, 3))
+	err = retry.Do(
+		ctx,
+		UntilGeneratedCommandAvailable(ctx, client, createOup.Uid, &metadata),
+		retry.NewOptionsBuilder().
+			Message("Waiting for FTD record to be created in CDO...").
+			Retries(3).
+			Timeout(retry.DefaultTimeout).
+			Delay(retry.DefaultDelay).
+			Logger(client.Logger).
+			EarlyExitOnError(true).
+			Build(),
+	)
 	if err != nil {
 		return nil, err
 	}

client/device/cloudftd/delete.go

@@ -51,7 +51,18 @@ func Delete(ctx context.Context, client http.Client, deleteInp DeleteInput) (*De
 	}
 
 	// 4. wait until the delete cloud FTD state machine has started
-	err = retry.Do(ctx, statemachine.UntilStarted(ctx, client, fmcReadSpecificRes.SpecificUid, "fmceDeleteFtdcStateMachine"), retry.DefaultOpts)
+	err = retry.Do(
+		ctx,
+		statemachine.UntilStarted(ctx, client, fmcReadSpecificRes.SpecificUid, "fmceDeleteFtdcStateMachine"),
+		retry.NewOptionsBuilder().
+			Message("Waiting for FTD deletion to begin...").
+			Retries(retry.DefaultRetries).
+			Delay(retry.DefaultDelay).
+			Logger(client.Logger).
+			EarlyExitOnError(true).
+			Timeout(retry.DefaultTimeout).
+			Build(),
+	)
 	if err != nil {
 		return nil, err
 	}

client/device/ios/create.go

@@ -121,7 +121,18 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 		publicKey = &connectorReadRes.PublicKey
 	}
 
-	err = retry.Do(ctx, iosconfig.UntilState(ctx, client, deviceCreateOutp.Uid, state.PRE_READ_METADATA), *retry.NewOptionsWithLogger(client.Logger))
+	err = retry.Do(
+		ctx,
+		iosconfig.UntilState(ctx, client, deviceCreateOutp.Uid, state.PRE_READ_METADATA),
+		retry.NewOptionsBuilder().
+			Message("Waiting for IOS device to be onboarded to CDO...").
+			Retries(retry.DefaultRetries).
+			Delay(retry.DefaultDelay).
+			Logger(client.Logger).
+			EarlyExitOnError(true).
+			Timeout(retry.DefaultTimeout).
+			Build(),
+	)
 	if err != nil {
 		return nil, &CreateError{
 			Err:               err,
@@ -149,7 +160,18 @@ func Create(ctx context.Context, client http.Client, createInp CreateInput) (*Cr
 	// poll until ios config state done
 	client.Logger.Println("waiting for device to reach state done")
 
-	err = retry.Do(ctx, iosconfig.UntilState(ctx, client, deviceCreateOutp.Uid, state.DONE), *retry.NewOptionsWithLogger(client.Logger))
+	err = retry.Do(
+		ctx,
+		iosconfig.UntilState(ctx, client, deviceCreateOutp.Uid, state.DONE),
+		retry.NewOptionsBuilder().
+			Message("Waiting for IOS device to be onboarded to CDO...").
+			Retries(retry.DefaultRetries).
+			Delay(retry.DefaultDelay).
+			Logger(client.Logger).
+			EarlyExitOnError(true).
+			Timeout(retry.DefaultTimeout).
+			Build(),
+	)
 	if err != nil {
 		return nil, &CreateError{
 			Err:               err,

client/device/ios/iosconfig/read.go

@@ -2,6 +2,7 @@ package iosconfig
 
 import (
 	"context"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/model/statemachine"
 
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/http"
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/url"
@@ -12,8 +13,9 @@ type ReadInput struct {
 }
 
 type ReadOutput struct {
-	Uid   string `json:"uid"`
-	State string `json:"state"`
+	Uid                 string               `json:"uid"`
+	State               string               `json:"state"`
+	StateMachineDetails statemachine.Details `json:"stateMachineDetails"`
 }
 
 func NewReadInput(specificUid string) *ReadInput {

client/device/ios/iosconfig/retry.go

@@ -2,7 +2,7 @@ package iosconfig
 
 import (
 	"context"
-	"fmt"
+	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/statemachine"
 	"strings"
 
 	"github.com/CiscoDevnet/terraform-provider-cdo/go-client/internal/http"
@@ -30,10 +30,10 @@ func UntilState(ctx context.Context, client http.Client, specificUid string, exp
 			return true, nil
 		}
 		if strings.EqualFold(readOutp.State, state.ERROR) {
-			return false, fmt.Errorf("workflow ended in ERROR") // TODO: add workflow error message
+			return false, statemachine.NewWorkflowErrorFromDetails(readOutp.StateMachineDetails)
 		}
 		if strings.EqualFold(readOutp.State, state.BAD_CREDENTIALS) {
-			return false, fmt.Errorf("bad credentials")
+			return false, statemachine.NewWorkflowErrorf("Bad Credentials")
 		}
 		return false, nil
 	}