[FABG-822] test pvt data reconciliation

Change-Id: I71a0310d28db101a82f68aa15352c42c9a584247
Signed-off-by: Baha Shaaban <baha.shaaban@securekey.com>

Author: Baha Shaaban

test/fixtures/dockerenv/docker-compose.yaml

@@ -128,6 +128,7 @@ services:
       - CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/tls/peer/ca.crt
       - CORE_PEER_TLS_CLIENTAUTHREQUIRED
       - CORE_PEER_TLS_CLIENTROOTCAS_FILES
+      - CORE_PEER_GOSSIP_PVTDATA_RECONCILESLEEPINTERVAL=1s
       # # the following setting starts chaincode containers on the same
       # # bridge network as the peers
       # # https://docs.docker.com/compose/networking/
@@ -186,6 +187,7 @@ services:
       - CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/tls/peer/ca.crt
       - CORE_PEER_TLS_CLIENTAUTHREQUIRED
       - CORE_PEER_TLS_CLIENTROOTCAS_FILES
+      - CORE_PEER_GOSSIP_PVTDATA_RECONCILESLEEPINTERVAL=1s
       # # the following setting starts chaincode containers on the same
       # # bridge network as the peers
       # # https://docs.docker.com/compose/networking/
@@ -246,6 +248,7 @@ services:
       - CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/tls/peer/ca.crt
       - CORE_PEER_TLS_CLIENTAUTHREQUIRED
       - CORE_PEER_TLS_CLIENTROOTCAS_FILES
+      - CORE_PEER_GOSSIP_PVTDATA_RECONCILESLEEPINTERVAL=1s
       # # the following setting starts chaincode containers on the same
       # # bridge network as the peers
       # # https://docs.docker.com/compose/networking/
@@ -305,6 +308,7 @@ services:
       - CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/tls/peer/ca.crt
       - CORE_PEER_TLS_CLIENTAUTHREQUIRED
       - CORE_PEER_TLS_CLIENTROOTCAS_FILES
+      - CORE_PEER_GOSSIP_PVTDATA_RECONCILESLEEPINTERVAL=1s
       # # the following setting starts chaincode containers on the same
       # # bridge network as the peers
       # # https://docs.docker.com/compose/networking/

test/integration/base_test_setup.go

@@ -325,6 +325,27 @@ func InstantiateChaincode(resMgmt *resmgmt.Client, channelID, ccName, ccPath, cc
 	)
 }
 
+// UpgradeChaincode upgrades the given chaincode on the given channel
+func UpgradeChaincode(resMgmt *resmgmt.Client, channelID, ccName, ccPath, ccVersion string, ccPolicyStr string, args [][]byte, collConfigs ...*cb.CollectionConfig) (resmgmt.UpgradeCCResponse, error) {
+	ccPolicy, err := cauthdsl.FromString(ccPolicyStr)
+	if err != nil {
+		return resmgmt.UpgradeCCResponse{}, errors.Wrapf(err, "error creating CC policy [%s]", ccPolicyStr)
+	}
+
+	return resMgmt.UpgradeCC(
+		channelID,
+		resmgmt.UpgradeCCRequest{
+			Name:       ccName,
+			Path:       ccPath,
+			Version:    ccVersion,
+			Args:       args,
+			Policy:     ccPolicy,
+			CollConfig: collConfigs,
+		},
+		resmgmt.WithRetry(retry.DefaultResMgmtOpts),
+	)
+}
+
 // DiscoverLocalPeers queries the local peers for the given MSP context and returns all of the peers. If
 // the number of peers does not match the expected number then an error is returned.
 func DiscoverLocalPeers(ctxProvider contextAPI.ClientProvider, expectedPeers int) ([]fabAPI.Peer, error) {

test/integration/e2e/configless/metricconfig_override_test.go

@@ -38,14 +38,14 @@ var (
 
 type exampleOperation struct{}
 
-//OperationCfg overrides MetricsConfig's OperationConfig function which returns the operations config
+//OperationCfg overrides MetricsConfig's OperationConfig function which returns the operations system config
 func (m *exampleOperation) OperationCfg() cfg.OperationConfig {
 	return operationConfig
 }
 
 type exampleMetric struct{}
 
-//MetricCfg overrides MetricsConfig's OperationConfig function which returns the operations config
+//MetricCfg overrides MetricsConfig's MetricConfig function which returns the metrics specific config
 func (m *exampleMetric) MetricCfg() cfg.MetricConfig {
 	return metricConfig
 }

test/integration/pkg/client/channel/channel_client_pvt_test.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 	"sync"
 	"testing"
+	"time"
 
 	"github.com/hyperledger/fabric-sdk-go/pkg/common/errors/retry"
 	"github.com/hyperledger/fabric-sdk-go/pkg/common/errors/status"
@@ -366,3 +367,221 @@ func newCollectionConfig(colName, policy string, reqPeerCount, maxPeerCount int3
 		},
 	}, nil
 }
