Skip to content

Add descriptive error messages to custom sync fields #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ack-bot merged 2 commits into from
Mar 22, 2022
Merged

Add descriptive error messages to custom sync fields #72

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f724587
Add proper error messages to custom sync fields
Mar 22, 2022
48eed50
Downgrad runtime in go.local.mod
Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions go.local.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ replace github.com/aws-controllers-k8s/runtime => ../runtime

Copy link
Contributor Author

@RedbackThomson RedbackThomson Mar 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI this is a go.local.mod file - these changes were automatically assumed because of the newest runtime version.

require (
github.com/aws-controllers-k8s/runtime v0.16.3
github.com/aws/aws-sdk-go v1.37.10
github.com/aws/aws-sdk-go v1.42.0
github.com/go-logr/logr v1.2.0
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.7.0
Expand All @@ -31,6 +31,8 @@ require (
github.com/google/uuid v1.1.2 // indirect
github.com/googleapis/gnostic v0.5.5 // indirect
github.com/imdario/mergo v0.3.12 // indirect
github.com/itchyny/gojq v0.12.6 // indirect
github.com/itchyny/timefmt-go v0.1.3 // indirect
github.com/jaypipes/envutil v1.0.0 // indirect
github.com/jmespath/go-jmespath v0.4.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
Expand All @@ -49,7 +51,7 @@ require (
go.uber.org/zap v1.19.1 // indirect
golang.org/x/net v0.0.0-20210825183410-e898025ed96a // indirect
golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f // indirect
golang.org/x/sys v0.0.0-20211029165221-6e7872819dc8 // indirect
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 // indirect
golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b // indirect
golang.org/x/text v0.3.7 // indirect
golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
Expand Down
89 changes: 50 additions & 39 deletions pkg/resource/bucket/hook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"context"
"strings"

"github.com/pkg/errors"

ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors"
ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
Expand Down Expand Up @@ -50,6 +52,8 @@ const (
ConfigurationActionUpdate
)

const ErrSyncingPutProperty = "Error syncing property '%s'"

func (rm *resourceManager) createPutFields(
ctx context.Context,
r *resource,
Expand All @@ -64,87 +68,87 @@ func (rm *resourceManager) createPutFields(

if r.ko.Spec.Accelerate != nil {
if err := rm.syncAccelerate(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Accelerate")
}
}
if len(r.ko.Spec.Analytics) != 0 {
if err := rm.syncAnalytics(ctx, r, nil); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Analytics")
}
}
if r.ko.Spec.CORS != nil {
if err := rm.syncCORS(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "CORS")
}
}
if r.ko.Spec.Encryption != nil {
if err := rm.syncEncryption(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Encryption")
}
}
if len(r.ko.Spec.IntelligentTiering) != 0 {
if err := rm.syncIntelligentTiering(ctx, r, nil); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "IntelligentTiering")
}
}
if len(r.ko.Spec.Inventory) != 0 {
if err := rm.syncInventory(ctx, r, nil); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Inventory")
}
}
if r.ko.Spec.Lifecycle != nil {
if err := rm.syncLifecycle(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Lifecycle")
}
}
if r.ko.Spec.Logging != nil {
if err := rm.syncLogging(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Logging")
}
}
if len(r.ko.Spec.Metrics) != 0 {
if err := rm.syncMetrics(ctx, r, nil); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Metrics")
}
}
if r.ko.Spec.Notification != nil {
if err := rm.syncNotification(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Notification")
}
}
if r.ko.Spec.OwnershipControls != nil {
if err := rm.syncOwnershipControls(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "OwnershipControls")
}
}
if r.ko.Spec.Policy != nil {
if err := rm.syncPolicy(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Policy")
}
}
if r.ko.Spec.PublicAccessBlock != nil {
if err := rm.syncPublicAccessBlock(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "PublicAccessBlock")
}
}
if r.ko.Spec.Replication != nil {
if err := rm.syncReplication(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Replication")
}
}
if r.ko.Spec.RequestPayment != nil {
if err := rm.syncRequestPayment(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "RequestPayment")
}
}
if r.ko.Spec.Tagging != nil {
if err := rm.syncTagging(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Tagging")
}
}
if r.ko.Spec.Website != nil {
if err := rm.syncWebsite(ctx, r); err != nil {
return err
return errors.Wrapf(err, ErrSyncingPutProperty, "Website")
}
}
return nil
Expand All @@ -170,12 +174,12 @@ func (rm *resourceManager) customUpdateBucket(

if delta.DifferentAt("Spec.Accelerate") {
if err := rm.syncAccelerate(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Accelerate")
}
}
if delta.DifferentAt("Spec.Analytics") {
if err := rm.syncAnalytics(ctx, desired, latest); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Analytics")
}
}
if delta.DifferentAt("Spec.ACL") ||
Expand All @@ -185,77 +189,77 @@ func (rm *resourceManager) customUpdateBucket(
delta.DifferentAt("Spec.GrantWrite") ||
delta.DifferentAt("Spec.GrantWriteACP") {
if err := rm.syncACL(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "ACLs or Grant Headers")
}
}
if delta.DifferentAt("Spec.CORS") {
if err := rm.syncCORS(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "CORS")
}
}
if delta.DifferentAt("Spec.Encryption") {
if err := rm.syncEncryption(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Encryption")
}
}
if delta.DifferentAt("Spec.IntelligentTiering") {
if err := rm.syncIntelligentTiering(ctx, desired, latest); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "IntelligentTiering")
}
}
if delta.DifferentAt("Spec.Inventory") {
if err := rm.syncInventory(ctx, desired, latest); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Inventory")
}
}
if delta.DifferentAt("Spec.Lifecycle") {
if err := rm.syncLifecycle(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Lifecycle")
}
}
if delta.DifferentAt("Spec.Logging") {
if err := rm.syncLogging(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Logging")
}
}
if delta.DifferentAt("Spec.Metrics") {
if err := rm.syncMetrics(ctx, desired, latest); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Metrics")
}
}
if delta.DifferentAt("Spec.Notification") {
if err := rm.syncNotification(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Notification")
}
}
if delta.DifferentAt("Spec.OwnershipControls") {
if err := rm.syncOwnershipControls(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "OwnershipControls")
}
}
if delta.DifferentAt("Spec.Policy") {
if err := rm.syncPolicy(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Policy")
}
}
if delta.DifferentAt("Spec.PublicAccessBlock") {
if err := rm.syncPublicAccessBlock(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "PublicAccessBlock")
}
}
if delta.DifferentAt("Spec.RequestPayment") {
if err := rm.syncRequestPayment(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "RequestPayment")
}
}
if delta.DifferentAt("Spec.Tagging") {
if err := rm.syncTagging(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Tagging")
}
}
if delta.DifferentAt("Spec.Website") {
if err := rm.syncWebsite(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Website")
}
}

