Skip to content

Commit

Permalink
labels: Add LabelDistributionSource
Browse files Browse the repository at this point in the history
Remove hardcoded usages of "containerd.io/distribution.source" label and
add a public const for it in `labels` package.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
  • Loading branch information
vvoland committed Mar 7, 2023
1 parent 2be87c1 commit be8230b
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 11 deletions.
3 changes: 2 additions & 1 deletion integration/client/image_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"github.com/containerd/containerd/errdefs"
"github.com/containerd/containerd/images"
imagelist "github.com/containerd/containerd/integration/images"
"github.com/containerd/containerd/labels"
"github.com/containerd/containerd/platforms"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)
Expand Down Expand Up @@ -105,7 +106,7 @@ func TestImagePullWithDistSourceLabel(t *testing.T) {
defer client.ImageService().Delete(ctx, imageName)

cs := client.ContentStore()
key := fmt.Sprintf("containerd.io/distribution.source.%s", source)
key := labels.LabelDistributionSource + "." + source

// only check the target platform
childrenHandler := images.LimitManifests(images.ChildrenHandler(cs), pMatcher, 1)
Expand Down
4 changes: 4 additions & 0 deletions labels/labels.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ const LabelUncompressed = "containerd.io/uncompressed"
// LabelSharedNamespace is added to a namespace to allow that namespaces
// contents to be shared.
const LabelSharedNamespace = "containerd.io/namespace.shareable"

// LabelDistributionSource is added to content to reference the source
// repository it was obtained from.
const LabelDistributionSource = "containerd.io/distribution.source"
7 changes: 1 addition & 6 deletions remotes/docker/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,6 @@ import (
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)

var (
// labelDistributionSource describes the source blob comes from.
labelDistributionSource = "containerd.io/distribution.source"
)

// AppendDistributionSourceLabel updates the label of blob with distribution source.
func AppendDistributionSourceLabel(manager content.Manager, ref string) (images.HandlerFunc, error) {
refspec, err := reference.Parse(ref)
Expand Down Expand Up @@ -108,7 +103,7 @@ func appendDistributionSourceLabel(originLabel, repo string) string {
}

func distributionSourceLabelKey(source string) string {
return fmt.Sprintf("%s.%s", labelDistributionSource, source)
return fmt.Sprintf("%s.%s", labels.LabelDistributionSource, source)
}

// selectRepositoryMountCandidate will select the repo which has longest
Expand Down
7 changes: 4 additions & 3 deletions remotes/docker/handler_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"reflect"
"testing"

"github.com/containerd/containerd/labels"
"github.com/containerd/containerd/reference"
)

Expand Down Expand Up @@ -69,7 +70,7 @@ func TestAppendDistributionLabel(t *testing.T) {
}

func TestDistributionSourceLabelKey(t *testing.T) {
expected := "containerd.io/distribution.source.testsource"
expected := labels.LabelDistributionSource + ".testsource"
if got := distributionSourceLabelKey("testsource"); !reflect.DeepEqual(got, expected) {
t.Fatalf("expected %v, but got %v", expected, got)
}
Expand Down Expand Up @@ -116,12 +117,12 @@ func TestSelectRepositoryMountCandidate(t *testing.T) {
},
{
refspec: reference.Spec{Locator: "user@host/path"},
source: map[string]string{"containerd.io/distribution.source.host": "foo,path,bar"},
source: map[string]string{labels.LabelDistributionSource + ".host": "foo,path,bar"},
expected: "bar",
},
{
refspec: reference.Spec{Locator: "user@host/path"},
source: map[string]string{"containerd.io/distribution.source.host": "foo,bar,path"},
source: map[string]string{labels.LabelDistributionSource + ".host": "foo,bar,path"},
expected: "bar",
},
} {
Expand Down
3 changes: 2 additions & 1 deletion remotes/handlers.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
"github.com/containerd/containerd/content"
"github.com/containerd/containerd/errdefs"
"github.com/containerd/containerd/images"
"github.com/containerd/containerd/labels"
"github.com/containerd/containerd/log"
"github.com/containerd/containerd/platforms"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
Expand Down Expand Up @@ -367,7 +368,7 @@ func annotateDistributionSourceHandler(f images.HandlerFunc, manager content.Man
}

for k, v := range info.Labels {
if !strings.HasPrefix(k, "containerd.io/distribution.source.") {
if !strings.HasPrefix(k, labels.LabelDistributionSource+".") {
continue
}

Expand Down

0 comments on commit be8230b

Please sign in to comment.