feat: add support to set labels without selector #5741

Mrflatt · 2024-08-03T08:58:14Z

Tries to solve issue: #3866

Based on existing feature merged in #4486, uses same command flags with edit set label
Set label removes existing duplicate labels from commonLabels, and labels where includeTemplates value does not match.

Duplicate of #4478, added modifications to command flags and test

linux-foundation-easycla · 2024-08-03T08:58:18Z

The committers listed above are authorized under a signed CLA.

✅ login: Mrflatt / name: Lauri (3290329, 4fb55f1)

k8s-ci-robot · 2024-08-03T08:58:22Z

Welcome @Mrflatt!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-08-03T08:58:23Z

Hi @Mrflatt. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot · 2024-08-03T08:58:36Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Mrflatt
Once this PR has been reviewed and has the lgtm label, please assign stormqueen1990 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

kustomize/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2024-08-03T09:18:33Z

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

stormqueen1990 · 2024-08-28T20:26:56Z

kustomize/commands/edit/set/setlabel.go

+func (o *setLabelOptions) removeDuplicateLabels(m *types.Kustomization) {
+	for k := range o.metadata {
+		delete(m.CommonLabels, k)
+		for idx, label := range m.Labels {
+			if label.IncludeTemplates != o.includeTemplates {
+				m.Labels = deleteLabel(k, label, m.Labels, idx)
+			}
+			if label.IncludeSelectors {
+				m.Labels = deleteLabel(k, label, m.Labels, idx)
+			}
+		}
+	}
+}
+
+func deleteLabel(key string, label types.Label, labels []types.Label, idx int) []types.Label {
+	delete(label.Pairs, key)
+	if len(label.Pairs) == 0 {
+		labels = append(labels[:idx], labels[idx+1:]...)
+	}
+	return labels
+}


Could you please add some comments explaining the mechanism of action of these functions to deduplicate existing labels?

stormqueen1990 · 2024-08-28T21:12:35Z

kustomize/commands/edit/set/setlabel_test.go

Is there any specific reason to use assert instead of require for the Equal assertions?

No, all of these should be require, will change all of them.

stormqueen1990 · 2024-08-28T21:13:00Z

/label tide/merge-method-squash

stormqueen1990 · 2024-09-03T20:02:55Z

/test all

stormqueen1990

Hi there, @Mrflatt! 👋🏻

Thank you for your contribution!

This looks mostly LGTM. I just have one outstanding question: I noticed you wrote code to deduplicate labels when --without-selector is specified, but this current logic still duplicates labels when you execute the following sequence of commands:

Run kustomize edit set label test:value1:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
commonLabels:
  test: value1

After that, run kustomize edit set label test:value2 --without-selector. This will remove the previously added label and replace it with an entry to the labels key, as expected:
```
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
labels:
- pairs:
    test: value2
```

However, if I again run kustomize edit set label test:value3, this will cause a duplicate in commonLabels:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
labels:
- pairs:
    test: value2
commonLabels:
  test: value3

Would you be interested in addressing this use case as part of this PR as well?

Mrflatt · 2024-09-04T03:58:17Z

Hi there, @Mrflatt! 👋🏻

Thank you for your contribution!

This looks mostly LGTM. I just have one outstanding question: I noticed you wrote code to deduplicate labels when --without-selector is specified, but this current logic still duplicates labels when you execute the following sequence of commands:
Run kustomize edit set label test:value1:
apiVersion: kustomize.config.k8s.io/v1beta1

kind: Kustomization

commonLabels:

  test: value1
After that, run kustomize edit set label test:value2 --without-selector. This will remove the previously added label and replace it with an entry to the labels key, as expected:
apiVersion: kustomize.config.k8s.io/v1beta1

kind: Kustomization

labels:

- pairs:

    test: value2
However, if I again run kustomize edit set label test:value3, this will cause a duplicate in commonLabels:
apiVersion: kustomize.config.k8s.io/v1beta1

kind: Kustomization

labels:

- pairs:

    test: value2

commonLabels:

  test: value3
