[FAB-5172] Keyvaluestore refactor and test coverage..

[FAB-4694] Orderer package refactoring

Change-Id: I5b79826e8bf1f50bce1053617d9014ceecde325a
Signed-off-by: Sudesh Shetty <sudesh.shetty@securekey.com>

Author: sudeshrshetty

api/apifabclient/keyvaluestore.go

@@ -20,7 +20,7 @@ type KeyValueStore interface {
 	 * @param {string} name of the key
 	 * @returns {[]byte}
 	 */
-	GetValue(key string) ([]byte, error)
+	Value(key string) ([]byte, error)
 
 	/**
 	 * Set the value associated with name.

api/apifabclient/orderer.go

@@ -13,7 +13,7 @@ import (
 // Orderer The Orderer class represents a peer in the target blockchain network to which
 // HFC sends a block of transactions of endorsed proposals requiring ordering.
 type Orderer interface {
-	GetURL() string
+	URL() string
 	SendBroadcast(envelope *SignedEnvelope) (*common.Status, error)
 	SendDeliver(envelope *SignedEnvelope) (chan *common.Block, chan error)
 }

pkg/fabric-client/channel/channel.go

@@ -250,12 +250,13 @@ func (c *channel) PrimaryPeer() fab.Peer {
 * @param {Orderer} orderer An instance of the Orderer class.
 * @throws {Error} if the orderer with that url already exists.
  */
+
 func (c *channel) AddOrderer(orderer fab.Orderer) error {
-	url := orderer.GetURL()
+	url := orderer.URL()
 	if c.orderers[url] != nil {
 		return fmt.Errorf("Orderer with URL %s already exists", url)
 	}
-	c.orderers[orderer.GetURL()] = orderer
+	c.orderers[orderer.URL()] = orderer
 	return nil
 }
 
@@ -264,8 +265,9 @@ func (c *channel) AddOrderer(orderer fab.Orderer) error {
 * Remove orderer endpoint from a channel object, this is a local-only operation.
 * @param {Orderer} orderer An instance of the Orderer class.
  */
+
 func (c *channel) RemoveOrderer(orderer fab.Orderer) {
-	url := orderer.GetURL()
+	url := orderer.URL()
 	if c.orderers[url] != nil {
 		delete(c.orderers, url)
 		logger.Debugf("Removed orderer with URL %s", url)
@@ -1297,14 +1299,14 @@ func (c *channel) BroadcastEnvelope(envelope *fab.SignedEnvelope) ([]*apitxn.Tra
 			defer wg.Done()
 			var transactionResponse *apitxn.TransactionResponse
 
-			logger.Debugf("Broadcasting envelope to orderer :%s\n", orderer.GetURL())
+			logger.Debugf("Broadcasting envelope to orderer :%s\n", orderer.URL())
 			if _, err := orderer.SendBroadcast(envelope); err != nil {
 				logger.Debugf("Receive Error Response from orderer :%v\n", err)
-				transactionResponse = &apitxn.TransactionResponse{Orderer: orderer.GetURL(),
-					Err: fmt.Errorf("Error calling orderer '%s':  %s", orderer.GetURL(), err)}
+				transactionResponse = &apitxn.TransactionResponse{Orderer: orderer.URL(),
+					Err: fmt.Errorf("Error calling orderer '%s':  %s", orderer.URL(), err)}
 			} else {
 				logger.Debugf("Receive Success Response from orderer\n")
-				transactionResponse = &apitxn.TransactionResponse{Orderer: orderer.GetURL(), Err: nil}
+				transactionResponse = &apitxn.TransactionResponse{Orderer: orderer.URL(), Err: nil}
 			}
 
 			responseMtx.Lock()
@@ -1331,8 +1333,10 @@ func (c *channel) SendEnvelope(envelope *fab.SignedEnvelope) (*common.Block, err
 
 	// Send the request to all orderers and return as soon as one responds with a block.
 	for _, o := range c.orderers {
+
 		go func(orderer fab.Orderer) {
-			logger.Debugf("Broadcasting envelope to orderer :%s\n", orderer.GetURL())
+			logger.Debugf("Broadcasting envelope to orderer :%s\n", orderer.URL())
+
 			blocks, errors := orderer.SendDeliver(envelope)
 			select {
 			case block := <-blocks:

pkg/fabric-client/client.go

@@ -198,7 +198,7 @@ func (c *client) LoadUserFromStateStore(name string) (fab.User, error) {
 	if c.cryptoSuite == nil {
 		return nil, fmt.Errorf("cryptoSuite is nil")
 	}
-	value, err := c.stateStore.GetValue(name)
+	value, err := c.stateStore.Value(name)
 	if err != nil {
 		return nil, nil
 	}
@@ -423,7 +423,7 @@ func (c *client) CreateOrUpdateChannel(request *fab.CreateChannelRequest, haveEn
 		Payload:   payloadBytes,
 	})
 	if err != nil {
-		return fmt.Errorf("Could not broadcast to orderer %s: %s", request.Orderer.GetURL(), err.Error())
+		return fmt.Errorf("Could not broadcast to orderer %s: %s", request.Orderer.URL(), err.Error())
 	}
 
 	return nil

pkg/fabric-client/client_test.go

@@ -114,7 +114,7 @@ func TestClientMethods(t *testing.T) {
 	}
 	client.SetStateStore(stateStore)
 	client.GetStateStore().SetValue("testvalue", []byte("data"))
-	value, err := client.GetStateStore().GetValue("testvalue")
+	value, err := client.GetStateStore().Value("testvalue")
 	if err != nil {
 		t.Fatalf("client.GetStateStore().GetValue() return error[%s]", err)
 	}

pkg/fabric-client/keyvaluestore/filekeyvaluestore.go

@@ -33,13 +33,13 @@ func CreateNewFileKeyValueStore(path string) (*FileKeyValueStore, error) {
 	return &FileKeyValueStore{path: path}, nil
 }
 
-// GetValue ...
+// Value ...
 /**
  * Get the value associated with name.
  * @param {string} name
  * @returns []byte for the value
  */
-func (fkvs *FileKeyValueStore) GetValue(key string) ([]byte, error) {
+func (fkvs *FileKeyValueStore) Value(key string) ([]byte, error) {
 	file := path.Join(fkvs.path, key+".json")
 	value, err := ioutil.ReadFile(file)
 	if err != nil {

pkg/fabric-client/keyvaluestore/filekeyvaluestore_test.go

@@ -16,12 +16,33 @@ func TestFKVSMethods(t *testing.T) {
 		t.Fatalf("CreateNewFileKeyValueStore return error[%s]", err)
 	}
 	stateStore.SetValue("testvalue", []byte("data"))
-	value, err := stateStore.GetValue("testvalue")
+	value, err := stateStore.Value("testvalue")
 	if err != nil {
 		t.Fatalf("stateStore.GetValue return error[%s]", err)
 	}
 	if string(value) != "data" {
 		t.Fatalf("stateStore.GetValue didn't return the right value")
 	}
+}
+
+func TestFKVSMethodsForFailures(t *testing.T) {
+
+	stateStore, err := CreateNewFileKeyValueStore("")
+
+	if err == nil || err.Error() != "FileKeyValueStore path is empty" {
+		t.Fatal("File path validation on CreateNewFileKeyValueStore is not working as expected")
+	}
+
+	stateStore, err = CreateNewFileKeyValueStore("/tmp/keyvaluestore")
+
+	_, err = stateStore.Value("invalid")
+	if err == nil {
+		t.Fatal(" fetching value was supposed to fail")
+	}
+
+	err = stateStore.SetValue("testvalue.json//C;", []byte(""))
+	if err == nil {
+		t.Fatal(" setting value was supposed to fail")
+	}
 
 }

pkg/fabric-client/mocks/mockorderer.go

@@ -26,7 +26,7 @@ type MockOrderer interface {
 	EnqueueForSendDeliver(value interface{})
 }
 type mockOrderer struct {
-	URL               string
+	OrdererURL        string
 	BroadcastListener chan *fab.SignedEnvelope
 	BroadcastErrors   chan error
 	Deliveries        chan *common.Block
@@ -39,7 +39,7 @@ type mockOrderer struct {
 // NewMockOrderer ...
 func NewMockOrderer(url string, broadcastListener chan *fab.SignedEnvelope) fab.Orderer {
 	o := &mockOrderer{
-		URL:               url,
+		OrdererURL:        url,
 		BroadcastListener: broadcastListener,
 		BroadcastErrors:   make(chan error, 100),
 		Deliveries:        make(chan *common.Block, 1),
@@ -74,9 +74,9 @@ func delivery(o *mockOrderer) {
 	}
 }
 
-// GetURL returns the URL of the mock Orderer
-func (o *mockOrderer) GetURL() string {
-	return o.URL
+// URL returns the URL of the mock Orderer
+func (o *mockOrderer) URL() string {
+	return o.OrdererURL
 }
 
 // SendBroadcast accepts client broadcast calls and reports them to the listener channel

pkg/fabric-client/orderer/orderer.go

@@ -56,9 +56,9 @@ func createNewOrdererWithCertPool(url string, tlsCaCertPool *x509.CertPool, serv
 	return &orderer{url: url, grpcDialOption: opts}
 }
 
-// GetURL Get the Orderer url. Required property for the instance objects.
+// URL Get the Orderer url. Required property for the instance objects.
 // @returns {string} The address of the Orderer
-func (o *orderer) GetURL() string {
+func (o *orderer) URL() string {
 	return o.url
 }
 

pkg/fabric-client/orderer/orderer_test.go

@@ -42,7 +42,7 @@ func TestOrdererViaChain(t *testing.T) {
 	}
 
 	orderers := chain.Orderers()
-	if orderers == nil || len(orderers) != 1 || orderers[0].GetURL() != "localhost:7050" {
+	if orderers == nil || len(orderers) != 1 || orderers[0].URL() != "localhost:7050" {
 		t.Fatalf("Failed to retieve the new orderer URL from the chain")
 	}
 	chain.RemoveOrderer(orderer)
@@ -56,7 +56,7 @@ func TestOrdererViaChain(t *testing.T) {
 	}
 	orderers = chain.Orderers()
 
-	if orderers == nil || len(orderers) != 1 || orderers[0].GetURL() != "localhost:7054" {
+	if orderers == nil || len(orderers) != 1 || orderers[0].URL() != "localhost:7054" {
 		t.Fatalf("Failed to retieve the new orderer URL from the chain")
 	}