refac: update return statements with pkg/errors

Signed-off-by: vg006 <devvg006@gmail.com>

Author: vg006

cmd/harbor/root/artifact/list.go

@@ -14,10 +14,9 @@
 package artifact
 
 import (
-	"fmt"
-
 	"github.com/goharbor/go-client/pkg/sdk/v2.0/client/artifact"
 	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/errors"
 	"github.com/goharbor/harbor-cli/pkg/prompt"
 	"github.com/goharbor/harbor-cli/pkg/utils"
 	artifactViews "github.com/goharbor/harbor-cli/pkg/views/artifact/list"
@@ -44,11 +43,11 @@ Supports pagination, search queries, and sorting using flags.`,
 		Args: cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if opts.PageSize < 0 {
-				return fmt.Errorf("page size must be greater than or equal to 0")
+				return errors.New("Invalid page size", "page size must be greater than or equal to 0")
 			}
 
 			if opts.PageSize > 100 {
-				return fmt.Errorf("page size should be less than or equal to 100")
+				return errors.New("Invalid page size", "page size must be less than or equal to 100")
 			}
 			var err error
 			var artifacts artifact.ListArtifactsOK
@@ -57,26 +56,25 @@ Supports pagination, search queries, and sorting using flags.`,
 			if len(args) > 0 {
 				projectName, repoName, err = utils.ParseProjectRepo(args[0])
 				if err != nil {
-					return fmt.Errorf("failed to parse project/repo: %v", err)
+					return errors.New("Invalid project/repository format", "expected format: <project>/<repository>")
 				}
 			} else {
 				projectName, err = prompt.GetProjectNameFromUser()
 				if err != nil {
-					return fmt.Errorf("failed to get project name: %v", utils.ParseHarborErrorMsg(err))
+					return errors.AsError(err).WithMessage("failed to get project name")
 				}
 				repoName = prompt.GetRepoNameFromUser(projectName)
 			}
 
 			artifacts, err = api.ListArtifact(projectName, repoName, opts)
 
 			if err != nil {
-				return fmt.Errorf("failed to list artifacts: %v", err)
+				return errors.AsError(err).WithMessage("failed to list artifacts")
 			}
 
 			FormatFlag := viper.GetString("output-format")
 			if FormatFlag != "" {
-				err = utils.PrintFormat(artifacts, FormatFlag)
-				if err != nil {
+				if err = utils.PrintFormat(artifacts, FormatFlag); err != nil {
 					return err
 				}
 			} else {

pkg/prompt/prompt.go

@@ -14,7 +14,6 @@
 package prompt
 
 import (
-	"errors"
 	"fmt"
 	"strconv"
 
@@ -24,6 +23,7 @@ import (
 	"github.com/goharbor/go-client/pkg/sdk/v2.0/models"
 	"github.com/goharbor/harbor-cli/pkg/api"
 	"github.com/goharbor/harbor-cli/pkg/constants"
+	"github.com/goharbor/harbor-cli/pkg/errors"
 	aview "github.com/goharbor/harbor-cli/pkg/views/artifact/select"
 	tview "github.com/goharbor/harbor-cli/pkg/views/artifact/tags/select"
 	immview "github.com/goharbor/harbor-cli/pkg/views/immutable/select"
@@ -102,7 +102,7 @@ func GetProjectNameFromUser() (string, error) {
 	go func() {
 		response, err := api.ListAllProjects()
 		if err != nil {
-			resultChan <- result{"", err}
+			resultChan <- result{"", errors.NewWithCause(err, "failed to list projects")}
 			return
 		}
 
@@ -116,7 +116,7 @@ func GetProjectNameFromUser() (string, error) {
 			if err == pview.ErrUserAborted {
 				resultChan <- result{"", errors.New("user aborted project selection")}
 			} else {
-				resultChan <- result{"", fmt.Errorf("error during project selection: %w", err)}
+				resultChan <- result{"", errors.NewWithCause(err, "error during project selection")}
 			}
 			return
 		}

pkg/utils/client.go

@@ -15,11 +15,11 @@ package utils
 
 import (
 	"context"
-	"fmt"
 	"sync"
 
 	"github.com/goharbor/go-client/pkg/harbor"
 	v2client "github.com/goharbor/go-client/pkg/sdk/v2.0/client"
+	"github.com/goharbor/harbor-cli/pkg/errors"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -33,12 +33,12 @@ func GetClient() (*v2client.HarborAPI, error) {
 	ClientOnce.Do(func() {
 		config, err := GetCurrentHarborConfig()
 		if err != nil {
-			ClientErr = fmt.Errorf("failed to get current credential name: %v", err)
+			ClientErr = errors.AsError(err).WithMessage("failed to get current credential name")
 			return
 		}
 		credentialName := config.CurrentCredentialName
 		if credentialName == "" {
-			ClientErr = fmt.Errorf("no Harbor credentials found. Please run `harbor login` to configure access")
+			ClientErr = errors.New("no Harbor credentials found.", "Please run `harbor login` to configure access")
 			return
 		}
 
@@ -73,19 +73,19 @@ func GetClientByConfig(clientConfig *harbor.ClientSetConfig) *v2client.HarborAPI
 func GetClientByCredentialName(credentialName string) (*v2client.HarborAPI, error) {
 	credential, err := GetCredentials(credentialName)
 	if err != nil {
-		return nil, fmt.Errorf("failed to get credential %s: %w", credentialName, err)
+		return nil, errors.AsError(err).WithMessage("failed to get credential", "credential: "+credentialName)
 	}
 
 	// Get encryption key
 	key, err := GetEncryptionKey()
 	if err != nil {
-		return nil, fmt.Errorf("failed to get encryption key: %w", err)
+		return nil, errors.NewWithCause(err, "failed to get encryption key")
 	}
 
 	// Decrypt password
 	decryptedPassword, err := Decrypt(key, string(credential.Password))
 	if err != nil {
-		return nil, fmt.Errorf("failed to decrypt password: %w", err)
+		return nil, errors.NewWithCause(err, "failed to decrypt password")
 	}
 
 	clientConfig := &harbor.ClientSetConfig{

pkg/utils/config.go

@@ -14,13 +14,13 @@
 package utils
 
 import (
-	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
 	"sync"
 
 	"github.com/goharbor/go-client/pkg/sdk/v2.0/models"
+	"github.com/goharbor/harbor-cli/pkg/errors"
 	log "github.com/sirupsen/logrus"
 
 	"github.com/spf13/viper"
@@ -75,7 +75,7 @@ func InitConfig(cfgFile string, userSpecifiedConfig bool) {
 
 		// Ensure data directory exists
 		if err := os.MkdirAll(harborDataDir, os.ModePerm); err != nil {
-			configInitError = fmt.Errorf("failed to create data directory: %w", err)
+			configInitError = errors.NewWithCause(err, "failed to create data directory")
 			log.Fatalf("%v", configInitError)
 		}
 
@@ -100,7 +100,7 @@ func InitConfig(cfgFile string, userSpecifiedConfig bool) {
 
 		var harborConfig HarborConfig
 		if err := viper.Unmarshal(&harborConfig); err != nil {
-			configInitError = fmt.Errorf("failed to unmarshal config file: %w", err)
+			configInitError = errors.NewWithCause(err, "failed to unmarshal config file")
 			log.Fatalf("%v", configInitError)
 		}
 
@@ -135,7 +135,7 @@ func DetermineConfigPath(cfgFile string, userSpecifiedConfig bool) (string, erro
 	if userSpecifiedConfig && cfgFile != "" {
 		harborConfigPath, err = filepath.Abs(cfgFile)
 		if err != nil {
-			return "", fmt.Errorf("failed to resolve absolute path for config file: %w", err)
+			return "", errors.NewWithCause(err, "failed to resolve absolute path for config file")
 		}
 		return harborConfigPath, nil
 	}
@@ -144,7 +144,7 @@ func DetermineConfigPath(cfgFile string, userSpecifiedConfig bool) (string, erro
 	if harborEnvVar != "" {
 		harborConfigPath, err = filepath.Abs(harborEnvVar)
 		if err != nil {
-			return "", fmt.Errorf("failed to resolve absolute path for config file from HARBOR_CLI_CONFIG: %w", err)
+			return "", errors.NewWithCause(err, "failed to resolve absolute path for config file from HARBOR_CLI_CONFIG")
 		}
 		return harborConfigPath, nil
 	}
@@ -154,13 +154,13 @@ func DetermineConfigPath(cfgFile string, userSpecifiedConfig bool) (string, erro
 	if xdgConfigHome == "" {
 		home, err := os.UserHomeDir()
 		if err != nil {
-			return "", fmt.Errorf("unable to determine user home directory: %w", err)
+			return "", errors.NewWithCause(err, "unable to determine user home directory")
 		}
 		xdgConfigHome = filepath.Join(home, ".config")
 	}
 	harborConfigPath, err = filepath.Abs(filepath.Join(xdgConfigHome, "harbor-cli", "config.yaml"))
 	if err != nil {
-		return "", fmt.Errorf("failed to resolve absolute path for default config file: %w", err)
+		return "", errors.NewWithCause(err, "failed to resolve absolute path for default config file")
 	}
 	return harborConfigPath, nil
 }
@@ -170,22 +170,22 @@ func EnsureConfigFileExists(harborConfigPath string) error {
 	// Ensure parent directory exists
 	configDir := filepath.Dir(harborConfigPath)
 	if err := os.MkdirAll(configDir, os.ModePerm); err != nil {
-		return fmt.Errorf("failed to create config directory: %w", err)
+		return errors.NewWithCause(err, "failed to create config directory")
 	}
 
 	if fileInfo, err := os.Stat(harborConfigPath); err != nil {
 		// No need to throw error if config file does not exist
 		if !os.IsNotExist(err) {
-			return fmt.Errorf("error while checking config file: %w", err)
+			return errors.NewWithCause(err, "error while checking config file")
 		}
 	} else if fileInfo.IsDir() {
-		return fmt.Errorf("expected a file but found a directory at path: %s", harborConfigPath)
+		return errors.Newf("expected a file but found a directory at path: %s", harborConfigPath)
 	}
 
 	// Create config file if it doesn't exist
 	if _, err := os.Stat(harborConfigPath); os.IsNotExist(err) {
 		if err := CreateConfigFile(harborConfigPath); err != nil {
-			return fmt.Errorf("failed to create config file: %w", err)
+			return errors.NewWithCause(err, "failed to create config file")
 		}
 	}
 	return nil
@@ -196,7 +196,7 @@ func ReadConfig(harborConfigPath string) error {
 	viper.SetConfigFile(harborConfigPath)
 	viper.SetConfigType("yaml")
 	if err := viper.ReadInConfig(); err != nil {
-		return fmt.Errorf("error reading config file: %w. Please ensure the config file exists", err)
+		return errors.NewWithCause(err, "error reading config file", "Please ensure the config file exists")
 	}
 	return nil
 }
@@ -207,7 +207,7 @@ func GetCurrentHarborConfig() (*HarborConfig, error) {
 	})
 
 	if configInitError != nil {
-		return nil, fmt.Errorf("initialization error: %w", configInitError)
+		return nil, errors.NewWithCause(configInitError, "initialization error")
 	}
 
 	configMutex.RLock()
@@ -267,7 +267,7 @@ func GetCurrentHarborData() (*HarborData, error) {
 	})
 
 	if configInitError != nil {
-		return nil, fmt.Errorf("initialization error: %w", configInitError)
+		return nil, errors.NewWithCause(configInitError, "initialization error")
 	}
 
 	configMutex.RLock()
@@ -320,7 +320,7 @@ func ReadDataFile(dataFilePath string) (HarborData, error) {
 	v.SetConfigFile(dataFilePath)
 
 	if err := v.ReadInConfig(); err != nil {
-		return dataFile, fmt.Errorf("failed to read data file: %v", err)
+		return dataFile, errors.NewWithCause(err, "failed to read data file")
 	}
 
 	dataFile.ConfigPath = v.GetString("configPath")
@@ -334,19 +334,19 @@ func ApplyDataFile(harborDataPath, harborConfigPath string) error {
 	if err == nil {
 		if dataFileContent.ConfigPath != harborConfigPath {
 			if err := UpdateDataFile(harborDataPath, harborConfigPath); err != nil {
-				return fmt.Errorf("failed to update data file: %w", err)
+				return errors.NewWithCause(err, "failed to update data file")
 			}
 		} else if dataFileContent.ConfigPath == "" {
 			if err := CreateDataFile(harborDataPath, harborConfigPath); err != nil {
-				return fmt.Errorf("failed to create data file: %w", err)
+				return errors.NewWithCause(err, "failed to create data file")
 			}
 		} else {
 			log.Debugf("Data file already exists with the same config path: %s", harborConfigPath)
 		}
 	} else {
 		// Data file does not exist, create it
 		if err := CreateDataFile(harborDataPath, harborConfigPath); err != nil {
-			return fmt.Errorf("failed to create data file: %w", err)
+			return errors.NewWithCause(err, "failed to create data file")
 		}
 	}
 	return nil
@@ -459,7 +459,7 @@ func UpdateConfigFile(config *HarborConfig) error {
 func GetCredentials(credentialName string) (Credential, error) {
 	currentConfig, err := GetCurrentHarborConfig()
 	if err != nil {
-		return Credential{}, fmt.Errorf("failed to get current Harbor configuration: %w", err)
+		return Credential{}, errors.AsError(err).WithMessage("failed to get current Harbor configuration")
 	}
 
 	if currentConfig == nil || currentConfig.Credentials == nil {
@@ -472,7 +472,7 @@ func GetCredentials(credentialName string) (Credential, error) {
 		}
 	}
 
-	return Credential{}, fmt.Errorf("credential with name '%s' not found", credentialName)
+	return Credential{}, errors.Newf("credential with name '%s' not found", credentialName)
 }
 
 func AddCredentialsToConfigFile(credential Credential, configPath string) error {