File: tracker_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 (414 lines) | stat: -rw-r--r-- 11,599 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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/*
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 progress

import (
	"bytes"
	"errors"
	"io"
	"testing"
)

func TestTrackerFunc_Close(t *testing.T) {
	var f TrackerFunc
	if err := f.Close(); err != nil {
		t.Errorf("TrackerFunc.Close() error = %v, wantErr false", err)
	}
}

func TestTrackerFunc_Update(t *testing.T) {
	wantStatus := Status{
		State:  StateTransmitted,
		Offset: 42,
	}
	var wantErr error
	tracker := TrackerFunc(func(status Status, err error) error {
		if status != wantStatus {
			t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
		}
		if err != nil {
			t.Errorf("TrackerFunc err = %v, want nil", err)
		}
		return wantErr
	})

	if err := tracker.Update(wantStatus); err != wantErr {
		t.Errorf("TrackerFunc.Update() error = %v, want %v", err, wantErr)
	}

	wantErr = errors.New("fail to track")
	if err := tracker.Update(wantStatus); err != wantErr {
		t.Errorf("TrackerFunc.Update() error = %v, want %v", err, wantErr)
	}
}

func TestTrackerFunc_Fail(t *testing.T) {
	reportErr := errors.New("fail to process")
	var wantStatus Status
	var wantErr error
	tracker := TrackerFunc(func(status Status, err error) error {
		if status != wantStatus {
			t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
		}
		if err != reportErr {
			t.Errorf("TrackerFunc err = %v, want %v", err, reportErr)
		}
		return wantErr
	})

	if err := tracker.Fail(reportErr); err != wantErr {
		t.Errorf("TrackerFunc.Fail() error = %v, want %v", err, wantErr)
	}

	wantErr = errors.New("fail to track")
	if err := tracker.Fail(reportErr); err != wantErr {
		t.Errorf("TrackerFunc.Fail() error = %v, want %v", err, wantErr)
	}
}

func TestStart(t *testing.T) {
	tests := []struct {
		name    string
		t       Tracker
		wantErr bool
	}{
		{
			name: "successful report initialization",
			t: TrackerFunc(func(status Status, err error) error {
				if status.State != StateInitialized {
					t.Errorf("expected state to be StateInitialized, got %v", status.State)
				}
				return nil
			}),
		},
		{
			name: "fail to report initialization",
			t: TrackerFunc(func(status Status, err error) error {
				return errors.New("fail to track")
			}),
			wantErr: true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			if err := Start(tt.t); (err != nil) != tt.wantErr {
				t.Errorf("Start() error = %v, wantErr %v", err, tt.wantErr)
			}
		})
	}
}

func TestDone(t *testing.T) {
	tests := []struct {
		name    string
		t       Tracker
		wantErr bool
	}{
		{
			name: "successful report initialization",
			t: TrackerFunc(func(status Status, err error) error {
				if status.State != StateTransmitted {
					t.Errorf("expected state to be StateTransmitted, got %v", status.State)
				}
				return nil
			}),
		},
		{
			name: "fail to report initialization",
			t: TrackerFunc(func(status Status, err error) error {
				return errors.New("fail to track")
			}),
			wantErr: true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			if err := Done(tt.t); (err != nil) != tt.wantErr {
				t.Errorf("Done() error = %v, wantErr %v", err, tt.wantErr)
			}
		})
	}
}

func TestTrackReader(t *testing.T) {
	const bufSize = 6
	content := []byte("hello world")
	t.Run("track io.Reader", func(t *testing.T) {
		var wantStatus Status
		tracker := TrackerFunc(func(status Status, err error) error {
			if status != wantStatus {
				t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
			}
			if err != nil {
				t.Errorf("TrackerFunc err = %v, want nil", err)
			}
			return nil
		})
		var reader io.Reader = bytes.NewReader(content)
		reader = io.LimitReader(reader, int64(len(content))) // remove the io.WriterTo interface
		gotReader := TrackReader(tracker, reader)
		if _, ok := gotReader.(*readTracker); !ok {
			t.Fatalf("TrackReader() = %v, want *readTracker", gotReader)
		}

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: bufSize,
		}
		buf := make([]byte, bufSize)
		n, err := gotReader.Read(buf)
		if err != nil {
			t.Fatalf("TrackReader() error = %v, want nil", err)
		}
		if n != bufSize {
			t.Fatalf("TrackReader() n = %v, want %v", n, bufSize)
		}
		if want := content[:bufSize]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: int64(len(content)),
		}
		n, err = gotReader.Read(buf)
		if err != nil {
			t.Fatalf("TrackReader() error = %v, want nil", err)
		}
		if want := len(content) - bufSize; n != want {
			t.Fatalf("TrackReader() n = %v, want %v", n, want)
		}
		buf = buf[:n]
		if want := content[bufSize:]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}
	})

	t.Run("track io.Reader + io.WriterTo", func(t *testing.T) {
		var wantStatus Status
		tracker := TrackerFunc(func(status Status, err error) error {
			if status != wantStatus {
				t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
			}
			if err != nil {
				t.Errorf("TrackerFunc err = %v, want nil", err)
			}
			return nil
		})
		var reader io.Reader = bytes.NewReader(content)
		gotReader := TrackReader(tracker, reader)
		if _, ok := gotReader.(*readTrackerWriteTo); !ok {
			t.Fatalf("TrackReader() = %v, want *readTrackerWriteTo", gotReader)
		}

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: bufSize,
		}
		buf := make([]byte, bufSize)
		n, err := gotReader.Read(buf)
		if err != nil {
			t.Fatalf("TrackReader() error = %v, want nil", err)
		}
		if n != bufSize {
			t.Fatalf("TrackReader() n = %v, want %v", n, bufSize)
		}
		if want := content[:bufSize]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: int64(len(content)),
		}
		writeBuf := bytes.NewBuffer(nil)
		wn, err := gotReader.(io.WriterTo).WriteTo(writeBuf)
		if err != nil {
			t.Fatalf("TrackReader() error = %v, want nil", err)
		}
		if want := len(content) - bufSize; wn != int64(want) {
			t.Fatalf("TrackReader() n = %v, want %v", wn, want)
		}
		buf = writeBuf.Bytes()
		if want := content[bufSize:]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}
	})

	t.Run("empty io.Reader", func(t *testing.T) {
		tracker := TrackerFunc(func(status Status, err error) error {
			t.Errorf("TrackerFunc should not be called for empty read")
			return nil
		})
		gotReader := TrackReader(tracker, bytes.NewReader(nil))

		buf := make([]byte, bufSize)
		n, err := gotReader.Read(buf)
		if want := io.EOF; err != want {
			t.Fatalf("TrackReader() error = %v, want %v", err, want)
		}
		if want := 0; n != want {
			t.Fatalf("TrackReader() n = %v, want %v", n, want)
		}

		writeBuf := bytes.NewBuffer(nil)
		wn, err := gotReader.(io.WriterTo).WriteTo(writeBuf)
		if err != nil {
			t.Fatalf("TrackReader() error = %v, want nil", err)
		}
		if want := int64(0); wn != want {
			t.Fatalf("TrackReader() n = %v, want %v", wn, want)
		}
		buf = writeBuf.Bytes()
		if want := []byte{}; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}
	})

	t.Run("report failure", func(t *testing.T) {
		var wantStatus Status
		wantErr := errors.New("fail to track")
		trackerMockStage := 0
		tracker := TrackerFunc(func(status Status, err error) error {
			defer func() {
				trackerMockStage++
			}()
			switch trackerMockStage {
			case 0:
				if status != wantStatus {
					t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
				}
				if err != nil {
					t.Errorf("TrackerFunc err = %v, want nil", err)
				}
				return wantErr
			case 1:
				var emptyStatus Status
				if wantStatus := emptyStatus; status != wantStatus {
					t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
				}
				if err != wantErr {
					t.Errorf("TrackerFunc err = %v, want %v", err, wantErr)
				}
				return nil
			default:
				t.Errorf("TrackerFunc should not be called")
				return nil
			}
		})
		gotReader := TrackReader(tracker, bytes.NewReader(content))

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: bufSize,
		}
		buf := make([]byte, bufSize)
		n, err := gotReader.Read(buf)
		if err != wantErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, wantErr)
		}
		if n != bufSize {
			t.Fatalf("TrackReader() n = %v, want %v", n, bufSize)
		}
		if want := content[:bufSize]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}

		wantStatus = Status{
			State:  StateTransmitting,
			Offset: int64(len(content)),
		}
		trackerMockStage = 0
		writeBuf := bytes.NewBuffer(nil)
		wn, err := gotReader.(io.WriterTo).WriteTo(writeBuf)
		if err != wantErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, wantErr)
		}
		if want := len(content) - bufSize; wn != int64(want) {
			t.Fatalf("TrackReader() n = %v, want %v", wn, want)
		}
		buf = writeBuf.Bytes()
		if want := content[bufSize:]; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}
	})

	t.Run("process failure", func(t *testing.T) {
		reportErr := io.ErrClosedPipe
		var wantStatus Status
		var wantErr error
		tracker := TrackerFunc(func(status Status, err error) error {
			if status != wantStatus {
				t.Errorf("TrackerFunc status = %v, want %v", status, wantStatus)
			}
			if err != reportErr {
				t.Errorf("TrackerFunc err = %v, want %v", err, reportErr)
			}
			return wantErr
		})
		pipeReader, pipeWriter := io.Pipe()
		_ = pipeReader.Close()
		_ = pipeWriter.Close()
		gotReader := TrackReader(tracker, pipeReader)

		buf := make([]byte, bufSize)
		n, err := gotReader.Read(buf)
		if err != reportErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, reportErr)
		}
		if want := 0; n != want {
			t.Fatalf("TrackReader() n = %v, want %v", n, want)
		}

		wantErr = errors.New("fail to track")
		n, err = gotReader.Read(buf)
		if err != wantErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, wantErr)
		}
		if want := 0; n != want {
			t.Fatalf("TrackReader() n = %v, want %v", n, want)
		}

		gotReader = TrackReader(tracker, io.MultiReader(pipeReader)) // wrap io.WriteTo
		wantErr = nil
		writeBuf := bytes.NewBuffer(nil)
		wn, err := gotReader.(io.WriterTo).WriteTo(writeBuf)
		if err != reportErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, reportErr)
		}
		if want := int64(0); wn != want {
			t.Fatalf("TrackReader() n = %v, want %v", wn, want)
		}
		buf = writeBuf.Bytes()
		if want := []byte{}; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}

		gotReader = TrackReader(tracker, io.MultiReader(pipeReader)) // wrap io.WriteTo
		wantErr = errors.New("fail to track")
		wn, err = gotReader.(io.WriterTo).WriteTo(writeBuf)
		if err != wantErr {
			t.Fatalf("TrackReader() error = %v, want %v", err, wantErr)
		}
		if want := int64(0); wn != want {
			t.Fatalf("TrackReader() n = %v, want %v", wn, want)
		}
		buf = writeBuf.Bytes()
		if want := []byte{}; !bytes.Equal(buf, want) {
			t.Fatalf("TrackReader() buf = %v, want %v", buf, want)
		}
	})
}