Merge pull request #389 from SumoLogic/ayiu_SUMO-194738_fgp_api_not_enabled

SUMO-194738: changing terraform code to deal with HTTP 404 + "api_not_enabled" error code

Author: ayiusumo

CHANGELOG.md

@@ -1,4 +1,6 @@
-## 2.17.0 (Unreleased)
+## 2.16.2 (Unreleased)
+BUG FIXES:
+* Monitor Folder provider now handles more error codes: "api_not_enabled", in addition to: "not_implemented_yet" (GH-389) 
 
 ## 2.16.1 (June 6, 2022)
 

sumologic/resource_sumologic_monitors_library_folder.go

@@ -159,13 +159,14 @@ func resourceSumologicMonitorsLibraryFolderRead(d *schema.ResourceData, meta int
 		return nil
 	}
 
-	fgpResponse, fgpErr := c.GetCmfFgp(fgpTargetType, folder.ID)
-	if fgpErr != nil {
+	fgpResponse, fgpGetErr := c.GetCmfFgp(fgpTargetType, folder.ID)
+	if fgpGetErr != nil {
 		// if FGP endpoint is not enabled (not implemented), we should suppress this error
-		if !HasErrorCode(fgpErr.Error(), "not_implemented_yet") {
-			return fgpErr
+		suppressedErrorCode := HasErrorCode(fgpGetErr.Error(), []string{"not_implemented_yet", "api_not_enabled"})
+		if suppressedErrorCode == "" {
+			return fgpGetErr
 		} else {
-			log.Printf("[WARN] FGP Feature has not been enabled yet. Suppressing \"not_implemented_yet\" error under GetCmfFgp operation.")
+			log.Printf("[WARN] FGP Feature has not been enabled yet. Suppressing \"%s\" error under GetCmfFgp operation.", suppressedErrorCode)
 		}
 	} else {
 		CmfFgpPermStmtsSetToResource(d, fgpResponse.PermissionStatements)
@@ -203,15 +204,16 @@ func resourceSumologicMonitorsLibraryFolderUpdate(d *schema.ResourceData, meta i
 		return convErr
 	}
 
-	// reading FGP from Backend to reconcille
+	// reading FGP from Backend to reconcile
 	fgpGetResponse, fgpGetErr := c.GetCmfFgp(fgpTargetType, monitorFolder.ID)
 	if fgpGetErr != nil {
 		// if FGP endpoint is not enabled (not implemented) and FGP feature is not used,
 		// we should suppress this error
-		if !HasErrorCode(fgpGetErr.Error(), "not_implemented_yet") && len(permStmts) == 0 {
+		suppressedErrorCode := HasErrorCode(fgpGetErr.Error(), []string{"not_implemented_yet", "api_not_enabled"})
+		if suppressedErrorCode == "" && len(permStmts) == 0 {
 			return fgpGetErr
 		} else {
-			log.Printf("[WARN] FGP Feature has not been enabled yet. Suppressing \"not_implemented_yet\" error under GetCmfFgp operation.")
+			log.Printf("[WARN] FGP Feature has not been enabled yet. Suppressing \"%s\" error under GetCmfFgp operation.", suppressedErrorCode)
 		}
 	}
 

sumologic/sumologic_client.go

@@ -235,6 +235,10 @@ func (s *Client) Put(urlPath string, payload interface{}) ([]byte, error) {
 }
 
 func (s *Client) Get(urlPath string) ([]byte, string, error) {
+	return s.GetWithErrOpt(urlPath, false)
+}
+
+func (s *Client) GetWithErrOpt(urlPath string, return404Err bool) ([]byte, string, error) {
 	relativeURL, _ := url.Parse(urlPath)
 	sumoURL := s.BaseURL.ResolveReference(relativeURL)
 
@@ -260,7 +264,11 @@ func (s *Client) Get(urlPath string) ([]byte, string, error) {
 	}
 
 	if resp.StatusCode == 404 {
-		return nil, "", nil
+		if return404Err {
+			return nil, "", errors.New(string(d))
+		} else {
+			return nil, "", nil
+		}
 	} else if resp.StatusCode >= 400 {
 		return nil, "", errors.New(string(d))
 	}
@@ -341,19 +349,21 @@ func NewClient(accessID, accessKey, authJwt, environment, base_url string, admin
 	return &client, nil
 }
 
-func HasErrorCode(errorJsonStr string, errorCode string) bool {
+func HasErrorCode(errorJsonStr string, errorCodeChoices []string) string {
 	var apiError ApiError
 	jsonErr := json.Unmarshal([]byte(errorJsonStr), &apiError)
 	if jsonErr != nil {
 		// when fail to unmarshal JSON, we should consider the errorCode is not found
-		return false
+		return ""
 	}
 	for i := range apiError.Errors {
-		if apiError.Errors[i].Code == errorCode {
-			return true
+		for j := range errorCodeChoices {
+			if apiError.Errors[i].Code == errorCodeChoices[j] {
+				return errorCodeChoices[j]
+			}
 		}
 	}
-	return false
+	return ""
 }
 
 type Error struct {
@@ -362,7 +372,9 @@ type Error struct {
 	Detail  string `json:"detail"`
 }
 
-// e.g. {"id":"8UQOI-82VTR-YBQ8G","errors":[{"code":"not_implemented_yet","message":"Not implemented yet"}]}
+// e.g.:
+// {"id":"8UQOI-82VTR-YBQ8G","errors":[{"code":"not_implemented_yet","message":"Not implemented yet"}]}
+// {"id":"RO4X1-BZW7P-Q8KJF","errors":[{"code":"api_not_enabled","message":"This API is not enabled for your organization."}]}
 type ApiError struct {
 	Id     string  `json:"id"`
 	Errors []Error `json:"errors"`

sumologic/sumologic_cmffgp.go

@@ -10,7 +10,7 @@ func (s *Client) GetCmfFgp(targetType string, targetId string) (*CmfFgpResponse,
 
 	// e.g. "v1/monitors/0000000000000003/permissions"
 	url := fmt.Sprintf("v1/%s/%s/permissions", targetType, targetId)
-	data, _, err := s.Get(url)
+	data, _, err := s.GetWithErrOpt(url, true)
 	if err != nil {
 		return nil, err
 	}