fix(cis): update error toolchain changes for cis (IBM-Cloud#6300)

Author: sridhargk

ibm/service/cis/data_source_ibm_cis.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"net/url"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -125,7 +124,7 @@ func dataSourceIBMCISInstanceRead(d *schema.ResourceData, meta interface{}) erro
 
 		serviceOff, err := rsCatRepo.FindByName(service.(string), true)
 		if err != nil {
-			return fmt.Errorf("[ERROR] Error retrieving service offering: %s", err)
+			return flex.FmtErrorf("[ERROR] Error retrieving service offering: %s", err)
 		}
 
 		rsInstQuery.ServiceID = serviceOff[0].ID
@@ -152,13 +151,13 @@ func dataSourceIBMCISInstanceRead(d *schema.ResourceData, meta interface{}) erro
 	}
 
 	if len(filteredInstances) == 0 {
-		return fmt.Errorf("[ERROR] No resource instance found with name [%s]\nIf not specified please specify more filters like resource_group_id if instance doesn't exists in default group, location or service", name)
+		return flex.FmtErrorf("[ERROR] No resource instance found with name [%s]\nIf not specified please specify more filters like resource_group_id if instance doesn't exists in default group, location or service", name)
 	}
 
 	var instance models.ServiceInstanceV2
 
 	if len(filteredInstances) > 1 {
-		return fmt.Errorf("[ERROR] More than one resource instance found with name matching [%s]\nIf not specified please specify more filters like resource_group_id if instance doesn't exists in default group, location or service", name)
+		return flex.FmtErrorf("[ERROR] More than one resource instance found with name matching [%s]\nIf not specified please specify more filters like resource_group_id if instance doesn't exists in default group, location or service", name)
 	}
 	instance = filteredInstances[0]
 
@@ -169,14 +168,14 @@ func dataSourceIBMCISInstanceRead(d *schema.ResourceData, meta interface{}) erro
 	d.Set("guid", instance.Guid)
 	serviceOff, err := rsCatRepo.GetServiceName(instance.ServiceID)
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error retrieving service offering: %s", err)
+		return flex.FmtErrorf("[ERROR] Error retrieving service offering: %s", err)
 	}
 
 	d.Set("service", serviceOff)
 
 	servicePlan, err := rsCatRepo.GetServicePlanName(instance.ResourcePlanID)
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error retrieving plan: %s", err)
+		return flex.FmtErrorf("[ERROR] Error retrieving plan: %s", err)
 	}
 	d.Set("plan", servicePlan)
 

ibm/service/cis/data_source_ibm_cis_alert_webhooks.go

