de6020a240
The package defined various special errors; these errors existed for two reasons; - being able to distinguish "not found" errors from other errors (as "not found" errors can be ignored in various cases). - to be able to update the context _name_ in the error message after the error was created. This was needed in cases where the name was not available at the location where the error was produced (e.g. only the "id" was present), and the helpers to detect "not found" errors did not support wrapped errors (so wrapping the error with a "name" could break logic); a `setContextName` interface and corresponding `patchErrContextName()` utility was created for this (which was a "creative", but not very standard approach). This patch: - Removes the special error-types, replacing them with errdefs definitions (which is a more common approach in our code-base to detect error types / classes). - Removes the internal utilities for error-handling, and deprecates the exported utilities (to allow external consumers to adjust their code). - Some errors have been enriched with detailed information (which may be useful for debugging / problem solving). - Note that in some cases, `patchErrContextName()` was called, but the code producing the error would never return a `setContextName` error, so would never update the error message. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
129 lines
3.3 KiB
Go
129 lines
3.3 KiB
Go
package store
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/docker/docker/errdefs"
|
|
"gotest.tools/v3/assert"
|
|
"gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func testMetadata(name string) Metadata {
|
|
return Metadata{
|
|
Endpoints: map[string]interface{}{
|
|
"ep1": endpoint{Foo: "bar"},
|
|
},
|
|
Metadata: context{Bar: "baz"},
|
|
Name: name,
|
|
}
|
|
}
|
|
|
|
func TestMetadataGetNotExisting(t *testing.T) {
|
|
testee := metadataStore{root: t.TempDir(), config: testCfg}
|
|
_, err := testee.get("noexist")
|
|
assert.ErrorType(t, err, errdefs.IsNotFound)
|
|
}
|
|
|
|
func TestMetadataCreateGetRemove(t *testing.T) {
|
|
testDir := t.TempDir()
|
|
testee := metadataStore{root: testDir, config: testCfg}
|
|
expected2 := Metadata{
|
|
Endpoints: map[string]interface{}{
|
|
"ep1": endpoint{Foo: "baz"},
|
|
"ep2": endpoint{Foo: "bee"},
|
|
},
|
|
Metadata: context{Bar: "foo"},
|
|
Name: "test-context",
|
|
}
|
|
testMeta := testMetadata("test-context")
|
|
err := testee.createOrUpdate(testMeta)
|
|
assert.NilError(t, err)
|
|
// create a new instance to check it does not depend on some sort of state
|
|
testee = metadataStore{root: testDir, config: testCfg}
|
|
meta, err := testee.get("test-context")
|
|
assert.NilError(t, err)
|
|
assert.DeepEqual(t, meta, testMeta)
|
|
|
|
// update
|
|
|
|
err = testee.createOrUpdate(expected2)
|
|
assert.NilError(t, err)
|
|
meta, err = testee.get("test-context")
|
|
assert.NilError(t, err)
|
|
assert.DeepEqual(t, meta, expected2)
|
|
|
|
assert.NilError(t, testee.remove("test-context"))
|
|
assert.NilError(t, testee.remove("test-context")) // support duplicate remove
|
|
_, err = testee.get("test-context")
|
|
assert.ErrorType(t, err, errdefs.IsNotFound)
|
|
}
|
|
|
|
func TestMetadataRespectJsonAnnotation(t *testing.T) {
|
|
testDir := t.TempDir()
|
|
testee := metadataStore{root: testDir, config: testCfg}
|
|
assert.NilError(t, testee.createOrUpdate(testMetadata("test")))
|
|
bytes, err := os.ReadFile(filepath.Join(testDir, string(contextdirOf("test")), "meta.json"))
|
|
assert.NilError(t, err)
|
|
assert.Assert(t, cmp.Contains(string(bytes), "a_very_recognizable_field_name"))
|
|
assert.Assert(t, cmp.Contains(string(bytes), "another_very_recognizable_field_name"))
|
|
}
|
|
|
|
func TestMetadataList(t *testing.T) {
|
|
testee := metadataStore{root: t.TempDir(), config: testCfg}
|
|
wholeData := []Metadata{
|
|
testMetadata("context1"),
|
|
testMetadata("context2"),
|
|
testMetadata("context3"),
|
|
}
|
|
|
|
for _, s := range wholeData {
|
|
assert.NilError(t, testee.createOrUpdate(s))
|
|
}
|
|
|
|
data, err := testee.list()
|
|
assert.NilError(t, err)
|
|
assert.DeepEqual(t, data, wholeData)
|
|
}
|
|
|
|
func TestEmptyConfig(t *testing.T) {
|
|
testee := metadataStore{root: t.TempDir()}
|
|
wholeData := []Metadata{
|
|
testMetadata("context1"),
|
|
testMetadata("context2"),
|
|
testMetadata("context3"),
|
|
}
|
|
|
|
for _, s := range wholeData {
|
|
assert.NilError(t, testee.createOrUpdate(s))
|
|
}
|
|
|
|
data, err := testee.list()
|
|
assert.NilError(t, err)
|
|
assert.Equal(t, len(data), len(wholeData))
|
|
}
|
|
|
|
type contextWithEmbedding struct {
|
|
embeddedStruct
|
|
}
|
|
type embeddedStruct struct {
|
|
Val string
|
|
}
|
|
|
|
func TestWithEmbedding(t *testing.T) {
|
|
testee := metadataStore{
|
|
root: t.TempDir(),
|
|
config: NewConfig(func() interface{} { return &contextWithEmbedding{} }),
|
|
}
|
|
testCtxMeta := contextWithEmbedding{
|
|
embeddedStruct: embeddedStruct{
|
|
Val: "Hello",
|
|
},
|
|
}
|
|
assert.NilError(t, testee.createOrUpdate(Metadata{Metadata: testCtxMeta, Name: "test"}))
|
|
res, err := testee.get("test")
|
|
assert.NilError(t, err)
|
|
assert.Equal(t, testCtxMeta, res.Metadata)
|
|
}
|