1515package remote_test
1616
1717import (
18+ "errors"
1819 "fmt"
20+ "net/http"
1921 "net/http/httptest"
2022 "net/url"
23+ "strings"
24+ "sync"
2125 "testing"
2226
2327 "github.com/google/go-cmp/cmp"
@@ -27,6 +31,7 @@ import (
2731 "github.com/google/go-containerregistry/pkg/v1/mutate"
2832 "github.com/google/go-containerregistry/pkg/v1/random"
2933 "github.com/google/go-containerregistry/pkg/v1/remote"
34+ "github.com/google/go-containerregistry/pkg/v1/remote/transport"
3035 "github.com/google/go-containerregistry/pkg/v1/types"
3136)
3237
@@ -215,3 +220,150 @@ func TestReferrers(t *testing.T) {
215220 }
216221 }
217222}
223+
224+ func TestReferrersTagFallbackDisabled (t * testing.T ) {
225+ // Push a subject image and an image referring to it, with the fallback
226+ // tag scheme disabled.
227+ pushWithSubject := func (t * testing.T , host string ) (rootDigest v1.Hash , leafDigest v1.Hash , err error ) {
228+ rootRef , err := name .ParseReference (fmt .Sprintf ("%s/repo:root" , host ))
229+ if err != nil {
230+ t .Fatal (err )
231+ }
232+ rootImg , err := random .Image (10 , 10 )
233+ if err != nil {
234+ t .Fatal (err )
235+ }
236+ if err := remote .Write (rootRef , rootImg , remote .WithReferrersTagFallback (false )); err != nil {
237+ t .Fatal (err )
238+ }
239+ rootDigest , err = rootImg .Digest ()
240+ if err != nil {
241+ t .Fatal (err )
242+ }
243+ rootSize , err := rootImg .Size ()
244+ if err != nil {
245+ t .Fatal (err )
246+ }
247+ rootMediaType , err := rootImg .MediaType ()
248+ if err != nil {
249+ t .Fatal (err )
250+ }
251+
252+ leafRef , err := name .ParseReference (fmt .Sprintf ("%s/repo:leaf" , host ))
253+ if err != nil {
254+ t .Fatal (err )
255+ }
256+ leafImg , err := random .Image (20 , 20 )
257+ if err != nil {
258+ t .Fatal (err )
259+ }
260+ leafImg = mutate .Subject (leafImg , v1.Descriptor {
261+ Digest : rootDigest ,
262+ Size : rootSize ,
263+ MediaType : rootMediaType ,
264+ }).(v1.Image )
265+ leafDigest , err = leafImg .Digest ()
266+ if err != nil {
267+ t .Fatal (err )
268+ }
269+ return rootDigest , leafDigest , remote .Write (leafRef , leafImg , remote .WithReferrersTagFallback (false ))
270+ }
271+
272+ // The fallback tag should never be created with the fallback disabled.
273+ checkNoFallbackTag := func (t * testing.T , host string , rootDigest v1.Hash ) {
274+ fallbackRef , err := name .ParseReference (fmt .Sprintf ("%s/repo:sha256-%s" , host , rootDigest .Hex ))
275+ if err != nil {
276+ t .Fatal (err )
277+ }
278+ if _ , err := remote .Head (fallbackRef ); err == nil {
279+ t .Errorf ("Head(%q) succeeded, want NotFound" , fallbackRef )
280+ } else {
281+ var terr * transport.Error
282+ if ! errors .As (err , & terr ) || terr .StatusCode != http .StatusNotFound {
283+ t .Errorf ("Head(%q) = %v, want NotFound" , fallbackRef , err )
284+ }
285+ }
286+ }
287+
288+ referrersDigest := func (t * testing.T , host string , rootDigest v1.Hash ) name.Digest {
289+ repo , err := name .NewRepository (fmt .Sprintf ("%s/repo" , host ))
290+ if err != nil {
291+ t .Fatal (err )
292+ }
293+ return repo .Digest (rootDigest .String ())
294+ }
295+
296+ t .Run ("registry without referrers API" , func (t * testing.T ) {
297+ // An OCI 1.0 registry (without referrers API), instrumented to record
298+ // requests to the referrers endpoint.
299+ reg := registry .New ()
300+ var mu sync.Mutex
301+ referrersProbes := 0
302+ s := httptest .NewServer (http .HandlerFunc (func (w http.ResponseWriter , r * http.Request ) {
303+ if strings .Contains (r .URL .Path , "/referrers/" ) {
304+ mu .Lock ()
305+ referrersProbes ++
306+ mu .Unlock ()
307+ }
308+ reg .ServeHTTP (w , r )
309+ }))
310+ defer s .Close ()
311+ u , err := url .Parse (s .URL )
312+ if err != nil {
313+ t .Fatal (err )
314+ }
315+
316+ // Pushing a subject-bearing manifest requires the Referrers API.
317+ rootDigest , _ , err := pushWithSubject (t , u .Host )
318+ if err == nil {
319+ t .Fatal ("Write() succeeded, want error" )
320+ } else if ! strings .Contains (err .Error (), "referrers tag fallback is disabled" ) {
321+ t .Fatalf ("Write() = %v, want referrers tag fallback error" , err )
322+ }
323+
324+ mu .Lock ()
325+ probes := referrersProbes
326+ mu .Unlock ()
327+ if probes != 1 {
328+ t .Errorf ("pushing probed the referrers endpoint %d times, want 1" , probes )
329+ }
330+
331+ checkNoFallbackTag (t , u .Host , rootDigest )
332+
333+ // Listing referrers requires the Referrers API too.
334+ if _ , err := remote .Referrers (referrersDigest (t , u .Host , rootDigest ), remote .WithReferrersTagFallback (false )); err == nil {
335+ t .Fatal ("Referrers() succeeded, want error" )
336+ } else if ! strings .Contains (err .Error (), "referrers tag fallback is disabled" ) {
337+ t .Fatalf ("Referrers() = %v, want referrers tag fallback error" , err )
338+ }
339+ })
340+
341+ t .Run ("registry with referrers API" , func (t * testing.T ) {
342+ s := httptest .NewServer (registry .New (registry .WithReferrersSupport (true )))
343+ defer s .Close ()
344+ u , err := url .Parse (s .URL )
345+ if err != nil {
346+ t .Fatal (err )
347+ }
348+
349+ rootDigest , leafDigest , err := pushWithSubject (t , u .Host )
350+ if err != nil {
351+ t .Fatal (err )
352+ }
353+
354+ checkNoFallbackTag (t , u .Host , rootDigest )
355+
356+ // The registry serves the referrer natively.
357+ index , err := remote .Referrers (referrersDigest (t , u .Host , rootDigest ), remote .WithReferrersTagFallback (false ))
358+ if err != nil {
359+ t .Fatal (err )
360+ }
361+ m , err := index .IndexManifest ()
362+ if err != nil {
363+ t .Fatal (err )
364+ }
365+ if len (m .Manifests ) != 1 || m .Manifests [0 ].Digest != leafDigest {
366+ t .Fatalf ("referrers = %v, want one entry for %s" , m .Manifests , leafDigest )
367+ }
368+ })
369+ }
0 commit comments