msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

code review (error checks, collapse forceConflicts, UpdateApplyFunc)

Browse Source 
Signed-off-by: George Jenkins <gvjenkins@gmail.com>
pull/31030/head
George Jenkins 3 weeks ago
parent 99dc23f00b
commit b2dc411f9d
6 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File

2
pkg/action/hooks.go
Unescape View File

@ -75,7 +75,7 @@ func (cfg *Configuration) execHook(rl *release.Release, hook release.HookEvent,
// Create hook resources // Create hook resources
if _, err := cfg.KubeClient.Create( if _, err := cfg.KubeClient.Create(
resources, resources,
kube.ClientCreateOptionServerSideApply(false)); err != nil { kube.ClientCreateOptionServerSideApply(false, false)); err != nil {
h.LastRun.CompletedAt = helmtime.Now() h.LastRun.CompletedAt = helmtime.Now()
h.LastRun.Phase = release.HookPhaseFailed h.LastRun.Phase = release.HookPhaseFailed
return fmt.Errorf("warning: Hook %s %s failed: %w", hook, h.Path, err) return fmt.Errorf("warning: Hook %s %s failed: %w", hook, h.Path, err)

8
pkg/action/install.go
Unescape View File

@ -175,7 +175,7 @@ func (i *Install) installCRDs(crds []chart.CRD) error {
// Send them to Kube // Send them to Kube
if _, err := i.cfg.KubeClient.Create( if _, err := i.cfg.KubeClient.Create(
res, res,
kube.ClientCreateOptionServerSideApply(false)); err != nil { kube.ClientCreateOptionServerSideApply(false, false)); err != nil {
// If the error is CRD already exists, continue. // If the error is CRD already exists, continue.
if apierrors.IsAlreadyExists(err) { if apierrors.IsAlreadyExists(err) {
crdName := res[0].Name crdName := res[0].Name
@ -403,7 +403,7 @@ func (i *Install) RunWithContext(ctx context.Context, chrt *chart.Chart, vals ma
} }
if _, err := i.cfg.KubeClient.Create( if _, err := i.cfg.KubeClient.Create(
resourceList, resourceList,
kube.ClientCreateOptionServerSideApply(false)); err != nil && !apierrors.IsAlreadyExists(err) { kube.ClientCreateOptionServerSideApply(false, false)); err != nil && !apierrors.IsAlreadyExists(err) {
return nil, err return nil, err
} }
} }
@ -474,13 +474,13 @@ func (i *Install) performInstall(rel *release.Release, toBeAdopted kube.Resource
if len(toBeAdopted) == 0 && len(resources) > 0 { if len(toBeAdopted) == 0 && len(resources) > 0 {
_, err = i.cfg.KubeClient.Create( _, err = i.cfg.KubeClient.Create(
resources, resources,
kube.ClientCreateOptionServerSideApply(false)) kube.ClientCreateOptionServerSideApply(false, false))
} else if len(resources) > 0 { } else if len(resources) > 0 {
updateThreeWayMergeForUnstructured := i.TakeOwnership updateThreeWayMergeForUnstructured := i.TakeOwnership
_, err = i.cfg.KubeClient.Update( _, err = i.cfg.KubeClient.Update(
toBeAdopted, toBeAdopted,
resources, resources,
kube.ClientUpdateOptionServerSideApply(false), kube.ClientUpdateOptionServerSideApply(false, false),
kube.ClientUpdateOptionThreeWayMergeForUnstructured(updateThreeWayMergeForUnstructured), kube.ClientUpdateOptionThreeWayMergeForUnstructured(updateThreeWayMergeForUnstructured),
kube.ClientUpdateOptionForceReplace(i.ForceReplace)) kube.ClientUpdateOptionForceReplace(i.ForceReplace))
} }

2
pkg/action/rollback.go
Unescape View File

@ -193,7 +193,7 @@ func (r *Rollback) performRollback(currentRelease, targetRelease *release.Releas
results, err := r.cfg.KubeClient.Update( results, err := r.cfg.KubeClient.Update(
current, current,
target, target,
kube.ClientUpdateOptionServerSideApply(false), kube.ClientUpdateOptionServerSideApply(false, false),
kube.ClientUpdateOptionForceReplace(r.ForceReplace)) kube.ClientUpdateOptionForceReplace(r.ForceReplace))
if err != nil { if err != nil {

2
pkg/action/upgrade.go
Unescape View File

@ -429,7 +429,7 @@ func (u *Upgrade) releasingUpgrade(c chan<- resultMessage, upgradedRelease *rele
results, err := u.cfg.KubeClient.Update( results, err := u.cfg.KubeClient.Update(
current, current,
target, target,
kube.ClientUpdateOptionServerSideApply(false), kube.ClientUpdateOptionServerSideApply(false, false),
kube.ClientUpdateOptionForceReplace(u.ForceReplace)) kube.ClientUpdateOptionForceReplace(u.ForceReplace))
if err != nil { if err != nil {
u.cfg.recordRelease(originalRelease) u.cfg.recordRelease(originalRelease)

64
pkg/kube/client.go
Unescape View File

@ -214,26 +214,23 @@ type ClientCreateOption func(*clientCreateOptions) error
// ClientUpdateOptionServerSideApply enables performing object apply server-side // ClientUpdateOptionServerSideApply enables performing object apply server-side
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/ // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/
func ClientCreateOptionServerSideApply(serverSideApply bool) ClientCreateOption { //
return func(o *clientCreateOptions) error { // `forceConflicts` forces conflicts to be resolved (may be when serverSideApply enabled only)
o.serverSideApply = serverSideApply
return nil
}
}
// ClientCreateOptionForceConflicts forces field conflicts to be resolved
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts
// Only valid when ClientUpdateOptionServerSideApply enabled func ClientCreateOptionServerSideApply(serverSideApply, forceConflicts bool) ClientCreateOption {
func ClientCreateOptionForceConflicts(forceConflicts bool) ClientCreateOption {
return func(o *clientCreateOptions) error { return func(o *clientCreateOptions) error {
if !serverSideApply && forceConflicts {
return fmt.Errorf("forceConflicts enabled when serverSideApply disabled")
}
o.serverSideApply = serverSideApply
o.forceConflicts = forceConflicts o.forceConflicts = forceConflicts
return nil return nil
} }
} }
// ClientCreateOptionDryRun performs non-mutating operations only // ClientCreateOptionDryRun requests the server to perform non-mutating operations only
func ClientCreateOptionDryRun(dryRun bool) ClientCreateOption { func ClientCreateOptionDryRun(dryRun bool) ClientCreateOption {
return func(o *clientCreateOptions) error { return func(o *clientCreateOptions) error {
o.dryRun = dryRun o.dryRun = dryRun
@ -264,8 +261,12 @@ func (c *Client) Create(resources ResourceList, options ...ClientCreateOption) (
fieldValidationDirective: FieldValidationDirectiveStrict, fieldValidationDirective: FieldValidationDirectiveStrict,
} }
errs := make([]error, 0, len(options))
for _, o := range options { for _, o := range options {
o(&createOptions) errs = append(errs, o(&createOptions))
}
if err := errors.Join(errs...); err != nil {
return nil, fmt.Errorf("invalid client create option(s): %w", err)
} }
if createOptions.forceConflicts && !createOptions.serverSideApply { if createOptions.forceConflicts && !createOptions.serverSideApply {
@ -499,7 +500,7 @@ func (c *Client) BuildTable(reader io.Reader, validate bool) (ResourceList, erro
transformRequests) transformRequests)
} }
func (c *Client) update(originals, targets ResourceList, updateApplyFunc func(original, target *resource.Info) error) (*Result, error) { func (c *Client) update(originals, targets ResourceList, updateApplyFunc UpdateApplyFunc) (*Result, error) {
updateErrors := []error{} updateErrors := []error{}
res := &Result{} res := &Result{}
@ -599,9 +600,17 @@ func ClientUpdateOptionThreeWayMergeForUnstructured(threeWayMergeForUnstructured
// ClientUpdateOptionServerSideApply enables performing object apply server-side (default) // ClientUpdateOptionServerSideApply enables performing object apply server-side (default)
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/ // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/
// Must not be enabled when ClientUpdateOptionThreeWayMerge is enabled // Must not be enabled when ClientUpdateOptionThreeWayMerge is enabled
func ClientUpdateOptionServerSideApply(serverSideApply bool) ClientUpdateOption { //
// `forceConflicts` forces conflicts to be resolved (may be enabled when serverSideApply enabled only)
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts
func ClientUpdateOptionServerSideApply(serverSideApply, forceConflicts bool) ClientUpdateOption {
return func(o *clientUpdateOptions) error { return func(o *clientUpdateOptions) error {
if !serverSideApply && forceConflicts {
return fmt.Errorf("forceConflicts enabled when serverSideApply disabled")
}
o.serverSideApply = serverSideApply o.serverSideApply = serverSideApply
o.forceConflicts = forceConflicts
return nil return nil
} }
@ -617,20 +626,7 @@ func ClientUpdateOptionForceReplace(forceReplace bool) ClientUpdateOption {
} }
} }
// ClientUpdateOptionForceConflicts forces field conflicts to be resolved // ClientUpdateOptionDryRun requests the server to perform non-mutating operations only
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts
// Must not be enabled when ClientUpdateOptionForceReplace is enabled
func ClientUpdateOptionForceConflicts(forceConflicts bool) ClientUpdateOption {
return func(o *clientUpdateOptions) error {
o.forceConflicts = forceConflicts
return nil
}
}
// ClientUpdateOptionForceConflicts forces field conflicts to be resolved
// see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts
// Must not be enabled when ClientUpdateOptionForceReplace is enabled
func ClientUpdateOptionDryRun(dryRun bool) ClientUpdateOption { func ClientUpdateOptionDryRun(dryRun bool) ClientUpdateOption {
return func(o *clientUpdateOptions) error { return func(o *clientUpdateOptions) error {
o.dryRun = dryRun o.dryRun = dryRun
@ -652,6 +648,8 @@ func ClientUpdateOptionFieldValidationDirective(fieldValidationDirective FieldVa
} }
} }
type UpdateApplyFunc func(original, target *resource.Info) error
// Update takes the current list of objects and target list of objects and // Update takes the current list of objects and target list of objects and
// creates resources that don't already exist, updates resources that have been // creates resources that don't already exist, updates resources that have been
// modified in the target configuration, and deletes resources from the current // modified in the target configuration, and deletes resources from the current
@ -667,8 +665,12 @@ func (c *Client) Update(originals, targets ResourceList, options ...ClientUpdate
fieldValidationDirective: FieldValidationDirectiveStrict, fieldValidationDirective: FieldValidationDirectiveStrict,
} }
errs := make([]error, 0, len(options))
for _, o := range options { for _, o := range options {
o(&updateOptions) errs = append(errs, o(&updateOptions))
}
if err := errors.Join(errs...); err != nil {
return nil, fmt.Errorf("invalid client update option(s): %w", err)
} }
if updateOptions.threeWayMergeForUnstructured && updateOptions.serverSideApply { if updateOptions.threeWayMergeForUnstructured && updateOptions.serverSideApply {
@ -683,7 +685,7 @@ func (c *Client) Update(originals, targets ResourceList, options ...ClientUpdate
return nil, fmt.Errorf("invalid operation: cannot use server-side apply and force replace together") return nil, fmt.Errorf("invalid operation: cannot use server-side apply and force replace together")
} }
makeUpdateApplyFunc := func() func(original, target *resource.Info) error { makeUpdateApplyFunc := func() UpdateApplyFunc {
if updateOptions.forceReplace { if updateOptions.forceReplace {
slog.Debug( slog.Debug(
"using resource replace update strategy", "using resource replace update strategy",

16
pkg/kube/client_test.go
Unescape View File

@ -292,7 +292,7 @@ func TestCreate(t *testing.T) {
result, err := c.Create( result, err := c.Create(
list, list,
ClientCreateOptionServerSideApply(tc.ServerSideApply)) ClientCreateOptionServerSideApply(tc.ServerSideApply, false))
if tc.ExpectedErrorContains != "" { if tc.ExpectedErrorContains != "" {
require.ErrorContains(t, err, tc.ExpectedErrorContains) require.ErrorContains(t, err, tc.ExpectedErrorContains)
} else { } else {
@ -467,7 +467,7 @@ func TestUpdate(t *testing.T) {
second, second,
ClientUpdateOptionThreeWayMergeForUnstructured(tc.ThreeWayMergeForUnstructured), ClientUpdateOptionThreeWayMergeForUnstructured(tc.ThreeWayMergeForUnstructured),
ClientUpdateOptionForceReplace(false), ClientUpdateOptionForceReplace(false),
ClientUpdateOptionServerSideApply(tc.ServerSideApply)) ClientUpdateOptionServerSideApply(tc.ServerSideApply, false))
require.NoError(t, err) require.NoError(t, err)
assert.Len(t, result.Created, 1, "expected 1 resource created, got %d", len(result.Created)) assert.Len(t, result.Created, 1, "expected 1 resource created, got %d", len(result.Created))
@ -684,7 +684,7 @@ func TestWait(t *testing.T) {
result, err := c.Create( result, err := c.Create(
resources, resources,
ClientCreateOptionServerSideApply(false)) ClientCreateOptionServerSideApply(false, false))
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
@ -744,7 +744,7 @@ func TestWaitJob(t *testing.T) {
} }
result, err := c.Create( result, err := c.Create(
resources, resources,
ClientCreateOptionServerSideApply(false)) ClientCreateOptionServerSideApply(false, false))
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
@ -806,7 +806,7 @@ func TestWaitDelete(t *testing.T) {
} }
result, err := c.Create( result, err := c.Create(
resources, resources,
ClientCreateOptionServerSideApply(false)) ClientCreateOptionServerSideApply(false, false))
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -1225,7 +1225,6 @@ func TestCreatePatchCustomResourceSpec(t *testing.T) {
t.Run(testCase.name, testCase.run) t.Run(testCase.name, testCase.run)
} }
<<<<<<< HEAD
type errorFactory struct { type errorFactory struct {
*cmdtesting.TestFactory *cmdtesting.TestFactory
err error err error
@ -1326,8 +1325,8 @@ func TestIsReachable(t *testing.T) {
} }
}) })
} }
||||||| parent of 36a476ff4 (Kube client support server-side apply) }
=======
func TestIsIncompatibleServerError(t *testing.T) { func TestIsIncompatibleServerError(t *testing.T) {
testCases := map[string]struct { testCases := map[string]struct {
Err error Err error
@ -1749,5 +1748,4 @@ func TestDetermineFieldValidationDirective(t *testing.T) {
assert.Equal(t, FieldValidationDirectiveIgnore, determineFieldValidationDirective(false)) assert.Equal(t, FieldValidationDirectiveIgnore, determineFieldValidationDirective(false))
assert.Equal(t, FieldValidationDirectiveStrict, determineFieldValidationDirective(true)) assert.Equal(t, FieldValidationDirectiveStrict, determineFieldValidationDirective(true))
>>>>>>> 36a476ff4 (Kube client support server-side apply)
} }

Write Preview
Loading…
Cancel
Save