Skip to content
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

Jump to bottom

Automated backport of #1001: Add IdentfyingLabels to CreateOrUpdateWithOptions #1003

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Automated backport of #1001: Add IdentfyingLabels to CreateOrUpdateWithOptions #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions pkg/util/create_or_update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ type CreateOrUpdateOptions[T runtime.Object] struct {
Obj T
MutateOnUpdate MutateFn[T]
MutateOnCreate MutateFn[T]
// IdentifyingLabels is used to find an existing resource if GenerateName is set in the target resource.
IdentifyingLabels map[string]string
}

func CreateOrUpdateWithOptions[T runtime.Object](ctx context.Context, options CreateOrUpdateOptions[T]) (OperationResult, T, error) {
Expand Down Expand Up @@ -121,7 +123,7 @@ func maybeCreateOrUpdate[T runtime.Object](ctx context.Context, options CreateOr
objMeta := resource.MustToMeta(options.Obj)

err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
existing, err := getResource(ctx, options.Client, options.Obj)
existing, err := getResource(ctx, &options)
if apierrors.IsNotFound(err) {
if op != opCreate {
logger.V(log.LIBTRACE).Infof("Resource %q does not exist - not updating", objMeta.GetName())
Expand Down Expand Up @@ -204,16 +206,23 @@ func maybeCreateOrUpdate[T runtime.Object](ctx context.Context, options CreateOr
}

//nolint:wrapcheck // No need to wrap errors
func getResource[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T) (T, error) {
objMeta := resource.MustToMeta(obj)
func getResource[T runtime.Object](ctx context.Context, options *CreateOrUpdateOptions[T]) (T, error) {
objMeta := resource.MustToMeta(options.Obj)

if objMeta.GetName() != "" || objMeta.GetGenerateName() == "" {
obj, err := client.Get(ctx, objMeta.GetName(), metav1.GetOptions{})
obj, err := options.Client.Get(ctx, objMeta.GetName(), metav1.GetOptions{})
return obj, err
}

list, err := client.List(ctx, metav1.ListOptions{
LabelSelector: labels.SelectorFromSet(objMeta.GetLabels()).String(),
var selectorLabels map[string]string
if len(options.IdentifyingLabels) > 0 {
selectorLabels = options.IdentifyingLabels
} else {
selectorLabels = objMeta.GetLabels()
}

list, err := options.Client.List(ctx, metav1.ListOptions{
LabelSelector: labels.SelectorFromSet(selectorLabels).String(),
})
if err != nil {
return *new(T), err
Expand Down
25 changes: 17 additions & 8 deletions pkg/util/create_or_update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,23 @@ var _ = Describe("CreateOrUpdate function", func() {
t := newCreateOrUpdateTestDiver()

createOrUpdate := func(expResult util.OperationResult) error {
result, err := util.CreateOrUpdate[*unstructured.Unstructured](context.TODO(), resource.ForDynamic(t.client),
resource.MustToUnstructured(t.pod), t.mutateFn)
options := util.CreateOrUpdateOptions[*unstructured.Unstructured]{
Client: resource.ForDynamic(t.client),
MutateOnUpdate: t.mutateFn,
}

if t.pod.GenerateName != "" {
options.IdentifyingLabels = map[string]string{}
for k, v := range t.pod.Labels {
options.IdentifyingLabels[k] = v
}

t.pod.Labels["new-label"] = "new-value"
}

options.Obj = resource.MustToUnstructured(t.pod)

result, _, err := util.CreateOrUpdateWithOptions[*unstructured.Unstructured](context.TODO(), options)
if err != nil && expResult != util.OperationResultNone {
return err
}
Expand All @@ -167,12 +182,6 @@ var _ = Describe("CreateOrUpdate function", func() {
})

Context("and a mutation function specified", func() {
BeforeEach(func() {
t.pod.Name = ""
t.pod.GenerateName = "name-prefix-"
t.pod.Labels = map[string]string{"label1": "value1", "label2": "value2"}
})

It("should invoke the function on create", func() {
result, created, err := util.CreateOrUpdateWithOptions[*unstructured.Unstructured](context.TODO(),
util.CreateOrUpdateOptions[*unstructured.Unstructured]{
Expand Down
Loading