refactor: Changing error for enum

Signed-off-by: Vincent Boutour <bob@vibioh.fr>
ViBiOh · Apr 27, 2024 · e69a094 · e69a094
1 parent ac9d7af
commit e69a094
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 28 deletions.
diff --git a/pkg/ketchup/ketchups.go b/pkg/ketchup/ketchups.go
@@ -48,9 +48,10 @@ func (s Service) handleCreate(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	ketchupFrequency, err := model.ParseKetchupFrequency(r.FormValue("frequency"))
+	rawKetchupFrequency := r.FormValue("frequency")
+	ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 	if err != nil {
-		s.renderer.Error(w, r, nil, httpModel.WrapInvalid(err))
+		s.renderer.Error(w, r, nil, httpModel.WrapInvalid(fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)))
 		return
 	}
 
@@ -103,9 +104,10 @@ func (s Service) handleUpdate(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	ketchupFrequency, err := model.ParseKetchupFrequency(r.FormValue("frequency"))
+	rawKetchupFrequency := r.FormValue("frequency")
+	ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 	if err != nil {
-		s.renderer.Error(w, r, nil, httpModel.WrapInvalid(err))
+		s.renderer.Error(w, r, nil, httpModel.WrapInvalid(fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)))
 		return
 	}
 

diff --git a/pkg/model/ketchup.go b/pkg/model/ketchup.go
@@ -1,7 +1,7 @@
 package model
 
 import (
-	"fmt"
+	"errors"
 	"strings"
 
 	"github.com/ViBiOh/httputils/v4/pkg/hash"
@@ -16,20 +16,23 @@ const (
 	Weekly
 )
 
-var KetchupFrequencyValues = []string{"None", "Daily", "Weekly"}
+var (
+	ErrUnknownKetchupFrequency = errors.New("unknown ketchup frequency")
+	ketchupFrequencyValues     = []string{"None", "Daily", "Weekly"}
+)
 
 func ParseKetchupFrequency(value string) (KetchupFrequency, error) {
-	for i, short := range KetchupFrequencyValues {
+	for i, short := range ketchupFrequencyValues {
 		if strings.EqualFold(short, value) {
 			return KetchupFrequency(i), nil
 		}
 	}
 
-	return Daily, fmt.Errorf("invalid value `%s` for ketchup frequency", value)
+	return Daily, ErrUnknownKetchupFrequency
 }
 
 func (r KetchupFrequency) String() string {
-	return KetchupFrequencyValues[r]
+	return ketchupFrequencyValues[r]
 }
 
 type Ketchup struct {

diff --git a/pkg/model/ketchup_test.go b/pkg/model/ketchup_test.go
@@ -1,7 +1,6 @@
 package model
 
 import (
-	"errors"
 	"reflect"
 	"sort"
 	"strings"
@@ -41,7 +40,7 @@ func TestParseKetchupFrequency(t *testing.T) {
 				value: "wrong",
 			},
 			Daily,
-			errors.New("invalid value `wrong` for ketchup frequency"),
+			ErrUnknownKetchupFrequency,
 		},
 	}
 

diff --git a/pkg/model/repository.go b/pkg/model/repository.go
@@ -3,6 +3,7 @@ package model
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"strings"
 )
@@ -23,20 +24,23 @@ const (
 	Pypi
 )
 
-var RepositoryKindValues = []string{"github", "helm", "docker", "npm", "pypi"}
+var (
+	ErrUnknownRepositoryKind = errors.New("unknown repository kind")
+	repositoryKindValues     = []string{"github", "helm", "docker", "npm", "pypi"}
+)
 
 func ParseRepositoryKind(value string) (RepositoryKind, error) {
-	for i, short := range RepositoryKindValues {
+	for i, short := range repositoryKindValues {
 		if strings.EqualFold(short, value) {
 			return RepositoryKind(i), nil
 		}
 	}
 
-	return Github, fmt.Errorf("invalid value `%s` for repository kind", value)
+	return Github, ErrUnknownRepositoryKind
 }
 
 func (r RepositoryKind) String() string {
-	return RepositoryKindValues[r]
+	return repositoryKindValues[r]
 }
 
 func (r RepositoryKind) MarshalJSON() ([]byte, error) {

diff --git a/pkg/model/repository_test.go b/pkg/model/repository_test.go
@@ -1,7 +1,6 @@
 package model
 
 import (
-	"errors"
 	"strings"
 	"testing"
 )
@@ -143,7 +142,7 @@ func TestParseRepositoryKind(t *testing.T) {
 				value: "wrong",
 			},
 			Github,
-			errors.New("invalid value `wrong` for repository kind"),
+			ErrUnknownRepositoryKind,
 		},
 	}
 

diff --git a/pkg/store/ketchup/ketchup.go b/pkg/store/ketchup/ketchup.go
@@ -78,13 +78,13 @@ func (s Service) List(ctx context.Context, pageSize uint, last string) ([]model.
 
 		ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)
 		}
 		item.Frequency = ketchupFrequency
 
 		repositoryKind, err := model.ParseRepositoryKind(rawRepositoryKind)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse kind `%s`: %w", rawRepositoryKind, err)
 		}
 		item.Repository.Kind = repositoryKind
 