@@ -4,10 +4,10 @@
 package cis
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
+	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex"
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate"
 	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -80,15 +80,15 @@ func DataSourceIBMCISAlertWebhooksValidator() *validate.ResourceValidator {
 func dataIBMCISWebhookRead(d *schema.ResourceData, meta interface{}) error {
 	sess, err := meta.(conns.ClientSession).CisWebhookSession()
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error while getting the cisWebhookession %s", err)
+		return flex.FmtErrorf("[ERROR] Error while getting the cisWebhookession %s", err)
 	}
 	crn := d.Get(cisID).(string)
 	sess.Crn = core.StringPtr(crn)
 	opt := sess.NewListWebhooksOptions()
 
 	result, resp, err := sess.ListWebhooks(opt)
 	if err != nil || result == nil {
-		return fmt.Errorf("[ERROR] Error Listing all Webhooks %q: %s %s", d.Id(), err, resp)
+		return flex.FmtErrorf("[ERROR] Error Listing all Webhooks %q: %s %s", d.Id(), err, resp)
 	}
 
 	webhooks := make([]map[string]interface{}, 0)

ibm/service/cis/data_source_ibm_cis_alerts.go

@@ -5,11 +5,11 @@ package cis
 
 import (
 	"encoding/json"
-	"fmt"
 	"log"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
+	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex"
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate"
 	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/IBM/networking-go-sdk/alertsv1"
@@ -146,12 +146,12 @@ func dataIBMCISAlertPolicyRead(d *schema.ResourceData, meta interface{}) error {
 		alertOutput[cisAlertType] = *alertObj.AlertType
 		filterOpt, err := json.Marshal(alertObj.Filters)
 		if err != nil {
-			return fmt.Errorf("[ERROR] Error marshalling the created filters: %s", err)
+			return flex.FmtErrorf("[ERROR] Error marshalling the created filters: %s", err)
 		}
 		alertOutput[cisAlertFilters] = string(filterOpt)
 		conditionsOpt, err := json.Marshal(alertObj.Conditions)
 		if err != nil {
-			return fmt.Errorf("[ERROR] Error marshalling the created Conditions: %s", err)
+			return flex.FmtErrorf("[ERROR] Error marshalling the created Conditions: %s", err)
 		}
 		alertOutput[cisAlertConditions] = string(conditionsOpt)
 		alertOutput[cisAlertMechanisms] = dataflattenCISMechanism(*alertObj.Mechanisms)

ibm/service/cis/data_source_ibm_cis_custom_certificates.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
@@ -133,7 +132,7 @@ func dataSourceIBMCISCustomCertificatesRead(d *schema.ResourceData, meta interfa
 	opt := cisClient.NewListCustomCertificatesOptions()
 	result, resp, err := cisClient.ListCustomCertificates(opt)
 	if err != nil {
-		return fmt.Errorf("[ERROR] Failed to list custom certificates: %v", resp)
+		return flex.FmtErrorf("[ERROR] Failed to list custom certificates: %v", resp)
 	}
 	certsList := make([]map[string]interface{}, 0)
 	for _, r := range result.Result {

ibm/service/cis/data_source_ibm_cis_domain.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"log"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
@@ -131,7 +130,7 @@ func dataSourceIBMCISDomainRead(d *schema.ResourceData, meta interface{}) error
 	}
 
 	if !zoneFound {
-		return fmt.Errorf("[ERROR] Given zone does not exist. Please specify correct domain")
+		return flex.FmtErrorf("[ERROR] Given zone does not exist. Please specify correct domain")
 	}
 
 	return nil

ibm/service/cis/data_source_ibm_cis_edge_functions_actions.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
@@ -139,7 +138,7 @@ func dataSourceIBMCISEdgeFunctionsActionsRead(d *schema.ResourceData, meta inter
 	opt := cisClient.NewListEdgeFunctionsActionsOptions()
 	result, _, err := cisClient.ListEdgeFunctionsActions(opt)
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error: %v", err)
+		return flex.FmtErrorf("[ERROR] Error: %v", err)
 	}
 	scriptInfo := make([]map[string]interface{}, 0)
 	for _, script := range result.Result {

ibm/service/cis/data_source_ibm_cis_edge_functions_triggers.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
@@ -104,7 +103,7 @@ func dataSourceIBMCISEdgeFunctionsTriggerRead(d *schema.ResourceData, meta inter
 	opt := cisClient.NewListEdgeFunctionsTriggersOptions()
 	result, _, err := cisClient.ListEdgeFunctionsTriggers(opt)
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error listing edge functions triggers: %v", err)
+		return flex.FmtErrorf("[ERROR] Error listing edge functions triggers: %v", err)
 	}
 	triggerInfo := make([]map[string]interface{}, 0)
 	for _, trigger := range result.Result {

ibm/service/cis/data_source_ibm_cis_filters.go

@@ -4,7 +4,6 @@
 package cis
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
@@ -87,20 +86,20 @@ func dataIBMCISFiltersRead(d *schema.ResourceData, meta interface{}) error {
 
 	sess, err := meta.(conns.ClientSession).BluemixSession()
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error while Getting IAM Access Token using BluemixSession %s", err)
+		return flex.FmtErrorf("[ERROR] Error while Getting IAM Access Token using BluemixSession %s", err)
 	}
 	xAuthtoken := sess.Config.IAMAccessToken
 
 	cisClient, err := meta.(conns.ClientSession).CisFiltersSession()
 	if err != nil {
-		return fmt.Errorf("[ERROR] Error while getting the CisFiltersSession %s", err)
+		return flex.FmtErrorf("[ERROR] Error while getting the CisFiltersSession %s", err)
 	}
 	crn := d.Get(cisID).(string)
 	zoneID, _, _ := flex.ConvertTftoCisTwoVar(d.Get(cisDomainID).(string))
 
 	result, resp, err := cisClient.ListAllFilters(cisClient.NewListAllFiltersOptions(xAuthtoken, crn, zoneID))
 	if err != nil || result == nil {
-		return fmt.Errorf("[ERROR] Error Listing all filters %q: %s %s", d.Id(), err, resp)
+		return flex.FmtErrorf("[ERROR] Error Listing all filters %q: %s %s", d.Id(), err, resp)
 	}
 
 	filtersList := make([]map[string]interface{}, 0)

ibm/service/cis/data_source_ibm_cis_firewall_rule.go

@@ -91,20 +91,29 @@ func DataSourceIBMCISFirewallRulesValidator() *validate.ResourceValidator {
 func dataSourceIBMCISFirewallRulesRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	sess, err := meta.(conns.ClientSession).BluemixSession()
 	if err != nil {
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err,
+			fmt.Sprintf("dataSourceIBMCISFirewallRulesRead BluemixSession initialization failed: %s", err.Error()),
+			"ibm_cis_firewall_rule", "read")
+		return tfErr.GetDiag()
 	}
 	xAuthtoken := sess.Config.IAMAccessToken
 
 	cisClient, err := meta.(conns.ClientSession).CisFirewallRulesSession()
 	if err != nil {
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err,
+			fmt.Sprintf("dataSourceIBMCISFirewallRulesRead CisFirewallRulesSession initialization failed: %s", err.Error()),
+			"ibm_cis_firewall_rule", "read")
+		return tfErr.GetDiag()
 	}
 	crn := d.Get(cisID).(string)
 	zoneID, _, _ := flex.ConvertTftoCisTwoVar(d.Get(cisDomainID).(string))
 
 	result, resp, err := cisClient.ListAllFirewallRules(cisClient.NewListAllFirewallRulesOptions(xAuthtoken, crn, zoneID))
 	if err != nil || result == nil {
-		return diag.FromErr(fmt.Errorf("[ERROR] Error listing the  firewall rules %s:%s", err, resp))
+		tfErr := flex.TerraformErrorf(err,
+			fmt.Sprintf("dataSourceIBMCISFirewallRulesRead ListAllFirewallRules failed with error: %s and response:\n%s", err, resp),
+			"ibm_cis_firewall_rule", "read")
+		return tfErr.GetDiag()
 	}
 
 	fwrList := make([]map[string]interface{}, 0)

ibm/service/cis/data_source_ibm_cis_mtls.go

@@ -118,7 +118,10 @@ func dataIBMCISMtlsRead(context context.Context, d *schema.ResourceData, meta in
 	sess, err := meta.(conns.ClientSession).CisMtlsSession()
 
 	if err != nil {
-		return diag.FromErr(fmt.Errorf("[ERROR] Error while getting the CisMtlsSession() %s %v", err, sess))
+		tfErr := flex.TerraformErrorf(err,
+			fmt.Sprintf("dataIBMCISMtlsRead CisMtlsSession initialization failed: %s", err.Error()),
+			"ibm_cis_mtls", "read")
+		return tfErr.GetDiag()
 	}
 
 	zoneID, crn, _ := flex.ConvertTftoCisTwoVar(d.Id())
@@ -128,8 +131,11 @@ func dataIBMCISMtlsRead(context context.Context, d *schema.ResourceData, meta in
 
 	result, resp, err := sess.ListAccessCertificates(opt)
 	if err != nil {
-		log.Printf("[WARN] List all certificates failed: %v\n", resp)
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err,
+			fmt.Sprintf("dataIBMCISMtlsRead ListAccessCertificates failed: %s", err.Error()),
+			"ibm_cis_mtls", "read")
+		log.Printf("[WARN] List all certificates failed: %v\n%s\n", resp, tfErr.GetDebugMessage())
+		return tfErr.GetDiag()
 	}
 	mtlsCertLists := make([]map[string]interface{}, 0)
 	for _, certObj := range result.Result {