+
+// TestPrivateDataReconcilePutAndGet tests put and get for private data with reconciliation of missing eligible data on some peers (org2's peers)
+// the idea to test private data reconciliation is to set a test collection with a policy of 1 member org, put/get private data
+// then update the collection config with a new policy of 2 member orgs, private data should be reconciled on peers of the newly added org
+func TestPrivateDataReconcilePutAndGet(t *testing.T) {
+	sdk := mainSDK
+	singleOrgPolicy := "AND('Org1MSP.member')"
+	multiOrgsPolicy := "OR('Org1MSP.member','Org2MSP.member')"
+	coll1 := "collectionx"
+	ccID := integration.GenerateExamplePvtID(true)
+	orgsContext := setupMultiOrgContext(t, sdk)
+
+	// instantiate and install CC on all peers using collection policy for org1 only then put/get some pvt data
+	runPvtDataPreReconcilePutAndGet(t, sdk, orgsContext, singleOrgPolicy, ccID, coll1)
+	// now verify pvt data is not available on org2 peers
+	verifyPvtDataPreReconcileGet(t, sdk, ccID, coll1)
+	// upgrade CC to include org2 in collection policy then verify pvt data is available on org2's peers
+	runPvtDataPostReconcileGet(t, sdk, orgsContext, multiOrgsPolicy, ccID, coll1)
+}
+
+func runPvtDataPreReconcilePutAndGet(t *testing.T, sdk *fabsdk.FabricSDK, orgsContext []*integration.OrgContext, policy, ccID, coll1 string) {
+	err := integration.EnsureChannelCreatedAndPeersJoined(t, sdk, orgChannelID, "orgchannel.tx", orgsContext)
+	require.NoError(t, err)
+
+	collConfig, err := newCollectionConfig(coll1, policy, 0, 2, 1000)
+	require.NoError(t, err)
+
+	err = integration.InstallExamplePvtChaincode(orgsContext, ccID)
+	require.NoError(t, err)
+	err = integration.InstantiateExamplePvtChaincode(orgsContext, orgChannelID, ccID, policy, collConfig)
+	require.NoError(t, err)
+
+	ctxProvider := sdk.ChannelContext(orgChannelID, fabsdk.WithUser(org1User), fabsdk.WithOrg(org1Name))
+
+	chClient, err := channel.New(ctxProvider)
+	require.NoError(t, err)
+
+	key1 := "key1"
+	key2 := "key2"
+	key3 := "key3"
+	value1 := "pvtValue1"
+	value2 := "pvtValue2"
+	value3 := "pvtValue3"
+
+	response, err := chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key1)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload: [%s]", string(response.Payload))
+	require.Nil(t, response.Payload)
+
+	response, err = chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivatebyrange",
+			Args:        [][]byte{[]byte(coll1), []byte(key1), []byte(key3)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload: [%s]", string(response.Payload))
+	require.Empty(t, string(response.Payload))
+
+	response, err = chClient.Execute(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "putprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key1), []byte(value1)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+	)
+	require.NoError(t, err)
+	require.NotEmptyf(t, response.Responses, "expecting at least one response")
+
+	response, err = chClient.Execute(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "putprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key2), []byte(value2)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+	)
+	require.NoError(t, err)
+	require.NotEmptyf(t, response.Responses, "expecting at least one response")
+
+	response, err = chClient.Execute(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "putprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key3), []byte(value3)},
+		},
+		channel.WithRetry(retry.TestRetryOpts),
+	)
+	require.NoError(t, err)
+	require.NotEmptyf(t, response.Responses, "expecting at least one response")
+
+	response, err = chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key1)},
+		},
+		channel.WithRetry(retry.TestRetryOpts),
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload for getprivate: %s", string(response.Payload))
+	require.Equal(t, value1, string(response.Payload))
+
+	response, err = chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivatebyrange",
+			Args:        [][]byte{[]byte(coll1), []byte(key1), []byte(key3)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload for getprivatebyrange: [%s]", string(response.Payload))
+	require.NotEmpty(t, string(response.Payload))
+}
+
+func verifyPvtDataPreReconcileGet(t *testing.T, sdk *fabsdk.FabricSDK, ccID, coll1 string) {
+	// create ctxProvider for org2 to query org2 peers for pvt data (should be empty)
+	ctxProvider := sdk.ChannelContext(orgChannelID, fabsdk.WithUser(org1User), fabsdk.WithOrg(org2Name))
+
+	// org2 peers are the only targets to test pre reconciliation as they should not have the pvt data as per the collection policy (singleOrgPolicy)
+	org2TargetOpts := channel.WithTargetEndpoints("peer0.org2.example.com", "peer1.org2.example.com")
+	chClient, err := channel.New(ctxProvider)
+	require.NoError(t, err)
+
+	key1 := "key1"
+	key3 := "key3"
+
+	response, err := chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key1)},
+		},
+		channel.WithRetry(retry.TestRetryOpts),
+		org2TargetOpts, // query org2 peers to ensure they don't have pvt data
+	)
+	require.Error(t, err)
+	t.Logf("Got response payload for getprivate: %s", string(response.Payload))
+	require.Empty(t, response.Payload)
+
+	response, err = chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivatebyrange",
+			Args:        [][]byte{[]byte(coll1), []byte(key1), []byte(key3)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+		org2TargetOpts, // query org2 peers to ensure they don't have pvt data
+	)
+
+	// for some reason, the peer throws an error for getprivate cc invoke(Failed to handle GET_STATE. error: private data matching public hash version is not available.),
+	// but not for getprivatebyrange cc invoke (it only returns empty payload)
+	require.NoError(t, err)
+	t.Logf("Got response payload for getprivatebyrange: [%s]", string(response.Payload))
+	require.Empty(t, string(response.Payload))
+
+}
+
+func runPvtDataPostReconcileGet(t *testing.T, sdk *fabsdk.FabricSDK, orgsContext []*integration.OrgContext, policy, ccID, coll1 string) {
+	collConfig, err := newCollectionConfig(coll1, policy, 0, 2, 1000)
+	require.NoError(t, err)
+
+	// org2 peers are the only targets to test post reconciliation as they should have the pvt data after cc upgrade as per the new collection policy (multiOrgsPolicy)
+	org2TargetOpts := channel.WithTargetEndpoints("peer0.org2.example.com", "peer1.org2.example.com")
+
+	err = integration.UpgradeExamplePvtChaincode(orgsContext, orgChannelID, ccID, policy, collConfig)
+	require.NoError(t, err)
+
+	// wait for pvt data reconciliation occurs on peers of org2
+	time.Sleep(2 * time.Second)
+
+	// create ctxProvider for org2 to query org2 peers for pvt data (should be not empty/reconciled)
+	ctxProvider := sdk.ChannelContext(orgChannelID, fabsdk.WithUser(org1User), fabsdk.WithOrg(org2Name))
+
+	chClient, err := channel.New(ctxProvider)
+	require.NoError(t, err)
+
+	key1 := "key1"
+	key3 := "key3"
+	value1 := "pvtValue1"
+
+	response, err := chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivate",
+			Args:        [][]byte{[]byte(coll1), []byte(key1)},
+		},
+		channel.WithRetry(retry.TestRetryOpts),
+		org2TargetOpts,
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload for getprivate: %s", string(response.Payload))
+	require.Equal(t, value1, string(response.Payload))
+
+	response, err = chClient.Query(
+		channel.Request{
+			ChaincodeID: ccID,
+			Fcn:         "getprivatebyrange",
+			Args:        [][]byte{[]byte(coll1), []byte(key1), []byte(key3)},
+		},
+		channel.WithRetry(retry.DefaultChannelOpts),
+		org2TargetOpts,
+	)
+	require.NoError(t, err)
+	t.Logf("Got response payload for getprivatebyrange: [%s]", string(response.Payload))
+	require.NotEmpty(t, string(response.Payload))
+}

