File: commit_test.go

package info (click to toggle)
golang-github-containers-buildah 1.41.4%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 8,148 kB
  • sloc: sh: 2,569; makefile: 241; perl: 187; asm: 16; awk: 12; ansic: 1
file content (580 lines) | stat: -rw-r--r-- 24,897 bytes parent folder | download | duplicates (2)
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
package buildah

import (
	"archive/tar"
	"context"
	"crypto/rand"
	"encoding/json"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"testing"
	"time"

	"github.com/containers/image/v5/manifest"
	ociLayout "github.com/containers/image/v5/oci/layout"
	imageStorage "github.com/containers/image/v5/storage"
	"github.com/containers/image/v5/transports"
	"github.com/containers/image/v5/types"
	"github.com/containers/storage"
	"github.com/containers/storage/pkg/archive"
	storageTypes "github.com/containers/storage/types"
	digest "github.com/opencontainers/go-digest"
	v1 "github.com/opencontainers/image-spec/specs-go/v1"
	rspec "github.com/opencontainers/runtime-spec/specs-go"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func makeFile(t *testing.T, base string, size int64) string {
	t.Helper()
	fn := filepath.Join(t.TempDir(), base)
	f, err := os.Create(fn)
	require.NoError(t, err)
	defer f.Close()
	if size == 0 {
		size = 512
	}
	_, err = io.CopyN(f, rand.Reader, size)
	require.NoErrorf(t, err, "writing payload file %d", base)
	return f.Name()
}

func TestCommitLinkedLayers(t *testing.T) {
	// This test cannot be parallelized as this uses NewBuilder()
	// which eventually and indirectly accesses a global variable
	// defined in `go-selinux`, this must be fixed at `go-selinux`
	// or builder must enable sometime of locking mechanism i.e if
	// routine is creating Builder other's must wait for it.
	// Tracked here: https://github.com/containers/buildah/issues/5967
	ctx := context.TODO()
	now := time.Now()

	graphDriverName := os.Getenv("STORAGE_DRIVER")
	if graphDriverName == "" {
		graphDriverName = "vfs"
	}
	t.Logf("using storage driver %q", graphDriverName)
	store, err := storage.GetStore(storageTypes.StoreOptions{
		RunRoot:         t.TempDir(),
		GraphRoot:       t.TempDir(),
		GraphDriverName: graphDriverName,
	})
	require.NoError(t, err, "initializing storage")
	t.Cleanup(func() { _, err := store.Shutdown(true); assert.NoError(t, err) })

	imageName := func(i int) string { return fmt.Sprintf("image%d", i) }
	makeFile := func(base string, size int64) string {
		return makeFile(t, base, size)
	}
	makeArchive := func(base string, size int64) string {
		t.Helper()
		file := makeFile(base, size)
		archiveDir := t.TempDir()
		st, err := os.Stat(file)
		require.NoError(t, err)
		archiveName := filepath.Join(archiveDir, filepath.Base(file))
		f, err := os.Create(archiveName)
		require.NoError(t, err)
		defer f.Close()
		tw := tar.NewWriter(f)
		defer tw.Close()
		hdr, err := tar.FileInfoHeader(st, "")
		require.NoErrorf(t, err, "building tar header for %s", file)
		err = tw.WriteHeader(hdr)
		require.NoErrorf(t, err, "writing tar header for %s", file)
		f, err = os.Open(file)
		require.NoError(t, err)
		defer f.Close()
		_, err = io.Copy(tw, f)
		require.NoErrorf(t, err, "writing tar payload for %s", file)
		return archiveName
	}
	layerNumber := 0

	// Build a from-scratch image with one layer.
	builderOptions := BuilderOptions{
		FromImage: "scratch",
		NamespaceOptions: []NamespaceOption{{
			Name: string(rspec.NetworkNamespace),
			Host: true,
		}},
		SystemContext: &testSystemContext,
	}
	b, err := NewBuilder(ctx, store, builderOptions)
	if strings.Contains(err.Error(), "netavark") {
		t.Skipf("Skipping test: %v", err)
	}
	require.NoError(t, err, "creating builder")
	b.SetCreatedBy(imageName(layerNumber))
	firstFile := makeFile("file0", 0)
	err = b.Add("/", false, AddAndCopyOptions{}, firstFile)
	require.NoError(t, err, "adding", firstFile)
	commitOptions := CommitOptions{
		SystemContext: &testSystemContext,
	}
	ref, err := imageStorage.Transport.ParseStoreReference(store, imageName(layerNumber))
	require.NoError(t, err, "parsing reference for to-be-committed image", imageName(layerNumber))
	_, _, _, err = b.Commit(ctx, ref, commitOptions)
	require.NoError(t, err, "committing", imageName(layerNumber))

	// Build another image based on the first with not much in its layer.
	builderOptions.FromImage = imageName(layerNumber)
	layerNumber++
	b, err = NewBuilder(ctx, store, builderOptions)
	require.NoError(t, err, "creating builder")
	b.SetCreatedBy(imageName(layerNumber))
	secondFile := makeFile("file1", 0)
	err = b.Add("/", false, AddAndCopyOptions{}, secondFile)
	require.NoError(t, err, "adding", secondFile)
	commitOptions = CommitOptions{
		SystemContext: &testSystemContext,
	}
	ref, err = imageStorage.Transport.ParseStoreReference(store, imageName(layerNumber))
	require.NoError(t, err, "parsing reference for to-be-committed image", imageName(layerNumber))
	_, _, _, err = b.Commit(ctx, ref, commitOptions)
	require.NoError(t, err, "committing", imageName(layerNumber))

	// Build a third image with two layers on either side of its read-write layer.
	builderOptions.FromImage = imageName(layerNumber)
	layerNumber++
	b, err = NewBuilder(ctx, store, builderOptions)
	require.NoError(t, err, "creating builder")
	thirdFile := makeFile("file2", 0)
	fourthArchiveFile := makeArchive("file3", 0)
	fifthFile := makeFile("file4", 0)
	sixthFile := makeFile("file5", 0)
	seventhArchiveFile := makeArchive("file6", 0)
	eighthFile := makeFile("file7", 0)
	ninthArchiveFile := makeArchive("file8", 0)
	err = b.Add("/", false, AddAndCopyOptions{}, sixthFile)
	require.NoError(t, err, "adding", sixthFile)
	b.SetCreatedBy(imageName(layerNumber + 3))
	b.AddPrependedLinkedLayer(nil, imageName(layerNumber), "", "", filepath.Dir(thirdFile))
	commitOptions = CommitOptions{
		PrependedLinkedLayers: []LinkedLayer{
			{
				BlobPath: fourthArchiveFile,
				History: v1.History{
					Created:   &now,
					CreatedBy: imageName(layerNumber + 1),
				},
			},
			{
				BlobPath: filepath.Dir(fifthFile),
				History: v1.History{
					Created:   &now,
					CreatedBy: imageName(layerNumber + 2),
				},
			},
		},
		AppendedLinkedLayers: []LinkedLayer{
			{
				BlobPath: seventhArchiveFile,
				History: v1.History{
					Created:   &now,
					CreatedBy: imageName(layerNumber + 4),
				},
			},
			{
				BlobPath: filepath.Dir(eighthFile),
				History: v1.History{
					Created:   &now,
					CreatedBy: imageName(layerNumber + 5),
				},
			},
		},
		SystemContext: &testSystemContext,
	}
	b.AddAppendedLinkedLayer(nil, imageName(layerNumber+6), "", "", ninthArchiveFile)
	ref, err = imageStorage.Transport.ParseStoreReference(store, imageName(layerNumber))
	require.NoErrorf(t, err, "parsing reference for to-be-committed image %q", imageName(layerNumber))
	_, _, _, err = b.Commit(ctx, ref, commitOptions)
	require.NoErrorf(t, err, "committing %q", imageName(layerNumber))

	// Build one last image based on the previous one.
	builderOptions.FromImage = imageName(layerNumber)
	layerNumber += 7
	b, err = NewBuilder(ctx, store, builderOptions)
	require.NoError(t, err, "creating builder")
	b.SetCreatedBy(imageName(layerNumber))
	tenthFile := makeFile("file9", 0)
	err = b.Add("/", false, AddAndCopyOptions{}, tenthFile)
	require.NoError(t, err, "adding", tenthFile)
	commitOptions = CommitOptions{
		SystemContext: &testSystemContext,
	}
	ref, err = imageStorage.Transport.ParseStoreReference(store, imageName(layerNumber))
	require.NoError(t, err, "parsing reference for to-be-committed image", imageName(layerNumber))
	_, _, _, err = b.Commit(ctx, ref, commitOptions)
	require.NoError(t, err, "committing", imageName(layerNumber))

	// Get set to examine this image.  At this point, each history entry
	// should just have "image%d" as its CreatedBy field, and each layer
	// should have the corresponding file (and nothing else) in it.
	src, err := ref.NewImageSource(ctx, &testSystemContext)
	require.NoError(t, err, "opening image source")
	defer src.Close()
	img, err := ref.NewImage(ctx, &testSystemContext)
	require.NoError(t, err, "opening image")
	defer img.Close()
	config, err := img.OCIConfig(ctx)
	require.NoError(t, err, "reading config in OCI format")
	require.Len(t, config.History, 10, "history length")
	for i := range config.History {
		require.Equal(t, fmt.Sprintf("image%d", i), config.History[i].CreatedBy, "history createdBy is off")
	}
	require.Len(t, config.RootFS.DiffIDs, 10, "diffID list")

	layerContents := func(archive io.ReadCloser) []string {
		var contents []string
		defer archive.Close()
		tr := tar.NewReader(archive)
		entry, err := tr.Next()
		for entry != nil {
			contents = append(contents, entry.Name)
			if err != nil {
				break
			}
			entry, err = tr.Next()
		}
		require.ErrorIs(t, err, io.EOF)
		return contents
	}
	infos, err := img.LayerInfosForCopy(ctx)
	require.NoError(t, err, "getting layer infos")
	require.Len(t, infos, 10)
	for i, blobInfo := range infos {
		func() {
			t.Helper()
			rc, _, err := src.GetBlob(ctx, blobInfo, nil)
			require.NoError(t, err, "getting blob", i)
			defer rc.Close()
			contents := layerContents(rc)
			require.Len(t, contents, 1)
			require.Equal(t, fmt.Sprintf("file%d", i), contents[0])
		}()
	}
}

func TestCommitCompression(t *testing.T) {
	// This test cannot be parallelized as this uses NewBuilder()
	// which eventually and indirectly accesses a global variable
	// defined in `go-selinux`, this must be fixed at `go-selinux`
	// or builder must enable sometime of locking mechanism i.e if
	// routine is creating Builder other's must wait for it.
	// Tracked here: https://github.com/containers/buildah/issues/5967
	ctx := context.TODO()

	graphDriverName := os.Getenv("STORAGE_DRIVER")
	if graphDriverName == "" {
		graphDriverName = "vfs"
	}
	t.Logf("using storage driver %q", graphDriverName)
	store, err := storage.GetStore(storageTypes.StoreOptions{
		RunRoot:         t.TempDir(),
		GraphRoot:       t.TempDir(),
		GraphDriverName: graphDriverName,
	})
	require.NoError(t, err, "initializing storage")
	t.Cleanup(func() { _, err := store.Shutdown(true); assert.NoError(t, err) })

	builderOptions := BuilderOptions{
		FromImage: "scratch",
		NamespaceOptions: []NamespaceOption{{
			Name: string(rspec.NetworkNamespace),
			Host: true,
		}},
		SystemContext: &testSystemContext,
	}
	b, err := NewBuilder(ctx, store, builderOptions)
	if strings.Contains(err.Error(), "netavark") {
		t.Skipf("Skipping test: %v", err)
	}
	require.NoError(t, err, "creating builder")
	payload := makeFile(t, "file0", 0)
	b.SetCreatedBy("ADD file0 in /")
	err = b.Add("/", false, AddAndCopyOptions{}, payload)
	require.NoError(t, err, "adding", payload)
	for _, compressor := range []struct {
		compression    archive.Compression
		name           string
		expectError    bool
		layerMediaType string
	}{
		{archive.Uncompressed, "uncompressed", false, v1.MediaTypeImageLayer},
		{archive.Gzip, "gzip", false, v1.MediaTypeImageLayerGzip},
		{archive.Bzip2, "bz2", true, ""},
		{archive.Xz, "xz", true, ""},
		{archive.Zstd, "zstd", false, v1.MediaTypeImageLayerZstd},
	} {
		t.Run(compressor.name, func(t *testing.T) {
			var ref types.ImageReference
			commitOptions := CommitOptions{
				PreferredManifestType: v1.MediaTypeImageManifest,
				SystemContext:         &testSystemContext,
				Compression:           compressor.compression,
			}
			imageName := compressor.name
			ref, err := imageStorage.Transport.ParseStoreReference(store, imageName)
			require.NoErrorf(t, err, "parsing reference for to-be-committed local image %q", imageName)
			_, _, _, err = b.Commit(ctx, ref, commitOptions)
			if compressor.expectError {
				require.Errorf(t, err, "committing local image %q", imageName)
			} else {
				require.NoErrorf(t, err, "committing local image %q", imageName)
			}
			imageName = t.TempDir()
			ref, err = ociLayout.Transport.ParseReference(imageName)
			require.NoErrorf(t, err, "parsing reference for to-be-committed oci layout %q", imageName)
			_, _, _, err = b.Commit(ctx, ref, commitOptions)
			if compressor.expectError {
				require.Errorf(t, err, "committing oci layout %q", imageName)
				return
			}
			require.NoErrorf(t, err, "committing oci layout %q", imageName)
			src, err := ref.NewImageSource(ctx, &testSystemContext)
			require.NoErrorf(t, err, "reading oci layout %q", imageName)
			defer src.Close()
			manifestBytes, manifestType, err := src.GetManifest(ctx, nil)
			require.NoErrorf(t, err, "reading manifest from oci layout %q", imageName)
			require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "manifest type from oci layout %q looked wrong", imageName)
			parsedManifest, err := manifest.OCI1FromManifest(manifestBytes)
			require.NoErrorf(t, err, "parsing manifest from oci layout %q", imageName)
			require.Lenf(t, parsedManifest.Layers, 1, "expected exactly one layer in oci layout %q", imageName)
			require.Equalf(t, compressor.layerMediaType, parsedManifest.Layers[0].MediaType, "expected the layer media type to reflect compression in oci layout %q", imageName)
			blobReadCloser, _, err := src.GetBlob(ctx, types.BlobInfo{
				Digest:    parsedManifest.Layers[0].Digest,
				MediaType: parsedManifest.Layers[0].MediaType,
			}, nil)
			require.NoErrorf(t, err, "reading the first layer from oci layout %q", imageName)
			defer blobReadCloser.Close()
			blob, err := io.ReadAll(blobReadCloser)
			require.NoErrorf(t, err, "consuming the first layer from oci layout %q", imageName)
			require.Equalf(t, compressor.compression, archive.DetectCompression(blob), "detected compression looks wrong for layer in oci layout %q")
		})
	}
}

