State list serializer test (#32)

state list serializer test

Author: vitiko

.github/workflows/go.yml

@@ -11,7 +11,7 @@ jobs:
  - name: Set up Go
  uses: actions/setup-go@v1
  with:
- go-version: '1.16'
+ go-version: '1.18'
 
  - name: Check out code
  uses: actions/checkout@v2

.github/workflows/golangci-lint.yml

@@ -4,24 +4,23 @@ on:
  tags:
  - v*
  branches:
- - master
  - main
  pull_request:
 jobs:
  golangci:
  name: lint
  strategy:
  matrix:
- go-version: [ 1.17.x, 1.18.x ]
+ go-version: [ 1.18.x ]
  os: [ ubuntu-latest ]
  runs-on: ${{ matrix.os }}
  steps:
  - uses: actions/checkout@v2
  - name: golangci-lint
- uses: golangci/golangci-lint-action@v2
+ uses: golangci/golangci-lint-action@v3
  with:
  # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
- version: v1.49
+ version: v1.52
 
  # Optional: working directory, useful for monorepos
  # working-directory: somedir

go.mod

@@ -1,6 +1,6 @@
 module github.com/hyperledger-labs/cckit
 
-go 1.17
+go 1.18
 
 require (
 github.com/btcsuite/btcutil v1.0.2

go.sum

@@ -407,7 +407,6 @@ golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210917161153-d61c044b1678 h1:J27LZFQBFoihqXoegpscI10HpjZ7B5WQLLKL2FZXQKw=
 golang.org/x/sys v0.0.0-20210917161153-d61c044b1678/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

serialize/serializer_test.go

@@ -18,7 +18,7 @@ import (
 
 func TestState(t *testing.T) {
 RegisterFailHandler(Fail)
-RunSpecs(t, "State suite")
+RunSpecs(t, "Serializer suite")
 }
 
 var (
@@ -36,7 +36,6 @@ var (
 )
 
 var _ = Describe(`Generic serializer`, func() {
-
 serializer := serialize.DefaultSerializer
 
 Context(`Bool`, func() {
@@ -104,7 +103,6 @@ var _ = Describe(`Generic serializer`, func() {
 })
 
 Context(`Proto`, func() {
-
 var serializedProto1 []byte
 It(`serialize`, func() {
 serializedProto1, err = serializer.ToBytesFrom(ProtoToSerialize)
@@ -125,10 +123,9 @@ var _ = Describe(`Generic serializer`, func() {
 })
 
 var _ = Describe(`Prefer JSON serializer`, func() {
-
 serializer := serialize.PreferJSONSerializer
-
 var serializedProtoAsJSON []byte
+
 It(`serialize (snake_case)`, func() {
 serializedProtoAsJSON, err = serializer.ToBytesFrom(ProtoToSerialize)
 Expect(err).NotTo(HaveOccurred())

state/mapping/mapping_test.go

@@ -1,15 +1,16 @@
 package mapping_test
 
 import (
+"reflect"
 "strconv"
 "strings"
 "testing"
 "time"
 
-"github.com/golang/protobuf/proto"
 "github.com/golang/protobuf/ptypes"
 . "github.com/onsi/ginkgo"
 . "github.com/onsi/gomega"
+"google.golang.org/protobuf/proto"
 
 identitytestdata "github.com/hyperledger-labs/cckit/identity/testdata"
 "github.com/hyperledger-labs/cckit/serialize"
@@ -27,16 +28,15 @@ func TestState(t *testing.T) {
 RunSpecs(t, "State suite")
 }
 
-var (
-compositeIDCC, complexIDCC, sliceIDCC, indexesCC, configCC *testcc.MockStub
+var _ = Describe(`State mapping in chaincode with default serializer`, func() {
 
-Owner = identitytestdata.Certificates[0].MustIdentity(`SOME_MSP`)
-)
-var _ = Describe(`State mapping in chaincode`, func() {
-
-BeforeSuite(func() {
+var (
+compositeIDCC, complexIDCC, sliceIDCC, indexesCC, configCC *testcc.MockStub
+Owner = identitytestdata.Certificates[0].MustIdentity(`SOME_MSP`)
+)
 
-compositeIDCC = testcc.NewMockStub(`proto`, testdata.NewCompositeIdCC())
+Describe(`init chaincodes`, func() {
+compositeIDCC = testcc.NewMockStub(`proto`, testdata.NewCompositeIdCC(serialize.DefaultSerializer))
 compositeIDCC.From(Owner).Init()
 
 complexIDCC = testcc.NewMockStub(`complex_id`, testdata.NewComplexIdCC())
@@ -60,7 +60,8 @@ var _ = Describe(`State mapping in chaincode`, func() {
 It("Allow to get mapping data by namespace", func() {
 mapping, err := testdata.EntityWithCompositeIdStateMapping.GetByNamespace(testdata.EntityCompositeIdNamespace)
 Expect(err).NotTo(HaveOccurred())
-Expect(mapping.Schema()).To(BeEquivalentTo(&schema.EntityWithCompositeId{}))
+Expect(reflect.TypeOf(mapping.Schema()).String()).To(
+Equal(reflect.TypeOf(&schema.EntityWithCompositeId{}).String()))
 
 key, err := mapping.PrimaryKey(&schema.EntityWithCompositeId{
 IdFirstPart: create1.IdFirstPart,
@@ -76,33 +77,33 @@ var _ = Describe(`State mapping in chaincode`, func() {
 
 It("Allow to add data to chaincode state", func(done Done) {
 events, closer := compositeIDCC.EventSubscription()
-expectcc.ResponseOk(compositeIDCC.Invoke(`create`, create1))
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.CreateFunc, create1))
 
 expectcc.EventStringerEqual(<-events,
 `CreateEntityWithCompositeId`, create1, compositeIDCC.Serializer)
 
-expectcc.ResponseOk(compositeIDCC.Invoke(`create`, create2))
-expectcc.ResponseOk(compositeIDCC.Invoke(`create`, create3))
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.CreateFunc, create2))
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.CreateFunc, create3))
 
 _ = closer()
 close(done)
 })
 
 It("Disallow to insert entries with same primary key", func() {
-expectcc.ResponseError(compositeIDCC.Invoke(`create`, create1), state.ErrKeyAlreadyExists)
+expectcc.ResponseError(compositeIDCC.Invoke(testdata.CreateFunc, create1), state.ErrKeyAlreadyExists)
 })
 
 It("Allow to get entry list", func() {
 // default serializer should serialize proto to / from binary representation
-entities := expectcc.PayloadIs(compositeIDCC.Query(`list`),
+entities := expectcc.PayloadIs(compositeIDCC.Query(testdata.ListFunc),
 &schema.EntityWithCompositeIdList{}, serialize.DefaultSerializer).(*schema.EntityWithCompositeIdList)
 Expect(len(entities.Items)).To(Equal(3))
 Expect(entities.Items[0].Name).To(Equal(create1.Name))
 Expect(entities.Items[0].Value).To(BeNumerically("==", create1.Value))
 })
 
 It("Allow to get entry raw protobuf", func() {
-dataFromCC := compositeIDCC.Query(`get`,
+dataFromCC := compositeIDCC.Query(testdata.GetFunc,
 &schema.EntityCompositeId{
 IdFirstPart: create1.IdFirstPart,
 IdSecondPart: create1.IdSecondPart,
@@ -122,7 +123,7 @@ var _ = Describe(`State mapping in chaincode`, func() {
 })
 
 It("Allow update data in chaincode state", func() {
-expectcc.ResponseOk(compositeIDCC.Invoke(`update`, &schema.UpdateEntityWithCompositeId{
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.UpdateFunc, &schema.UpdateEntityWithCompositeId{
 IdFirstPart: create1.IdFirstPart,
 IdSecondPart: create1.IdSecondPart,
 IdThirdPart: create1.IdThirdPart,
@@ -131,7 +132,7 @@ var _ = Describe(`State mapping in chaincode`, func() {
 }))
 
 entityFromCC := expectcc.PayloadIs(
-compositeIDCC.Query(`get`, &schema.EntityCompositeId{
+compositeIDCC.Query(testdata.GetFunc, &schema.EntityCompositeId{
 IdFirstPart: create1.IdFirstPart,
 IdSecondPart: create1.IdSecondPart,
 IdThirdPart: create1.IdThirdPart,
@@ -150,22 +151,21 @@ var _ = Describe(`State mapping in chaincode`, func() {
 IdThirdPart: create1.IdThirdPart,
 }
 
-expectcc.ResponseOk(compositeIDCC.Invoke(`delete`, toDelete))
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.DeleteFunc, toDelete))
 ee := expectcc.PayloadIs(
-compositeIDCC.Invoke(`list`),
+compositeIDCC.Invoke(testdata.ListFunc),
 &schema.EntityWithCompositeIdList{}, compositeIDCC.Serializer).(*schema.EntityWithCompositeIdList)
 
 Expect(len(ee.Items)).To(Equal(2))
-expectcc.ResponseError(compositeIDCC.Invoke(`get`, toDelete), state.ErrKeyNotFound)
+expectcc.ResponseError(compositeIDCC.Invoke(testdata.GetFunc, toDelete), state.ErrKeyNotFound)
 })
 
 It("Allow to insert entry once more time", func() {
-expectcc.ResponseOk(compositeIDCC.Invoke(`create`, create1))
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.CreateFunc, create1))
 })
 })
 
 Describe(`Entity with complex id`, func() {
-
 ent1 := testdata.CreateEntityWithComplextId[0]
 
 It("Allow to add data to chaincode state", func() {
@@ -391,3 +391,30 @@ var _ = Describe(`State mapping in chaincode`, func() {
 
 })
 })
+
+var _ = Describe(`State mapping in chaincode with JSON serializer`, func() {
+
+var (
+compositeIDCC *testcc.MockStub
+Owner = identitytestdata.Certificates[0].MustIdentity(`SOME_MSP`)
+)
+
+Describe("init chaincode", func() {
+compositeIDCC = testcc.NewMockStub(`proto`, testdata.NewCompositeIdCC(serialize.PreferJSONSerializer))
+compositeIDCC.Serializer = serialize.PreferJSONSerializer // need to set for correct invoking
+compositeIDCC.From(Owner).Init()
+})
+
+It("Allow to add data to chaincode state", func() {
+expectcc.ResponseOk(compositeIDCC.Invoke(testdata.CreateFunc, testdata.CreateEntityWithCompositeId[0]))
+})
+
+It("Allow to get entry list", func() {
+res := compositeIDCC.Query(testdata.ListFunc)
+Expect(string(res.Payload)[0:1]).To(Equal(`{`)) // json serialized
+entities := expectcc.JSONPayloadIs(res, &schema.EntityWithCompositeIdList{}).(*schema.EntityWithCompositeIdList)
+Expect(len(entities.Items)).To(Equal(1))
+Expect(entities.Items[0].Name).To(Equal(testdata.CreateEntityWithCompositeId[0].Name))
+Expect(entities.Items[0].Value).To(BeNumerically("==", testdata.CreateEntityWithCompositeId[0].Value))
+})
+})

state/mapping/testdata/cc_composite_id.go

@@ -5,6 +5,7 @@ import (
 "github.com/hyperledger-labs/cckit/extensions/owner"
 "github.com/hyperledger-labs/cckit/router"
 "github.com/hyperledger-labs/cckit/router/param/defparam"
+"github.com/hyperledger-labs/cckit/serialize"
 "github.com/hyperledger-labs/cckit/state"
 "github.com/hyperledger-labs/cckit/state/mapping"
 "github.com/hyperledger-labs/cckit/state/mapping/testdata/schema"
@@ -20,9 +21,8 @@ var (
 mapping.List(&schema.EntityWithCompositeIdList{}))
 )
 
-func NewCompositeIdCC() *router.Chaincode {
-r := router.New("composite_id")
-
+func NewCompositeIdCC(serializer serialize.Serializer) *router.Chaincode {
+r := router.New("composite_id", router.WithSerializer(serializer))
 r.Use(mapping.MapStates(EntityWithCompositeIdStateMapping))
 
 r.Use(mapping.MapEvents(mapping.EventMappings{}.
@@ -33,11 +33,11 @@ func NewCompositeIdCC() *router.Chaincode {
 debug.AddHandlers(r, "debug", owner.Only)
 
 r.
-Query("list", queryListComposite).
-Query("get", queryByIdComposite, defparam.Proto(&schema.EntityCompositeId{})).
-Invoke("create", invokeCreateComposite, defparam.Proto(&schema.CreateEntityWithCompositeId{})).
-Invoke("update", invokeUpdateComposite, defparam.Proto(&schema.UpdateEntityWithCompositeId{})).
-Invoke("delete", invokeDeleteComposite, defparam.Proto(&schema.EntityCompositeId{}))
+Query(ListFunc, queryListComposite).
+Query(GetFunc, queryByIdComposite, defparam.Proto(&schema.EntityCompositeId{})).
+Invoke(CreateFunc, invokeCreateComposite, defparam.Proto(&schema.CreateEntityWithCompositeId{})).
+Invoke(UpdateFunc, invokeUpdateComposite, defparam.Proto(&schema.UpdateEntityWithCompositeId{})).
+Invoke(DeleteFunc, invokeDeleteComposite, defparam.Proto(&schema.EntityCompositeId{}))
 
 return router.NewChaincode(r)
 }

state/mapping/testdata/funcs.go

@@ -0,0 +1,9 @@
+package testdata
+
+const (
+CreateFunc = `create`
+ListFunc = `list`
+GetFunc = `get`
+UpdateFunc = `update`
+DeleteFunc = `delete`
+)

state/state.go

@@ -218,7 +218,7 @@ func (s *Impl) Exists(entry interface{}) (bool, error) {
 // List data from state using objectType prefix in composite key, trying to convert to target interface.
 // Keys - additional components of composite key
 func (s *Impl) List(namespace interface{}, target ...interface{}) (interface{}, error) {
-stateList, err := NewStateList(target...)
+stateList, err := NewList(target...)
 if err != nil {
 return nil, err
 }
@@ -267,7 +267,7 @@ func (s *Impl) normalizeAndTransformKey(namespace interface{}) (Key, Key, error)
 func (s *Impl) ListPaginated(
 namespace interface{}, pageSize int32, bookmark string, target ...interface{}) (
 interface{}, *pb.QueryResponseMetadata, error) {
-stateList, err := NewStateList(target...)
+stateList, err := NewList(target...)
 if err != nil {
 return nil, nil, err
 }
@@ -469,7 +469,7 @@ func (s *Impl) ExistsPrivate(collection string, entry interface{}) (bool, error)
 // If usePrivateDataIterator is true, used private state for iterate over objects
 // if false, used public state for iterate over keys and GetPrivateData for each key
 func (s *Impl) ListPrivate(collection string, usePrivateDataIterator bool, namespace interface{}, target ...interface{}) (interface{}, error) {
-stateList, err := NewStateList(target...)
+stateList, err := NewList(target...)
 if err != nil {
 return nil, err
 }

state/state_list.go

@@ -13,14 +13,17 @@ import (
 )
 
 type (
-StateList struct {
-itemTarget interface{}
-listTarget interface{}
-list []interface{}
+List struct {
+itemTarget interface{} // type of item
+listTarget interface{} // type of item list
+list []interface{} // actual lost
 }
 )
 
-func NewStateList(config ...interface{}) (sl *StateList, err error) {
+// ListItemsField name of field with items in listTarget proto structure setting
+const ListItemsField = `Items`
+
+func NewList(config ...interface{}) (*List, error) {
 var (
 itemTarget, listTarget interface{}
 )
@@ -31,10 +34,11 @@ func NewStateList(config ...interface{}) (sl *StateList, err error) {
 listTarget = config[1]
 }
 
-return &StateList{itemTarget: itemTarget, listTarget: listTarget}, nil
+return &List{itemTarget: itemTarget, listTarget: listTarget}, nil
 }
 
-func (sl *StateList) Fill(
+// Fill state list from iterator
+func (sl *List) Fill(
 iter shim.StateQueryIteratorInterface, fromBytesConverter serialize.FromBytesConverter) (list interface{}, err error) {
 for iter.HasNext() {
 kv, err := iter.Next()
@@ -50,13 +54,12 @@ func (sl *StateList) Fill(
 return sl.Get()
 }
 
-func (sl *StateList) Get() (list interface{}, err error) {
-
-// custom list proto.Message
+func (sl *List) Get() (list interface{}, err error) {
+// list type is proto.Message, with predefined Items field
 if _, isListProto := sl.listTarget.(proto.Message); isListProto {
-
-customList := proto.Clone(sl.listTarget.(proto.Message))
+customList := proto.Clone(sl.listTarget.(proto.Message)) // create copy of list type proto message
 items := reflect.ValueOf(customList).Elem().FieldByName(`Items`)
+
 for _, v := range sl.list {
 items.Set(reflect.Append(items, reflect.ValueOf(v)))
 }
@@ -79,6 +82,6 @@ func (sl *StateList) Get() (list interface{}, err error) {
 return sl.list, nil
 }
 
-func (sl *StateList) AddElementToList(elem interface{}) {
+func (sl *List) AddElementToList(elem interface{}) {
 sl.list = append(sl.list, elem)
 }