[FAB-9900] WithOrdererURL & WithTargetURLs renaming

- WithOrdererURL renamed to WithOrdererEndpoint
- WithTargetURLs renamed to WithTargetEndppoints
- No logic changes


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

pkg/client/channel/api.go

@@ -64,17 +64,17 @@ func WithTargets(targets ...fab.Peer) RequestOption {
 	}
 }
 
-// WithTargetURLs allows overriding of the target peers for the request.
-// Targets are specified by URL, and the SDK will create the underlying peer
+// WithTargetEndpoints allows overriding of the target peers for the request.
+// Targets are specified by name or URL, and the SDK will create the underlying peer
 // objects.
-func WithTargetURLs(urls ...string) RequestOption {
+func WithTargetEndpoints(keys ...string) RequestOption {
 	return func(ctx context.Client, opts *requestOptions) error {
 
 		var targets []fab.Peer
 
-		for _, url := range urls {
+		for _, url := range keys {
 
-			peerCfg, err := comm.NetworkPeerConfigFromURL(ctx.EndpointConfig(), url)
+			peerCfg, err := comm.NetworkPeerConfig(ctx.EndpointConfig(), url)
 			if err != nil {
 				return err
 			}

pkg/client/channel/api_test.go

@@ -19,7 +19,7 @@ import (
 
 func TestWithTargetURLsInvalid(t *testing.T) {
 	ctx := setupMockTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("invalid")
+	opt := WithTargetEndpoints("invalid")
 
 	mockConfig := &fcmocks.MockConfig{}
 
@@ -37,7 +37,7 @@ func TestWithTargetURLsInvalid(t *testing.T) {
 
 func TestWithTargetURLsValid(t *testing.T) {
 	ctx := setupMockTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("127.0.0.1:7050")
+	opt := WithTargetEndpoints("127.0.0.1:7050")
 
 	mockConfig := &fcmocks.MockConfig{}
 

pkg/client/ledger/opts.go

@@ -61,16 +61,16 @@ func WithTargets(targets ...fab.Peer) RequestOption {
 	}
 }
 
-// WithTargetURLs allows overriding of the target peers per request.
-// Targets are specified by URL, and the SDK will create the underlying peer objects.
-func WithTargetURLs(urls ...string) RequestOption {
+// WithTargetEndpoints allows overriding of the target peers per request.
+// Targets are specified by name or URL, and the SDK will create the underlying peer objects.
+func WithTargetEndpoints(keys ...string) RequestOption {
 	return func(ctx context.Client, opts *requestOptions) error {
 
 		var targets []fab.Peer
 
-		for _, url := range urls {
+		for _, url := range keys {
 
-			peerCfg, err := comm.NetworkPeerConfigFromURL(ctx.EndpointConfig(), url)
+			peerCfg, err := comm.NetworkPeerConfig(ctx.EndpointConfig(), url)
 			if err != nil {
 				return err
 			}

pkg/client/ledger/opts_test.go

@@ -18,7 +18,7 @@ import (
 
 func TestWithTargetURLsInvalid(t *testing.T) {
 	ctx := setupTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("invalid")
+	opt := WithTargetEndpoints("invalid")
 
 	mockConfig := &fcmocks.MockConfig{}
 
@@ -36,7 +36,7 @@ func TestWithTargetURLsInvalid(t *testing.T) {
 
 func TestWithTargetURLsValid(t *testing.T) {
 	ctx := setupTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("127.0.0.1:7050")
+	opt := WithTargetEndpoints("127.0.0.1:7050")
 
 	mockConfig := &fcmocks.MockConfig{}
 

pkg/client/resmgmt/example_test.go

@@ -211,7 +211,7 @@ func ExampleClient_SaveChannel() {
 	// Output: Saved channel
 }
 
-func ExampleClient_SaveChannel_withOrdererURL() {
+func ExampleClient_SaveChannel_withOrdererEndpoint() {
 
 	c, err := New(mockClientProvider())
 	if err != nil {
@@ -224,7 +224,7 @@ func ExampleClient_SaveChannel_withOrdererURL() {
 	}
 	defer r.Close()
 
-	resp, err := c.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r}, WithOrdererURL("example.com"))
+	resp, err := c.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r}, WithOrdererEndpoint("example.com"))
 	if err != nil {
 		fmt.Printf("failed to save channel: %v", err)
 	}

pkg/client/resmgmt/opts.go

@@ -33,17 +33,17 @@ func WithTargets(targets ...fab.Peer) RequestOption {
 	}
 }
 
-// WithTargetURLs allows overriding of the target peers for the request.
-// Targets are specified by URL, and the SDK will create the underlying peer
+// WithTargetEndpoints allows overriding of the target peers for the request.
+// Targets are specified by name or URL, and the SDK will create the underlying peer
 // objects.
-func WithTargetURLs(urls ...string) RequestOption {
+func WithTargetEndpoints(keys ...string) RequestOption {
 	return func(ctx context.Client, opts *requestOptions) error {
 
 		var targets []fab.Peer
 
-		for _, url := range urls {
+		for _, url := range keys {
 
-			peerCfg, err := comm.NetworkPeerConfigFromURL(ctx.EndpointConfig(), url)
+			peerCfg, err := comm.NetworkPeerConfig(ctx.EndpointConfig(), url)
 			if err != nil {
 				return err
 			}
@@ -80,15 +80,16 @@ func WithTimeout(timeoutType fab.TimeoutType, timeout time.Duration) RequestOpti
 	}
 }
 
-// WithOrdererURL allows an orderer to be specified for the request.
-// The orderer will be looked-up based on the name/url argument.
-func WithOrdererURL(nameOrURL string) RequestOption {
+// WithOrdererEndpoint allows an orderer to be specified for the request.
+// The orderer will be looked-up based on the key argument.
+// key argument can be a name or url
+func WithOrdererEndpoint(key string) RequestOption {
 
 	return func(ctx context.Client, opts *requestOptions) error {
 
-		ordererCfg, err := ctx.EndpointConfig().OrdererConfig(nameOrURL)
+		ordererCfg, err := ctx.EndpointConfig().OrdererConfig(key)
 		if err != nil {
-			return errors.Wrapf(err, "orderer not found for url : %s", nameOrURL)
+			return errors.Wrapf(err, "orderer not found for url : %s", key)
 		}
 
 		orderer, err := ctx.InfraProvider().CreateOrdererFromConfig(ordererCfg)

pkg/client/resmgmt/opts_test.go

@@ -18,7 +18,7 @@ import (
 
 func TestWithTargetURLsInvalid(t *testing.T) {
 	ctx := setupTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("invalid")
+	opt := WithTargetEndpoints("invalid")
 
 	mockConfig := &fcmocks.MockConfig{}
 
@@ -36,7 +36,7 @@ func TestWithTargetURLsInvalid(t *testing.T) {
 
 func TestWithTargetURLsValid(t *testing.T) {
 	ctx := setupTestContext("test", "Org1MSP")
-	opt := WithTargetURLs("127.0.0.1:7050")
+	opt := WithTargetEndpoints("127.0.0.1:7050")
 
 	mockConfig := &fcmocks.MockConfig{}
 

pkg/client/resmgmt/resmgmt_test.go

@@ -252,7 +252,7 @@ func TestJoinChannelWithOptsRequiredParameters(t *testing.T) {
 	}
 
 	// Test targets only
-	err = rc.JoinChannel("mychannel", WithTargets(peers...), WithOrdererURL("orderer.example.com"))
+	err = rc.JoinChannel("mychannel", WithTargets(peers...), WithOrdererEndpoint("orderer.example.com"))
 	if err != nil {
 		t.Fatalf(err.Error())
 	}
@@ -1186,12 +1186,12 @@ func TestSaveChannelSuccess(t *testing.T) {
 	assert.Contains(t, err.Error(), "reading channel config file failed")
 
 	// Test valid Save Channel request (success)
-	resp, err := cc.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r}, WithOrdererURL("example.com"))
+	resp, err := cc.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r}, WithOrdererEndpoint("example.com"))
 	assert.Nil(t, err, "error should be nil")
 	assert.NotEmpty(t, resp.TransactionID, "transaction ID should be populated")
 
 	// Test valid Save Channel request (success / filename)
-	resp, err = cc.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfigPath: channelConfig}, WithOrdererURL("example.com"))
+	resp, err = cc.SaveChannel(SaveChannelRequest{ChannelID: "mychannel", ChannelConfigPath: channelConfig}, WithOrdererEndpoint("example.com"))
 	assert.Nil(t, err, "error should be nil")
 	assert.NotEmpty(t, resp.TransactionID, "transaction ID should be populated")
 }
@@ -1250,7 +1250,7 @@ func TestSaveChannelWithOpts(t *testing.T) {
 	req := SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r1}
 
 	// Test empty option (default order is random orderer from config)
-	opts := WithOrdererURL("")
+	opts := WithOrdererEndpoint("")
 	resp, err := cc.SaveChannel(req, opts)
 	assert.Nil(t, err, "error should be nil")
 	assert.NotEmpty(t, resp.TransactionID, "transaction ID should be populated")
@@ -1262,7 +1262,7 @@ func TestSaveChannelWithOpts(t *testing.T) {
 
 	req = SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r2}
 
-	opts = WithOrdererURL("orderer.example.com")
+	opts = WithOrdererEndpoint("orderer.example.com")
 	resp, err = cc.SaveChannel(req, opts)
 	assert.Nil(t, err, "error should be nil")
 	assert.NotEmpty(t, resp.TransactionID, "transaction ID should be populated")
@@ -1279,7 +1279,7 @@ func TestSaveChannelWithOpts(t *testing.T) {
 
 	cc = setupResMgmtClient(t, ctx)
 
-	opts = WithOrdererURL("Invalid")
+	opts = WithOrdererEndpoint("Invalid")
 	_, err = cc.SaveChannel(req, opts)
 	assert.NotNil(t, err, "Should have failed for invalid orderer ID")
 	assert.Contains(t, err.Error(), "failed to read opts in resmgmt: orderer not found for url")
@@ -1288,7 +1288,7 @@ func TestSaveChannelWithOpts(t *testing.T) {
 func TestJoinChannelWithInvalidOpts(t *testing.T) {
 
 	cc := setupDefaultResMgmtClient(t)
-	opts := WithOrdererURL("Invalid")
+	opts := WithOrdererEndpoint("Invalid")
 	err := cc.JoinChannel("mychannel", opts)
 	assert.NotNil(t, err, "Should have failed for invalid orderer ID")
 	assert.Contains(t, err.Error(), "failed to read opts in resmgmt: orderer not found for url")
@@ -1331,7 +1331,7 @@ func TestSaveChannelWithMultipleSigningIdenities(t *testing.T) {
 
 	secondCtx := fcmocks.NewMockContext(mspmocks.NewMockSigningIdentity("second", "second"))
 	req = SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: r2, SigningIdentities: []msp.SigningIdentity{cc.ctx, secondCtx}}
-	resp, err = cc.SaveChannel(req, WithOrdererURL(""))
+	resp, err = cc.SaveChannel(req, WithOrdererEndpoint(""))
 	assert.Nil(t, err, "Failed to save channel with multiple signing identities: %s", err)
 	assert.NotEmpty(t, resp.TransactionID, "transaction ID should be populated")
 }

pkg/fab/comm/network.go

@@ -12,9 +12,9 @@ import (
 	"github.com/pkg/errors"
 )
 
-// NetworkPeerConfigFromURL fetches the peer configuration based on a URL.
-func NetworkPeerConfigFromURL(cfg fab.EndpointConfig, url string) (*fab.NetworkPeer, error) {
-	peerCfg, err := cfg.PeerConfig(url)
+// NetworkPeerConfig fetches the peer configuration based on a key (name or URL).
+func NetworkPeerConfig(cfg fab.EndpointConfig, key string) (*fab.NetworkPeer, error) {
+	peerCfg, err := cfg.PeerConfig(key)
 	if err != nil {
 		return nil, errors.WithMessage(err, "peer not found")
 	}

pkg/fab/comm/network_test.go

@@ -30,15 +30,15 @@ func TestNetworkPeerConfigFromURL(t *testing.T) {
 		t.Fatalf("Unexpected error reading config: %v", err)
 	}
 
-	_, err = NetworkPeerConfigFromURL(sampleConfig, "invalid")
+	_, err = NetworkPeerConfig(sampleConfig, "invalid")
 	assert.NotNil(t, err, "invalid url should return err")
 
-	np, err := NetworkPeerConfigFromURL(sampleConfig, "peer0.org2.example.com:8051")
+	np, err := NetworkPeerConfig(sampleConfig, "peer0.org2.example.com:8051")
 	assert.Nil(t, err, "valid url should not return err")
 	assert.Equal(t, "peer0.org2.example.com:8051", np.URL, "wrong URL")
 	assert.Equal(t, "Org2MSP", np.MSPID, "wrong MSP")
 
-	np, err = NetworkPeerConfigFromURL(sampleConfig, "peer0.org1.example.com:7051")
+	np, err = NetworkPeerConfig(sampleConfig, "peer0.org1.example.com:7051")
 	assert.Nil(t, err, "valid url should not return err")
 	assert.Equal(t, "peer0.org1.example.com:7051", np.URL, "wrong URL")
 	assert.Equal(t, "Org1MSP", np.MSPID, "wrong MSP")

pkg/fab/endpointconfig.go

@@ -254,7 +254,7 @@ func (c *EndpointConfig) PeersConfig(org string) ([]fab.PeerConfig, error) {
 	return peers, nil
 }
 
-// PeerConfig Retrieves a specific peer from the configuration by org and name
+// PeerConfig Retrieves a specific peer from the configuration by name or url
 func (c *EndpointConfig) PeerConfig(nameOrURL string) (*fab.PeerConfig, error) {
 	networkConfig, err := c.NetworkConfig()
 	if err != nil {

pkg/fab/events/deliverclient/deliverclient_test.go

@@ -449,10 +449,6 @@ func newMockConfig() *mockConfig {
 	}
 }
 
-func (c *mockConfig) PeerConfigByURL(url string) (*fab.PeerConfig, error) {
-	return &fab.PeerConfig{}, nil
-}
-
 func newMockContext() *fabmocks.MockContext {
 	ctx := fabmocks.NewMockContextWithCustomDiscovery(
 		mspmocks.NewMockSigningIdentity("user1", "test1"),

pkg/fab/events/endpoint/endpoint_test.go

@@ -26,12 +26,7 @@ var p1 = fabmocks.NewMockPeer("p1", url1)
 var p2 = fabmocks.NewMockPeer("p2", url2)
 var p3 = fabmocks.NewMockPeer("p3", url3)
 
-var pc1 = fab.PeerConfig{URL: url1}
-var pc2 = fab.PeerConfig{URL: url2}
-var pc3 = fab.PeerConfig{URL: url3}
-
 var peers = []fab.Peer{p1, p2, p3}
-var peerConfigs = []fab.PeerConfig{pc1, pc2, pc3}
 
 func TestEndpoint(t *testing.T) {
 	expectedEventURL := "localhost:7053"
@@ -146,15 +141,6 @@ func newMockConfig(channelPeers ...fab.ChannelPeer) *mockConfig {
 	}
 }
 
-func (c *mockConfig) PeerConfigByURL(url string) (*fab.PeerConfig, error) {
-	for _, pc := range peerConfigs {
-		if pc.URL == url {
-			return &pc, nil
-		}
-	}
-	return nil, nil
-}
-
 func (c *mockConfig) ChannelPeers(name string) ([]fab.ChannelPeer, error) {
 	fmt.Printf("mockConfig.ChannelPeers - returning %#v", c.channelPeers)
 	return c.channelPeers, nil

test/integration/e2e/end_to_end.go

@@ -133,7 +133,7 @@ func createChannelAndCC(t *testing.T, sdk *fabsdk.FabricSDK) {
 	}
 
 	// Org peers join channel
-	if err = orgResMgmt.JoinChannel(channelID, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererURL("orderer.example.com")); err != nil {
+	if err = orgResMgmt.JoinChannel(channelID, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererEndpoint("orderer.example.com")); err != nil {
 		t.Fatalf("Org peers failed to JoinChannel: %s", err)
 	}
 
@@ -204,7 +204,7 @@ func createChannel(sdk *fabsdk.FabricSDK, t *testing.T, resMgmtClient *resmgmt.C
 	req := resmgmt.SaveChannelRequest{ChannelID: channelID,
 		ChannelConfigPath: path.Join("../../../", metadata.ChannelConfigPath, "mychannel.tx"),
 		SigningIdentities: []msp.SigningIdentity{adminIdentity}}
-	txID, err := resMgmtClient.SaveChannel(req, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererURL("orderer.example.com"))
+	txID, err := resMgmtClient.SaveChannel(req, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererEndpoint("orderer.example.com"))
 	require.Nil(t, err, "error should be nil")
 	require.NotEmpty(t, txID, "transaction ID should be populated")
 }

test/integration/expiredpeer/expired_certificate_test.go

@@ -77,7 +77,7 @@ func TestExpiredPeersCert(t *testing.T) {
 	req := resmgmt.SaveChannelRequest{ChannelID: "orgchannel",
 		ChannelConfigPath: path.Join("../../../", metadata.ChannelConfigPath, "orgchannel.tx"),
 		SigningIdentities: []msp.SigningIdentity{org1AdminUser, org2AdminUser}}
-	txID, err := chMgmtClient.SaveChannel(req, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererURL("orderer.example.com"))
+	txID, err := chMgmtClient.SaveChannel(req, resmgmt.WithRetry(retry.DefaultResMgmtOpts), resmgmt.WithOrdererEndpoint("orderer.example.com"))
 	require.Nil(t, err, "error should be nil")
 	require.NotEmpty(t, txID, "transaction ID should be populated")