refactor internal func

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
oras-project · Jul 24, 2023 · 103dd22 · 103dd22
1 parent 4388126
commit 103dd22
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 62 deletions.
diff --git a/registry/remote/referrers.go b/registry/remote/referrers.go
@@ -17,13 +17,11 @@ package remote
 
 import (
 	"errors"
-	"net/http"
 	"strings"
 
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"oras.land/oras-go/v2/content"
 	"oras.land/oras-go/v2/internal/descriptor"
-	"oras.land/oras-go/v2/internal/spec"
 )
 
 // zeroDigest represents a digest that consists of zeros. zeroDigest is used
@@ -111,22 +109,6 @@ func buildReferrersTag(desc ocispec.Descriptor) string {
 	return alg + "-" + encoded
 }
 
-// isAnnotationsContainReferrersFilter checks annotations to see if requested
-// is in the applied filter list.
-// Reference: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#listing-referrers
-func isAnnotationsContainReferrersFilter(annotations map[string]string, requested string) bool {
-	applied := annotations[spec.AnnotationReferrersFiltersApplied]
-	return isReferrersFilterApplied(applied, requested)
-}
-
-// isHeaderContainReferrersFilter checks headers of resp to see if requested
-// is in the applied filter list.
-// Reference: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc3/spec.md#listing-referrers
-func isHeaderContainReferrersFilter(resp *http.Response, requested string) bool {
-	applied := resp.Header.Get(headerOCIFiltersApplied)
-	return isReferrersFilterApplied(applied, requested)
-}
-
 // isReferrersFilterApplied checks if requsted is in the applied filter list.
 func isReferrersFilterApplied(applied, requested string) bool {
 	if applied == "" || requested == "" {

diff --git a/registry/remote/referrers_test.go b/registry/remote/referrers_test.go
@@ -61,65 +61,59 @@ func Test_buildReferrersTag(t *testing.T) {
 	}
 }
 
-func Test_isAnnotationsContainReferrersFilter(t *testing.T) {
+func Test_isReferrersFilterApplied(t *testing.T) {
 	tests := []struct {
-		name        string
-		annotations map[string]string
-		requested   string
-		want        bool
+		name      string
+		applied   string
+		requested string
+		want      bool
 	}{
 		{
-			name:        "single filter applied, specified filter matches",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: "artifactType"},
-			requested:   "artifactType",
-			want:        true,
+			name:      "single filter applied, specified filter matches",
+			applied:   "artifactType",
+			requested: "artifactType",
+			want:      true,
 		},
 		{
-			name:        "single filter applied, specified filter does not match",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: "foo"},
-			requested:   "artifactType",
-			want:        false,
+			name:      "single filter applied, specified filter does not match",
+			applied:   "foo",
+			requested: "artifactType",
+			want:      false,
 		},
 		{
-			name:        "multiple filters applied, specified filter matches",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: "foo,artifactType"},
-			requested:   "artifactType",
-			want:        true,
+			name:      "multiple filters applied, specified filter matches",
+			applied:   "foo,artifactType",
+			requested: "artifactType",
+			want:      true,
 		},
 		{
-			name:        "multiple filters applied, specified filter does not match",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: "foo,bar"},
-			requested:   "artifactType",
-			want:        false,
+			name:      "multiple filters applied, specified filter does not match",
+			applied:   "foo,bar",
+			requested: "artifactType",
+			want:      false,
 		},
 		{
-			name:        "single filter applied, specified filter empty",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: "foo"},
-			requested:   "",
-			want:        false,
+			name:      "single filter applied, no specified filter",
+			applied:   "foo",
+			requested: "",
+			want:      false,
 		},
 		{
-			name:        "no filter applied",
-			annotations: map[string]string{},
-			requested:   "artifactType",
-			want:        false,
+			name:      "no filter applied, specified filter does not match",
+			applied:   "",
+			requested: "artifactType",
+			want:      false,
 		},
 		{
-			name:        "empty filter applied",
-			annotations: map[string]string{spec.AnnotationReferrersFiltersApplied: ""},
-			requested:   "artifactType",
-			want:        false,
-		},
-		{
-			name:        "no filter applied, specified filter empty",
-			annotations: map[string]string{},
-			requested:   "",
-			want:        false,
+			name:      "no filter applied, no specified filter",
+			applied:   "",
+			requested: "",
+			want:      false,
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := isAnnotationsContainReferrersFilter(tt.annotations, tt.requested); got != tt.want {
+			if got := isReferrersFilterApplied(tt.applied, tt.requested); got != tt.want {
 				t.Errorf("isReferrersFilterApplied() = %v, want %v", got, tt.want)
 			}
 		})

diff --git a/registry/remote/repository.go b/registry/remote/repository.go
@@ -514,10 +514,12 @@ func (r *Repository) referrersPageByAPI(ctx context.Context, artifactType string
 	referrers := index.Manifests
 	if artifactType != "" {
 		requested := "artifactType"
-		// check both header and annotations for compatibility
-		// reference for header: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc3/spec.md#listing-referrers
-		// reference for annotations: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#listing-referrers
-		if !isHeaderContainReferrersFilter(resp, requested) && !isAnnotationsContainReferrersFilter(index.Annotations, requested) {
+		// check both filters header and filters annotations for compatibility
+		// reference for filters header: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc3/spec.md#listing-referrers
+		// reference for filters annotations: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#listing-referrers
+		filtersHeader := resp.Header.Get(headerOCIFiltersApplied)
+		filtersAnnotation := index.Annotations[spec.AnnotationReferrersFiltersApplied]
+		if !isReferrersFilterApplied(filtersHeader, requested) && !isReferrersFilterApplied(filtersAnnotation, requested) {
 			// perform client side filtering if the filter is not applied on the server side
 			referrers = filterReferrers(referrers, artifactType)
 		}