File: graph_test.go

package info (click to toggle)
oras 1.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,752 kB
  • sloc: sh: 157; makefile: 147
file content (363 lines) | stat: -rw-r--r-- 13,504 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
/*
Copyright The ORAS 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 graph

import (
	"context"
	"encoding/json"
	"errors"
	"reflect"
	"strconv"
	"testing"

	"github.com/opencontainers/go-digest"
	"github.com/opencontainers/image-spec/specs-go"
	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
	"oras.land/oras-go/v2"
	"oras.land/oras-go/v2/content"
	"oras.land/oras-go/v2/content/memory"
	"oras.land/oras/internal/docker"
	"oras.land/oras/internal/testutils"
)

func TestSuccessors(t *testing.T) {
	mockFetcher := testutils.NewMockFetcher()
	fetcher := mockFetcher.Fetcher
	ctx := context.Background()
	type args struct {
		ctx     context.Context
		fetcher content.Fetcher
		node    ocispec.Descriptor
	}
	tests := []struct {
		name        string
		args        args
		wantNodes   []ocispec.Descriptor
		wantSubject *ocispec.Descriptor
		wantConfig  *ocispec.Descriptor
		wantErr     bool
	}{
		{"should failed to get non-existent OCI image", args{ctx, fetcher, ocispec.Descriptor{MediaType: ocispec.MediaTypeImageManifest}}, nil, nil, nil, true},
		{"should failed to get non-existent docker image", args{ctx, fetcher, ocispec.Descriptor{MediaType: docker.MediaTypeManifest}}, nil, nil, nil, true},
		{"should get successors of a docker image", args{ctx, fetcher, mockFetcher.DockerImage}, nil, nil, &mockFetcher.Config, false},
		{"should get successors of an OCI image", args{ctx, fetcher, mockFetcher.OciImage}, []ocispec.Descriptor{mockFetcher.ImageLayer}, &mockFetcher.Subject, &mockFetcher.Config, false},
		{"should get successors of an index", args{ctx, fetcher, mockFetcher.Index}, []ocispec.Descriptor{mockFetcher.Subject}, nil, nil, false},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			gotNodes, gotSubject, gotConfig, err := Successors(tt.args.ctx, tt.args.fetcher, tt.args.node)
			if (err != nil) != tt.wantErr {
				t.Errorf("Successors() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(gotNodes, tt.wantNodes) {
				t.Errorf("Successors() gotNodes = %v, want %v", gotNodes, tt.wantNodes)
			}
			if !reflect.DeepEqual(gotSubject, tt.wantSubject) {
				t.Errorf("Successors() gotSubject = %v, want %v", gotSubject, tt.wantSubject)
			}
			if !reflect.DeepEqual(gotConfig, tt.wantConfig) {
				t.Errorf("Successors() gotConfig = %v, want %v", gotConfig, tt.wantConfig)
			}
		})
	}
}

func TestDescriptor_GetSuccessors(t *testing.T) {
	mockFetcher := testutils.NewMockFetcher()

	allFilter := func(ocispec.Descriptor) bool {
		return true
	}
	got, err := FilteredSuccessors(context.Background(), mockFetcher.OciImage, mockFetcher.Fetcher, allFilter)
	if nil != err {
		t.Errorf("FilteredSuccessors unexpected error %v", err)
	}
	if len(got) != 3 {
		t.Errorf("Expected 2 successors got %v", len(got))
	}
	if mockFetcher.Subject.Digest != got[0].Digest {
		t.Errorf("FilteredSuccessors got %v, want %v", got[0], mockFetcher.Subject)
	}
	if mockFetcher.Config.Digest != got[1].Digest {
		t.Errorf("FilteredSuccessors got %v, want %v", got[1], mockFetcher.Subject)
	}

	noConfig := func(desc ocispec.Descriptor) bool {
		return desc.Digest != mockFetcher.Config.Digest
	}
	got, err = FilteredSuccessors(context.Background(), mockFetcher.OciImage, mockFetcher.Fetcher, noConfig)
	if nil != err {
		t.Errorf("FilteredSuccessors unexpected error %v", err)
	}
	if len(got) != 2 {
		t.Errorf("Expected 1 successors got %v", len(got))
	}
	if mockFetcher.Subject.Digest != got[0].Digest {
		t.Errorf("FilteredSuccessors got %v, want %v", got[0], mockFetcher.Subject)
	}

	got, err = FilteredSuccessors(context.Background(), ocispec.Descriptor{MediaType: ocispec.MediaTypeImageManifest}, mockFetcher.Fetcher, allFilter)
	if nil == err {
		t.Error("FilteredSuccessors expected error")
	}
	if got != nil {
		t.Errorf("FilteredSuccessors unexpected %v", got)
	}
}

func TestFindPredecessors(t *testing.T) {
	store := memory.New()
	ctx := context.Background()

	// prepare subjects
	var subjects []ocispec.Descriptor
	for i := range 2 {
		subject, err := oras.PackManifest(ctx, store, oras.PackManifestVersion1_1, "test/subject", oras.PackManifestOptions{
			ManifestAnnotations: map[string]string{
				"test.subject.number": strconv.Itoa(i),
			},
		})
		if err != nil {
			t.Fatalf("PackManifest unexpected error: %v", err)
		}
		subjects = append(subjects, subject)
	}

	// prepare referrers
	referrers := make(map[digest.Digest]ocispec.Descriptor)
	for _, subject := range subjects {
		for i := range 3 {
			referrer, err := oras.PackManifest(ctx, store, oras.PackManifestVersion1_1, "test/referrer", oras.PackManifestOptions{
				Subject: &subject,
				ManifestAnnotations: map[string]string{
					"test.referrer.number": strconv.Itoa(i),
				},
			})
			if err != nil {
				t.Fatalf("PackManifest unexpected error: %v", err)
			}
			referrers[referrer.Digest] = referrer
		}
	}

	// test FindPredecessors
	opts := oras.DefaultExtendedCopyGraphOptions
	gotReferrers, err := FindPredecessors(ctx, store, subjects, opts)
	if err != nil {
		t.Fatalf("FindPredecessors unexpected error: %v", err)
	}
	if len(gotReferrers) != len(referrers) {
		t.Fatalf("FindPredecessors got %d referrers, want %d", len(gotReferrers), len(referrers))
	}
	for _, got := range gotReferrers {
		wantReferrer, ok := referrers[got.Digest]
		if !ok {
			t.Errorf("FindPredecessors got unexpected referrer %v", got)
		}
		if !reflect.DeepEqual(got, wantReferrer) {
			t.Errorf("FindPredecessors got referrer %v, want %v", got, wantReferrer)
		}
	}
}

func TestRecursiveFindReferrers(t *testing.T) {
	// prepare test data
	ctx := context.Background()
	target := memory.New()

	// create manifests
	manifestDesc1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/manifest1", oras.PackManifestOptions{})
	if err != nil {
		t.Fatalf("failed to create manifest descriptor 1: %v", err)
	}
	manifestDesc2, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/manifest2", oras.PackManifestOptions{})
	if err != nil {
		t.Fatalf("failed to create manifest descriptor 2: %v", err)
	}
	// create flatten referrers
	referrerDesc1_1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/referrer1_1", oras.PackManifestOptions{Subject: &manifestDesc1})
	if err != nil {
		t.Fatalf("failed to create referrer descriptor 1: %v", err)
	}
	referrerDesc1_2, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/referrer1_2", oras.PackManifestOptions{Subject: &manifestDesc1})
	if err != nil {
		t.Fatalf("failed to create referrer descriptor 1: %v", err)
	}
	// create nested referrers
	referrerDesc2_1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/referrer2_1", oras.PackManifestOptions{Subject: &manifestDesc2})
	if err != nil {
		t.Fatalf("failed to create referrer descriptor 2: %v", err)
	}
	referrerDesc2_1_1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/referrer2_1_1", oras.PackManifestOptions{Subject: &referrerDesc2_1})
	if err != nil {
		t.Fatalf("failed to create referrer descriptor 2: %v", err)
	}
	// create index manifest
	index := ocispec.Index{
		Versioned: specs.Versioned{
			SchemaVersion: 2,
		},
		Manifests: []ocispec.Descriptor{
			manifestDesc1,
			manifestDesc2,
		},
	}
	indexBytes, err := json.Marshal(index)
	if err != nil {
		t.Fatalf("failed to marshal index manifest: %v", err)
	}
	indexDesc, err := oras.PushBytes(ctx, target, ocispec.MediaTypeImageIndex, indexBytes)
	if err != nil {
		t.Fatalf("failed to push index manifest: %v", err)
	}
	// add nested referrers to the index
	referrerDesc3_1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/index", oras.PackManifestOptions{Subject: &indexDesc})
	if err != nil {
		t.Fatalf("failed to create index referrer: %v", err)
	}
	referrerDesc3_1_1, err := oras.PackManifest(ctx, target, oras.PackManifestVersion1_1, "test/index_referrer1", oras.PackManifestOptions{Subject: &referrerDesc3_1})
	if err != nil {
		t.Fatalf("failed to create nested index referrer: %v", err)
	}

	t.Run("find referers for empty manifest list", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		if len(gotReferrers) != 0 {
			t.Errorf("RecursiveFindReferrers got %d referrers, want 0", len(gotReferrers))
		}
	})

	t.Run("find referrers for manifest without referrers", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{referrerDesc3_1_1}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		if len(gotReferrers) != 0 {
			t.Errorf("RecursiveFindReferrers got %d referrers, want 0", len(gotReferrers))
		}
	})

	t.Run("find referrers for manifest 1", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{manifestDesc1}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		wantReferrers := map[digest.Digest]ocispec.Descriptor{
			referrerDesc1_1.Digest: referrerDesc1_1,
			referrerDesc1_2.Digest: referrerDesc1_2,
		}
		if len(gotReferrers) != len(wantReferrers) {
			t.Fatalf("RecursiveFindReferrers got %d referrers, want %d", len(gotReferrers), len(wantReferrers))
		}
		for _, got := range gotReferrers {
			want, ok := wantReferrers[got.Digest]
			if !ok {
				t.Errorf("RecursiveFindReferrers got unexpected referrer %v", got)
			}
			if !reflect.DeepEqual(got, want) {
				t.Errorf("RecursiveFindReferrers got referrer %v, want %v", got, want)
			}
		}
	})

	t.Run("find referrers for manifest 2", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{manifestDesc2}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		wantReferrers := map[digest.Digest]ocispec.Descriptor{
			referrerDesc2_1.Digest:   referrerDesc2_1,
			referrerDesc2_1_1.Digest: referrerDesc2_1_1,
		}
		if len(gotReferrers) != len(wantReferrers) {
			t.Fatalf("RecursiveFindReferrers got %d referrers, want %d", len(gotReferrers), len(wantReferrers))
		}
		for _, got := range gotReferrers {
			want, ok := wantReferrers[got.Digest]
			if !ok {
				t.Errorf("RecursiveFindReferrers got unexpected referrer %v", got)
			}
			if !reflect.DeepEqual(got, want) {
				t.Errorf("RecursiveFindReferrers got referrer %v, want %v", got, want)
			}
		}
	})

	t.Run("find referrers for manifest 1 and 2", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{manifestDesc1, manifestDesc2}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		wantReferrers := map[digest.Digest]ocispec.Descriptor{
			referrerDesc1_1.Digest:   referrerDesc1_1,
			referrerDesc1_2.Digest:   referrerDesc1_2,
			referrerDesc2_1.Digest:   referrerDesc2_1,
			referrerDesc2_1_1.Digest: referrerDesc2_1_1,
		}
		if len(gotReferrers) != len(wantReferrers) {
			t.Fatalf("RecursiveFindReferrers got %d referrers, want %d", len(gotReferrers), len(wantReferrers))
		}
		for _, got := range gotReferrers {
			want, ok := wantReferrers[got.Digest]
			if !ok {
				t.Errorf("RecursiveFindReferrers got unexpected referrer %v", got)
			}
			if !reflect.DeepEqual(got, want) {
				t.Errorf("RecursiveFindReferrers got referrer %v, want %v", got, want)
			}
		}
	})

	t.Run("find referrers for index manifest", func(t *testing.T) {
		gotReferrers, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{indexDesc}, oras.DefaultExtendedCopyGraphOptions)
		if err != nil {
			t.Fatalf("RecursiveFindReferrers unexpected error: %v", err)
		}
		wantReferrers := map[digest.Digest]ocispec.Descriptor{
			referrerDesc3_1.Digest:   referrerDesc3_1,
			referrerDesc3_1_1.Digest: referrerDesc3_1_1,
		}
		if len(gotReferrers) != len(wantReferrers) {
			t.Fatalf("RecursiveFindReferrers got %d referrers, want %d", len(gotReferrers), len(wantReferrers))
		}
		for _, got := range gotReferrers {
			want, ok := wantReferrers[got.Digest]
			if !ok {
				t.Errorf("RecursiveFindReferrers got unexpected referrer %v", got)
			}
			if !reflect.DeepEqual(got, want) {
				t.Errorf("RecursiveFindReferrers got referrer %v, want %v", got, want)
			}
		}
	})

	t.Run("bad FindPredecessors options", func(t *testing.T) {
		testErr := errors.New("test error")
		opts := oras.ExtendedCopyGraphOptions{
			FindPredecessors: func(ctx context.Context, src content.ReadOnlyGraphStorage, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) {
				return nil, testErr
			},
		}
		_, err := RecursiveFindReferrers(ctx, target, []ocispec.Descriptor{manifestDesc1}, opts)
		if !errors.Is(err, testErr) {
			t.Errorf("expected error %v, got %v", testErr, err)
		}
	})
}