chore: cleanup ErrorMessage

flanksource · Apr 29, 2024 · 2380288 · 2380288
1 parent 3dbd73a
commit 2380288
Show file tree

Hide file tree

Showing 22 changed files with 63 additions and 80 deletions.
diff --git a/checks/alertmanager.go b/checks/alertmanager.go
@@ -67,7 +67,7 @@ func (c *AlertManagerChecker) Check(ctx *context.Context, extConfig external.Che
 		Filter:  filters,
 	})
 	if err != nil {
-		results.ErrorMessage(fmt.Errorf("Error fetching from alertmanager: %v", err))
+		results.Errorf("error fetching from alertmanager: %v", err)
 		return results
 	}
 

diff --git a/checks/aws_config.go b/checks/aws_config.go
@@ -46,7 +46,7 @@ func (c *AwsConfigChecker) Check(ctx *context.Context, extConfig external.Check)
 
 	cfg, err := awsUtil.NewSession(ctx.Context, *check.AWSConnection)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	client := configservice.NewFromConfig(*cfg)
@@ -56,15 +56,15 @@ func (c *AwsConfigChecker) Check(ctx *context.Context, extConfig external.Check)
 			Expression:                  &check.Query,
 		})
 		if err != nil {
-			return results.ErrorMessage(err)
+			return results.Error(err)
 		}
 		result.AddDetails(output.Results)
 	} else {
 		output, err := client.SelectResourceConfig(ctx, &configservice.SelectResourceConfigInput{
 			Expression: &check.Query,
 		})
 		if err != nil {
-			return results.ErrorMessage(err)
+			return results.Error(err)
 		}
 		result.AddDetails(output.Results)
 	}

