wider coverage of error stack (#358)

jschwinger233 · web-flow · commit 5399d075bc7f · 2021-03-17T16:25:06.000+08:00
diff --git a/lock/etcdlock/mutex.go b/lock/etcdlock/mutex.go
@@ -6,6 +6,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/pkg/errors"
 	"github.com/projecteru2/core/types"
 	"go.etcd.io/etcd/v3/clientv3"
 	"go.etcd.io/etcd/v3/clientv3/concurrency"
@@ -37,13 +38,13 @@ func (c *lockContext) Err() error {
 	if c.err != nil {
 		return c.err
 	}
-	return c.Context.Err()
+	return errors.WithStack(c.Context.Err())
 }
 
 // New new a lock
 func New(cli *clientv3.Client, key string, ttl time.Duration) (*Mutex, error) {
 	if key == "" {
-		return nil, types.ErrKeyIsEmpty
+		return nil, errors.WithStack(types.ErrKeyIsEmpty)
 	}
 
 	if !strings.HasPrefix(key, "/") {
diff --git a/types/node.go b/types/node.go
@@ -5,6 +5,7 @@ import (
 
 	"math"
 
+	"github.com/pkg/errors"
 	engine "github.com/projecteru2/core/engine"
 	enginetypes "github.com/projecteru2/core/engine/types"
 )
@@ -66,9 +67,10 @@ func (n *Node) Init() {
 // Info show node info
 func (n *Node) Info(ctx context.Context) (*enginetypes.Info, error) {
 	if n.Engine == nil {
-		return nil, ErrNilEngine
+		return nil, errors.WithStack(ErrNilEngine)
 	}
-	return n.Engine.Info(ctx)
+	info, err := n.Engine.Info(ctx)
+	return info, errors.WithStack(err)
 }
 
 // SetCPUUsed set cpuusage
diff --git a/types/resource.go b/types/resource.go
@@ -3,6 +3,8 @@ package types
 import (
 	"encoding/json"
 	"sort"
+
+	"github.com/pkg/errors"
 )
 
 // ResourceOptions for create/realloc/replace
@@ -163,12 +165,12 @@ func (p *VolumePlan) UnmarshalJSON(b []byte) (err error) {
 	}
 	plan := map[string]VolumeMap{}
 	if err = json.Unmarshal(b, &plan); err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 	for volume, vmap := range plan {
 		vb, err := NewVolumeBinding(volume)
 		if err != nil {
-			return err
+			return errors.WithStack(err)
 		}
 		(*p)[*vb] = vmap
 	}
@@ -181,7 +183,8 @@ func (p VolumePlan) MarshalJSON() ([]byte, error) {
 	for vb, vmap := range p {
 		plan[vb.ToString(false)] = vmap
 	}
-	return json.Marshal(plan)
+	bs, err := json.Marshal(plan)
+	return bs, errors.WithStack(err)
 }
 
 // ToLiteral returns literal VolumePlan
diff --git a/types/stream.go b/types/stream.go
@@ -5,6 +5,8 @@ import (
 	"io"
 	"io/ioutil"
 	"sync"
+
+	"github.com/pkg/errors"
 )
 
 // ReaderManager return Reader under concurrency
@@ -17,7 +19,7 @@ func NewReaderManager(r io.Reader) (ReaderManager, error) {
 	bs, err := ioutil.ReadAll(r)
 	return &readerManager{
 		r: bytes.NewReader(bs),
-	}, err
+	}, errors.WithStack(err)
 }
 
 type readerManager struct {
@@ -30,8 +32,8 @@ func (rm *readerManager) GetReader() (_ io.Reader, err error) {
 	defer rm.mux.Unlock()
 	buf := &bytes.Buffer{}
 	if _, err = io.Copy(buf, rm.r); err != nil {
-		return
+		return nil, errors.WithStack(err)
 	}
 	_, err = rm.r.Seek(0, io.SeekStart)
-	return buf, err
+	return buf, errors.WithStack(err)
 }
diff --git a/types/volume.go b/types/volume.go
@@ -35,10 +35,10 @@ func NewVolumeBinding(volume string) (_ *VolumeBinding, err error) {
 	case 4:
 		src, dst, flags = parts[0], parts[1], parts[2]
 		if size, err = strconv.ParseInt(parts[3], 10, 64); err != nil {
-			return nil, err
+			return nil, errors.WithStack(err)
 		}
 	default:
-		return nil, fmt.Errorf("invalid volume: %v", volume)
+		return nil, errors.WithStack(fmt.Errorf("invalid volume: %v", volume))
 	}
 
 	flagParts := strings.Split(flags, "")
@@ -56,10 +56,10 @@ func NewVolumeBinding(volume string) (_ *VolumeBinding, err error) {
 // Validate return error if invalid
 func (vb VolumeBinding) Validate() error {
 	if vb.Destination == "" {
-		return errors.Errorf("invalid volume, dest must be provided: %v", vb)
+		return errors.WithStack(errors.Errorf("invalid volume, dest must be provided: %v", vb))
 	}
 	if vb.RequireScheduleMonopoly() && vb.RequireScheduleUnlimitedQuota() {
-		return errors.Errorf("invalid volume, monopoly volume must not be limited: %v", vb)
+		return errors.WithStack(errors.Errorf("invalid volume, monopoly volume must not be limited: %v", vb))
 	}
 	return nil
 }
@@ -131,7 +131,7 @@ func (vbs VolumeBindings) ToStringSlice(sorted, normalize bool) (volumes []strin
 func (vbs *VolumeBindings) UnmarshalJSON(b []byte) (err error) {
 	volumes := []string{}
 	if err = json.Unmarshal(b, &volumes); err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 	*vbs, err = NewVolumeBindings(volumes)
 	return
@@ -143,7 +143,8 @@ func (vbs VolumeBindings) MarshalJSON() ([]byte, error) {
 	for _, vb := range vbs {
 		volumes = append(volumes, vb.ToString(false))
 	}
-	return json.Marshal(volumes)
+	bs, err := json.Marshal(volumes)
+	return bs, errors.WithStack(err)
 }
 
 // ApplyPlan creates new VolumeBindings according to volume plan
diff --git a/types/workload.go b/types/workload.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"time"
 
+	"github.com/pkg/errors"
 	engine "github.com/projecteru2/core/engine"
 	enginetypes "github.com/projecteru2/core/engine/types"
 )
@@ -47,37 +48,38 @@ type Workload struct {
 // Inspect a workload
 func (c *Workload) Inspect(ctx context.Context) (*enginetypes.VirtualizationInfo, error) {
 	if c.Engine == nil {
-		return nil, ErrNilEngine
+		return nil, errors.WithStack(ErrNilEngine)
 	}
-	return c.Engine.VirtualizationInspect(ctx, c.ID)
+	info, err := c.Engine.VirtualizationInspect(ctx, c.ID)
+	return info, errors.WithStack(err)
 }
 
 // Start a workload
 func (c *Workload) Start(ctx context.Context) error {
 	if c.Engine == nil {
-		return ErrNilEngine
+		return errors.WithStack(ErrNilEngine)
 	}
-	return c.Engine.VirtualizationStart(ctx, c.ID)
+	return errors.WithStack(c.Engine.VirtualizationStart(ctx, c.ID))
 }
 
 // Stop a workload
 func (c *Workload) Stop(ctx context.Context, force bool) error {
 	if c.Engine == nil {
-		return ErrNilEngine
+		return errors.WithStack(ErrNilEngine)
 	}
 	gracefulTimeout := time.Duration(-1) // -1 indicates use engine default timeout
 	if force {
 		gracefulTimeout = 0 // don't wait, kill -15 && kill -9
 	}
-	return c.Engine.VirtualizationStop(ctx, c.ID, gracefulTimeout)
+	return errors.WithStack(c.Engine.VirtualizationStop(ctx, c.ID, gracefulTimeout))
 }
 
 // Remove a workload
 func (c *Workload) Remove(ctx context.Context, force bool) error {
 	if c.Engine == nil {
 		return ErrNilEngine
 	}
-	return c.Engine.VirtualizationRemove(ctx, c.ID, true, force)
+	return errors.WithStack(c.Engine.VirtualizationRemove(ctx, c.ID, true, force))
 }
 
 // WorkloadStatus store deploy status
diff --git a/utils/utils.go b/utils/utils.go
@@ -11,6 +11,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/pkg/errors"
 	"github.com/projecteru2/core/cluster"
 	"github.com/projecteru2/core/log"
 	"github.com/projecteru2/core/types"
@@ -45,7 +46,7 @@ func Tail(path string) string {
 // GetGitRepoName return git repo name
 func GetGitRepoName(url string) (string, error) {
 	if !(strings.Contains(url, "git@") || strings.Contains(url, "gitlab@") || strings.Contains(url, "https://")) || !strings.HasSuffix(url, ".git") {
-		return "", types.NewDetailedErr(types.ErrInvalidGitURL, url)
+		return "", errors.WithStack(types.NewDetailedErr(types.ErrInvalidGitURL, url))
 	}
 
 	return strings.TrimSuffix(Tail(url), ".git"), nil
@@ -92,7 +93,7 @@ func ParseWorkloadName(workloadName string) (string, string, string, error) {
 	if length >= 3 {
 		return strings.Join(splits[0:length-2], "_"), splits[length-2], splits[length-1], nil
 	}
-	return "", "", "", types.NewDetailedErr(types.ErrInvalidWorkloadName, workloadName)
+	return "", "", "", errors.WithStack(types.NewDetailedErr(types.ErrInvalidWorkloadName, workloadName))
 }
 
 // MakePublishInfo generate publish info
@@ -178,13 +179,13 @@ func CleanStatsdMetrics(k string) string {
 func TempFile(stream io.ReadCloser) (string, error) {
 	f, err := ioutil.TempFile(os.TempDir(), "")
 	if err != nil {
-		return "", err
+		return "", errors.WithStack(err)
 	}
 	defer f.Close()
 	defer stream.Close()
 
 	_, err = io.Copy(f, stream)
-	return f.Name(), err
+	return f.Name(), errors.WithStack(err)
 }
 
 // Round for float64 to int

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`
`6`	`6`	`"math"`
`7`	`7`
	`8`	`+ "github.com/pkg/errors"`
`8`	`9`	`engine "github.com/projecteru2/core/engine"`
`9`	`10`	`enginetypes "github.com/projecteru2/core/engine/types"`
`10`	`11`	`)`
`@@ -66,9 +67,10 @@ func (n *Node) Init() {`
`66`	`67`	`// Info show node info`
`67`	`68`	`func (n Node) Info(ctx context.Context) (enginetypes.Info, error) {`
`68`	`69`	`if n.Engine == nil {`
`69`		`- return nil, ErrNilEngine`
	`70`	`+ return nil, errors.WithStack(ErrNilEngine)`
`70`	`71`	`}`
`71`		`- return n.Engine.Info(ctx)`
	`72`	`+ info, err := n.Engine.Info(ctx)`
	`73`	`+ return info, errors.WithStack(err)`
`72`	`74`	`}`
`73`	`75`
`74`	`76`	`// SetCPUUsed set cpuusage`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@ package types`
`3`	`3`	`import (`
`4`	`4`	`"encoding/json"`
`5`	`5`	`"sort"`
	`6`	`+`
	`7`	`+ "github.com/pkg/errors"`
`6`	`8`	`)`
`7`	`9`
`8`	`10`	`// ResourceOptions for create/realloc/replace`
`@@ -163,12 +165,12 @@ func (p *VolumePlan) UnmarshalJSON(b []byte) (err error) {`
`163`	`165`	`}`
`164`	`166`	`plan := map[string]VolumeMap{}`
`165`	`167`	`if err = json.Unmarshal(b, &plan); err != nil {`
`166`		`- return err`
	`168`	`+ return errors.WithStack(err)`
`167`	`169`	`}`
`168`	`170`	`for volume, vmap := range plan {`
`169`	`171`	`vb, err := NewVolumeBinding(volume)`
`170`	`172`	`if err != nil {`
`171`		`- return err`
	`173`	`+ return errors.WithStack(err)`
`172`	`174`	`}`
`173`	`175`	`(p)[vb] = vmap`
`174`	`176`	`}`
`@@ -181,7 +183,8 @@ func (p VolumePlan) MarshalJSON() ([]byte, error) {`
`181`	`183`	`for vb, vmap := range p {`
`182`	`184`	`plan[vb.ToString(false)] = vmap`
`183`	`185`	`}`
`184`		`- return json.Marshal(plan)`
	`186`	`+ bs, err := json.Marshal(plan)`
	`187`	`+ return bs, errors.WithStack(err)`
`185`	`188`	`}`
`186`	`189`
`187`	`190`	`// ToLiteral returns literal VolumePlan`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,10 @@ func NewVolumeBinding(volume string) (_ *VolumeBinding, err error) {`
`35`	`35`	`case 4:`
`36`	`36`	`src, dst, flags = parts[0], parts[1], parts[2]`
`37`	`37`	`if size, err = strconv.ParseInt(parts[3], 10, 64); err != nil {`
`38`		`- return nil, err`
	`38`	`+ return nil, errors.WithStack(err)`
`39`	`39`	`}`
`40`	`40`	`default:`
`41`		`- return nil, fmt.Errorf("invalid volume: %v", volume)`
	`41`	`+ return nil, errors.WithStack(fmt.Errorf("invalid volume: %v", volume))`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`flagParts := strings.Split(flags, "")`
`@@ -56,10 +56,10 @@ func NewVolumeBinding(volume string) (_ *VolumeBinding, err error) {`
`56`	`56`	`// Validate return error if invalid`
`57`	`57`	`func (vb VolumeBinding) Validate() error {`
`58`	`58`	`if vb.Destination == "" {`
`59`		`- return errors.Errorf("invalid volume, dest must be provided: %v", vb)`
	`59`	`+ return errors.WithStack(errors.Errorf("invalid volume, dest must be provided: %v", vb))`
`60`	`60`	`}`
`61`	`61`	`if vb.RequireScheduleMonopoly() && vb.RequireScheduleUnlimitedQuota() {`
`62`		`- return errors.Errorf("invalid volume, monopoly volume must not be limited: %v", vb)`
	`62`	`+ return errors.WithStack(errors.Errorf("invalid volume, monopoly volume must not be limited: %v", vb))`
`63`	`63`	`}`
`64`	`64`	`return nil`
`65`	`65`	`}`
`@@ -131,7 +131,7 @@ func (vbs VolumeBindings) ToStringSlice(sorted, normalize bool) (volumes []strin`
`131`	`131`	`func (vbs *VolumeBindings) UnmarshalJSON(b []byte) (err error) {`
`132`	`132`	`volumes := []string{}`
`133`	`133`	`if err = json.Unmarshal(b, &volumes); err != nil {`
`134`		`- return err`
	`134`	`+ return errors.WithStack(err)`
`135`	`135`	`}`
`136`	`136`	`*vbs, err = NewVolumeBindings(volumes)`
`137`	`137`	`return`
`@@ -143,7 +143,8 @@ func (vbs VolumeBindings) MarshalJSON() ([]byte, error) {`
`143`	`143`	`for _, vb := range vbs {`
`144`	`144`	`volumes = append(volumes, vb.ToString(false))`
`145`	`145`	`}`
`146`		`- return json.Marshal(volumes)`
	`146`	`+ bs, err := json.Marshal(volumes)`
	`147`	`+ return bs, errors.WithStack(err)`
`147`	`148`	`}`
`148`	`149`
`149`	`150`	`// ApplyPlan creates new VolumeBindings according to volume plan`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import (`
`4`	`4`	`"context"`
`5`	`5`	`"time"`
`6`	`6`
	`7`	`+ "github.com/pkg/errors"`
`7`	`8`	`engine "github.com/projecteru2/core/engine"`
`8`	`9`	`enginetypes "github.com/projecteru2/core/engine/types"`
`9`	`10`	`)`
`@@ -47,37 +48,38 @@ type Workload struct {`
`47`	`48`	`// Inspect a workload`
`48`	`49`	`func (c Workload) Inspect(ctx context.Context) (enginetypes.VirtualizationInfo, error) {`
`49`	`50`	`if c.Engine == nil {`
`50`		`- return nil, ErrNilEngine`
	`51`	`+ return nil, errors.WithStack(ErrNilEngine)`
`51`	`52`	`}`
`52`		`- return c.Engine.VirtualizationInspect(ctx, c.ID)`
	`53`	`+ info, err := c.Engine.VirtualizationInspect(ctx, c.ID)`
	`54`	`+ return info, errors.WithStack(err)`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`// Start a workload`
`56`	`58`	`func (c *Workload) Start(ctx context.Context) error {`
`57`	`59`	`if c.Engine == nil {`
`58`		`- return ErrNilEngine`
	`60`	`+ return errors.WithStack(ErrNilEngine)`
`59`	`61`	`}`
`60`		`- return c.Engine.VirtualizationStart(ctx, c.ID)`
	`62`	`+ return errors.WithStack(c.Engine.VirtualizationStart(ctx, c.ID))`
`61`	`63`	`}`
`62`	`64`
`63`	`65`	`// Stop a workload`
`64`	`66`	`func (c *Workload) Stop(ctx context.Context, force bool) error {`
`65`	`67`	`if c.Engine == nil {`
`66`		`- return ErrNilEngine`
	`68`	`+ return errors.WithStack(ErrNilEngine)`
`67`	`69`	`}`
`68`	`70`	`gracefulTimeout := time.Duration(-1) // -1 indicates use engine default timeout`
`69`	`71`	`if force {`
`70`	`72`	`gracefulTimeout = 0 // don't wait, kill -15 && kill -9`
`71`	`73`	`}`
`72`		`- return c.Engine.VirtualizationStop(ctx, c.ID, gracefulTimeout)`
	`74`	`+ return errors.WithStack(c.Engine.VirtualizationStop(ctx, c.ID, gracefulTimeout))`
`73`	`75`	`}`
`74`	`76`
`75`	`77`	`// Remove a workload`
`76`	`78`	`func (c *Workload) Remove(ctx context.Context, force bool) error {`
`77`	`79`	`if c.Engine == nil {`
`78`	`80`	`return ErrNilEngine`
`79`	`81`	`}`
`80`		`- return c.Engine.VirtualizationRemove(ctx, c.ID, true, force)`
	`82`	`+ return errors.WithStack(c.Engine.VirtualizationRemove(ctx, c.ID, true, force))`
`81`	`83`	`}`
`82`	`84`
`83`	`85`	`// WorkloadStatus store deploy status`