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.

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

Don’t replace existing labels #4105

Merged
merged 1 commit into from
May 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion pkg/skaffold/deploy/kubectl/labels.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ func (r *labelsSetter) Visit(o map[interface{}]interface{}, k interface{}, v int
}

for k, v := range r.labels {
labels[k] = v
// Don't replace existing label.
if _, present := labels[k]; !present {
labels[k] = v
}
}

return false
Expand Down
4 changes: 2 additions & 2 deletions pkg/skaffold/deploy/kubectl/labels_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright 2019 The Skaffold Authors
Copyright 2020 The Skaffold Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -63,7 +63,6 @@ kind: Pod
metadata:
labels:
key0: value0
key1: ignored
name: getting-started
spec:
containers:
Expand All @@ -87,6 +86,7 @@ spec:
`)}

resultManifest, err := manifests.SetLabels(map[string]string{
"key0": "should-be-ignored",
"key1": "value1",
"key2": "value2",
})
Expand Down
2 changes: 1 addition & 1 deletion pkg/skaffold/deploy/labels.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ func labelDeployResults(labels map[string]string, results []Artifact) {
func addLabels(labels map[string]string, accessor metav1.Object) {
kv := make(map[string]string)

copyMap(kv, accessor.GetLabels())
copyMap(kv, labels)
copyMap(kv, accessor.GetLabels())

accessor.SetLabels(kv)
}
Expand Down
117 changes: 117 additions & 0 deletions pkg/skaffold/deploy/labels_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
/*
Copyright 2019 The Skaffold Authors
dgageot marked this conversation as resolved.
Show resolved Hide resolved

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 deploy

import (
"testing"

v1 "k8s.io/api/apps/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/dynamic"
fakedynclient "k8s.io/client-go/dynamic/fake"
"k8s.io/client-go/kubernetes"
fakeclient "k8s.io/client-go/kubernetes/fake"
"k8s.io/client-go/kubernetes/scheme"

k8s "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes"
"github.com/GoogleContainerTools/skaffold/testutil"
)

func mockClient(m kubernetes.Interface) func() (kubernetes.Interface, error) {
return func() (kubernetes.Interface, error) {
return m, nil
}
}

func mockDynamicClient(m dynamic.Interface) func() (dynamic.Interface, error) {
return func() (dynamic.Interface, error) {
return m, nil
}
}

func TestLabelDeployResults(t *testing.T) {
tests := []struct {
description string
existingLabels map[string]string
appliedLabels map[string]string
expectedLabels map[string]string
}{
{
description: "set labels",
existingLabels: map[string]string{},
appliedLabels: map[string]string{
"key1": "value1",
"key2": "value2",
},
expectedLabels: map[string]string{
"key1": "value1",
"key2": "value2",
},
},
{
description: "add labels",
existingLabels: map[string]string{
"key0": "value0",
},
appliedLabels: map[string]string{
"key0": "should-be-ignored",
"key1": "value1",
},
expectedLabels: map[string]string{
"key0": "value0",
"key1": "value1",
},
},
}

for _, test := range tests {
testutil.Run(t, test.description, func(t *testutil.T) {
dep := &v1.Deployment{
TypeMeta: metav1.TypeMeta{
APIVersion: "apps/v1",
Kind: "Deployment",
},
ObjectMeta: metav1.ObjectMeta{
Name: "foo",
Labels: test.existingLabels,
},
}

// Mock Kubernetes
dgageot marked this conversation as resolved.
Show resolved Hide resolved
client := fakeclient.NewSimpleClientset(dep)
client.Resources = append(client.Resources, &metav1.APIResourceList{
GroupVersion: dep.APIVersion,
APIResources: []metav1.APIResource{{
Kind: dep.Kind,
Name: "deployments",
}},
})
t.Override(&k8s.Client, mockClient(client))
dynClient := fakedynclient.NewSimpleDynamicClient(scheme.Scheme, dep)
t.Override(&k8s.DynamicClient, mockDynamicClient(dynClient))

// Patch labels
labelDeployResults(test.appliedLabels, []Artifact{{Obj: dep}})

// Check modified value
modified, err := dynClient.Resource(schema.GroupVersionResource{Group: "apps", Version: "v1", Resource: "deployments"}).Get("foo", metav1.GetOptions{})
t.CheckNoError(err)
t.CheckDeepEqual(test.expectedLabels, modified.GetLabels())
})
}
}