[FAB-14207] extract extensions from protos/ledger

SetRawReads and SetMerkelSummary were moved to txmgmt/rwsetutil. Other
functions were, whereappropriate, were relocated to the point of use.

Change-Id: Id4775f5ccb9f673bfd5136af42203d76d9fe695e
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>

Author: sykesm

core/ledger/kvledger/hashcheck_pvtdata.go

@@ -103,7 +103,7 @@ func findValidAndInvalidTxPvtData(txPvtData *ledger.TxPvtData, txRWSet *rwsetuti
 		toDeleteNsColl = append(toDeleteNsColl, invalidNsColl...)
 	}
 	for _, nsColl := range toDeleteNsColl {
-		txPvtData.WriteSet.Remove(nsColl.ns, nsColl.coll)
+		removeCollFromTxPvtReadWriteSet(txPvtData.WriteSet, nsColl.ns, nsColl.coll)
 	}
 	if len(txPvtData.WriteSet.NsPvtRwset) == 0 {
 		// denotes that all namespaces had
@@ -113,6 +113,33 @@ func findValidAndInvalidTxPvtData(txPvtData *ledger.TxPvtData, txRWSet *rwsetuti
 	return txPvtData, invalidPvtData
 }
 
+// Remove removes the rwset for the given <ns, coll> tuple. If after this removal,
+// there are no more collection in the namespace <ns>, the whole namespace entry is removed
+func removeCollFromTxPvtReadWriteSet(p *rwset.TxPvtReadWriteSet, ns, coll string) {
+	for i := 0; i < len(p.NsPvtRwset); i++ {
+		n := p.NsPvtRwset[i]
+		if n.Namespace != ns {
+			continue
+		}
+		removeCollFromNsPvtWriteSet(n, coll)
+		if len(n.CollectionPvtRwset) == 0 {
+			p.NsPvtRwset = append(p.NsPvtRwset[:i], p.NsPvtRwset[i+1:]...)
+		}
+		return
+	}
+}
+
+func removeCollFromNsPvtWriteSet(n *rwset.NsPvtReadWriteSet, collName string) {
+	for i := 0; i < len(n.CollectionPvtRwset); i++ {
+		c := n.CollectionPvtRwset[i]
+		if c.CollectionName != collName {
+			continue
+		}
+		n.CollectionPvtRwset = append(n.CollectionPvtRwset[:i], n.CollectionPvtRwset[i+1:]...)
+		return
+	}
+}
+
 type nsColl struct {
 	ns, coll string
 }

core/ledger/kvledger/hashcheck_pvtdata_test.go

@@ -156,3 +156,61 @@ func produceSamplePvtdata(t *testing.T, txNum uint64, nsColls []string, values [
 	assert.NoError(t, err)
 	return &ledger.TxPvtData{SeqInBlock: txNum, WriteSet: simRes.PvtSimulationResults}, pubSimulationResultsBytes
 }
+
+func TestRemoveCollFromTxPvtReadWriteSet(t *testing.T) {
+	txpvtrwset := testutilConstructSampleTxPvtRwset(
+		[]*testNsColls{
+			{ns: "ns-1", colls: []string{"coll-1", "coll-2"}},
+			{ns: "ns-2", colls: []string{"coll-3", "coll-4"}},
+		},
+	)
+
+	removeCollFromTxPvtReadWriteSet(txpvtrwset, "ns-1", "coll-1")
+	assert.Equal(
+		t,
+		testutilConstructSampleTxPvtRwset(
+			[]*testNsColls{
+				{ns: "ns-1", colls: []string{"coll-2"}},
+				{ns: "ns-2", colls: []string{"coll-3", "coll-4"}},
+			},
+		),
+		txpvtrwset,
+	)
+
+	removeCollFromTxPvtReadWriteSet(txpvtrwset, "ns-1", "coll-2")
+	assert.Equal(
+		t,
+		testutilConstructSampleTxPvtRwset(
+			[]*testNsColls{
+				{ns: "ns-2", colls: []string{"coll-3", "coll-4"}},
+			},
+		),
+		txpvtrwset,
+	)
+}
+
+func testutilConstructSampleTxPvtRwset(nsCollsList []*testNsColls) *rwset.TxPvtReadWriteSet {
+	txPvtRwset := &rwset.TxPvtReadWriteSet{}
+	for _, nsColls := range nsCollsList {
+		ns := nsColls.ns
+		nsdata := &rwset.NsPvtReadWriteSet{
+			Namespace:          ns,
+			CollectionPvtRwset: []*rwset.CollectionPvtReadWriteSet{},
+		}
+		txPvtRwset.NsPvtRwset = append(txPvtRwset.NsPvtRwset, nsdata)
+		for _, coll := range nsColls.colls {
+			nsdata.CollectionPvtRwset = append(nsdata.CollectionPvtRwset,
+				&rwset.CollectionPvtReadWriteSet{
+					CollectionName: coll,
+					Rwset:          []byte(fmt.Sprintf("pvtrwset-for-%s-%s", ns, coll)),
+				},
+			)
+		}
+	}
+	return txPvtRwset
+}
+
+type testNsColls struct {
+	ns    string
+	colls []string
+}

protos/ledger/rwset/kvrwset/tests/kv_rwset_test.go renamed to core/ledger/kvledger/txmgmt/rwsetutil/kv_rwset_test.go

@@ -1,20 +1,10 @@
 /*
 Copyright IBM Corp. 2016 All Rights Reserved.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-		 http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+SPDX-License-Identifier: Apache-2.0
 */
 
-package kvrwset
+package rwsetutil
 
 import (
 	"io/ioutil"
@@ -26,7 +16,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-const binaryTestFileName = "kvrwsetV1ProtoBytes"
+const binaryTestFileName = "testdata/kvrwsetV1ProtoBytes"
 
 // TestKVRWSetV1BackwardCompatible passes if the 'KVRWSet' messgae declared in the latest version
 // is able to unmarshal the protobytes that are produced by the 'KVRWSet' proto message declared in
@@ -53,13 +43,13 @@ func PrepareBinaryFileSampleKVRWSetV1(t *testing.T) {
 
 func constructSampleKVRWSet() *kvrwset.KVRWSet {
 	rqi1 := &kvrwset.RangeQueryInfo{StartKey: "k0", EndKey: "k9", ItrExhausted: true}
-	rqi1.SetRawReads([]*kvrwset.KVRead{
+	SetRawReads(rqi1, []*kvrwset.KVRead{
 		{Key: "k1", Version: &kvrwset.Version{BlockNum: 1, TxNum: 1}},
 		{Key: "k2", Version: &kvrwset.Version{BlockNum: 1, TxNum: 2}},
 	})
 
 	rqi2 := &kvrwset.RangeQueryInfo{StartKey: "k00", EndKey: "k90", ItrExhausted: true}
-	rqi2.SetMerkelSummary(&kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
+	SetMerkelSummary(rqi2, &kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
 	return &kvrwset.KVRWSet{
 		Reads:            []*kvrwset.KVRead{{Key: "key1", Version: &kvrwset.Version{BlockNum: 1, TxNum: 1}}},
 		RangeQueriesInfo: []*kvrwset.RangeQueryInfo{rqi1, rqi2},

core/ledger/kvledger/txmgmt/rwsetutil/kvrwset_proto_util.go

@@ -0,0 +1,23 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package rwsetutil
+
+import "github.com/hyperledger/fabric/protos/ledger/rwset/kvrwset"
+
+// SetRawReads sets the 'readsInfo' field to raw KVReads performed by the query
+func SetRawReads(rqi *kvrwset.RangeQueryInfo, kvReads []*kvrwset.KVRead) {
+	rqi.ReadsInfo = &kvrwset.RangeQueryInfo_RawReads{
+		RawReads: &kvrwset.QueryReads{
+			KvReads: kvReads,
+		},
+	}
+}
+
+// SetMerkelSummary sets the 'readsInfo' field to merkle summary of the raw KVReads of query results
+func SetMerkelSummary(rqi *kvrwset.RangeQueryInfo, merkleSummary *kvrwset.QueryReadsMerkleSummary) {
+	rqi.ReadsInfo = &kvrwset.RangeQueryInfo_ReadsMerkleHashes{ReadsMerkleHashes: merkleSummary}
+}

core/ledger/kvledger/txmgmt/rwsetutil/kvrwset_proto_util_test.go

@@ -0,0 +1,44 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package rwsetutil
+
+import (
+	"testing"
+
+	"github.com/hyperledger/fabric/protos/ledger/rwset/kvrwset"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSetRawReads(t *testing.T) {
+	rqi := &kvrwset.RangeQueryInfo{StartKey: "start", EndKey: "end"}
+	kvReads := []*kvrwset.KVRead{{Key: "key1"}, {Key: "key2"}}
+
+	expected := &kvrwset.RangeQueryInfo{
+		StartKey: "start",
+		EndKey:   "end",
+		ReadsInfo: &kvrwset.RangeQueryInfo_RawReads{
+			RawReads: &kvrwset.QueryReads{KvReads: kvReads},
+		},
+	}
+
+	SetRawReads(rqi, kvReads)
+	assert.Equal(t, expected, rqi)
+}
+
+func TestSetMerkelSummary(t *testing.T) {
+	rqi := &kvrwset.RangeQueryInfo{StartKey: "start", EndKey: "end"}
+	merkleSummary := &kvrwset.QueryReadsMerkleSummary{MaxDegree: 12, MaxLevel: 99}
+
+	expected := &kvrwset.RangeQueryInfo{
+		StartKey:  "start",
+		EndKey:    "end",
+		ReadsInfo: &kvrwset.RangeQueryInfo_ReadsMerkleHashes{ReadsMerkleHashes: merkleSummary},
+	}
+
+	SetMerkelSummary(rqi, merkleSummary)
+	assert.Equal(t, expected, rqi)
+}

core/ledger/kvledger/txmgmt/rwsetutil/rwset_builder_test.go

@@ -33,19 +33,19 @@ func TestTxSimulationResultWithOnlyPubData(t *testing.T) {
 
 	rqi1 := &kvrwset.RangeQueryInfo{StartKey: "bKey", EndKey: "", ItrExhausted: false, ReadsInfo: nil}
 	rqi1.EndKey = "eKey"
-	rqi1.SetRawReads([]*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
+	SetRawReads(rqi1, []*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
 	rqi1.ItrExhausted = true
 	rwSetBuilder.AddToRangeQuerySet("ns1", rqi1)
 
 	rqi2 := &kvrwset.RangeQueryInfo{StartKey: "bKey", EndKey: "", ItrExhausted: false, ReadsInfo: nil}
 	rqi2.EndKey = "eKey"
-	rqi2.SetRawReads([]*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
+	SetRawReads(rqi2, []*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
 	rqi2.ItrExhausted = true
 	rwSetBuilder.AddToRangeQuerySet("ns1", rqi2)
 
 	rqi3 := &kvrwset.RangeQueryInfo{StartKey: "bKey", EndKey: "", ItrExhausted: true, ReadsInfo: nil}
 	rqi3.EndKey = "eKey1"
-	rqi3.SetRawReads([]*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
+	SetRawReads(rqi3, []*kvrwset.KVRead{NewKVRead("bKey1", version.NewHeight(2, 3)), NewKVRead("bKey2", version.NewHeight(2, 4))})
 	rwSetBuilder.AddToRangeQuerySet("ns1", rqi3)
 
 	rwSetBuilder.AddToReadSet("ns2", "key2", version.NewHeight(1, 2))

core/ledger/kvledger/txmgmt/rwsetutil/rwset_proto_util_test.go

@@ -31,13 +31,13 @@ func TestTxRWSetMarshalUnmarshal(t *testing.T) {
 	txRwSet := &TxRwSet{}
 
 	rqi1 := &kvrwset.RangeQueryInfo{StartKey: "k0", EndKey: "k9", ItrExhausted: true}
-	rqi1.SetRawReads([]*kvrwset.KVRead{
+	SetRawReads(rqi1, []*kvrwset.KVRead{
 		{Key: "k1", Version: &kvrwset.Version{BlockNum: 1, TxNum: 1}},
 		{Key: "k2", Version: &kvrwset.Version{BlockNum: 1, TxNum: 2}},
 	})
 
 	rqi2 := &kvrwset.RangeQueryInfo{StartKey: "k00", EndKey: "k90", ItrExhausted: true}
-	rqi2.SetMerkelSummary(&kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
+	SetMerkelSummary(rqi2, &kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
 
 	txRwSet.NsRwSets = []*NsRwSet{
 		{NameSpace: "ns1", KvRwSet: &kvrwset.KVRWSet{
@@ -155,13 +155,13 @@ func sampleNsRwSetWithNoCollHashedRWs(ns string) *NsRwSet {
 
 func sampleKvRwSet() *kvrwset.KVRWSet {
 	rqi1 := &kvrwset.RangeQueryInfo{StartKey: "k0", EndKey: "k9", ItrExhausted: true}
-	rqi1.SetRawReads([]*kvrwset.KVRead{
+	SetRawReads(rqi1, []*kvrwset.KVRead{
 		{Key: "k1", Version: &kvrwset.Version{BlockNum: 1, TxNum: 1}},
 		{Key: "k2", Version: &kvrwset.Version{BlockNum: 1, TxNum: 2}},
 	})
 
 	rqi2 := &kvrwset.RangeQueryInfo{StartKey: "k00", EndKey: "k90", ItrExhausted: true}
-	rqi2.SetMerkelSummary(&kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
+	SetMerkelSummary(rqi2, &kvrwset.QueryReadsMerkleSummary{MaxDegree: 5, MaxLevel: 4, MaxLevelHashes: [][]byte{[]byte("Hash-1"), []byte("Hash-2")}})
 	return &kvrwset.KVRWSet{
 		Reads:            []*kvrwset.KVRead{{Key: "key1", Version: &kvrwset.Version{BlockNum: 1, TxNum: 1}}},
 		RangeQueriesInfo: []*kvrwset.RangeQueryInfo{rqi1},

protos/ledger/rwset/kvrwset/tests/.gitattributes renamed to core/ledger/kvledger/txmgmt/rwsetutil/testdata/.gitattributes

@@ -300,10 +300,10 @@ func (h *queryHelper) addRangeQueryInfo() {
 				return
 			}
 			if results != nil {
-				itr.rangeQueryInfo.SetRawReads(results)
+				rwsetutil.SetRawReads(itr.rangeQueryInfo, results)
 			}
 			if hash != nil {
-				itr.rangeQueryInfo.SetMerkelSummary(hash)
+				rwsetutil.SetMerkelSummary(itr.rangeQueryInfo, hash)
 			}
 			h.rwsetBuilder.AddToRangeQuerySet(itr.ns, itr.rangeQueryInfo)
 		}