Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-go / ac63710ec22a279b455379ba0a9456c0a5f2cdde / . / vendor / go.etcd.io / etcd / etcdserver / api / v3rpc / rpctypes / error.go
blob: 55eab38ef17bc37618348199827f8de973ba0d49 [file] [log] [blame]
khenaidooac637102019-01-14 15:44:34 -0500[diff] [blame^]1// Copyright 2015 The etcd Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package rpctypes
16
17import (
18 "google.golang.org/grpc/codes"
19 "google.golang.org/grpc/status"
20)
21
22// server-side error
23var (
24 ErrGRPCEmptyKey = status.New(codes.InvalidArgument, "etcdserver: key is not provided").Err()
25 ErrGRPCKeyNotFound = status.New(codes.InvalidArgument, "etcdserver: key not found").Err()
26 ErrGRPCValueProvided = status.New(codes.InvalidArgument, "etcdserver: value is provided").Err()
27 ErrGRPCLeaseProvided = status.New(codes.InvalidArgument, "etcdserver: lease is provided").Err()
28 ErrGRPCTooManyOps = status.New(codes.InvalidArgument, "etcdserver: too many operations in txn request").Err()
29 ErrGRPCDuplicateKey = status.New(codes.InvalidArgument, "etcdserver: duplicate key given in txn request").Err()
30 ErrGRPCCompacted = status.New(codes.OutOfRange, "etcdserver: mvcc: required revision has been compacted").Err()
31 ErrGRPCFutureRev = status.New(codes.OutOfRange, "etcdserver: mvcc: required revision is a future revision").Err()
32 ErrGRPCNoSpace = status.New(codes.ResourceExhausted, "etcdserver: mvcc: database space exceeded").Err()
33
34 ErrGRPCLeaseNotFound = status.New(codes.NotFound, "etcdserver: requested lease not found").Err()
35 ErrGRPCLeaseExist = status.New(codes.FailedPrecondition, "etcdserver: lease already exists").Err()
36 ErrGRPCLeaseTTLTooLarge = status.New(codes.OutOfRange, "etcdserver: too large lease TTL").Err()
37
38 ErrGRPCMemberExist = status.New(codes.FailedPrecondition, "etcdserver: member ID already exist").Err()
39 ErrGRPCPeerURLExist = status.New(codes.FailedPrecondition, "etcdserver: Peer URLs already exists").Err()
40 ErrGRPCMemberNotEnoughStarted = status.New(codes.FailedPrecondition, "etcdserver: re-configuration failed due to not enough started members").Err()
41 ErrGRPCMemberBadURLs = status.New(codes.InvalidArgument, "etcdserver: given member URLs are invalid").Err()
42 ErrGRPCMemberNotFound = status.New(codes.NotFound, "etcdserver: member not found").Err()
43
44 ErrGRPCRequestTooLarge = status.New(codes.InvalidArgument, "etcdserver: request is too large").Err()
45 ErrGRPCRequestTooManyRequests = status.New(codes.ResourceExhausted, "etcdserver: too many requests").Err()
46
47 ErrGRPCRootUserNotExist = status.New(codes.FailedPrecondition, "etcdserver: root user does not exist").Err()
48 ErrGRPCRootRoleNotExist = status.New(codes.FailedPrecondition, "etcdserver: root user does not have root role").Err()
49 ErrGRPCUserAlreadyExist = status.New(codes.FailedPrecondition, "etcdserver: user name already exists").Err()
50 ErrGRPCUserEmpty = status.New(codes.InvalidArgument, "etcdserver: user name is empty").Err()
51 ErrGRPCUserNotFound = status.New(codes.FailedPrecondition, "etcdserver: user name not found").Err()
52 ErrGRPCRoleAlreadyExist = status.New(codes.FailedPrecondition, "etcdserver: role name already exists").Err()
53 ErrGRPCRoleNotFound = status.New(codes.FailedPrecondition, "etcdserver: role name not found").Err()
54 ErrGRPCAuthFailed = status.New(codes.InvalidArgument, "etcdserver: authentication failed, invalid user ID or password").Err()
55 ErrGRPCPermissionDenied = status.New(codes.PermissionDenied, "etcdserver: permission denied").Err()
56 ErrGRPCRoleNotGranted = status.New(codes.FailedPrecondition, "etcdserver: role is not granted to the user").Err()
57 ErrGRPCPermissionNotGranted = status.New(codes.FailedPrecondition, "etcdserver: permission is not granted to the role").Err()
58 ErrGRPCAuthNotEnabled = status.New(codes.FailedPrecondition, "etcdserver: authentication is not enabled").Err()
59 ErrGRPCInvalidAuthToken = status.New(codes.Unauthenticated, "etcdserver: invalid auth token").Err()
60 ErrGRPCInvalidAuthMgmt = status.New(codes.InvalidArgument, "etcdserver: invalid auth management").Err()
61
62 ErrGRPCNoLeader = status.New(codes.Unavailable, "etcdserver: no leader").Err()
63 ErrGRPCNotLeader = status.New(codes.FailedPrecondition, "etcdserver: not leader").Err()
64 ErrGRPCNotCapable = status.New(codes.Unavailable, "etcdserver: not capable").Err()
65 ErrGRPCStopped = status.New(codes.Unavailable, "etcdserver: server stopped").Err()
66 ErrGRPCTimeout = status.New(codes.Unavailable, "etcdserver: request timed out").Err()
67 ErrGRPCTimeoutDueToLeaderFail = status.New(codes.Unavailable, "etcdserver: request timed out, possibly due to previous leader failure").Err()
68 ErrGRPCTimeoutDueToConnectionLost = status.New(codes.Unavailable, "etcdserver: request timed out, possibly due to connection lost").Err()
69 ErrGRPCUnhealthy = status.New(codes.Unavailable, "etcdserver: unhealthy cluster").Err()
70 ErrGRPCCorrupt = status.New(codes.DataLoss, "etcdserver: corrupt cluster").Err()
71
72 errStringToError = map[string]error{
73 ErrorDesc(ErrGRPCEmptyKey): ErrGRPCEmptyKey,
74 ErrorDesc(ErrGRPCKeyNotFound): ErrGRPCKeyNotFound,
75 ErrorDesc(ErrGRPCValueProvided): ErrGRPCValueProvided,
76 ErrorDesc(ErrGRPCLeaseProvided): ErrGRPCLeaseProvided,
77
78 ErrorDesc(ErrGRPCTooManyOps): ErrGRPCTooManyOps,
79 ErrorDesc(ErrGRPCDuplicateKey): ErrGRPCDuplicateKey,
80 ErrorDesc(ErrGRPCCompacted): ErrGRPCCompacted,
81 ErrorDesc(ErrGRPCFutureRev): ErrGRPCFutureRev,
82 ErrorDesc(ErrGRPCNoSpace): ErrGRPCNoSpace,
83
84 ErrorDesc(ErrGRPCLeaseNotFound): ErrGRPCLeaseNotFound,
85 ErrorDesc(ErrGRPCLeaseExist): ErrGRPCLeaseExist,
86 ErrorDesc(ErrGRPCLeaseTTLTooLarge): ErrGRPCLeaseTTLTooLarge,
87
88 ErrorDesc(ErrGRPCMemberExist): ErrGRPCMemberExist,
89 ErrorDesc(ErrGRPCPeerURLExist): ErrGRPCPeerURLExist,
90 ErrorDesc(ErrGRPCMemberNotEnoughStarted): ErrGRPCMemberNotEnoughStarted,
91 ErrorDesc(ErrGRPCMemberBadURLs): ErrGRPCMemberBadURLs,
92 ErrorDesc(ErrGRPCMemberNotFound): ErrGRPCMemberNotFound,
93
94 ErrorDesc(ErrGRPCRequestTooLarge): ErrGRPCRequestTooLarge,
95 ErrorDesc(ErrGRPCRequestTooManyRequests): ErrGRPCRequestTooManyRequests,
96
97 ErrorDesc(ErrGRPCRootUserNotExist): ErrGRPCRootUserNotExist,
98 ErrorDesc(ErrGRPCRootRoleNotExist): ErrGRPCRootRoleNotExist,
99 ErrorDesc(ErrGRPCUserAlreadyExist): ErrGRPCUserAlreadyExist,
100 ErrorDesc(ErrGRPCUserEmpty): ErrGRPCUserEmpty,
101 ErrorDesc(ErrGRPCUserNotFound): ErrGRPCUserNotFound,
102 ErrorDesc(ErrGRPCRoleAlreadyExist): ErrGRPCRoleAlreadyExist,
103 ErrorDesc(ErrGRPCRoleNotFound): ErrGRPCRoleNotFound,
104 ErrorDesc(ErrGRPCAuthFailed): ErrGRPCAuthFailed,
105 ErrorDesc(ErrGRPCPermissionDenied): ErrGRPCPermissionDenied,
106 ErrorDesc(ErrGRPCRoleNotGranted): ErrGRPCRoleNotGranted,
107 ErrorDesc(ErrGRPCPermissionNotGranted): ErrGRPCPermissionNotGranted,
108 ErrorDesc(ErrGRPCAuthNotEnabled): ErrGRPCAuthNotEnabled,
109 ErrorDesc(ErrGRPCInvalidAuthToken): ErrGRPCInvalidAuthToken,
110 ErrorDesc(ErrGRPCInvalidAuthMgmt): ErrGRPCInvalidAuthMgmt,
111
112 ErrorDesc(ErrGRPCNoLeader): ErrGRPCNoLeader,
113 ErrorDesc(ErrGRPCNotLeader): ErrGRPCNotLeader,
114 ErrorDesc(ErrGRPCNotCapable): ErrGRPCNotCapable,
115 ErrorDesc(ErrGRPCStopped): ErrGRPCStopped,
116 ErrorDesc(ErrGRPCTimeout): ErrGRPCTimeout,
117 ErrorDesc(ErrGRPCTimeoutDueToLeaderFail): ErrGRPCTimeoutDueToLeaderFail,
118 ErrorDesc(ErrGRPCTimeoutDueToConnectionLost): ErrGRPCTimeoutDueToConnectionLost,
119 ErrorDesc(ErrGRPCUnhealthy): ErrGRPCUnhealthy,
120 ErrorDesc(ErrGRPCCorrupt): ErrGRPCCorrupt,
121 }
122)
123
124// client-side error
125var (
126 ErrEmptyKey = Error(ErrGRPCEmptyKey)
127 ErrKeyNotFound = Error(ErrGRPCKeyNotFound)
128 ErrValueProvided = Error(ErrGRPCValueProvided)
129 ErrLeaseProvided = Error(ErrGRPCLeaseProvided)
130 ErrTooManyOps = Error(ErrGRPCTooManyOps)
131 ErrDuplicateKey = Error(ErrGRPCDuplicateKey)
132 ErrCompacted = Error(ErrGRPCCompacted)
133 ErrFutureRev = Error(ErrGRPCFutureRev)
134 ErrNoSpace = Error(ErrGRPCNoSpace)
135
136 ErrLeaseNotFound = Error(ErrGRPCLeaseNotFound)
137 ErrLeaseExist = Error(ErrGRPCLeaseExist)
138 ErrLeaseTTLTooLarge = Error(ErrGRPCLeaseTTLTooLarge)
139
140 ErrMemberExist = Error(ErrGRPCMemberExist)
141 ErrPeerURLExist = Error(ErrGRPCPeerURLExist)
142 ErrMemberNotEnoughStarted = Error(ErrGRPCMemberNotEnoughStarted)
143 ErrMemberBadURLs = Error(ErrGRPCMemberBadURLs)
144 ErrMemberNotFound = Error(ErrGRPCMemberNotFound)
145
146 ErrRequestTooLarge = Error(ErrGRPCRequestTooLarge)
147 ErrTooManyRequests = Error(ErrGRPCRequestTooManyRequests)
148
149 ErrRootUserNotExist = Error(ErrGRPCRootUserNotExist)
150 ErrRootRoleNotExist = Error(ErrGRPCRootRoleNotExist)
151 ErrUserAlreadyExist = Error(ErrGRPCUserAlreadyExist)
152 ErrUserEmpty = Error(ErrGRPCUserEmpty)
153 ErrUserNotFound = Error(ErrGRPCUserNotFound)
154 ErrRoleAlreadyExist = Error(ErrGRPCRoleAlreadyExist)
155 ErrRoleNotFound = Error(ErrGRPCRoleNotFound)
156 ErrAuthFailed = Error(ErrGRPCAuthFailed)
157 ErrPermissionDenied = Error(ErrGRPCPermissionDenied)
158 ErrRoleNotGranted = Error(ErrGRPCRoleNotGranted)
159 ErrPermissionNotGranted = Error(ErrGRPCPermissionNotGranted)
160 ErrAuthNotEnabled = Error(ErrGRPCAuthNotEnabled)
161 ErrInvalidAuthToken = Error(ErrGRPCInvalidAuthToken)
162 ErrInvalidAuthMgmt = Error(ErrGRPCInvalidAuthMgmt)
163
164 ErrNoLeader = Error(ErrGRPCNoLeader)
165 ErrNotLeader = Error(ErrGRPCNotLeader)
166 ErrNotCapable = Error(ErrGRPCNotCapable)
167 ErrStopped = Error(ErrGRPCStopped)
168 ErrTimeout = Error(ErrGRPCTimeout)
169 ErrTimeoutDueToLeaderFail = Error(ErrGRPCTimeoutDueToLeaderFail)
170 ErrTimeoutDueToConnectionLost = Error(ErrGRPCTimeoutDueToConnectionLost)
171 ErrUnhealthy = Error(ErrGRPCUnhealthy)
172 ErrCorrupt = Error(ErrGRPCCorrupt)
173)
174
175// EtcdError defines gRPC server errors.
176// (https://github.com/grpc/grpc-go/blob/master/rpc_util.go#L319-L323)
177type EtcdError struct {
178 code codes.Code
179 desc string
180}
181
182// Code returns grpc/codes.Code.
183// TODO: define clientv3/codes.Code.
184func (e EtcdError) Code() codes.Code {
185 return e.code
186}
187
188func (e EtcdError) Error() string {
189 return e.desc
190}
191
192func Error(err error) error {
193 if err == nil {
194 return nil
195 }
196 verr, ok := errStringToError[ErrorDesc(err)]
197 if !ok { // not gRPC error
198 return err
199 }
200 ev, ok := status.FromError(verr)
201 var desc string
202 if ok {
203 desc = ev.Message()
204 } else {
205 desc = verr.Error()
206 }
207 return EtcdError{code: ev.Code(), desc: desc}
208}
209
210func ErrorDesc(err error) string {
211 if s, ok := status.FromError(err); ok {
212 return s.Message()
213 }
214 return err.Error()
215}