Skip to content

Commit

Permalink
Merge pull request #589 from alvaroaleman/list-opts-as-list-option
Browse files Browse the repository at this point in the history
✨ Client option types implement client option interfaces
  • Loading branch information
k8s-ci-robot committed Sep 16, 2019
2 parents 524b614 + b7dfffa commit dd6ead6
Show file tree
Hide file tree
Showing 3 changed files with 303 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

95 changes: 95 additions & 0 deletions pkg/client/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,21 @@ func (o *CreateOptions) ApplyOptions(opts []CreateOption) *CreateOptions {
return o
}

// ApplyToCreate implements CreateOption
func (o *CreateOptions) ApplyToCreate(co *CreateOptions) {
if o.DryRun != nil {
co.DryRun = o.DryRun
}
if o.FieldManager != "" {
co.FieldManager = o.FieldManager
}
if o.Raw != nil {
co.Raw = o.Raw
}
}

var _ CreateOption = &CreateOptions{}

// CreateDryRunAll sets the "dry run" option to "all".
//
// Deprecated: Use DryRunAll
Expand Down Expand Up @@ -211,6 +226,27 @@ func (o *DeleteOptions) ApplyOptions(opts []DeleteOption) *DeleteOptions {
return o
}

var _ DeleteOption = &DeleteOptions{}

// ApplyToDelete implements DeleteOption
func (o *DeleteOptions) ApplyToDelete(do *DeleteOptions) {
if o.GracePeriodSeconds != nil {
do.GracePeriodSeconds = o.GracePeriodSeconds
}
if o.Preconditions != nil {
do.Preconditions = o.Preconditions
}
if o.PropagationPolicy != nil {
do.PropagationPolicy = o.PropagationPolicy
}
if o.Raw != nil {
do.Raw = o.Raw
}
if o.DryRun != nil {
do.DryRun = o.DryRun
}
}

// GracePeriodSeconds sets the grace period for the deletion
// to the given number of seconds.
type GracePeriodSeconds int64
Expand Down Expand Up @@ -273,6 +309,24 @@ type ListOptions struct {
Raw *metav1.ListOptions
}

var _ ListOption = &ListOptions{}

// ApplyToList implements ListOption for ListOptions
func (o *ListOptions) ApplyToList(lo *ListOptions) {
if o.LabelSelector != nil {
lo.LabelSelector = o.LabelSelector
}
if o.FieldSelector != nil {
lo.FieldSelector = o.FieldSelector
}
if o.Namespace != "" {
lo.Namespace = o.Namespace
}
if o.Raw != nil {
lo.Raw = o.Raw
}
}

// AsListOptions returns these options as a flattened metav1.ListOptions.
// This may mutate the Raw field.
func (o *ListOptions) AsListOptions() *metav1.ListOptions {
Expand Down Expand Up @@ -422,6 +476,21 @@ func (o *UpdateOptions) ApplyOptions(opts []UpdateOption) *UpdateOptions {
return o
}

var _ UpdateOption = &UpdateOptions{}

// ApplyToUpdate implements UpdateOption
func (o *UpdateOptions) ApplyToUpdate(uo *UpdateOptions) {
if o.DryRun != nil {
uo.DryRun = o.DryRun
}
if o.FieldManager != "" {
uo.FieldManager = o.FieldManager
}
if o.Raw != nil {
uo.Raw = o.Raw
}
}

// UpdateDryRunAll sets the "dry run" option to "all".
//
// Deprecated: Use DryRunAll
Expand Down Expand Up @@ -479,6 +548,24 @@ func (o *PatchOptions) AsPatchOptions() *metav1.PatchOptions {
return o.Raw
}

var _ PatchOption = &PatchOptions{}

// ApplyToPatch implements PatchOptions
func (o *PatchOptions) ApplyToPatch(po *PatchOptions) {
if o.DryRun != nil {
po.DryRun = o.DryRun
}
if o.Force != nil {
po.Force = o.Force
}
if o.FieldManager != "" {
po.FieldManager = o.FieldManager
}
if o.Raw != nil {
po.Raw = o.Raw
}
}

// ForceOwnership indicates that in case of conflicts with server-side apply,
// the client should acquire ownership of the conflicting field. Most
// controllers should use this.
Expand Down Expand Up @@ -518,4 +605,12 @@ func (o *DeleteAllOfOptions) ApplyOptions(opts []DeleteAllOfOption) *DeleteAllOf
return o
}

