labels: Add LabelDistributionSource

vvoland · vvoland · commit dd3eedf3c35c · 2023-03-08T10:01:58.000+01:00
Add a public const for "containerd.io/distribution.source" in `labels`
package and replace hardcoded usages.

Signed-off-by: Paweł Gronowski &lt;pawel.gronowski@docker.com&gt;
diff --git a/integration/client/image_test.go b/integration/client/image_test.go
@@ -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"
 )
@@ -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)
diff --git a/labels/labels.go b/labels/labels.go
@@ -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 indicate its origin.
+// e.g., "containerd.io/distribution.source.docker.io=library/redis"
+const LabelDistributionSource = "containerd.io/distribution.source"
diff --git a/remotes/docker/handler.go b/remotes/docker/handler.go
@@ -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)
@@ -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
diff --git a/remotes/docker/handler_test.go b/remotes/docker/handler_test.go
@@ -20,6 +20,7 @@ import (
 	"reflect"
 	"testing"
 
+	"github.com/containerd/containerd/labels"
 	"github.com/containerd/containerd/reference"
 )
 
@@ -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)
 	}
@@ -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",
 		},
 	} {
diff --git a/remotes/handlers.go b/remotes/handlers.go
@@ -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"
@@ -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
 				}
 

Original file line number	Diff line number	Diff line change
`@@ -30,11 +30,6 @@ import (`
`30`	`30`	`ocispec "github.com/opencontainers/image-spec/specs-go/v1"`
`31`	`31`	`)`
`32`	`32`
`33`		`-var (`
`34`		`- // labelDistributionSource describes the source blob comes from.`
`35`		`- labelDistributionSource = "containerd.io/distribution.source"`
`36`		`-)`
`37`		`-`
`38`	`33`	`// AppendDistributionSourceLabel updates the label of blob with distribution source.`
`39`	`34`	`func AppendDistributionSourceLabel(manager content.Manager, ref string) (images.HandlerFunc, error) {`
`40`	`35`	`refspec, err := reference.Parse(ref)`
`@@ -108,7 +103,7 @@ func appendDistributionSourceLabel(originLabel, repo string) string {`
`108`	`103`	`}`
`109`	`104`
`110`	`105`	`func distributionSourceLabelKey(source string) string {`
`111`		`- return fmt.Sprintf("%s.%s", labelDistributionSource, source)`
	`106`	`+ return fmt.Sprintf("%s.%s", labels.LabelDistributionSource, source)`
`112`	`107`	`}`
`113`	`108`
`114`	`109`	`// selectRepositoryMountCandidate will select the repo which has longest`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ import (`
`20`	`20`	`"reflect"`
`21`	`21`	`"testing"`
`22`	`22`
	`23`	`+ "github.com/containerd/containerd/labels"`
`23`	`24`	`"github.com/containerd/containerd/reference"`
`24`	`25`	`)`
`25`	`26`
`@@ -69,7 +70,7 @@ func TestAppendDistributionLabel(t *testing.T) {`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`func TestDistributionSourceLabelKey(t *testing.T) {`
`72`		`- expected := "containerd.io/distribution.source.testsource"`
	`73`	`+ expected := labels.LabelDistributionSource + ".testsource"`
`73`	`74`	`if got := distributionSourceLabelKey("testsource"); !reflect.DeepEqual(got, expected) {`
`74`	`75`	`t.Fatalf("expected %v, but got %v", expected, got)`
`75`	`76`	`}`
`@@ -116,12 +117,12 @@ func TestSelectRepositoryMountCandidate(t *testing.T) {`
`116`	`117`	`},`
`117`	`118`	`{`
`118`	`119`	`refspec: reference.Spec{Locator: "user@host/path"},`
`119`		`- source: map[string]string{"containerd.io/distribution.source.host": "foo,path,bar"},`
	`120`	`+ source: map[string]string{labels.LabelDistributionSource + ".host": "foo,path,bar"},`
`120`	`121`	`expected: "bar",`
`121`	`122`	`},`
`122`	`123`	`{`
`123`	`124`	`refspec: reference.Spec{Locator: "user@host/path"},`
`124`		`- source: map[string]string{"containerd.io/distribution.source.host": "foo,bar,path"},`
	`125`	`+ source: map[string]string{labels.LabelDistributionSource + ".host": "foo,bar,path"},`
`125`	`126`	`expected: "bar",`
`126`	`127`	`},`
`127`	`128`	`} {`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ import (`
`28`	`28`	`"github.com/containerd/containerd/content"`
`29`	`29`	`"github.com/containerd/containerd/errdefs"`
`30`	`30`	`"github.com/containerd/containerd/images"`
	`31`	`+ "github.com/containerd/containerd/labels"`
`31`	`32`	`"github.com/containerd/containerd/log"`
`32`	`33`	`"github.com/containerd/containerd/platforms"`
`33`	`34`	`ocispec "github.com/opencontainers/image-spec/specs-go/v1"`
`@@ -367,7 +368,7 @@ func annotateDistributionSourceHandler(f images.HandlerFunc, manager content.Man`
`367`	`368`	`}`
`368`	`369`
`369`	`370`	`for k, v := range info.Labels {`
`370`		`- if !strings.HasPrefix(k, "containerd.io/distribution.source.") {`
	`371`	`+ if !strings.HasPrefix(k, labels.LabelDistributionSource+".") {`
`371`	`372`	`continue`
`372`	`373`	`}`
`373`	`374`