[FAB-8940] Refactor pkg.common.msp.Providers interface

Now it follows the same pattern as other providers' interfaces. Change-Id: I75edec2abf407eaf65ddc9d8e7f49b57bca64e64 Signed-off-by: Aleksandar Likic <aleksandar.likic@securekey.com>
hyperledger · Mar 16, 2018 · 79f2f4e · 79f2f4e
1 parent cc16a4a
commit 79f2f4e
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 33 deletions.
diff --git a/pkg/common/providers/msp/provider.go b/pkg/common/providers/msp/provider.go
@@ -14,15 +14,13 @@ type Context interface {
 	Providers
 }
 
-// TODO - the Providers/Provider interfaces need to be refactored to be similar to other Providers
-
-// Provider provides MSP services
-type Provider interface {
-	UserStore() UserStore
+// IdentityManagerProvider provides identity management services
+type IdentityManagerProvider interface {
 	IdentityManager(orgName string) (IdentityManager, bool)
 }
 
-// Providers represents the MSP service providers context.
+// Providers represents a provider of MSP service.
 type Providers interface {
-	Provider
+	UserStore() UserStore
+	IdentityManagerProvider
 }
diff --git a/pkg/context/context.go b/pkg/context/context.go
@@ -59,15 +59,15 @@ func (c *Channel) ChannelID() string {
 	return c.channelID
 }
 
-//Provider implementation for Providers interface
+//Provider implementation of Providers interface
 type Provider struct {
 	config            core.Config
 	userStore         msp.UserStore
 	cryptoSuite       core.CryptoSuite
 	discoveryProvider fab.DiscoveryProvider
 	selectionProvider fab.SelectionProvider
 	signingManager    core.SigningManager
-	mspProvider       msp.Provider
+	idMgmtProvider    msp.IdentityManagerProvider
 	infraProvider     fab.InfraProvider
 	channelProvider   fab.ChannelProvider
 }
@@ -84,7 +84,7 @@ func (c *Provider) CryptoSuite() core.CryptoSuite {
 
 // IdentityManager returns identity manager for organization
 func (c *Provider) IdentityManager(orgName string) (msp.IdentityManager, bool) {
-	return c.mspProvider.IdentityManager(orgName)
+	return c.idMgmtProvider.IdentityManager(orgName)
 }
 
 // SigningManager returns signing manager
@@ -162,10 +162,10 @@ func WithSigningManager(signingManager core.SigningManager) SDKContextParams {
 	}
 }
 
-//WithMSPProvider sets MSPProvider maps to context
-func WithMSPProvider(provider msp.Provider) SDKContextParams {
+//WithIdentityManagerProvider sets IdentityManagerProvider maps to context
+func WithIdentityManagerProvider(provider msp.IdentityManagerProvider) SDKContextParams {
 	return func(ctx *Provider) {
-		ctx.mspProvider = provider
+		ctx.idMgmtProvider = provider
 	}
 }
 

diff --git a/pkg/fabsdk/api/factory.go b/pkg/fabsdk/api/factory.go
@@ -29,7 +29,7 @@ type CoreProviderFactory interface {
 // MSPProviderFactory allows overriding providers of MSP services
 type MSPProviderFactory interface {
 	CreateUserStore(config core.Config) (msp.UserStore, error)
-	CreateProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.Provider, error)
+	CreateIdentityManagerProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.IdentityManagerProvider, error)
 }
 
 // ServiceProviderFactory allows overriding default service providers (such as peer discovery)

diff --git a/pkg/fabsdk/fabsdk.go b/pkg/fabsdk/fabsdk.go
@@ -175,13 +175,13 @@ func initSDK(sdk *FabricSDK, config core.Config, opts []Option) error {
 		return errors.WithMessage(err, "failed to initialize signing manager")
 	}
 
-	// Initialize MSP Provider
-	mspProvider, err := sdk.opts.MSP.CreateProvider(config, cryptoSuite, userStore)
+	// Initialize IdentityManagerProvider
+	identityManagerProvider, err := sdk.opts.MSP.CreateIdentityManagerProvider(config, cryptoSuite, userStore)
 	if err != nil {
 		return errors.WithMessage(err, "failed to initialize identity manager provider")
 	}
 
-	// Initialize Fabric Provider
+	// Initialize Fabric provider
 	infraProvider, err := sdk.opts.Core.CreateInfraProvider(config)
 	if err != nil {
 		return errors.WithMessage(err, "failed to initialize infra provider")
@@ -211,7 +211,7 @@ func initSDK(sdk *FabricSDK, config core.Config, opts []Option) error {
 		context.WithUserStore(userStore),
 		context.WithDiscoveryProvider(discoveryProvider),
 		context.WithSelectionProvider(selectionProvider),
-		context.WithMSPProvider(mspProvider),
+		context.WithIdentityManagerProvider(identityManagerProvider),
 		context.WithInfraProvider(infraProvider),
 		context.WithChannelProvider(channelProvider))
 

diff --git a/pkg/fabsdk/fabsdk_test.go b/pkg/fabsdk/fabsdk_test.go
@@ -108,7 +108,7 @@ func TestWithMSPPkg(t *testing.T) {
 	factory := mockapisdk.NewMockMSPProviderFactory(mockCtrl)
 
 	factory.EXPECT().CreateUserStore(c).Return(nil, nil)
-	factory.EXPECT().CreateProvider(c, gomock.Any(), gomock.Any()).Return(nil, nil).AnyTimes()
+	factory.EXPECT().CreateIdentityManagerProvider(c, gomock.Any(), gomock.Any()).Return(nil, nil).AnyTimes()
 
 	_, err = New(WithConfig(c), WithMSPPkg(factory))
 	if err != nil {

diff --git a/pkg/fabsdk/factory/defmsp/mspfactory.go b/pkg/fabsdk/factory/defmsp/mspfactory.go
@@ -47,7 +47,7 @@ func (f *ProviderFactory) CreateUserStore(config core.Config) (msp.UserStore, er
 	return userStore, nil
 }
 
-// CreateProvider returns a new default implementation of MSP provider
-func (f *ProviderFactory) CreateProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.Provider, error) {
+// CreateIdentityManagerProvider returns a new default implementation of MSP provider
+func (f *ProviderFactory) CreateIdentityManagerProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.IdentityManagerProvider, error) {
 	return msppvdr.New(config, cryptoProvider, userStore)
 }
diff --git a/pkg/fabsdk/factory/defmsp/mspfactory_test.go b/pkg/fabsdk/factory/defmsp/mspfactory_test.go
@@ -116,7 +116,7 @@ func TestCreateIdentityManager(t *testing.T) {
 		t.Fatalf("Unexpected error creating user store %v", err)
 	}
 
-	provider, err := factory.CreateProvider(config, cryptosuite, userStore)
+	provider, err := factory.CreateIdentityManagerProvider(config, cryptosuite, userStore)
 	if err != nil {
 		t.Fatalf("Unexpected error creating provider %v", err)
 	}

diff --git a/pkg/fabsdk/mocks/mockfabsdkapi.gen.go b/pkg/fabsdk/mocks/mockfabsdkapi.gen.go
diff --git a/test/integration/msp/custom_core_factory.go b/test/integration/msp/custom_core_factory.go
@@ -12,7 +12,7 @@ import (
 	"github.com/hyperledger/fabric-sdk-go/pkg/fabsdk/factory/defcore"
 )
 
-// ========== MSP Provider Factory with custom crypto provider ============= //
+// ========== Core Provider Factory with custom crypto provider ============= //
 
 // CustomCoreFactory is a custom factory for tests.
 type CustomCoreFactory struct {

diff --git a/test/integration/msp/custom_msp_factory.go b/test/integration/msp/custom_msp_factory.go
@@ -30,7 +30,7 @@ func (f *CustomMSPFactory) CreateUserStore(config core.Config) (msp.UserStore, e
 	return f.customUserStore, nil
 }
 
-// CreateProvider creates an MSP provider
-func (f *CustomMSPFactory) CreateProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.Provider, error) {
-	return f.defaultFactory.CreateProvider(config, cryptoProvider, f.customUserStore)
+// CreateIdentityManagerProvider creates an IdentityManager provider
+func (f *CustomMSPFactory) CreateIdentityManagerProvider(config core.Config, cryptoProvider core.CryptoSuite, userStore msp.UserStore) (msp.IdentityManagerProvider, error) {
+	return f.defaultFactory.CreateIdentityManagerProvider(config, cryptoProvider, f.customUserStore)
 }