@@ -154,7 +154,7 @@ func (s Service) ListByRepositoriesIDAndFrequencies(ctx context.Context, ids []m
 
 		ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)
 		}
 		item.Frequency = ketchupFrequency
 
@@ -208,13 +208,13 @@ func (s Service) ListOutdated(ctx context.Context, userIds ...model.Identifier)
 
 		ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)
 		}
 		item.Frequency = ketchupFrequency
 
 		repositoryKind, err := model.ParseRepositoryKind(rawRepositoryKind)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse kind `%s`: %w", rawRepositoryKind, err)
 		}
 		item.Repository.Kind = repositoryKind
 
@@ -265,7 +265,7 @@ func (s Service) ListSilentForRepositories(ctx context.Context, ids []uint64) ([
 
 		ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)
 		}
 		item.Frequency = ketchupFrequency
 
@@ -320,13 +320,13 @@ func (s Service) GetByRepository(ctx context.Context, id model.Identifier, patte
 
 		ketchupFrequency, err := model.ParseKetchupFrequency(rawKetchupFrequency)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse frequency `%s`: %w", rawKetchupFrequency, err)
 		}
 		item.Frequency = ketchupFrequency
 
 		repositoryKind, err := model.ParseRepositoryKind(rawRepositoryKind)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse kind `%s`: %w", rawRepositoryKind, err)
 		}
 		item.Repository.Kind = repositoryKind
 

diff --git a/pkg/store/ketchup/ketchup_test.go b/pkg/store/ketchup/ketchup_test.go
@@ -72,7 +72,7 @@ func TestList(t *testing.T) {
 				pageSize: 20,
 			},
 			nil,
-			errors.New("invalid value `wrong` for repository kind"),
+			model.ErrUnknownRepositoryKind,
 		},
 	}
 

diff --git a/pkg/store/repository/repository.go b/pkg/store/repository/repository.go
@@ -38,7 +38,7 @@ func (s Service) list(ctx context.Context, query string, args ...any) ([]model.R
 
 		repositoryKind, err := model.ParseRepositoryKind(rawRepositoryKind)
 		if err != nil {
-			return err
+			return fmt.Errorf("parse kind `%s`: %w", rawRepositoryKind, err)
 		}
 		item.Kind = repositoryKind
 

diff --git a/pkg/store/repository/repository_test.go b/pkg/store/repository/repository_test.go
@@ -84,7 +84,7 @@ func TestList(t *testing.T) {
 			},
 			nil,
 			0,
-			errors.New("invalid value `wrong` for repository kind"),
+			model.ErrUnknownRepositoryKind,
 		},
 	}
-Original file line number
+Diff line change
@@ Expand Up / @@ -72,7 +72,7 @@ func TestList(t *testing.T) { @@
     				pageSize: 20,
     			},
     			nil,
-    			errors.New("invalid value `wrong` for repository kind"),
+    			model.ErrUnknownRepositoryKind,
     		},
     	}
@@ Expand Down @@