Expand All @@ -265,17 +269,17 @@ func (rm *resourceManager) customUpdateBucket(
if delta.DifferentAt("Spec.Replication") || delta.DifferentAt("Spec.Versioning") {
if desired.ko.Spec.Replication == nil || desired.ko.Spec.Replication.Rules == nil {
if err := rm.syncReplication(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Replication")
}
if err := rm.syncVersioning(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Versioningc")
}
} else {
if err := rm.syncVersioning(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Versioningc")
}
if err := rm.syncReplication(ctx, desired); err != nil {
return nil, err
return nil, errors.Wrapf(err, ErrSyncingPutProperty, "Replication")
}
}
}
Expand All @@ -292,7 +296,14 @@ func (rm *resourceManager) addPutFieldsToSpec(
) (err error) {
getAccelerateResponse, err := rm.sdkapi.GetBucketAccelerateConfigurationWithContext(ctx, rm.newGetBucketAcceleratePayload(r))
if err != nil {
return err
// This method is not supported in every region, ignore any errors if
// we attempt to describe this property in a region in which it's not
// supported.
if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "MethodNotAllowed" {
getAccelerateResponse = &svcsdk.GetBucketAccelerateConfigurationOutput{}
} else {
return err
}
}
ko.Spec.Accelerate = rm.setResourceAccelerate(r, getAccelerateResponse)

Expand Down