Skip to content

Commit 5ae3f12

Browse files
committed
Refactor error messages to include aws error details (#53)
* refactor error messages to include aws error details * update deps
1 parent 5f96422 commit 5ae3f12

File tree

12 files changed

+148
-143
lines changed

12 files changed

+148
-143
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ plan.tfplan
44
*.log
55
*.out
66
*.html
7+
8+
# IntelliJ IDEA project files
9+
.idea
10+
*.iprg

go.mod

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ require (
1818
github.com/mitchellh/mapstructure v1.5.0
1919
github.com/stretchr/testify v1.8.4
2020
google.golang.org/grpc v1.61.0
21-
google.golang.org/protobuf v1.33.0
21+
google.golang.org/protobuf v1.35.1
2222
)
2323

2424
require (
@@ -55,10 +55,10 @@ require (
5555
github.com/mitchellh/reflectwalk v1.0.2 // indirect
5656
github.com/pmezard/go-difflib v1.0.0 // indirect
5757
github.com/zclconf/go-cty v1.10.0 // indirect
58-
golang.org/x/crypto v0.18.0 // indirect
59-
golang.org/x/net v0.20.0 // indirect
60-
golang.org/x/sys v0.16.0 // indirect
61-
golang.org/x/text v0.14.0 // indirect
58+
golang.org/x/crypto v0.28.0 // indirect
59+
golang.org/x/net v0.30.0 // indirect
60+
golang.org/x/sys v0.26.0 // indirect
61+
golang.org/x/text v0.19.0 // indirect
6262
google.golang.org/genproto v0.0.0-20240116215550-a9fa1716bcac // indirect
6363
google.golang.org/genproto/googleapis/api v0.0.0-20240125205218-1f4bbc51befe // indirect
6464
google.golang.org/genproto/googleapis/rpc v0.0.0-20240125205218-1f4bbc51befe // indirect

go.sum

+10-10
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,8 @@ go.uber.org/goleak v1.1.12/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ
210210
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
211211
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
212212
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
213-
golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
214-
golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
213+
golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
214+
golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U=
215215
golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
216216
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
217217
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
@@ -224,8 +224,8 @@ golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR
224224
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
225225
golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
226226
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
227-
golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
228-
golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
227+
golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
228+
golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
229229
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
230230
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
231231
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -239,14 +239,14 @@ golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBc
239239
golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
240240
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
241241
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
242-
golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
243-
golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
242+
golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
243+
golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
244244
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
245245
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
246246
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
247247
golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
248-
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
249-
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
248+
golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
249+
golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
250250
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
251251
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
252252
golang.org/x/tools v0.0.0-20191108193012-7d206e10da11/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
@@ -269,8 +269,8 @@ google.golang.org/grpc v1.61.0 h1:TOvOcuXn30kRao+gfcvsebNEa5iZIiLkisYEkf7R7o0=
269269
google.golang.org/grpc v1.61.0/go.mod h1:VUbo7IFqmF1QtCAstipjG0GIoq49KvMe9+h1jFLBNJs=
270270
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
271271
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
272-
google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
273-
google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
272+
google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
273+
google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
274274
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
275275
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
276276
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=

internal/credential/state.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func (s *AwsCredentialPersistedState) ValidateCreds(ctx context.Context) error {
114114
return errors.BadRequestStatus("missing credentials config")
115115
}
116116
if _, err := s.CredentialsConfig.GetCallerIdentity(ctx, s.testOpts...); err != nil {
117-
st, _ := errors.ParseAWSError(err, "validating credentials")
117+
st, _ := errors.ParseAWSError("validating credentials", err)
118118
return st.Err()
119119
}
120120
return nil
@@ -135,7 +135,7 @@ func (s *AwsCredentialPersistedState) RotateCreds(ctx context.Context) error {
135135
if err := s.CredentialsConfig.RotateKeys(ctx, append([]awsutil.Option{
136136
awsutil.WithValidityCheckTimeout(rotationWaitTimeout),
137137
}, s.testOpts...)...); err != nil {
138-
st, _ := errors.ParseAWSError(err, "error rotating credentials")
138+
st, _ := errors.ParseAWSError("rotating credentials", err)
139139
return st.Err()
140140
}
141141
s.CredsLastRotatedTime = time.Now()
@@ -192,7 +192,7 @@ func (s *AwsCredentialPersistedState) DeleteCreds(ctx context.Context) error {
192192
}
193193

194194
// Otherwise treat it as an actual error.
195-
st, _ := errors.ParseAWSError(err, "failed to delete access key")
195+
st, _ := errors.ParseAWSError("deleting credentials", err)
196196
return st.Err()
197197
}
198198

@@ -252,17 +252,17 @@ func AwsCredentialPersistedStateFromProto(secrets *structpb.Struct, attrs *Crede
252252

253253
accessKeyId, err := values.GetStringValue(secrets, ConstAccessKeyId, false)
254254
if err != nil {
255-
return nil, fmt.Errorf("persisted state integrity error: %w", err)
255+
return nil, fmt.Errorf("persisted state integrity: %w", err)
256256
}
257257

258258
secretAccessKey, err := values.GetStringValue(secrets, ConstSecretAccessKey, false)
259259
if err != nil {
260-
return nil, fmt.Errorf("persisted state integrity error: %w", err)
260+
return nil, fmt.Errorf("persisted state integrity: %w", err)
261261
}
262262

263263
credsLastRotatedTime, err := values.GetTimeValue(secrets, ConstCredsLastRotatedTime)
264264
if err != nil {
265-
return nil, fmt.Errorf("persisted state integrity error: %w", err)
265+
return nil, fmt.Errorf("persisted state integrity: %w", err)
266266
}
267267

268268
s, err := NewAwsCredentialPersistedState(opts...)

internal/credential/state_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ func TestAwsCredentialPersistedStateFromProto(t *testing.T) {
186186
attrs: &CredentialAttributes{
187187
Region: "us-west-2",
188188
},
189-
expectedErr: "persisted state integrity error: could not parse time in value \"creds_last_rotated_time\": parsing time \"notatime\" as \"2006-01-02T15:04:05.999999999Z07:00\": cannot parse \"notatime\" as \"2006\"",
189+
expectedErr: "persisted state integrity: could not parse time in value \"creds_last_rotated_time\": parsing time \"notatime\" as \"2006-01-02T15:04:05.999999999Z07:00\": cannot parse \"notatime\" as \"2006\"",
190190
},
191191
{
192192
name: "option error",
@@ -458,7 +458,7 @@ func TestAwsCatalogPersistedState_RotateCreds(t *testing.T) {
458458
),
459459
},
460460
},
461-
expectedErr: "aws service unknown: unknown error: error rotating credentials",
461+
expectedErr: "aws service unknown: unknown error: rotating credentials",
462462
expectedStatusCode: codes.Unknown,
463463
},
464464
{
@@ -568,7 +568,7 @@ func TestAwsCatalogPersistedState_ReplaceCreds(t *testing.T) {
568568
},
569569
},
570570
credentialConfig: &awsutil.CredentialsConfig{},
571-
expectedErr: "aws service unknown: unknown error: failed to delete access key",
571+
expectedErr: "aws service unknown: unknown error: deleting credentials",
572572
expectedStatusCode: codes.Unknown,
573573
},
574574
{
@@ -693,7 +693,7 @@ func TestAwsCatalogPersistedState_DeleteCreds(t *testing.T) {
693693
),
694694
},
695695
},
696-
expectedErr: "aws service unknown: unknown error: failed to delete access key",
696+
expectedErr: "aws service unknown: unknown error: deleting credentials",
697697
expectedStatusCode: codes.Unknown,
698698
},
699699
{

internal/errors/error.go

+15-14
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,12 @@ func InvalidArgumentError(msg string, f map[string]string) error {
8181
// and credentials. This method will fallback to parsing the http status code
8282
// when it cannot match an aws error code. This method does not handle specific
8383
// service type errors such as S3 or EC2.
84-
func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Permission) {
84+
func ParseAWSError(op string, err error) (st *status.Status, permission *pb.Permission) {
8585
if err == nil {
8686
return nil, nil
8787
}
8888

89+
msg := fmt.Sprintf("%s: %v", op, err)
8990
// find the service name of the aws api
9091
serviceName := "unknown"
9192
var oe *smithy.OperationError
@@ -113,7 +114,7 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
113114
Codes: retry.DefaultThrottleErrorCodes,
114115
}
115116
if throttleErr.IsErrorThrottle(err).Bool() {
116-
statusMsg := fmt.Sprintf("aws service %s: throttling error: %s", serviceName, msg)
117+
statusMsg := fmt.Sprintf("aws service %s: throttling: %s", serviceName, msg)
117118
return status.New(codes.Unavailable, statusMsg), nil
118119
}
119120

@@ -126,31 +127,31 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
126127
case awsErrorInvalidAccessKeyId:
127128
fallthrough
128129
case awsErrorExpiredToken:
129-
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg)
130+
statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
130131
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
131132
State: pb.StateType_STATE_TYPE_ERROR,
132133
ErrorDetails: apiErr.ErrorMessage(),
133134
CheckedAt: timestamppb.Now(),
134135
}
135136
case awsErrorNoSuchBucket:
136-
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg)
137+
statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
137138
return status.New(codes.NotFound, statusMsg), &pb.Permission{
138139
State: pb.StateType_STATE_TYPE_ERROR,
139140
ErrorDetails: apiErr.ErrorMessage(),
140141
CheckedAt: timestamppb.Now(),
141142
}
142143
case awsErrorBadDigest:
143-
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg)
144+
statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
144145
return status.New(codes.Aborted, statusMsg), nil
145146
case awsErrorNoSuchKey:
146147
fallthrough
147148
case awsErrorInvalidObjectState:
148-
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg)
149+
statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
149150
return status.New(codes.NotFound, statusMsg), nil
150151
case awsErrorRequestTimeout:
151152
fallthrough
152153
case awsErrorRequestTimeoutException:
153-
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg)
154+
statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
154155
return status.New(codes.DeadlineExceeded, statusMsg), nil
155156
}
156157
}
@@ -165,39 +166,39 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
165166
defer httpErr.Response.Body.Close()
166167
switch httpErr.HTTPStatusCode() {
167168
case http.StatusBadRequest:
168-
statusMsg := fmt.Sprintf("aws service %s: bad request error: %s", serviceName, msg)
169+
statusMsg := fmt.Sprintf("aws service %s: bad request: %s", serviceName, msg)
169170
return status.New(codes.InvalidArgument, statusMsg), nil
170171
case http.StatusUnauthorized:
171-
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg)
172+
statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
172173
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
173174
State: pb.StateType_STATE_TYPE_ERROR,
174175
ErrorDetails: buf.String(),
175176
CheckedAt: timestamppb.Now(),
176177
}
177178
case http.StatusForbidden:
178-
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg)
179+
statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
179180
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
180181
State: pb.StateType_STATE_TYPE_ERROR,
181182
ErrorDetails: buf.String(),
182183
CheckedAt: timestamppb.Now(),
183184
}
184185
case http.StatusNotFound:
185-
statusMsg := fmt.Sprintf("aws service %s: resource not found error: %s", serviceName, msg)
186+
statusMsg := fmt.Sprintf("aws service %s: resource not found: %s", serviceName, msg)
186187
return status.New(codes.NotFound, statusMsg), nil
187188
case http.StatusTooManyRequests:
188-
statusMsg := fmt.Sprintf("aws service %s: throttling error: %s", serviceName, msg)
189+
statusMsg := fmt.Sprintf("aws service %s: throttling: %s", serviceName, msg)
189190
return status.New(codes.Unavailable, statusMsg), nil
190191
case http.StatusInternalServerError:
191192
fallthrough
192193
case http.StatusBadGateway:
193194
fallthrough
194195
case http.StatusServiceUnavailable:
195-
statusMsg := fmt.Sprintf("aws service %s: connectivity error: %s", serviceName, msg)
196+
statusMsg := fmt.Sprintf("aws service %s: connectivity: %s", serviceName, msg)
196197
return status.New(codes.Unavailable, statusMsg), nil
197198
case http.StatusRequestTimeout:
198199
fallthrough
199200
case http.StatusGatewayTimeout:
200-
statusMsg := fmt.Sprintf("aws service %s: timeout error: %s", serviceName, msg)
201+
statusMsg := fmt.Sprintf("aws service %s: timeout: %s", serviceName, msg)
201202
return status.New(codes.DeadlineExceeded, statusMsg), nil
202203
}
203204
}

0 commit comments

Comments
 (0)