func TestCommitEmpty(t *testing.T) {
	// This test cannot be parallelized as this uses NewBuilder()
	// which eventually and indirectly accesses a global variable
	// defined in `go-selinux`, this must be fixed at `go-selinux`
	// or builder must enable sometime of locking mechanism i.e if
	// routine is creating Builder other's must wait for it.
	// Tracked here: https://github.com/containers/buildah/issues/5967
	ctx := context.TODO()

	graphDriverName := os.Getenv("STORAGE_DRIVER")
	if graphDriverName == "" {
		graphDriverName = "vfs"
	}
	t.Logf("using storage driver %q", graphDriverName)
	store, err := storage.GetStore(storageTypes.StoreOptions{
		RunRoot:         t.TempDir(),
		GraphRoot:       t.TempDir(),
		GraphDriverName: graphDriverName,
	})
	require.NoError(t, err, "initializing storage")
	t.Cleanup(func() { _, err := store.Shutdown(true); assert.NoError(t, err) })

	builderOptions := BuilderOptions{
		FromImage: "scratch",
		NamespaceOptions: []NamespaceOption{{
			Name: string(rspec.NetworkNamespace),
			Host: true,
		}},
		SystemContext: &testSystemContext,
	}
	b, err := NewBuilder(ctx, store, builderOptions)
	if strings.Contains(err.Error(), "netavark") {
		t.Skipf("Skipping test: %v", err)
	}
	require.NoError(t, err, "creating builder")

	committedLayoutDir := t.TempDir()
	committedRef, err := ociLayout.ParseReference(committedLayoutDir)
	require.NoError(t, err, "parsing reference to where we're committing a basic image")
	_, _, _, err = b.Commit(ctx, committedRef, CommitOptions{})
	require.NoError(t, err, "committing with default settings")

	committedImg, err := committedRef.NewImageSource(ctx, &testSystemContext)
	require.NoError(t, err, "preparing to read committed image")
	defer committedImg.Close()
	committedManifestBytes, committedManifestType, err := committedImg.GetManifest(ctx, nil)
	require.NoError(t, err, "reading manifest from committed image")
	require.Equalf(t, v1.MediaTypeImageManifest, committedManifestType, "unexpected manifest type")
	committedManifest, err := manifest.FromBlob(committedManifestBytes, committedManifestType)
	require.NoError(t, err, "parsing manifest from committed image")
	require.Equalf(t, 1, len(committedManifest.LayerInfos()), "expected one layer in manifest")
	configReadCloser, _, err := committedImg.GetBlob(ctx, committedManifest.ConfigInfo(), nil)
	require.NoError(t, err, "reading config blob from committed image")
	defer configReadCloser.Close()
	var committedImage v1.Image
	err = json.NewDecoder(configReadCloser).Decode(&committedImage)
	require.NoError(t, err, "parsing config blob from committed image")
	require.Equalf(t, 1, len(committedImage.History), "expected one history entry")
	require.Falsef(t, committedImage.History[0].EmptyLayer, "expected lone history entry to not be marked as an empty layer")
	require.Equalf(t, 1, len(committedImage.RootFS.DiffIDs), "expected one rootfs layer")

	t.Run("emptylayer", func(t *testing.T) {
		options := CommitOptions{
			EmptyLayer: true,
		}
		layoutDir := t.TempDir()
		ref, err := ociLayout.ParseReference(layoutDir)
		require.NoError(t, err, "parsing reference to image we're going to commit with EmptyLayer")
		_, _, _, err = b.Commit(ctx, ref, options)
		require.NoError(t, err, "committing with EmptyLayer = true")
		img, err := ref.NewImageSource(ctx, &testSystemContext)
		require.NoError(t, err, "preparing to read committed image")
		defer img.Close()
		manifestBytes, manifestType, err := img.GetManifest(ctx, nil)
		require.NoError(t, err, "reading manifest from committed image")
		require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "unexpected manifest type")
		parsedManifest, err := manifest.FromBlob(manifestBytes, manifestType)
		require.NoError(t, err, "parsing manifest from committed image")
		require.Zerof(t, len(parsedManifest.LayerInfos()), "expected no layers in manifest")
		configReadCloser, _, err := img.GetBlob(ctx, parsedManifest.ConfigInfo(), nil)
		require.NoError(t, err, "reading config blob from committed image")
		defer configReadCloser.Close()
		var image v1.Image
		err = json.NewDecoder(configReadCloser).Decode(&image)
		require.NoError(t, err, "parsing config blob from committed image")
		require.Equalf(t, 1, len(image.History), "expected one history entry")
		require.Truef(t, image.History[0].EmptyLayer, "expected lone history entry to be marked as an empty layer")
	})

	t.Run("omitlayerhistoryentry", func(t *testing.T) {
		options := CommitOptions{
			OmitLayerHistoryEntry: true,
		}
		layoutDir := t.TempDir()
		ref, err := ociLayout.ParseReference(layoutDir)
		require.NoError(t, err, "parsing reference to image we're going to commit with OmitLayerHistoryEntry")
		_, _, _, err = b.Commit(ctx, ref, options)
		require.NoError(t, err, "committing with OmitLayerHistoryEntry = true")
		img, err := ref.NewImageSource(ctx, &testSystemContext)
		require.NoError(t, err, "preparing to read committed image")
		defer img.Close()
		manifestBytes, manifestType, err := img.GetManifest(ctx, nil)
		require.NoError(t, err, "reading manifest from committed image")
		require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "unexpected manifest type")
		parsedManifest, err := manifest.FromBlob(manifestBytes, manifestType)
		require.NoError(t, err, "parsing manifest from committed image")
		require.Equalf(t, 0, len(parsedManifest.LayerInfos()), "expected no layers in manifest")
		configReadCloser, _, err := img.GetBlob(ctx, parsedManifest.ConfigInfo(), nil)
		require.NoError(t, err, "reading config blob from committed image")
		defer configReadCloser.Close()
		var image v1.Image
		err = json.NewDecoder(configReadCloser).Decode(&image)
		require.NoError(t, err, "parsing config blob from committed image")
		require.Equalf(t, 0, len(image.History), "expected no history entries")
		require.Equalf(t, 0, len(image.RootFS.DiffIDs), "expected no diff IDs")
	})

	builderOptions.FromImage = transports.ImageName(committedRef)
	b, err = NewBuilder(ctx, store, builderOptions)
	require.NoError(t, err, "creating builder from committed base image")

	t.Run("derived-emptylayer", func(t *testing.T) {
		options := CommitOptions{
			EmptyLayer: true,
		}
		layoutDir := t.TempDir()
		ref, err := ociLayout.ParseReference(layoutDir)
		require.NoError(t, err, "parsing reference to image we're going to commit with EmptyLayer")
		_, _, _, err = b.Commit(ctx, ref, options)
		require.NoError(t, err, "committing with EmptyLayer = true")
		img, err := ref.NewImageSource(ctx, &testSystemContext)
		require.NoError(t, err, "preparing to read committed image")
		defer img.Close()
		manifestBytes, manifestType, err := img.GetManifest(ctx, nil)
		require.NoError(t, err, "reading manifest from committed image")
		require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "unexpected manifest type")
		parsedManifest, err := manifest.FromBlob(manifestBytes, manifestType)
		require.NoError(t, err, "parsing manifest from committed image")
		require.Equalf(t, len(committedManifest.LayerInfos()), len(parsedManifest.LayerInfos()), "expected no new layers in manifest")
		configReadCloser, _, err := img.GetBlob(ctx, parsedManifest.ConfigInfo(), nil)
		require.NoError(t, err, "reading config blob from committed image")
		defer configReadCloser.Close()
		var image v1.Image
		err = json.NewDecoder(configReadCloser).Decode(&image)
		require.NoError(t, err, "parsing config blob from committed image")
		require.Equalf(t, len(committedImage.History)+1, len(image.History), "expected one new history entry")
		require.Equalf(t, len(committedImage.RootFS.DiffIDs), len(image.RootFS.DiffIDs), "expected no new diff IDs")
		require.Truef(t, image.History[1].EmptyLayer, "expected new history entry to be marked as an empty layer")
	})

	t.Run("derived-omitlayerhistoryentry", func(t *testing.T) {
		options := CommitOptions{
			OmitLayerHistoryEntry: true,
		}
		layoutDir := t.TempDir()
		ref, err := ociLayout.ParseReference(layoutDir)
		require.NoError(t, err, "parsing reference to image we're going to commit with OmitLayerHistoryEntry")
		_, _, _, err = b.Commit(ctx, ref, options)
		require.NoError(t, err, "committing with OmitLayerHistoryEntry = true")
		img, err := ref.NewImageSource(ctx, &testSystemContext)
		require.NoError(t, err, "preparing to read committed image")
		defer img.Close()
		manifestBytes, manifestType, err := img.GetManifest(ctx, nil)
		require.NoError(t, err, "reading manifest from committed image")
		require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "unexpected manifest type")
		parsedManifest, err := manifest.FromBlob(manifestBytes, manifestType)
		require.NoError(t, err, "parsing manifest from committed image")
		require.Equalf(t, len(committedManifest.LayerInfos()), len(parsedManifest.LayerInfos()), "expected no new layers in manifest")
		configReadCloser, _, err := img.GetBlob(ctx, parsedManifest.ConfigInfo(), nil)
		require.NoError(t, err, "reading config blob from committed image")
		defer configReadCloser.Close()
		var image v1.Image
		err = json.NewDecoder(configReadCloser).Decode(&image)
		require.NoError(t, err, "parsing config blob from committed image")
		require.Equalf(t, len(committedImage.History), len(image.History), "expected no new history entry")
		require.Equalf(t, len(committedImage.RootFS.DiffIDs), len(image.RootFS.DiffIDs), "expected no new diff IDs")
	})

	t.Run("derived-synthetic", func(t *testing.T) {
		randomDir := t.TempDir()
		randomFile, err := os.CreateTemp(randomDir, "file")
		require.NoError(t, err, "creating a temporary file")
		layerDigest := digest.Canonical.Digester()
		_, err = io.CopyN(io.MultiWriter(layerDigest.Hash(), randomFile), rand.Reader, 512)
		require.NoError(t, err, "writing a temporary file")
		require.NoError(t, randomFile.Close(), "closing temporary file")
		options := CommitOptions{
			OmitLayerHistoryEntry: true,
			AppendedLinkedLayers: []LinkedLayer{{
				History: v1.History{
					CreatedBy: "yolo",
				}, // history entry to add
				BlobPath: randomFile.Name(),
			}},
		}
		layoutDir := t.TempDir()
		ref, err := ociLayout.ParseReference(layoutDir)
		require.NoErrorf(t, err, "parsing reference for to-be-committed image with externally-controlled changes")
		_, _, _, err = b.Commit(ctx, ref, options)
		require.NoError(t, err, "committing with OmitLayerHistoryEntry = true")
		img, err := ref.NewImageSource(ctx, &testSystemContext)
		require.NoError(t, err, "preparing to read committed image")
		defer img.Close()
		manifestBytes, manifestType, err := img.GetManifest(ctx, nil)
		require.NoError(t, err, "reading manifest from committed image")
		require.Equalf(t, v1.MediaTypeImageManifest, manifestType, "unexpected manifest type")
		parsedManifest, err := manifest.FromBlob(manifestBytes, manifestType)
		require.NoError(t, err, "parsing manifest from committed image")
		require.Equalf(t, len(committedManifest.LayerInfos())+1, len(parsedManifest.LayerInfos()), "expected one new layer in manifest")
		configReadCloser, _, err := img.GetBlob(ctx, parsedManifest.ConfigInfo(), nil)
		require.NoError(t, err, "reading config blob from committed image")
		defer configReadCloser.Close()
		var image v1.Image
		err = json.NewDecoder(configReadCloser).Decode(&image)
		require.NoError(t, err, "decoding image config")
		require.Equalf(t, len(committedImage.History)+1, len(image.History), "expected one new history entry")
		require.Equalf(t, len(committedImage.RootFS.DiffIDs)+1, len(image.RootFS.DiffIDs), "expected one new diff ID")
		require.Equalf(t, layerDigest.Digest(), image.RootFS.DiffIDs[len(image.RootFS.DiffIDs)-1], "expected new diff ID to match the randomly-generated layer")
	})
}