Added - Adding Json format to error message

Author: jotruon

internal/tfresource/errors.go

@@ -4,13 +4,17 @@
 package tfresource
 
 import (
+	"encoding/json"
 	"fmt"
 	"log"
 	"reflect"
 	"regexp"
+	"strconv"
 	"strings"
 	"time"
 
+	"github.com/oracle/terraform-provider-oci/internal/utils"
+
 	oci_common "github.com/oracle/oci-go-sdk/v65/common"
 
 	"github.com/oracle/terraform-provider-oci/internal/globalvar"
@@ -23,29 +27,31 @@ var serviceErrorCheck = func(err error) (failure oci_common.ServiceErrorLocaliza
 }
 
 const (
+	JsonErrorEnable                    = "PROVIDER_JSON_ERROR"
 	ServiceError         errorTypeEnum = "ServiceError"
 	TimeoutError         errorTypeEnum = "TimeoutError"
 	UnexpectedStateError errorTypeEnum = "UnexpectedStateError"
 	WorkRequestError     errorTypeEnum = "WorkRequestError"
 )
 
 type customError struct {
-	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
+	TypeOfError             errorTypeEnum     `json:"type_of_error"`
+	ErrorCode               int               `json:"error_code"`
+	ErrorCodeName           string            `json:"error_code_name"`
+	Service                 string            `json:"service"`
+	Message                 string            `json:"message"`
+	OriginalMessage         string            `json:"original_message"`
+	OriginalMessageTemplate string            `json:"original_message_template"`
+	MessageArgument         map[string]string `json:"message_argument"`
+	OpcRequestID            string            `json:"opc_request_id"`
+	ResourceOCID            string            `json:"resource_ocid"`
+	OperationName           string            `json:"operation_name"`
+	RequestTarget           string            `json:"request_target"`
+	Suggestion              string            `json:"suggestion"`
+	VersionError            string            `json:"version_error"`
+	ResourceDocs            string            `json:"resource_docs"`
+	SdkApiDocs              string            `json:"sdk_api_docs"`
+	JsonError               string            `json:"-"`
 }
 
 // Create new error format for Terraform output
@@ -102,10 +108,20 @@ func newCustomError(sync interface{}, err error) error {
 
 	tfError.VersionError = GetVersionAndDateError()
 	tfError.Suggestion = getSuggestionFromError(tfError)
+	tfError.JsonError = getJsonError(tfError)
+
 	return tfError.Error()
 }
-
+func getJsonError(tfError customError) string {
+	errByte, err := json.Marshal(tfError)
+	if err != nil {
+		log.Printf("[ERROR] Fail to marshal error: %v", err)
+		return ""
+	}
+	return string(errByte)
+}
 func (tfE customError) Error() error {
+	var finalError error
 	switch tfE.TypeOfError {
 	case ServiceError:
 		var serviceError string
@@ -129,33 +145,41 @@ func (tfE customError) Error() error {
 			// For compute out of host capacity error support
 			serviceError = shortErrorDescription + furtherInfo + detailedDescription
 		}
-		return fmt.Errorf(serviceError)
+		finalError = fmt.Errorf(serviceError)
 	case TimeoutError:
-		return fmt.Errorf("%s \n"+
+		finalError = fmt.Errorf("%s \n"+
 			"%s \n"+
 			"Service: %s \n"+
 			"Error Message: %s \n"+
 			"Suggestion: %s\n",
 			tfE.ErrorCodeName, tfE.VersionError, tfE.Service, tfE.Message, tfE.Suggestion)
 	case UnexpectedStateError:
-		return fmt.Errorf("%s \n"+
+		finalError = fmt.Errorf("%s \n"+
 			"%s \n"+
 			"Service: %s \n"+
 			"Error Message: %s \n"+
 			"Resource OCID: %s \n"+
 			"Suggestion: %s\n",
 			tfE.ErrorCodeName, tfE.VersionError, tfE.Service, tfE.Message, tfE.ResourceOCID, tfE.Suggestion)
 	case WorkRequestError:
-		return fmt.Errorf("%s \n"+
+		finalError = fmt.Errorf("%s \n"+
 			"%s \n"+
 			"Service: %s \n"+
 			"Error Message: %s \n"+
 			"Resource OCID: %s \n"+
 			"Suggestion: %s\n",
 			tfE.ErrorCodeName, tfE.VersionError, tfE.Service, tfE.Message, tfE.ResourceOCID, tfE.Suggestion)
 	default:
-		return fmt.Errorf(tfE.Message)
+		finalError = fmt.Errorf(tfE.Message)
+	}
+	if isJsonErrorEnable, _ := strconv.ParseBool(utils.GetEnvSettingWithDefault(JsonErrorEnable, "false")); isJsonErrorEnable {
+		finalError = fmt.Errorf("%s \n"+
+			"JSON Error: %s \n",
+			finalError, tfE.JsonError)
 	}
+
+	return finalError
+
 }
 
 func handleMissingResourceError(sync ResourceVoider, err *error) {

internal/tfresource/errors_test.go

@@ -236,3 +236,16 @@ func TestUnitHandleError(t *testing.T) {
 	assert.Contains(t, response.Error(), "Request a service limit increase for this resource")
 
 }
+
+func TestUnitGetJsonError(t *testing.T) {
+	var jsonError customError
+	jsonError.ErrorCodeName = "NOT FOUND"
+	jsonError.ErrorCode = 404
+	jsonError.Message = "Not found error"
+
+	wantError := getJsonError(jsonError)
+	assert.Contains(t, wantError, "NOT FOUND")
+	assert.Contains(t, wantError, "404")
+	assert.Contains(t, wantError, "Not found error")
+
+}