test/integration/prepare.go

@@ -36,6 +36,7 @@ const (
 	examplePvtCCName    = "example_pvt_cc"
 	examplePvtCCPath    = "github.com/example_pvt_cc"
 	examplePvtCCVersion = "v0"
+	exampleUpgdPvtCCVer = "v1"
 )
 
 // GenerateExamplePvtID supplies a chaincode name for example_pvt_cc
@@ -149,6 +150,23 @@ func InstantiateExamplePvtChaincode(orgs []*OrgContext, channelID, ccID, ccPolic
 	return err
 }
 
+// UpgradeExamplePvtChaincode upgrades the instantiated example pvt CC on the given channel
+func UpgradeExamplePvtChaincode(orgs []*OrgContext, channelID, ccID, ccPolicy string, collConfigs ...*cb.CollectionConfig) error {
+	// first install the CC with the upgraded cc version
+	ccPkg, err := packager.NewCCPackage(examplePvtCCPath, GetDeployPath())
+	if err != nil {
+		return errors.WithMessage(err, "creating chaincode package failed")
+	}
+	err = InstallChaincodeWithOrgContexts(orgs, ccPkg, examplePvtCCPath, ccID, exampleUpgdPvtCCVer)
+	if err != nil {
+		return errors.WithMessage(err, "installing example chaincode failed")
+	}
+
+	// now upgrade cc
+	_, err = UpgradeChaincode(orgs[0].ResMgmt, channelID, ccID, examplePvtCCPath, exampleUpgdPvtCCVer, ccPolicy, ExampleCCInitArgs(), collConfigs...)
+	return err
+}
+
 func resetExampleCC(sdk *fabsdk.FabricSDK, user fabsdk.ContextOption, orgName string, channelID string, chainCodeID string, args [][]byte) error {
 	clientContext := sdk.ChannelContext(channelID, user, fabsdk.WithOrg(orgName))