Skip to content

Commit

Permalink
Fix order of operations when setting lease labels
Browse files Browse the repository at this point in the history
Fixes an edge case where `WithLabels` would overwrite `WithExpiration`
on a lease when using client options.

Signed-off-by: Austin Vazquez <macedonv@amazon.com>
  • Loading branch information
austinvazquez committed Nov 22, 2022
1 parent 8e78754 commit b0a1057
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 2 deletions.
9 changes: 7 additions & 2 deletions leases/lease.go
Expand Up @@ -65,10 +65,15 @@ func SynchronousDelete(ctx context.Context, o *DeleteOptions) error {
return nil
}

// WithLabels sets labels on a lease
// WithLabels merges labels on a lease
func WithLabels(labels map[string]string) Opt {
return func(l *Lease) error {
l.Labels = labels
if l.Labels == nil {
l.Labels = map[string]string{}
}
for k, v := range labels {
l.Labels[k] = v
}
return nil
}
}
Expand Down
83 changes: 83 additions & 0 deletions leases/lease_test.go
@@ -0,0 +1,83 @@
/*
Copyright The containerd 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 leases

import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestWithLabels(t *testing.T) {
type unitTest struct {
name string
uut *Lease
labels map[string]string
expected map[string]string
}

addLabelsToEmptyMap := &unitTest{
name: "AddLabelsToEmptyMap",
uut: &Lease{},
labels: map[string]string{
"containerd.io/gc.root": "2015-12-04T00:00:00Z",
},
expected: map[string]string{
"containerd.io/gc.root": "2015-12-04T00:00:00Z",
},
}

addLabelsToNonEmptyMap := &unitTest{
name: "AddLabelsToNonEmptyMap",
uut: &Lease{
Labels: map[string]string{
"containerd.io/gc.expire": "2015-12-05T00:00:00Z",
},
},
labels: map[string]string{
"containerd.io/gc.root": "2015-12-04T00:00:00Z",
"containerd.io/gc.ref.snapshot.overlayfs": "sha256:87806a591ce894ff5c699c28fe02093d6cdadd6b1ad86819acea05ccb212ff3d",
},
expected: map[string]string{
"containerd.io/gc.root": "2015-12-04T00:00:00Z",
"containerd.io/gc.ref.snapshot.overlayfs": "sha256:87806a591ce894ff5c699c28fe02093d6cdadd6b1ad86819acea05ccb212ff3d",
"containerd.io/gc.expire": "2015-12-05T00:00:00Z",
},
}

testcases := []*unitTest{
addLabelsToEmptyMap,
addLabelsToNonEmptyMap,
}

for _, testcase := range testcases {
t.Run(testcase.name, func(t *testing.T) {
testcase := testcase

f := WithLabels(testcase.labels)

err := f(testcase.uut)
require.NoError(t, err)

for k, v := range testcase.expected {
assert.Contains(t, testcase.uut.Labels, k)
assert.Equal(t, v, testcase.uut.Labels[k])
}
})
}
}

0 comments on commit b0a1057

Please sign in to comment.