-
Notifications
You must be signed in to change notification settings - Fork 20
/
error.go
69 lines (56 loc) · 2.07 KB
/
error.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*******************************************************************************
* IBM Confidential
* OCO Source Materials
* IBM Cloud Container Service, 5737-D43
* (C) Copyright IBM Corp. 2018, 2019 All Rights Reserved.
* The source code for this program is not published or otherwise divested of
* its trade secrets, irrespective of what has been deposited with
* the U.S. Copyright Office.
******************************************************************************/
package provider
import (
"github.com/IBM/ibmcloud-storage-volume-lib/lib/utils/reasoncode"
)
// Error implements the error interface for a Fault.
// Most easily constructed using util.NewError() or util.NewErrorWithProperties()
type Error struct {
// Fault ...
Fault Fault
}
// Fault encodes a fault condition.
// Does not implement the error interface so that cannot be accidentally
// misassigned to error variables when returned in a function response.
type Fault struct {
// Message is the fault message (required)
Message string `json:"msg"`
// ReasonCode is fault reason code (required) //TODO: will have better reasoncode mechanism
ReasonCode reasoncode.ReasonCode `json:"code"`
// WrappedErrors contains wrapped error messages (if applicable)
Wrapped []string `json:"wrapped,omitempty"`
// Properties contains diagnostic properties (if applicable)
Properties map[string]string `json:"properties,omitempty"`
}
// FaultResponse is an optional Fault
type FaultResponse struct {
Fault *Fault `json:"fault,omitempty"`
}
var _ error = Error{}
// Error satisfies the error contract
func (err Error) Error() string {
return err.Fault.Message
}
// Code satisfies the legacy provider.Error interface
func (err Error) Code() reasoncode.ReasonCode {
if err.Fault.ReasonCode == "" {
return reasoncode.ErrorUnclassified
}
return err.Fault.ReasonCode
}
// Wrapped mirrors the legacy provider.Error interface
func (err Error) Wrapped() []string {
return err.Fault.Wrapped
}
// Properties satisfies the legacy provider.Error interface
func (err Error) Properties() map[string]string {
return err.Fault.Properties
}