Add reference link to error message

Author: jotruon

internal/globalvar/constants.go

@@ -73,3 +73,5 @@ const (
 	TfEnvPrefix    = "TF_VAR_"
 	OciEnvPrefix   = "OCI_"
 )
+
+const TerraformDocumentLink = "https://registry.terraform.io/providers/oracle/oci/latest/docs/"

internal/tfresource/errors.go

@@ -41,6 +41,7 @@ type customError struct {
 	RequestTarget string
 	Suggestion    string
 	VersionError  string
+	ResourceDocs  string
 }
 
 // Create new error format for Terraform output
@@ -59,6 +60,7 @@ func newCustomError(sync interface{}, err error) error {
 			OperationName: failure.GetOperationName(),
 			RequestTarget: failure.GetRequestTarget(),
 			Service:       getServiceName(sync),
+			ResourceDocs:  getResourceDocsURL(sync),
 		}
 	} else if strings.Contains(errorMessage, "timeout while waiting for state") {
 		// Timeout error
@@ -98,15 +100,16 @@ func newCustomError(sync interface{}, err error) error {
 func (tfE customError) Error() error {
 	switch tfE.TypeOfError {
 	case ServiceError:
-		return fmt.Errorf("%d-%s \n"+
+		return fmt.Errorf("%d-%s, %s \n"+
+			"Suggestion: %s\n"+
+			"Documentation: %s \n"+
+			"Request Target: %s \n"+
 			"%s \n"+
 			"Service: %s \n"+
 			"Operation Name: %s \n"+
-			"Request Target: %s \n"+
-			"Error Message: %s \n"+
-			"OPC request ID: %s \n"+
-			"Suggestion: %s\n",
-			tfE.ErrorCode, tfE.ErrorCodeName, tfE.VersionError, tfE.Service, tfE.OperationName, tfE.RequestTarget, tfE.Message, tfE.OpcRequestID, tfE.Suggestion)
+			"OPC request ID: %s \n",
+			tfE.ErrorCode, tfE.ErrorCodeName, tfE.Message, tfE.Suggestion, tfE.ResourceDocs, tfE.RequestTarget,
+			tfE.VersionError, tfE.Service, tfE.OperationName, tfE.OpcRequestID)
 	case TimeoutError:
 		return fmt.Errorf("%s \n"+
 			"%s \n"+
@@ -183,6 +186,42 @@ func getServiceName(sync interface{}) string {
 	return ""
 }
 
+// Return the Terraform document for the resource/datasource
+func getResourceDocsURL(sync interface{}) string {
+	baseURL := globalvar.TerraformDocumentLink
+	var result = baseURL
+	syncTypeName := reflect.TypeOf(sync).String()
+	if strings.Contains(syncTypeName, "ResourceCrud") {
+		result += "resources/"
+		resourceName := syncTypeName[strings.Index(syncTypeName, ".")+1 : strings.Index(syncTypeName, "ResourceCrud")]
+		result += toSnakeCase(resourceName)
+		return result
+	}
+	if strings.Contains(syncTypeName, "DataSourcesCrud") {
+		result += "data-sources/"
+		datasourceName := syncTypeName[strings.Index(syncTypeName, ".")+1 : strings.Index(syncTypeName, "DataSourcesCrud")]
+		result += toSnakeCase(datasourceName)
+		return result
+	}
+	if strings.Contains(syncTypeName, "DataSourceCrud") {
+		result += "data-sources/"
+		datasourceName := syncTypeName[strings.Index(syncTypeName, ".")+1 : strings.Index(syncTypeName, "DataSourceCrud")]
+		result += toSnakeCase(datasourceName)
+		return result
+	}
+	log.Printf("[DEBUG] Can't get the resource name for: %v", syncTypeName)
+	return ""
+}
+
+// CoreBootVolume -> core_boot_volume
+func toSnakeCase(name string) string {
+	var matchFirstCap = regexp.MustCompile("(.)([A-Z][a-z]+)")
+	var matchAllCap = regexp.MustCompile("([a-z0-9])([A-Z])")
+	snake := matchFirstCap.ReplaceAllString(name, "${1}_${2}")
+	snake = matchAllCap.ReplaceAllString(snake, "${1}_${2}")
+	return strings.ToLower(snake)
+}
+
 func removeDuplicate(name string) string {
 	re := regexp.MustCompile(`[A-Z][^A-Z]*`)
 	subMatchAll := re.FindAllString(name, -1)

internal/tfresource/errors_test.go

@@ -85,6 +85,19 @@ func TestUnitGetServiceName(t *testing.T) {
 	assert.EqualValues(t, expectedOutput, getServiceName(test))
 }
 
+func TestUnitGetResourceDocsURL(t *testing.T) {
+	expectedOutput := globalvar.TerraformDocumentLink
+	resourceCrud := TestResourceCrud{}
+	assert.EqualValues(t, expectedOutput+"resources/test", getResourceDocsURL(resourceCrud))
+	dataSourceCrud := TestDataSourceCrud{}
+	assert.EqualValues(t, expectedOutput+"data-sources/test", getResourceDocsURL(dataSourceCrud))
+	dataSourcesCrud := TestDataSourcesCrud{}
+	assert.EqualValues(t, expectedOutput+"data-sources/test", getResourceDocsURL(dataSourcesCrud))
+	test := Test{}
+	expectedOutput = ""
+	assert.EqualValues(t, expectedOutput, getResourceDocsURL(test))
+}
+
 func TestUnitGetResourceOCID(t *testing.T) {
 	temp := &MockStatefulResource{false}
 	assert.EqualValues(t, "dummyId", getResourceOCID(temp))

internal/tfresource/suggestions.go

@@ -38,7 +38,7 @@ func getSuggestionForServiceError(tfError customError) string {
 func getSuggestionFor400(tfError customError) string {
 	switch tfError.ErrorCodeName {
 	case "InvalidParameter":
-		return fmt.Sprintf("Please Update the parameter(s) in the Terraform config as per error message %s", tfError.Message)
+		return fmt.Sprintf("Please update the parameter(s) in the Terraform config as per error message %s", tfError.Message)
 	case "LimitExceeded":
 		return fmt.Sprintf("Request a service limit increase for this resource %s", tfError.Service)
 	case "QuotaExceeded":

internal/tfresource/suggestions_test.go

@@ -20,7 +20,7 @@ func TestUnit_getSuggestionFor400(t *testing.T) {
 					Message:       "testMessage",
 				},
 			},
-			want: "Please Update the parameter(s) in the Terraform config as per error message testMessage",
+			want: "Please update the parameter(s) in the Terraform config as per error message testMessage",
 		},
 		{
 			name: "Test returned value is as expected for LimitExceeded",
@@ -85,7 +85,7 @@ func TestUnit_getSuggestionForServiceError(t *testing.T) {
 					Message:       "testMessage",
 				},
 			},
-			want: "Please Update the parameter(s) in the Terraform config as per error message testMessage",
+			want: "Please update the parameter(s) in the Terraform config as per error message testMessage",
 		},
 		{
 			name: "Test returned value is as expected for 404 code",
@@ -168,7 +168,7 @@ func TestUnit_getSuggestionFromError(t *testing.T) {
 					Message:       "testMessage",
 				},
 			},
-			want: "Please Update the parameter(s) in the Terraform config as per error message testMessage",
+			want: "Please update the parameter(s) in the Terraform config as per error message testMessage",
 		},
 		{
 			name: "Test returned value is as expected for TimeoutError",