image/store: Use errdefs for errors
Fixes:
- https://github.com/moby/moby/issues/44290

Changed errors returned to use errdefs. The original intent was to fix the mentioned issue, but I went ahead and also changed all others errors here.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
image/store_test.go
package image // import "github.com/docker/docker/image"

import (
	"fmt"
	"testing"

	"github.com/docker/docker/layer"
	"gotest.tools/v3/assert"
	is "gotest.tools/v3/assert/cmp"
)

func TestCreate(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	_, err := imgStore.Create([]byte(`{}`))
	assert.Check(t, is.Error(err, "invalid image JSON, no RootFS key"))
}

func TestRestore(t *testing.T) {
	fs, cleanup := defaultFSStoreBackend(t)
	defer cleanup()

	id1, err := fs.Set([]byte(`{"comment": "abc", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	_, err = fs.Set([]byte(`invalid`))
	assert.NilError(t, err)

	id2, err := fs.Set([]byte(`{"comment": "def", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)

	err = fs.SetMetadata(id2, "parent", []byte(id1))
	assert.NilError(t, err)

	imgStore, err := NewImageStore(fs, &mockLayerGetReleaser{})
	assert.NilError(t, err)

	assert.Check(t, is.Len(imgStore.Map(), 2))

	img1, err := imgStore.Get(ID(id1))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), img1.computedID))
	assert.Check(t, is.Equal(string(id1), img1.computedID.String()))

	img2, err := imgStore.Get(ID(id2))
	assert.NilError(t, err)
	assert.Check(t, is.Equal("abc", img1.Comment))
	assert.Check(t, is.Equal("def", img2.Comment))

	_, err = imgStore.GetParent(ID(id1))
	assert.ErrorContains(t, err, "failed to read metadata")

	p, err := imgStore.GetParent(ID(id2))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), p))

	children := imgStore.Children(ID(id1))
	assert.Check(t, is.Len(children, 1))
	assert.Check(t, is.Equal(ID(id2), children[0]))
	assert.Check(t, is.Len(imgStore.Heads(), 1))

	sid1, err := imgStore.Search(string(id1)[:10])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), sid1))

	sid1, err = imgStore.Search(id1.Encoded()[:6])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), sid1))

	invalidPattern := id1.Encoded()[1:6]
	_, err = imgStore.Search(invalidPattern)
	assert.ErrorContains(t, err, "No such image")
}