diff --git a/checks/azure_devops.go b/checks/azure_devops.go
@@ -51,12 +51,12 @@ func (t *AzureDevopsChecker) check(ctx *context.Context, check v1.AzureDevopsChe
 	connection := azuredevops.NewPatConnection(fmt.Sprintf("https://dev.azure.com/%s", check.Organization), c.Password)
 	coreClient, err := core.NewClient(ctx, connection)
 	if err != nil {
-		return results.ErrorMessage(fmt.Errorf("failed to create core client: %w", err))
+		return results.Errorf("failed to create core client: %w", err)
 	}
 
 	project, err := coreClient.GetProject(ctx, core.GetProjectArgs{ProjectId: &check.Project})
 	if err != nil {
-		return results.ErrorMessage(fmt.Errorf("failed to get project (name=%s): %w", check.Project, err))
+		return results.Errorf("failed to get project (name=%s): %w", check.Project, err)
 	}
 	projectID := project.Id.String()
 
@@ -68,7 +68,7 @@ func (t *AzureDevopsChecker) check(ctx *context.Context, check v1.AzureDevopsChe
 	pipelineClient := pipelines.NewClient(ctx, connection)
 	allPipelines, err := pipelineClient.ListPipelines(ctx, pipelines.ListPipelinesArgs{Project: &projectID})
 	if err != nil {
-		return results.ErrorMessage(fmt.Errorf("failed to get pipeline (project=%s): %w", check.Project, err))
+		return results.Errorf("failed to get pipeline (project=%s): %w", check.Project, err)
 	}
 
 	for _, pipeline := range *allPipelines {
@@ -89,7 +89,7 @@ func (t *AzureDevopsChecker) check(ctx *context.Context, check v1.AzureDevopsChe
 		// https://learn.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/list?view=azure-devops-rest-7.1
 		runs, err := pipelineClient.ListRuns(ctx, pipelines.ListRunsArgs{PipelineId: pipeline.Id, Project: &projectID})
 		if err != nil {
-			return results.ErrorMessage(fmt.Errorf("failed to get runs (pipeline=%s): %w", check.Pipeline, err))
+			return results.Errorf("failed to get runs (pipeline=%s): %w", check.Pipeline, err)
 		}
 
 		latestRun := getLatestCompletedRun(*runs)
@@ -105,7 +105,7 @@ func (t *AzureDevopsChecker) check(ctx *context.Context, check v1.AzureDevopsChe
 		// because the ListRuns API doesn't return Resources.
 		latestRun, err = pipelineClient.GetRun(ctx, pipelines.GetRunArgs{Project: &projectID, PipelineId: pipeline.Id, RunId: (*runs)[0].Id})
 		if err != nil {
-			return results.ErrorMessage(fmt.Errorf("failed to get run (pipeline=%s): %w", check.Pipeline, err))
+			return results.Errorf("failed to get run (pipeline=%s): %w", check.Pipeline, err)
 		}
 
 		if !matchBranchNames(check.Branches, latestRun.Resources) {

diff --git a/checks/cloudwatch.go b/checks/cloudwatch.go
@@ -44,7 +44,7 @@ func (c *CloudWatchChecker) Check(ctx *context.Context, extConfig external.Check
 
 	cfg, err := awsUtil.NewSession(ctx.Context, check.AWSConnection)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	client := cloudwatch.NewFromConfig(*cfg)
 	maxRecords := int32(100)
@@ -56,10 +56,10 @@ func (c *CloudWatchChecker) Check(ctx *context.Context, extConfig external.Check
 		MaxRecords:      &maxRecords,
 	})
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	if o, err := unstructure(alarms); err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	} else {
 		result.AddDetails(o)
 	}

diff --git a/checks/database_backup.go b/checks/database_backup.go
@@ -1,7 +1,6 @@
 package checks
 
 import (
-	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
 
 	"github.com/flanksource/canary-checker/api/context"
@@ -60,5 +59,5 @@ func FailDatabaseBackupParse(ctx *context.Context, check v1.DatabaseBackupCheck)
 	result := pkg.Fail(check, ctx.Canary)
 	var results pkg.Results
 	results = append(results, result)
-	return results.ErrorMessage(errors.New("Could not parse databaseBackup input"))
+	return results.Errorf("Could not parse databaseBackup input")
 }
diff --git a/checks/database_backup_gcp.go b/checks/database_backup_gcp.go
@@ -1,7 +1,6 @@
 package checks
 
 import (
-	"errors"
 	"fmt"
 	"strings"
 	"time"
@@ -36,15 +35,15 @@ func GCPDatabaseBackupCheck(ctx *context.Context, check v1.DatabaseBackupCheck)
 	svc, err := gcp.NewSQLAdmin(ctx.Context, check.GCP.GCPConnection)
 	if err != nil {
 		databaseScanFailCount.WithLabelValues(check.GCP.Project, check.GCP.Instance).Inc()
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	// Only checking one backup for now, but setting up the logic that this could maybe be configurable.
 	// Would need some extra parsing on the age to select latest
 	backupList, err := svc.BackupRuns.List(check.GCP.Project, check.GCP.Instance).MaxResults(1).Do()
 	if err != nil {
 		databaseScanFailCount.WithLabelValues(check.GCP.Project, check.GCP.Instance).Inc()
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	var errorMessages []string
 	for _, backup := range backupList.Items {
@@ -103,7 +102,7 @@ func GCPDatabaseBackupCheck(ctx *context.Context, check v1.DatabaseBackupCheck)
 	}
 	if len(errorMessages) > 0 {
 		databaseScanFailCount.WithLabelValues(check.GCP.Project, check.GCP.Instance).Inc()
-		return results.ErrorMessage(errors.New(strings.Join(errorMessages, ", ")))
+		return results.Errorf(strings.Join(errorMessages, ", "))
 	}
 
 	backupRaw, err := backupList.Items[0].MarshalJSON()

diff --git a/checks/elasticsearch.go b/checks/elasticsearch.go
@@ -2,7 +2,6 @@ package checks
 
 import (
 	"encoding/json"
-	"fmt"
 	"strings"
 
 	"github.com/flanksource/canary-checker/api/context"
@@ -47,7 +46,7 @@ func (c *ElasticsearchChecker) Check(ctx *context.Context, extConfig external.Ch
 
 	es, err := elasticsearch.NewClient(cfg)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	body := strings.NewReader(check.Query)
@@ -58,21 +57,19 @@ func (c *ElasticsearchChecker) Check(ctx *context.Context, extConfig external.Ch
 	)
 
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	if res.IsError() {
 		var e map[string]any
 		if err := json.NewDecoder(res.Body).Decode(&e); err != nil {
-			return results.ErrorMessage(
-				fmt.Errorf("Error parsing the response body: %s", err),
-			)
+			return results.Errorf("error parsing the response body: %s", err)
 		} else {
-			return results.ErrorMessage(fmt.Errorf("Error from elasticsearch [%s]: %v, %v",
+			return results.Errorf("error from elasticsearch [%s]: %v, %v",
 				res.Status(),
 				e["error"].(map[string]any)["type"],
 				e["error"].(map[string]any)["reason"],
-			))
+			)
 		}
 	}
 
@@ -81,9 +78,7 @@ func (c *ElasticsearchChecker) Check(ctx *context.Context, extConfig external.Ch
 	defer res.Body.Close()
 	var r map[string]any
 	if err := json.NewDecoder(res.Body).Decode(&r); err != nil {
-		return results.ErrorMessage(
-			fmt.Errorf("Error parsing the response body: %s", err),
-		)
+		return results.Errorf("Error parsing the response body: %s", err)
 	}
 
 	count := int(r["hits"].(map[string]any)["total"].(map[string]any)["value"].(float64))

diff --git a/checks/exec.go b/checks/exec.go
@@ -122,7 +122,7 @@ func (c *ExecChecker) Check(ctx *context.Context, extConfig external.Check) pkg.
 
 	env, err := c.prepareEnvironment(ctx, check)
 	if err != nil {
-		return results.Invalidf(err.Error())
+		return results.Error(err)
 	}
 
 	switch runtime.GOOS {
@@ -175,7 +175,7 @@ func execBash(ctx *context.Context, check v1.ExecCheck, envParams *execEnv) pkg.
 	}
 
 	if err := setupConnection(ctx, check, cmd); err != nil {
-		return results.Invalidf("failed to setup connection: %v", err)
+		return results.Errorf("failed to setup connection: %v", err)
 	}
 
 	return checkCmd(ctx, check, cmd, result)

diff --git a/checks/folder.go b/checks/folder.go
@@ -95,14 +95,14 @@ func checkLocalFolder(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	// Form a dummy connection to get a local filesystem
 	localFS, err := artifacts.GetFSForConnection(ctx.Context, models.Connection{Type: models.ConnectionTypeFolder})
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	folders, err := genericFolderCheck(localFS, check.Path, check.Recursive, check.Filter)
 	result.AddDetails(folders)
 
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	if test := folders.Test(check.FolderTest); test != "" {

diff --git a/checks/folder_gcs.go b/checks/folder_gcs.go
@@ -1,7 +1,6 @@
 package checks
 
 import (
-	"errors"
 	"strings"
 
 	gcs "cloud.google.com/go/storage"
@@ -23,7 +22,7 @@ func CheckGCSBucket(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	results = append(results, result)
 
 	if check.GCSConnection == nil {
-		return results.ErrorMessage(errors.New("missing GCS connection"))
+		return results.Errorf("missing GCS connection")
 	}
 
 	var bucket string
@@ -46,12 +45,12 @@ func CheckGCSBucket(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 
 	fs, err := artifacts.GetFSForConnection(ctx.Context, *connection)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	folders, err := genericFolderCheckWithoutPrecheck(fs, check.Path, check.Recursive, check.Filter)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	result.AddDetails(folders)
 

diff --git a/checks/folder_s3.go b/checks/folder_s3.go
@@ -3,7 +3,6 @@
 package checks
 
 import (
-	"errors"
 	"strings"
 
 	"github.com/aws/aws-sdk-go-v2/service/s3"
@@ -25,7 +24,7 @@ func CheckS3Bucket(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	results = append(results, result)
 
 	if check.S3Connection == nil {
-		return results.ErrorMessage(errors.New("missing AWS connection"))
+		return results.Errorf("missing AWS connection")
 	}
 
 	var bucket string
@@ -48,12 +47,12 @@ func CheckS3Bucket(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 
 	fs, err := artifacts.GetFSForConnection(ctx.Context, *connection)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	folders, err := genericFolderCheckWithoutPrecheck(fs, check.Path, check.Recursive, check.Filter)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	result.AddDetails(folders)
 

diff --git a/checks/folder_sftp.go b/checks/folder_sftp.go
@@ -25,20 +25,20 @@ func CheckSFTP(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	if !foundConn {
 		auth, err = ctx.GetAuthValues(check.SFTPConnection.Authentication)
 		if err != nil {
-			return results.ErrorMessage(err)
+			return results.Error(err)
 		}
 	}
 
 	client, err := sftp.SSHConnect(fmt.Sprintf("%s:%d", check.SFTPConnection.Host, check.SFTPConnection.GetPort()), auth.GetUsername(), auth.GetPassword())
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	defer client.Close()
 
 	session := artifacts.Filesystem(client)
 	folders, err := genericFolderCheck(session, check.Path, check.Recursive, check.Filter)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	result.AddDetails(folders)
 

diff --git a/checks/folder_smb.go b/checks/folder_smb.go
@@ -18,7 +18,7 @@ func CheckSmb(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	var serverPath = strings.TrimPrefix(check.Path, "smb://")
 	server, sharename, path, err := extractServerDetails(serverPath)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	foundConn, err := check.SMBConnection.HydrateConnection(ctx)
@@ -30,21 +30,21 @@ func CheckSmb(ctx *context.Context, check v1.FolderCheck) pkg.Results {
 	if !foundConn {
 		auth, err = ctx.GetAuthValues(check.SMBConnection.Authentication)
 		if err != nil {
-			return results.ErrorMessage(err)
+			return results.Error(err)
 		}
 	}
 
 	session, err := smb.SMBConnect(server, fmt.Sprintf("%d", check.SMBConnection.GetPort()), sharename, auth)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	if session != nil {
 		defer session.Close()
 	}
 
 	folders, err := genericFolderCheck(session, path, check.Recursive, check.Filter)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	var totalBlockCount, freeBlockCount, blockSize int // TODO:

diff --git a/checks/http.go b/checks/http.go
@@ -174,20 +174,20 @@ func (c *HTTPChecker) Check(ctx *context.Context, check v1.HTTPCheck) pkg.Result
 
 	request, err := c.generateHTTPRequest(ctx, check, connection)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	if body != "" {
 		if err := request.Body(body); err != nil {
-			return results.ErrorMessage(err)
+			return results.Error(err)
 		}
 	}
 
 	start := time.Now()
 
 	response, err := request.Do(check.GetMethod(), connection.URL)
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 
 	elapsed := time.Since(start)
@@ -219,7 +219,7 @@ func (c *HTTPChecker) Check(ctx *context.Context, check v1.HTTPCheck) pkg.Result
 
 	responseBody, err := response.AsString()
 	if err != nil {
-		return results.ErrorMessage(err)
+		return results.Error(err)
 	}
 	data["content"] = responseBody