Added the default ignore config for service disable error (#476)

Co-authored-by: Patrick Decat <[email protected]>

config/gcp.spc

@@ -31,6 +31,9 @@ connection "gcp" {
   # If neither is specified, billing and quota are tracked against the project associated with the credentials used for authentication.
   # quota_project = "YOUR_QUOTA_PROJECT_ID"
 
+  # `ignore_error_messages` (optional) - List of additional GCP error message pattern to ignore for all queries.
+  #  ignore_error_messages = ["^.*API has not been used.*$"]
+
   # `ignore_error_codes` (optional) - List of additional GCP error codes to ignore for all queries.
   # By default, common not found error codes are ignored and will still be ignored even if this argument is not set.
   # Refer https://cloud.google.com/resource-manager/docs/core_errors#Global_Errors for more information on GCP error codes

docs/index.md

@@ -92,13 +92,16 @@ connection "gcp" {
   # If not set, no impersonation is done.
   #impersonate_service_account = "YOUR_SERVICE_ACCOUNT"
 
-   # `quota_project` (optional) - The project ID used for billing and quota. When set,
+  # `quota_project` (optional) - The project ID used for billing and quota. When set,
   # this project ID is used to track quota usage and billing for the operations performed with the GCP connection.
   # If `quota_project` is not specified directly, the system will look for the `GOOGLE_CLOUD_QUOTA_PROJECT`
   # environment variable to determine which project to use for billing and quota.
   # If neither is specified, billing and quota are tracked against the project associated with the credentials used for authentication.
   # quota_project = "YOUR_QUOTA_PROJECT_ID"
 
+  # `ignore_error_messages` (optional) - List of additional GCP error message patterns to ignore for all queries.
+  #ignore_error_messages = ["^.*API has not been used.*$"]
+
   # `ignore_error_codes` (optional) - List of additional GCP error codes to ignore for all queries.
   # By default, the common not found error codes are ignored and will still be ignored even if this argument is not set.
   # Refer https://cloud.google.com/resource-manager/docs/core_errors#Global_Errors for more information on GCP error codes

gcp/connection_config.go

@@ -9,8 +9,9 @@ type gcpConfig struct {
 	Credentials               *string  `hcl:"credentials"`
 	ImpersonateAccessToken    *string  `hcl:"impersonate_access_token"`
 	ImpersonateServiceAccount *string  `hcl:"impersonate_service_account"`
+  	QuotaProject              *string  `hcl:"quota_project,optional"`
+	IgnoreErrorMessages       []string `hcl:"ignore_error_messages,optional"`
 	IgnoreErrorCodes          []string `hcl:"ignore_error_codes,optional"`
-	QuotaProject              *string  `hcl:"quota_project,optional"`
 }
 
 func ConfigInstance() interface{} {
@@ -25,3 +26,5 @@ func GetConfig(connection *plugin.Connection) gcpConfig {
 	config, _ := connection.Config.(gcpConfig)
 	return config
 }
+
+

gcp/ignore_error_predicate.go

@@ -3,6 +3,7 @@ package gcp
 import (
 	"context"
 	"path"
+	"regexp"
 
 	"github.com/turbot/go-kit/helpers"
 	"github.com/turbot/go-kit/types"
@@ -20,27 +21,36 @@ func isIgnorableError(notFoundErrors []string) plugin.ErrorPredicate {
 	}
 }
 
-// shouldIgnoreErrorPluginDefault:: Plugin level default function to ignore a set errors for hydrate functions based on "ignore_error_codes" config argument
+// shouldIgnoreErrorPluginDefault:: Plugin level default function to ignore a set errors for hydrate functions based on "ignore_error_codes" and "ignore_error_messages" config argument
 func shouldIgnoreErrorPluginDefault() plugin.ErrorPredicateWithContext {
 	return func(ctx context.Context, d *plugin.QueryData, h *plugin.HydrateData, err error) bool {
-		if !hasIgnoredErrorCodes(d.Connection) {
-			return false
+		gcpConfig := GetConfig(d.Connection)
+
+		logger := plugin.Logger(ctx)
+
+		// Add to support regex match as per error message
+		for _, pattern := range gcpConfig.IgnoreErrorMessages {
+			// Validate regex pattern
+			re, er := regexp.Compile(pattern)
+			if er != nil {
+				panic(er.Error() + " the regex pattern configured in 'ignore_error_messages' is invalid. Edit your connection configuration file and then restart Steampipe")
+			}
+			result := re.MatchString(err.Error())
+			if result {
+				logger.Debug("ignore_error_predicate.shouldIgnoreErrorPluginDefault", "ignore_error_message", err.Error())
+				return true
+			}
 		}
 
-		gcpConfig := GetConfig(d.Connection)
 		if gerr, ok := err.(*googleapi.Error); ok {
 			// Added to support regex in not found errors
 			for _, pattern := range gcpConfig.IgnoreErrorCodes {
 				if ok, _ := path.Match(pattern, types.ToString(gerr.Code)); ok {
+					logger.Debug("ignore_error_predicate.shouldIgnoreErrorPluginDefault", "ignore_error_code", err.Error())
 					return true
 				}
 			}
 		}
 		return false
 	}
 }
-
-func hasIgnoredErrorCodes(connection *plugin.Connection) bool {
-	gcpConfig := GetConfig(connection)
-	return len(gcpConfig.IgnoreErrorCodes) > 0
-}