error improvement for Compute Out of Capacity

Author: Maxrovr

internal/tfresource/errors.go

@@ -18,8 +18,8 @@ import (
 
 type errorTypeEnum string
 
-var serviceErrorCheck = func(err error) (failure oci_common.ServiceErrorRichInfo, ok bool) {
-	return oci_common.IsServiceErrorRichInfo(err)
+var serviceErrorCheck = func(err error) (failure oci_common.ServiceErrorLocalizationMessage, ok bool) {
+	return oci_common.IsServiceErrorLocalizationMessage(err)
 }
 
 const (
@@ -30,19 +30,22 @@ const (
 )
 
 type customError struct {
-	TypeOfError   errorTypeEnum
-	ErrorCode     int
-	ErrorCodeName string
-	Service       string
-	Message       string
-	OpcRequestID  string
-	ResourceOCID  string
-	OperationName string
-	RequestTarget string
-	Suggestion    string
-	VersionError  string
-	ResourceDocs  string
-	SdkApiDocs    string
+	TypeOfError             errorTypeEnum
+	ErrorCode               int
+	ErrorCodeName           string
+	Service                 string
+	Message                 string
+	OriginalMessage         string
+	OriginalMessageTemplate string
+	MessageArgument         map[string]string
+	OpcRequestID            string
+	ResourceOCID            string
+	OperationName           string
+	RequestTarget           string
+	Suggestion              string
+	VersionError            string
+	ResourceDocs            string
+	SdkApiDocs              string
 }
 
 // Create new error format for Terraform output
@@ -53,16 +56,19 @@ func newCustomError(sync interface{}, err error) error {
 	// Service error
 	if failure, isServiceError := serviceErrorCheck(err); isServiceError {
 		tfError = customError{
-			TypeOfError:   ServiceError,
-			ErrorCode:     failure.GetHTTPStatusCode(),
-			ErrorCodeName: failure.GetCode(),
-			Message:       failure.GetMessage(),
-			OpcRequestID:  failure.GetOpcRequestID(),
-			OperationName: failure.GetOperationName(),
-			RequestTarget: failure.GetRequestTarget(),
-			Service:       getServiceName(sync),
-			ResourceDocs:  getResourceDocsURL(sync),
-			SdkApiDocs:    failure.GetOperationReferenceLink(),
+			TypeOfError:             ServiceError,
+			ErrorCode:               failure.GetHTTPStatusCode(),
+			ErrorCodeName:           failure.GetCode(),
+			Message:                 failure.GetMessage(),
+			OriginalMessage:         failure.GetOriginalMessage(),
+			OriginalMessageTemplate: failure.GetOriginalMessageTemplate(),
+			MessageArgument:         failure.GetMessageArgument(),
+			OpcRequestID:            failure.GetOpcRequestID(),
+			OperationName:           failure.GetOperationName(),
+			RequestTarget:           failure.GetRequestTarget(),
+			Service:                 getServiceName(sync),
+			ResourceDocs:            getResourceDocsURL(sync),
+			SdkApiDocs:              failure.GetOperationReferenceLink(),
 		}
 	} else if strings.Contains(errorMessage, "timeout while waiting for state") {
 		// Timeout error
@@ -102,17 +108,28 @@ func newCustomError(sync interface{}, err error) error {
 func (tfE customError) Error() error {
 	switch tfE.TypeOfError {
 	case ServiceError:
-		return fmt.Errorf("%d-%s, %s \n"+
-			"Suggestion: %s\n"+
+		var serviceError string
+
+		shortErrorDescription := fmt.Sprintf("%d-%s, %s\n", tfE.ErrorCode, tfE.ErrorCodeName, tfE.Message)
+		detailedDescription := fmt.Sprintf("Suggestion: %s\n"+
 			"Documentation: %s \n"+
 			"API Reference: %s \n"+
 			"Request Target: %s \n"+
 			"%s \n"+
 			"Service: %s \n"+
 			"Operation Name: %s \n"+
 			"OPC request ID: %s \n",
-			tfE.ErrorCode, tfE.ErrorCodeName, tfE.Message, tfE.Suggestion, tfE.ResourceDocs, tfE.SdkApiDocs, tfE.RequestTarget,
+			tfE.Suggestion, tfE.ResourceDocs, tfE.SdkApiDocs, tfE.RequestTarget,
 			tfE.VersionError, tfE.Service, tfE.OperationName, tfE.OpcRequestID)
+		furtherInfo := fmt.Sprintf("Further Information: %s\n", tfE.OriginalMessage)
+
+		if tfE.OriginalMessage == "" {
+			serviceError = shortErrorDescription + detailedDescription
+		} else {
+			// For compute out of host capacity error support
+			serviceError = shortErrorDescription + furtherInfo + detailedDescription
+		}
+		return fmt.Errorf(serviceError)
 	case TimeoutError:
 		return fmt.Errorf("%s \n"+
 			"%s \n"+

internal/tfresource/errors_test.go

@@ -116,10 +116,13 @@ func (err *MockError) Error() string {
 }
 
 type MockServiceFailure struct {
-	StatusCode   int
-	Code         string
-	Message      string
-	OpcRequestID string
+	StatusCode              int
+	Code                    string
+	Message                 string
+	OriginalMessage         string            `json:"originalMessage"`
+	OriginalMessageTemplate string            `json:"originalMessageTemplate"`
+	MessageArgument         map[string]string `json:"messageArguments"`
+	OpcRequestID            string
 	// debugging information
 	TargetService string             `json:"target-service"`
 	OperationName string             `json:"operation-name"`
@@ -132,6 +135,18 @@ type MockServiceFailure struct {
 	ErrorTroubleshootingLink string `json:"error-troubleshooting-link"`
 }
 
+func (err *MockServiceFailure) GetOriginalMessage() string {
+	return err.OriginalMessage
+}
+
+func (err *MockServiceFailure) GetMessageArgument() map[string]string {
+	return err.MessageArgument
+}
+
+func (err *MockServiceFailure) GetOriginalMessageTemplate() string {
+	return err.OriginalMessageTemplate
+}
+
 func (err *MockServiceFailure) GetTargetService() string {
 	return err.TargetService
 }
@@ -214,7 +229,9 @@ func TestUnitHandleError(t *testing.T) {
 		Message:      "LimitExceeded",
 		OpcRequestID: "Not Applicable",
 	}
-	serviceErrorCheck = func(err error) (failure oci_common.ServiceErrorRichInfo, ok bool) { return mockServiceFailure, true }
+	serviceErrorCheck = func(err error) (failure oci_common.ServiceErrorLocalizationMessage, ok bool) {
+		return mockServiceFailure, true
+	}
 	response = HandleError(temp, mockServiceFailure)
 	assert.Contains(t, response.Error(), "Request a service limit increase for this resource")