func TestAddDelete(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id1, err := imgStore.Create([]byte(`{"comment": "abc", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID("sha256:8d25a9c45df515f9d0fe8e4a6b1c64dd3b965a84790ddbcc7954bb9bc89eb993"), id1))

	img, err := imgStore.Get(id1)
	assert.NilError(t, err)
	assert.Check(t, is.Equal("abc", img.Comment))

	id2, err := imgStore.Create([]byte(`{"comment": "def", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)

	err = imgStore.SetParent(id2, id1)
	assert.NilError(t, err)

	pid1, err := imgStore.GetParent(id2)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(pid1, id1))

	_, err = imgStore.Delete(id1)
	assert.NilError(t, err)

	_, err = imgStore.Get(id1)
	assert.ErrorContains(t, err, "failed to get digest")

	_, err = imgStore.Get(id2)
	assert.NilError(t, err)

	_, err = imgStore.GetParent(id2)
	assert.ErrorContains(t, err, "failed to read metadata")
}

func TestSearchAfterDelete(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := imgStore.Create([]byte(`{"comment": "abc", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id1, err := imgStore.Search(string(id)[:15])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(id1, id))

	_, err = imgStore.Delete(id)
	assert.NilError(t, err)

	_, err = imgStore.Search(string(id)[:15])
	assert.ErrorContains(t, err, "No such image")
}

func TestParentReset(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := imgStore.Create([]byte(`{"comment": "abc1", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id2, err := imgStore.Create([]byte(`{"comment": "abc2", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id3, err := imgStore.Create([]byte(`{"comment": "abc3", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	assert.Check(t, imgStore.SetParent(id, id2))
	assert.Check(t, is.Len(imgStore.Children(id2), 1))

	assert.Check(t, imgStore.SetParent(id, id3))
	assert.Check(t, is.Len(imgStore.Children(id2), 0))
	assert.Check(t, is.Len(imgStore.Children(id3), 1))
}

func defaultImageStore(t *testing.T) (Store, func()) {
	fsBackend, cleanup := defaultFSStoreBackend(t)

	store, err := NewImageStore(fsBackend, &mockLayerGetReleaser{})
	assert.NilError(t, err)

	return store, cleanup
}

func TestGetAndSetLastUpdated(t *testing.T) {
	store, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := store.Create([]byte(`{"comment": "abc1", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	updated, err := store.GetLastUpdated(id)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(updated.IsZero(), true))

	assert.Check(t, store.SetLastUpdated(id))

	updated, err = store.GetLastUpdated(id)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(updated.IsZero(), false))
}

func TestStoreLen(t *testing.T) {
	store, cleanup := defaultImageStore(t)
	defer cleanup()

	expected := 10
	for i := 0; i < expected; i++ {
		_, err := store.Create([]byte(fmt.Sprintf(`{"comment": "abc%d", "rootfs": {"type": "layers"}}`, i)))
		assert.NilError(t, err)
	}
	numImages := store.Len()
	assert.Equal(t, expected, numImages)
	assert.Equal(t, len(store.Map()), numImages)
}

type mockLayerGetReleaser struct{}

func (ls *mockLayerGetReleaser) Get(layer.ChainID) (layer.Layer, error) {
	return nil, nil
}

func (ls *mockLayerGetReleaser) Release(layer.Layer) ([]layer.Metadata, error) {
	return nil, nil
}

package image // import "github.com/docker/docker/image"

import (
	"fmt"
	"testing"

	"github.com/docker/docker/errdefs"
	"github.com/docker/docker/layer"
	"gotest.tools/v3/assert"
	is "gotest.tools/v3/assert/cmp"
)

func TestCreate(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	_, err := imgStore.Create([]byte(`{}`))
	assert.Check(t, is.Error(err, "invalid image JSON, no RootFS key"))
}

func TestRestore(t *testing.T) {
	fs, cleanup := defaultFSStoreBackend(t)
	defer cleanup()

	id1, err := fs.Set([]byte(`{"comment": "abc", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	_, err = fs.Set([]byte(`invalid`))
	assert.NilError(t, err)

	id2, err := fs.Set([]byte(`{"comment": "def", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)

	err = fs.SetMetadata(id2, "parent", []byte(id1))
	assert.NilError(t, err)

	imgStore, err := NewImageStore(fs, &mockLayerGetReleaser{})
	assert.NilError(t, err)

	assert.Check(t, is.Len(imgStore.Map(), 2))

	img1, err := imgStore.Get(ID(id1))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), img1.computedID))
	assert.Check(t, is.Equal(string(id1), img1.computedID.String()))

	img2, err := imgStore.Get(ID(id2))
	assert.NilError(t, err)
	assert.Check(t, is.Equal("abc", img1.Comment))
	assert.Check(t, is.Equal("def", img2.Comment))

	_, err = imgStore.GetParent(ID(id1))
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
	assert.ErrorContains(t, err, "failed to read metadata")

	p, err := imgStore.GetParent(ID(id2))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), p))

	children := imgStore.Children(ID(id1))
	assert.Check(t, is.Len(children, 1))
	assert.Check(t, is.Equal(ID(id2), children[0]))
	assert.Check(t, is.Len(imgStore.Heads(), 1))

	sid1, err := imgStore.Search(string(id1)[:10])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), sid1))

	sid1, err = imgStore.Search(id1.Encoded()[:6])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID(id1), sid1))

	invalidPattern := id1.Encoded()[1:6]
	_, err = imgStore.Search(invalidPattern)
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
	assert.Check(t, is.ErrorContains(err, invalidPattern))
}

func TestAddDelete(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id1, err := imgStore.Create([]byte(`{"comment": "abc", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)
	assert.Check(t, is.Equal(ID("sha256:8d25a9c45df515f9d0fe8e4a6b1c64dd3b965a84790ddbcc7954bb9bc89eb993"), id1))

	img, err := imgStore.Get(id1)
	assert.NilError(t, err)
	assert.Check(t, is.Equal("abc", img.Comment))

	id2, err := imgStore.Create([]byte(`{"comment": "def", "rootfs": {"type": "layers", "diff_ids": ["2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"]}}`))
	assert.NilError(t, err)

	err = imgStore.SetParent(id2, id1)
	assert.NilError(t, err)

	pid1, err := imgStore.GetParent(id2)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(pid1, id1))

	_, err = imgStore.Delete(id1)
	assert.NilError(t, err)

	_, err = imgStore.Get(id1)
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
	assert.ErrorContains(t, err, "failed to get digest")

	_, err = imgStore.Get(id2)
	assert.NilError(t, err)

	_, err = imgStore.GetParent(id2)
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
	assert.ErrorContains(t, err, "failed to read metadata")
}

func TestSearchAfterDelete(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := imgStore.Create([]byte(`{"comment": "abc", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id1, err := imgStore.Search(string(id)[:15])
	assert.NilError(t, err)
	assert.Check(t, is.Equal(id1, id))

	_, err = imgStore.Delete(id)
	assert.NilError(t, err)

	_, err = imgStore.Search(string(id)[:15])
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
	assert.ErrorContains(t, err, "No such image")
}

func TestDeleteNotExisting(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	_, err := imgStore.Delete(ID("i_dont_exists"))
	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
}

func TestParentReset(t *testing.T) {
	imgStore, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := imgStore.Create([]byte(`{"comment": "abc1", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id2, err := imgStore.Create([]byte(`{"comment": "abc2", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	id3, err := imgStore.Create([]byte(`{"comment": "abc3", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	assert.Check(t, imgStore.SetParent(id, id2))
	assert.Check(t, is.Len(imgStore.Children(id2), 1))

	assert.Check(t, imgStore.SetParent(id, id3))
	assert.Check(t, is.Len(imgStore.Children(id2), 0))
	assert.Check(t, is.Len(imgStore.Children(id3), 1))
}

func defaultImageStore(t *testing.T) (Store, func()) {
	fsBackend, cleanup := defaultFSStoreBackend(t)

	store, err := NewImageStore(fsBackend, &mockLayerGetReleaser{})
	assert.NilError(t, err)

	return store, cleanup
}

func TestGetAndSetLastUpdated(t *testing.T) {
	store, cleanup := defaultImageStore(t)
	defer cleanup()

	id, err := store.Create([]byte(`{"comment": "abc1", "rootfs": {"type": "layers"}}`))
	assert.NilError(t, err)

	updated, err := store.GetLastUpdated(id)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(updated.IsZero(), true))

	assert.Check(t, store.SetLastUpdated(id))

	updated, err = store.GetLastUpdated(id)
	assert.NilError(t, err)
	assert.Check(t, is.Equal(updated.IsZero(), false))
}

func TestStoreLen(t *testing.T) {
	store, cleanup := defaultImageStore(t)
	defer cleanup()

	expected := 10
	for i := 0; i < expected; i++ {
		_, err := store.Create([]byte(fmt.Sprintf(`{"comment": "abc%d", "rootfs": {"type": "layers"}}`, i)))
		assert.NilError(t, err)
	}
	numImages := store.Len()
	assert.Equal(t, expected, numImages)
	assert.Equal(t, len(store.Map()), numImages)
}

type mockLayerGetReleaser struct{}

func (ls *mockLayerGetReleaser) Get(layer.ChainID) (layer.Layer, error) {
	return nil, nil
}

func (ls *mockLayerGetReleaser) Release(layer.Layer) ([]layer.Metadata, error) {
	return nil, nil
}

Oh, that's a really good find, thanks!