Would you be interested in addressing this use case as part of this PR as well?

@stormqueen1990 Yeah, will fix that also. Would solution be to remove labels and add commonLabel? Or modify labels and not add deprecated commonLabel, which would a bit change to functionality

stormqueen1990 · 2024-09-09T18:12:42Z

@stormqueen1990 Yeah, will fix that also. Would solution be to remove labels and add commonLabel? Or modify labels and not add deprecated commonLabel, which would a bit change to functionality

Hi again, @Mrflatt!

In my opinion the request of the user should be honoured. So if the command issued had --without-selector specified, the labels field should be retained; otherwise, the commonLabels field should be retained.

The main goal for my request was ensuring kustomize edit fix will still work after using this command. It will fail if there are duplicates between these two fields (which makes sense).

Mrflatt · 2024-09-09T20:02:45Z

@stormqueen1990 Yeah, will fix that also. Would solution be to remove labels and add commonLabel? Or modify labels and not add deprecated commonLabel, which would a bit change to functionality

Hi again, @Mrflatt!

In my opinion the request of the user should be honoured. So if the command issued had --without-selector specified, the labels field should be retained; otherwise, the commonLabels field should be retained.

The main goal for my request was ensuring kustomize edit fix will still work after using this command. It will fail if there are duplicates between these two fields (which makes sense).

Yeap, it should be fixed. Also simplified duplicate label removing.

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 3, 2024

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 3, 2024

k8s-ci-robot requested review from stormqueen1990 and varshaprasad96 August 3, 2024 08:58

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 3, 2024

Mrflatt force-pushed the kustomize-edit-set-label branch from 9e0ec32 to 4d88162 Compare August 3, 2024 09:24

stormqueen1990 reviewed Aug 28, 2024

View reviewed changes

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 28, 2024

Mrflatt force-pushed the kustomize-edit-set-label branch from 4d88162 to 54e367b Compare August 30, 2024 04:30

add support to set labels without selector

3290329

Mrflatt force-pushed the kustomize-edit-set-label branch from 54e367b to 3290329 Compare August 30, 2024 04:47

stormqueen1990 reviewed Sep 3, 2024

View reviewed changes

Fix removing duplicate label when setting common label

4fb55f1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support to set labels without selector #5741

feat: add support to set labels without selector #5741

Mrflatt commented Aug 3, 2024

linux-foundation-easycla bot commented Aug 3, 2024 •

edited

Loading

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

stormqueen1990 Aug 28, 2024

stormqueen1990 Aug 28, 2024

Mrflatt Aug 29, 2024 •

edited

Loading

stormqueen1990 commented Aug 28, 2024

stormqueen1990 commented Sep 3, 2024

stormqueen1990 left a comment

Mrflatt commented Sep 4, 2024 •

edited

Loading

stormqueen1990 commented Sep 9, 2024

Mrflatt commented Sep 9, 2024 •

edited

Loading

feat: add support to set labels without selector #5741

Are you sure you want to change the base?

feat: add support to set labels without selector #5741

Conversation

Mrflatt commented Aug 3, 2024

linux-foundation-easycla bot commented Aug 3, 2024 • edited Loading

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

k8s-ci-robot commented Aug 3, 2024

stormqueen1990 Aug 28, 2024

Choose a reason for hiding this comment

stormqueen1990 Aug 28, 2024

Choose a reason for hiding this comment

Mrflatt Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

stormqueen1990 commented Aug 28, 2024

stormqueen1990 commented Sep 3, 2024

stormqueen1990 left a comment

Choose a reason for hiding this comment

Mrflatt commented Sep 4, 2024 • edited Loading

stormqueen1990 commented Sep 9, 2024

Mrflatt commented Sep 9, 2024 • edited Loading

linux-foundation-easycla bot commented Aug 3, 2024 •

edited

Loading

Mrflatt Aug 29, 2024 •

edited

Loading

Mrflatt commented Sep 4, 2024 •

edited

Loading

Mrflatt commented Sep 9, 2024 •

edited

Loading