6ea2049944
## Description
This PR adds a `ModuleDB` interface which can be used directly by Cosmos SDK modules. A simplified bank example with Mint/Send/Burn functionality against Balance and Supply tables is included in the tests.
This PR also:
* adds simplified `Get` and `Has` methods to `Table` which use the primary key values in the message instead of `...interface{}`
* adds a stable deterministic proto JSON marshaler and updates the `Entry.String` methods to use it because the golden tests are not deterministic without this. This code is currently internal but can be extracted to a public `codec` or `cosmos-proto` package eventually.
---
### 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...
- [ ] 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
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] 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)
- [ ] 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`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] 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)
76 lines
2.4 KiB
Go
76 lines
2.4 KiB
Go
package ormkv_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"google.golang.org/protobuf/reflect/protoreflect"
|
|
"gotest.tools/v3/assert"
|
|
|
|
"github.com/cosmos/cosmos-sdk/orm/encoding/encodeutil"
|
|
"github.com/cosmos/cosmos-sdk/orm/encoding/ormkv"
|
|
"github.com/cosmos/cosmos-sdk/orm/internal/testpb"
|
|
)
|
|
|
|
var aFullName = (&testpb.ExampleTable{}).ProtoReflect().Descriptor().FullName()
|
|
|
|
func TestPrimaryKeyEntry(t *testing.T) {
|
|
entry := &ormkv.PrimaryKeyEntry{
|
|
TableName: aFullName,
|
|
Key: encodeutil.ValuesOf(uint32(1), "abc"),
|
|
Value: &testpb.ExampleTable{I32: -1},
|
|
}
|
|
assert.Equal(t, `PK testpb.ExampleTable 1/abc -> {"i32":-1}`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
|
|
// prefix key
|
|
entry = &ormkv.PrimaryKeyEntry{
|
|
TableName: aFullName,
|
|
Key: encodeutil.ValuesOf(uint32(1), "abc"),
|
|
Value: nil,
|
|
}
|
|
assert.Equal(t, `PK testpb.ExampleTable 1/abc -> _`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
}
|
|
|
|
func TestIndexKeyEntry(t *testing.T) {
|
|
entry := &ormkv.IndexKeyEntry{
|
|
TableName: aFullName,
|
|
Fields: []protoreflect.Name{"u32", "i32", "str"},
|
|
IsUnique: false,
|
|
IndexValues: encodeutil.ValuesOf(uint32(10), int32(-1), "abc"),
|
|
PrimaryKey: encodeutil.ValuesOf("abc", int32(-1)),
|
|
}
|
|
assert.Equal(t, `IDX testpb.ExampleTable u32/i32/str : 10/-1/abc -> abc/-1`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
|
|
entry = &ormkv.IndexKeyEntry{
|
|
TableName: aFullName,
|
|
Fields: []protoreflect.Name{"u32"},
|
|
IsUnique: true,
|
|
IndexValues: encodeutil.ValuesOf(uint32(10)),
|
|
PrimaryKey: encodeutil.ValuesOf("abc", int32(-1)),
|
|
}
|
|
assert.Equal(t, `UNIQ testpb.ExampleTable u32 : 10 -> abc/-1`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
|
|
// prefix key
|
|
entry = &ormkv.IndexKeyEntry{
|
|
TableName: aFullName,
|
|
Fields: []protoreflect.Name{"u32", "i32", "str"},
|
|
IsUnique: false,
|
|
IndexValues: encodeutil.ValuesOf(uint32(10), int32(-1)),
|
|
}
|
|
assert.Equal(t, `IDX testpb.ExampleTable u32/i32/str : 10/-1 -> _`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
|
|
// prefix key
|
|
entry = &ormkv.IndexKeyEntry{
|
|
TableName: aFullName,
|
|
Fields: []protoreflect.Name{"str", "i32"},
|
|
IsUnique: true,
|
|
IndexValues: encodeutil.ValuesOf("abc", int32(1)),
|
|
}
|
|
assert.Equal(t, `UNIQ testpb.ExampleTable str/i32 : abc/1 -> _`, entry.String())
|
|
assert.Equal(t, aFullName, entry.GetTableName())
|
|
}
|