/
errors.go
290 lines (250 loc) · 11.9 KB
/
errors.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
// Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helper
import (
"errors"
"regexp"
"strings"
"time"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
utilerrors "github.com/gardener/gardener/pkg/utils/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
)
// ErrorWithCodes contains error codes and an error message.
type ErrorWithCodes struct {
message string
codes []gardencorev1beta1.ErrorCode
}
// Retriable marks ErrorWithCodes as retriable.
func (e *ErrorWithCodes) Retriable() {}
// NewErrorWithCodes creates a new error that additionally exposes the given codes via the Coder interface.
func NewErrorWithCodes(message string, codes ...gardencorev1beta1.ErrorCode) error {
return &ErrorWithCodes{message, codes}
}
// Codes returns all error codes.
func (e *ErrorWithCodes) Codes() []gardencorev1beta1.ErrorCode {
return e.codes
}
// Error returns the error message.
func (e *ErrorWithCodes) Error() string {
return e.message
}
var (
unauthenticatedRegexp = regexp.MustCompile(`(?i)(InvalidAuthenticationTokenTenant|Authentication failed|AuthFailure|invalid character|invalid_client|query returned no results|InvalidAccessKeyId|cannot fetch token|InvalidSecretAccessKey|InvalidSubscriptionId)`)
unauthorizedRegexp = regexp.MustCompile(`(?i)(Unauthorized|InvalidClientTokenId|SignatureDoesNotMatch|AuthorizationFailed|invalid_grant|Authorization Profile was not found|no active subscriptions|UnauthorizedOperation|not authorized|AccessDenied|OperationNotAllowed|Error 403|SERVICE_ACCOUNT_ACCESS_DENIED)`)
quotaExceededRegexp = regexp.MustCompile(`(?i)((?:^|[^t]|(?:[^s]|^)t|(?:[^e]|^)st|(?:[^u]|^)est|(?:[^q]|^)uest|(?:[^e]|^)quest|(?:[^r]|^)equest)LimitExceeded|Quotas|Quota.*exceeded|exceeded quota|Quota has been met|QUOTA_EXCEEDED|Maximum number of ports exceeded|ZONE_RESOURCE_POOL_EXHAUSTED_WITH_DETAILS|VolumeSizeExceedsAvailableQuota)`)
rateLimitsExceededRegexp = regexp.MustCompile(`(?i)(RequestLimitExceeded|Throttling|Too many requests)`)
dependenciesRegexp = regexp.MustCompile(`(?i)(PendingVerification|Access Not Configured|accessNotConfigured|DependencyViolation|OptInRequired|DeleteConflict|Conflict|inactive billing state|ReadOnlyDisabledSubscription|is already being used|InUseSubnetCannotBeDeleted|VnetInUse|InUseRouteTableCannotBeDeleted|timeout while waiting for state to become|InvalidCidrBlock|already busy for|InsufficientFreeAddressesInSubnet|InternalServerError|internalerror|internal server error|A resource with the ID|VnetAddressSpaceCannotChangeDueToPeerings|InternalBillingError|There are not enough hosts available)`)
retryableDependenciesRegexp = regexp.MustCompile(`(?i)(RetryableError)`)
resourcesDepletedRegexp = regexp.MustCompile(`(?i)(not available in the current hardware cluster|InsufficientInstanceCapacity|SkuNotAvailable|ZonalAllocationFailed|out of stock|Zone.NotOnSale)`)
configurationProblemRegexp = regexp.MustCompile(`(?i)(AzureBastionSubnet|not supported in your requested Availability Zone|InvalidParameter|InvalidParameterValue|notFound|NetcfgInvalidSubnet|InvalidSubnet|Invalid value|KubeletHasInsufficientMemory|KubeletHasDiskPressure|KubeletHasInsufficientPID|violates constraint|no attached internet gateway found|Your query returned no results|PrivateEndpointNetworkPoliciesCannotBeEnabledOnPrivateEndpointSubnet|invalid VPC attributes|PrivateLinkServiceNetworkPoliciesCannotBeEnabledOnPrivateLinkServiceSubnet|unrecognized feature gate|runtime-config invalid key|LoadBalancingRuleMustDisableSNATSinceSameFrontendIPConfigurationIsReferencedByOutboundRule|strict decoder error|not allowed to configure an unsupported|error during apply of object .* is invalid:|OverconstrainedZonalAllocationRequest|duplicate zones|overlapping zones)`)
retryableConfigurationProblemRegexp = regexp.MustCompile(`(?i)(is misconfigured and requires zero voluntary evictions|SDK.CanNotResolveEndpoint|The requested configuration is currently not supported)`)
)
// DetermineError determines the Garden error code for the given error and creates a new error with the given message.
// TODO(timebertt): this is should be improved: clean up the usages to not pass the error twice (once as an error and
// once as a string) and properly wrap the given error instead of creating a new one from the given error message,
// so we can use errors.As up the call stack.
func DetermineError(err error, message string) error {
if err == nil {
return errors.New(message)
}
errMsg := message
if errMsg == "" {
errMsg = err.Error()
}
codes := DetermineErrorCodes(err)
if codes == nil {
return errors.New(errMsg)
}
return &ErrorWithCodes{errMsg, codes}
}
// DetermineErrorCodes determines error codes based on the given error.
func DetermineErrorCodes(err error) []gardencorev1beta1.ErrorCode {
var (
coder Coder
message = err.Error()
codes = sets.NewString()
knownCodes = map[gardencorev1beta1.ErrorCode]func(string) bool{
gardencorev1beta1.ErrorInfraUnauthenticated: unauthenticatedRegexp.MatchString,
gardencorev1beta1.ErrorInfraUnauthorized: unauthorizedRegexp.MatchString,
gardencorev1beta1.ErrorInfraQuotaExceeded: quotaExceededRegexp.MatchString,
gardencorev1beta1.ErrorInfraRateLimitsExceeded: rateLimitsExceededRegexp.MatchString,
gardencorev1beta1.ErrorInfraDependencies: dependenciesRegexp.MatchString,
gardencorev1beta1.ErrorRetryableInfraDependencies: retryableDependenciesRegexp.MatchString,
gardencorev1beta1.ErrorInfraResourcesDepleted: resourcesDepletedRegexp.MatchString,
gardencorev1beta1.ErrorConfigurationProblem: configurationProblemRegexp.MatchString,
gardencorev1beta1.ErrorRetryableConfigurationProblem: retryableConfigurationProblemRegexp.MatchString,
}
)
// try to re-use codes from error
if errors.As(err, &coder) {
for _, code := range coder.Codes() {
codes.Insert(string(code))
// found codes don't need to be checked any more
delete(knownCodes, code)
}
}
// determine error codes
for code, matchFn := range knownCodes {
if !codes.Has(string(code)) && matchFn(message) {
codes.Insert(string(code))
}
}
// compute error code list based on code string set
var out []gardencorev1beta1.ErrorCode
for _, c := range codes.List() {
out = append(out, gardencorev1beta1.ErrorCode(c))
}
return out
}
// Coder is an error that may produce a ErrorCodes visible to the outside.
type Coder interface {
error
Codes() []gardencorev1beta1.ErrorCode
}
// ExtractErrorCodes extracts all error codes from the given error by using utilerrors.Errors
func ExtractErrorCodes(err error) []gardencorev1beta1.ErrorCode {
var codes []gardencorev1beta1.ErrorCode
for _, err := range utilerrors.Errors(err) {
var coder Coder
if errors.As(err, &coder) {
codes = append(codes, coder.Codes()...)
}
}
return codes
}
var _ error = (*MultiErrorWithCodes)(nil)
// MultiErrorWithCodes is a struct that contains multiple errors and ErrorCodes.
type MultiErrorWithCodes struct {
errors []error
errorFormat func(errs []error) string
errorCodeStr sets.String
codes []gardencorev1beta1.ErrorCode
}
// NewMultiErrorWithCodes returns a new instance of `MultiErrorWithCodes`.
func NewMultiErrorWithCodes(errorFormat func(errs []error) string) *MultiErrorWithCodes {
return &MultiErrorWithCodes{
errorFormat: errorFormat,
errorCodeStr: sets.NewString(),
}
}
// Append appends the given error to the `MultiErrorWithCodes`.
func (m *MultiErrorWithCodes) Append(err error) {
for _, code := range ExtractErrorCodes(err) {
if m.errorCodeStr.Has(string(code)) {
continue
}
m.errorCodeStr.Insert(string(code))
m.codes = append(m.codes, code)
}
m.errors = append(m.errors, err)
}
// Codes returns all underlying `gardencorev1beta1.ErrorCode` codes.
func (m *MultiErrorWithCodes) Codes() []gardencorev1beta1.ErrorCode {
if m.codes == nil {
return nil
}
cp := make([]gardencorev1beta1.ErrorCode, len(m.codes))
copy(cp, m.codes)
return cp
}
// ErrorOrNil returns nil if no underlying errors are given.
func (m *MultiErrorWithCodes) ErrorOrNil() error {
if len(m.errors) == 0 {
return nil
}
return m
}
// Error implements the error interface.
func (m *MultiErrorWithCodes) Error() string {
return m.errorFormat(m.errors)
}
// FormatLastErrDescription formats the error message string for the last occurred error.
func FormatLastErrDescription(err error) string {
errString := err.Error()
if len(errString) > 0 {
errString = strings.ToUpper(string(errString[0])) + errString[1:]
}
return errString
}
// WrappedLastErrors is a structure which contains the general description of the lastErrors which occurred and an array of all lastErrors
type WrappedLastErrors struct {
Description string
LastErrors []gardencorev1beta1.LastError
}
// NewWrappedLastErrors returns an error
func NewWrappedLastErrors(description string, err error) *WrappedLastErrors {
var lastErrors []gardencorev1beta1.LastError
for _, partError := range utilerrors.Errors(err) {
lastErrors = append(lastErrors, *LastErrorWithTaskID(
partError.Error(),
utilerrors.GetID(partError),
DetermineErrorCodes(utilerrors.Unwrap(partError))...))
}
return &WrappedLastErrors{
Description: description,
LastErrors: lastErrors,
}
}
// LastError creates a new LastError with the given description, optional codes and sets timestamp when the error is lastly observed.
func LastError(description string, codes ...gardencorev1beta1.ErrorCode) *gardencorev1beta1.LastError {
return &gardencorev1beta1.LastError{
Description: description,
Codes: codes,
LastUpdateTime: &metav1.Time{
Time: time.Now(),
},
}
}
// LastErrorWithTaskID creates a new LastError with the given description, the ID of the task when the error occurred, optional codes and sets timestamp when the error is lastly observed.
func LastErrorWithTaskID(description string, taskID string, codes ...gardencorev1beta1.ErrorCode) *gardencorev1beta1.LastError {
return &gardencorev1beta1.LastError{
Description: description,
Codes: codes,
TaskID: &taskID,
LastUpdateTime: &metav1.Time{
Time: time.Now(),
},
}
}
// HasNonRetryableErrorCode returns true if at least one of given list of last errors has at least one error code that
// indicates that an automatic retry would not help fixing the problem.
func HasNonRetryableErrorCode(lastErrors ...gardencorev1beta1.LastError) bool {
for _, lastError := range lastErrors {
for _, code := range lastError.Codes {
if code == gardencorev1beta1.ErrorInfraUnauthenticated ||
code == gardencorev1beta1.ErrorInfraUnauthorized ||
code == gardencorev1beta1.ErrorInfraDependencies ||
code == gardencorev1beta1.ErrorInfraQuotaExceeded ||
code == gardencorev1beta1.ErrorInfraRateLimitsExceeded ||
code == gardencorev1beta1.ErrorConfigurationProblem {
return true
}
}
}
return false
}
// HasErrorCode checks whether at least one LastError from the given slice of LastErrors <lastErrors>
// contains the given ErrorCode <code>.
func HasErrorCode(lastErrors []gardencorev1beta1.LastError, code gardencorev1beta1.ErrorCode) bool {
for _, lastError := range lastErrors {
for _, current := range lastError.Codes {
if current == code {
return true
}
}
}
return false
}