531bf50845
## Description Closes: #10729 Includes: * table, auto-increment table, and singleton `Table` implementations * primary key, index and unique index `Index` implementations * store wrappers based on tm-db but that could be retargeted to the new ADR 040 db which separate index and commitment stores, with a debug wrapper * streaming JSON import and export * full logical decoding (and encoding) --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
318 lines
7.2 KiB
Go
318 lines
7.2 KiB
Go
package ormkv_test
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"testing"
|
|
|
|
"google.golang.org/protobuf/reflect/protoreflect"
|
|
"gotest.tools/v3/assert"
|
|
"pgregory.net/rapid"
|
|
|
|
"github.com/cosmos/cosmos-sdk/orm/encoding/encodeutil"
|
|
"github.com/cosmos/cosmos-sdk/orm/encoding/ormkv"
|
|
"github.com/cosmos/cosmos-sdk/orm/internal/testpb"
|
|
"github.com/cosmos/cosmos-sdk/orm/internal/testutil"
|
|
)
|
|
|
|
func TestKeyCodec(t *testing.T) {
|
|
rapid.Check(t, func(t *rapid.T) {
|
|
key := testutil.TestKeyCodecGen(0, 5).Draw(t, "key").(testutil.TestKeyCodec)
|
|
for i := 0; i < 100; i++ {
|
|
keyValues := key.Draw(t, "values")
|
|
|
|
bz1 := assertEncDecKey(t, key, keyValues)
|
|
|
|
if key.Codec.IsFullyOrdered() {
|
|
// check if ordered keys have ordered encodings
|
|
keyValues2 := key.Draw(t, "values2")
|
|
bz2 := assertEncDecKey(t, key, keyValues2)
|
|
// bytes comparison should equal comparison of values
|
|
assert.Equal(t, key.Codec.CompareKeys(keyValues, keyValues2), bytes.Compare(bz1, bz2))
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
func assertEncDecKey(t *rapid.T, key testutil.TestKeyCodec, keyValues []protoreflect.Value) []byte {
|
|
bz, err := key.Codec.EncodeKey(keyValues)
|
|
assert.NilError(t, err)
|
|
keyValues2, err := key.Codec.DecodeKey(bytes.NewReader(bz))
|
|
assert.NilError(t, err)
|
|
assert.Equal(t, 0, key.Codec.CompareKeys(keyValues, keyValues2))
|
|
return bz
|
|
}
|
|
|
|
func TestCompareValues(t *testing.T) {
|
|
cdc, err := ormkv.NewKeyCodec(nil,
|
|
(&testpb.ExampleTable{}).ProtoReflect().Type(),
|
|
[]protoreflect.Name{"u32", "str", "i32"})
|
|
assert.NilError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
values1 []protoreflect.Value
|
|
values2 []protoreflect.Value
|
|
expect int
|
|
validRange bool
|
|
}{
|
|
{
|
|
"eq",
|
|
encodeutil.ValuesOf(uint32(0), "abc", int32(-3)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", int32(-3)),
|
|
0,
|
|
false,
|
|
},
|
|
{
|
|
"eq prefix 0",
|
|
encodeutil.ValuesOf(),
|
|
encodeutil.ValuesOf(),
|
|
0,
|
|
false,
|
|
},
|
|
{
|
|
"eq prefix 1",
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
0,
|
|
false,
|
|
},
|
|
{
|
|
"eq prefix 2",
|
|
encodeutil.ValuesOf(uint32(0), "abc"),
|
|
encodeutil.ValuesOf(uint32(0), "abc"),
|
|
0,
|
|
false,
|
|
},
|
|
{
|
|
"lt1",
|
|
encodeutil.ValuesOf(uint32(0), "abc", int32(-3)),
|
|
encodeutil.ValuesOf(uint32(1), "abc", int32(-3)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"lt2",
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-3)),
|
|
encodeutil.ValuesOf(uint32(1), "abc", int32(-3)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"lt3",
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-4)),
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-3)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"less prefix 0",
|
|
encodeutil.ValuesOf(),
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-4)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"less prefix 1",
|
|
encodeutil.ValuesOf(uint32(1)),
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-4)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"less prefix 2",
|
|
encodeutil.ValuesOf(uint32(1), "abb"),
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-4)),
|
|
-1,
|
|
true,
|
|
},
|
|
{
|
|
"gt1",
|
|
encodeutil.ValuesOf(uint32(2), "abb", int32(-4)),
|
|
encodeutil.ValuesOf(uint32(1), "abb", int32(-4)),
|
|
1,
|
|
false,
|
|
},
|
|
{
|
|
"gt2",
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(-4)),
|
|
encodeutil.ValuesOf(uint32(2), "abb", int32(-4)),
|
|
1,
|
|
false,
|
|
},
|
|
{
|
|
"gt3",
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(1)),
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(-3)),
|
|
1,
|
|
false,
|
|
},
|
|
{
|
|
"gt prefix 0",
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(-3)),
|
|
encodeutil.ValuesOf(),
|
|
1,
|
|
true,
|
|
},
|
|
{
|
|
"gt prefix 1",
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(-3)),
|
|
encodeutil.ValuesOf(uint32(2)),
|
|
1,
|
|
true,
|
|
},
|
|
{
|
|
"gt prefix 2",
|
|
encodeutil.ValuesOf(uint32(2), "abc", int32(-3)),
|
|
encodeutil.ValuesOf(uint32(2), "abc"),
|
|
1,
|
|
true,
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
assert.Equal(
|
|
t, test.expect,
|
|
cdc.CompareKeys(test.values1, test.values2),
|
|
)
|
|
// CheckValidRangeIterationKeys should give comparable results
|
|
err := cdc.CheckValidRangeIterationKeys(test.values1, test.values2)
|
|
if test.validRange {
|
|
assert.NilError(t, err)
|
|
} else {
|
|
assert.ErrorContains(t, err, "")
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestDecodePrefixKey(t *testing.T) {
|
|
cdc, err := ormkv.NewKeyCodec(nil,
|
|
(&testpb.ExampleTable{}).ProtoReflect().Type(),
|
|
[]protoreflect.Name{"u32", "str", "bz", "i32"})
|
|
|
|
assert.NilError(t, err)
|
|
tests := []struct {
|
|
name string
|
|
values []protoreflect.Value
|
|
}{
|
|
{
|
|
"1",
|
|
encodeutil.ValuesOf(uint32(5), "abc"),
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
bz, err := cdc.EncodeKey(test.values)
|
|
assert.NilError(t, err)
|
|
values, err := cdc.DecodeKey(bytes.NewReader(bz))
|
|
assert.ErrorType(t, err, io.EOF)
|
|
assert.Equal(t, 0, cdc.CompareKeys(test.values, values))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestValidRangeIterationKeys(t *testing.T) {
|
|
cdc, err := ormkv.NewKeyCodec(nil,
|
|
(&testpb.ExampleTable{}).ProtoReflect().Type(),
|
|
[]protoreflect.Name{"u32", "str", "bz", "i32"})
|
|
assert.NilError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
values1 []protoreflect.Value
|
|
values2 []protoreflect.Value
|
|
expectErr bool
|
|
}{
|
|
{
|
|
"1 eq",
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
true,
|
|
},
|
|
{
|
|
"1 lt",
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
encodeutil.ValuesOf(uint32(1)),
|
|
false,
|
|
},
|
|
{
|
|
"1 gt",
|
|
encodeutil.ValuesOf(uint32(1)),
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
true,
|
|
},
|
|
{
|
|
"1,2 lt",
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
encodeutil.ValuesOf(uint32(0), "abc"),
|
|
false,
|
|
},
|
|
{
|
|
"1,2 gt",
|
|
encodeutil.ValuesOf(uint32(0), "abc"),
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
false,
|
|
},
|
|
{
|
|
"1,2,3",
|
|
encodeutil.ValuesOf(uint32(0)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}),
|
|
true,
|
|
},
|
|
{
|
|
"1,2,3,4 lt",
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(-1)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(1)),
|
|
false,
|
|
},
|
|
{
|
|
"too long",
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(-1)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(1), int32(1)),
|
|
true,
|
|
},
|
|
{
|
|
"1,2,3,4 eq",
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(1)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(1)),
|
|
true,
|
|
},
|
|
{
|
|
"1,2,3,4 bz err",
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2}, int32(-1)),
|
|
encodeutil.ValuesOf(uint32(0), "abc", []byte{1, 2, 3}, int32(1)),
|
|
true,
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
err := cdc.CheckValidRangeIterationKeys(test.values1, test.values2)
|
|
if test.expectErr {
|
|
assert.ErrorContains(t, err, "")
|
|
} else {
|
|
assert.NilError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetSet(t *testing.T) {
|
|
cdc, err := ormkv.NewKeyCodec(nil,
|
|
(&testpb.ExampleTable{}).ProtoReflect().Type(),
|
|
[]protoreflect.Name{"u32", "str", "i32"})
|
|
assert.NilError(t, err)
|
|
|
|
var a testpb.ExampleTable
|
|
values := encodeutil.ValuesOf(uint32(4), "abc", int32(1))
|
|
cdc.SetKeyValues(a.ProtoReflect(), values)
|
|
values2 := cdc.GetKeyValues(a.ProtoReflect())
|
|
assert.Equal(t, 0, cdc.CompareKeys(values, values2))
|
|
bz, err := cdc.EncodeKey(values)
|
|
assert.NilError(t, err)
|
|
values3, bz2, err := cdc.EncodeKeyFromMessage(a.ProtoReflect())
|
|
assert.NilError(t, err)
|
|
assert.Equal(t, 0, cdc.CompareKeys(values, values3))
|
|
assert.Assert(t, bytes.Equal(bz, bz2))
|
|
}
|