var _ DeleteAllOfOption = &DeleteAllOfOptions{}

// ApplyToDeleteAllOf implements DeleteAllOfOption
func (o *DeleteAllOfOptions) ApplyToDeleteAllOf(do *DeleteAllOfOptions) {
o.ApplyToList(&do.ListOptions)
o.ApplyToDelete(&do.DeleteOptions)
}

// }}}
205 changes: 205 additions & 0 deletions pkg/client/options_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
/*
Copyright 2018 The Kubernetes Authors.
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 client_test

import (
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/labels"
utilpointer "k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
)

var _ = Describe("ListOptions", func() {
It("Should set LabelSelector", func() {
labelSelector, err := labels.Parse("a=b")
Expect(err).NotTo(HaveOccurred())
o := &client.ListOptions{LabelSelector: labelSelector}
newListOpts := &client.ListOptions{}
o.ApplyToList(newListOpts)
Expect(newListOpts).To(Equal(o))
})
It("Should set FieldSelector", func() {
o := &client.ListOptions{FieldSelector: fields.Nothing()}
newListOpts := &client.ListOptions{}
o.ApplyToList(newListOpts)
Expect(newListOpts).To(Equal(o))
})
It("Should set Namespace", func() {
o := &client.ListOptions{Namespace: "my-ns"}
newListOpts := &client.ListOptions{}
o.ApplyToList(newListOpts)
Expect(newListOpts).To(Equal(o))
})
It("Should set Raw", func() {
o := &client.ListOptions{Raw: &metav1.ListOptions{FieldSelector: "Hans"}}
newListOpts := &client.ListOptions{}
o.ApplyToList(newListOpts)
Expect(newListOpts).To(Equal(o))
})
It("Should not set anything", func() {
o := &client.ListOptions{}
newListOpts := &client.ListOptions{}
o.ApplyToList(newListOpts)
Expect(newListOpts).To(Equal(o))
})
})

var _ = Describe("CreateOptions", func() {
It("Should set DryRun", func() {
o := &client.CreateOptions{DryRun: []string{"Hello", "Theodore"}}
newCreatOpts := &client.CreateOptions{}
o.ApplyToCreate(newCreatOpts)
Expect(newCreatOpts).To(Equal(o))
})
It("Should set FieldManager", func() {
o := &client.CreateOptions{FieldManager: "FieldManager"}
newCreatOpts := &client.CreateOptions{}
o.ApplyToCreate(newCreatOpts)
Expect(newCreatOpts).To(Equal(o))
})
It("Should set Raw", func() {
o := &client.CreateOptions{Raw: &metav1.CreateOptions{DryRun: []string{"Bye", "Theodore"}}}
newCreatOpts := &client.CreateOptions{}
o.ApplyToCreate(newCreatOpts)
Expect(newCreatOpts).To(Equal(o))
})
It("Should not set anything", func() {
o := &client.CreateOptions{}
newCreatOpts := &client.CreateOptions{}
o.ApplyToCreate(newCreatOpts)
Expect(newCreatOpts).To(Equal(o))
})
})

var _ = Describe("DeleteOptions", func() {
It("Should set GracePeriodSeconds", func() {
o := &client.DeleteOptions{GracePeriodSeconds: utilpointer.Int64Ptr(42)}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
It("Should set Preconditions", func() {
o := &client.DeleteOptions{Preconditions: &metav1.Preconditions{}}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
It("Should set PropagationPolicy", func() {
policy := metav1.DeletePropagationBackground
o := &client.DeleteOptions{PropagationPolicy: &policy}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
It("Should set Raw", func() {
o := &client.DeleteOptions{Raw: &metav1.DeleteOptions{}}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
It("Should set DryRun", func() {
o := &client.DeleteOptions{DryRun: []string{"Hello", "Pippa"}}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
It("Should not set anything", func() {
o := &client.DeleteOptions{}
newDeleteOpts := &client.DeleteOptions{}
o.ApplyToDelete(newDeleteOpts)
Expect(newDeleteOpts).To(Equal(o))
})
})

var _ = Describe("UpdateOptions", func() {
It("Should set DryRun", func() {
o := &client.UpdateOptions{DryRun: []string{"Bye", "Pippa"}}
newUpdateOpts := &client.UpdateOptions{}
o.ApplyToUpdate(newUpdateOpts)
Expect(newUpdateOpts).To(Equal(o))
})
It("Should set FieldManager", func() {
o := &client.UpdateOptions{FieldManager: "Hello Boris"}
newUpdateOpts := &client.UpdateOptions{}
o.ApplyToUpdate(newUpdateOpts)
Expect(newUpdateOpts).To(Equal(o))
})
It("Should set Raw", func() {
o := &client.UpdateOptions{Raw: &metav1.UpdateOptions{}}
newUpdateOpts := &client.UpdateOptions{}
o.ApplyToUpdate(newUpdateOpts)
Expect(newUpdateOpts).To(Equal(o))
})
It("Should not set anything", func() {
o := &client.UpdateOptions{}
newUpdateOpts := &client.UpdateOptions{}
o.ApplyToUpdate(newUpdateOpts)
Expect(newUpdateOpts).To(Equal(o))
})
})

var _ = Describe("PatchOptions", func() {
It("Should set DryRun", func() {
o := &client.PatchOptions{DryRun: []string{"Bye", "Boris"}}
newPatchOpts := &client.PatchOptions{}
o.ApplyToPatch(newPatchOpts)
Expect(newPatchOpts).To(Equal(o))
})
It("Should set Force", func() {
o := &client.PatchOptions{Force: utilpointer.BoolPtr(true)}
newPatchOpts := &client.PatchOptions{}
o.ApplyToPatch(newPatchOpts)
Expect(newPatchOpts).To(Equal(o))
})
It("Should set FieldManager", func() {
o := &client.PatchOptions{FieldManager: "Hello Julian"}
newPatchOpts := &client.PatchOptions{}
o.ApplyToPatch(newPatchOpts)
Expect(newPatchOpts).To(Equal(o))
})
It("Should set Raw", func() {
o := &client.PatchOptions{Raw: &metav1.PatchOptions{}}
newPatchOpts := &client.PatchOptions{}
o.ApplyToPatch(newPatchOpts)
Expect(newPatchOpts).To(Equal(o))
})
It("Should not set anything", func() {
o := &client.PatchOptions{}
newPatchOpts := &client.PatchOptions{}
o.ApplyToPatch(newPatchOpts)
Expect(newPatchOpts).To(Equal(o))
})
})

var _ = Describe("DeleteAllOfOptions", func() {
It("Should set ListOptions", func() {
o := &client.DeleteAllOfOptions{ListOptions: client.ListOptions{Raw: &metav1.ListOptions{}}}
newDeleteAllOfOpts := &client.DeleteAllOfOptions{}
o.ApplyToDeleteAllOf(newDeleteAllOfOpts)
Expect(newDeleteAllOfOpts).To(Equal(o))
})
It("Should set DeleleteOptions", func() {
o := &client.DeleteAllOfOptions{DeleteOptions: client.DeleteOptions{GracePeriodSeconds: utilpointer.Int64Ptr(44)}}
newDeleteAllOfOpts := &client.DeleteAllOfOptions{}
o.ApplyToDeleteAllOf(newDeleteAllOfOpts)
Expect(newDeleteAllOfOpts).To(Equal(o))
})
})

0 comments on commit dd6ead6

Please sign in to comment.