Skip to content

Commit

Permalink
[FAB-7935] Make context func names consistent
Browse files Browse the repository at this point in the history 
This change modifies SDK to use Context names without the provider
suffix.

Change-Id: I95698902e731fe59adb0b67ddd8e166cea3247df
Signed-off-by: Troy Ronda <troy@troyronda.com>
  • Loading branch information
@troyronda
troyronda committed Jan 26, 2018
1 parent 10205b2 commit 335b2b5
Show file tree
Hide file tree
Showing 11 changed files with 111 additions and 112 deletions.
4 changes: 2 additions & 2 deletions pkg/fabric-txn/selection/dynamicselection/ccpolicyprovider.go
View file
Expand Up @@ -50,12 +50,12 @@ func newCCPolicyProvider(sdk *fabsdk.FabricSDK, channelID string, userName strin
client := sdk.NewClient(fabsdk.WithUser(userName), fabsdk.WithOrg(orgName))

// TODO: Add option to use anchor peers instead of config
targetPeers, err := sdk.ConfigProvider().ChannelPeers(channelID)
targetPeers, err := sdk.Config().ChannelPeers(channelID)
if err != nil {
return nil, errors.WithMessage(err, "unable to read configuration for channel peers")
}

return &ccPolicyProvider{config: sdk.ConfigProvider(), client: client, channelID: channelID, targetPeers: targetPeers, ccDataMap: make(map[string]*ccprovider.ChaincodeData)}, nil
return &ccPolicyProvider{config: sdk.Config(), client: client, channelID: channelID, targetPeers: targetPeers, ccDataMap: make(map[string]*ccprovider.ChaincodeData)}, nil
}

type ccPolicyProvider struct {
Expand Down
6 changes: 3 additions & 3 deletions pkg/fabsdk/api/context.go
View file
Expand Up @@ -21,9 +21,9 @@ type Providers interface {

// CoreProviders represents the configured core providers context
type CoreProviders interface {
CryptoSuiteProvider() apicryptosuite.CryptoSuite
StateStoreProvider() fab.KeyValueStore
ConfigProvider() apiconfig.Config
CryptoSuite() apicryptosuite.CryptoSuite
StateStore() fab.KeyValueStore
Config() apiconfig.Config
SigningManager() fab.SigningManager
FabricProvider() apicore.FabricProvider
}
Expand Down
72 changes: 36 additions & 36 deletions pkg/fabsdk/api/mocks/mocksdkapi.gen.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions pkg/fabsdk/client.go
View file
Expand Up @@ -25,9 +25,9 @@ type Client struct {
type ClientOption func(opts *clientOptions) error

type clientOptions struct {
orgID string
configProvider apiconfig.Config
targetFilter resmgmt.TargetFilter
orgID string
config apiconfig.Config
targetFilter resmgmt.TargetFilter
}

type clientProvider func() (*clientContext, error)
Expand Down Expand Up @@ -57,9 +57,9 @@ func WithTargetFilter(targetFilter resmgmt.TargetFilter) ClientOption {

// withConfig allows for overriding the configuration of the client.
// TODO: This should be removed once the depreacted functions are removed.
func withConfig(configProvider apiconfig.Config) ClientOption {
func withConfig(config apiconfig.Config) ClientOption {
return func(opts *clientOptions) error {
opts.configProvider = configProvider
opts.config = config
return nil
}
}
Expand All @@ -69,7 +69,7 @@ func (sdk *FabricSDK) NewClient(identityOpt IdentityOption, opts ...ClientOption
// delay execution of the following logic to avoid error return from this function.
// this is done to allow a cleaner API - i.e., client, err := sdk.NewClient(args).<Desired Interface>(extra args)
provider := func() (*clientContext, error) {
o, err := newClientOptions(sdk.configProvider, opts)
o, err := newClientOptions(sdk.config, opts)
if err != nil {
return nil, errors.WithMessage(err, "unable to retrieve configuration from SDK")
}
Expand Down Expand Up @@ -101,8 +101,8 @@ func newClientOptions(config apiconfig.Config, options []ClientOption) (*clientO
}

opts := clientOptions{
orgID: client.Organization,
configProvider: config,
orgID: client.Organization,
config: config,
}

for _, option := range options {
Expand All @@ -127,7 +127,7 @@ func (c *Client) ChannelMgmt() (chmgmt.ChannelMgmtClient, error) {
}

session := newSession(p.identity)
client, err := p.clientFactory.NewChannelMgmtClient(p.providers, session, p.opts.configProvider)
client, err := p.clientFactory.NewChannelMgmtClient(p.providers, session, p.opts.config)
if err != nil {
return nil, errors.WithMessage(err, "failed to create new channel management client")
}
Expand All @@ -143,7 +143,7 @@ func (c *Client) ResourceMgmt() (resmgmt.ResourceMgmtClient, error) {
}

session := newSession(p.identity)
client, err := p.clientFactory.NewResourceMgmtClient(p.providers, session, p.opts.configProvider, p.opts.targetFilter)
client, err := p.clientFactory.NewResourceMgmtClient(p.providers, session, p.opts.config, p.opts.targetFilter)
if err != nil {
return nil, errors.WithMessage(err, "failed to created new resource management client")
}
Expand All @@ -159,7 +159,7 @@ func (c *Client) Channel(id string) (apitxn.ChannelClient, error) {
}

session := newSession(p.identity)
client, err := p.clientFactory.NewChannelClient(p.providers, session, p.opts.configProvider, id)
client, err := p.clientFactory.NewChannelClient(p.providers, session, p.opts.config, id)
if err != nil {
return nil, errors.WithMessage(err, "failed to created new resource management client")
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/fabsdk/client_test.go
View file
Expand Up @@ -132,7 +132,7 @@ func TestWithConfig(t *testing.T) {
t.Fatalf("Expected no error from option, but got %v", err)
}

if opts.configProvider != c {
if opts.config != c {
t.Fatalf("Expected config to be set in opts")
}
}
Expand Down
14 changes: 7 additions & 7 deletions pkg/fabsdk/context.go
View file
Expand Up @@ -18,18 +18,18 @@ type sdkContext struct {
sdk *FabricSDK
}

// ConfigProvider returns the Config provider of sdk.
func (c *sdkContext) ConfigProvider() apiconfig.Config {
return c.sdk.configProvider
// Config returns the Config provider of sdk.
func (c *sdkContext) Config() apiconfig.Config {
return c.sdk.config
}

// CryptoSuiteProvider returns the BCCSP provider of sdk.
func (c *sdkContext) CryptoSuiteProvider() apicryptosuite.CryptoSuite {
// CryptoSuite returns the BCCSP provider of sdk.
func (c *sdkContext) CryptoSuite() apicryptosuite.CryptoSuite {
return c.sdk.cryptoSuite
}

// StateStoreProvider returns state store
func (c *sdkContext) StateStoreProvider() apifabclient.KeyValueStore {
// StateStore returns state store
func (c *sdkContext) StateStore() apifabclient.KeyValueStore {
return c.sdk.stateStore
}

Expand Down
27 changes: 13 additions & 14 deletions pkg/fabsdk/fabsdk.go
View file
Expand Up @@ -24,7 +24,7 @@ import (
type FabricSDK struct {
opts options

configProvider apiconfig.Config
config apiconfig.Config
stateStore apifabclient.KeyValueStore
cryptoSuite apicryptosuite.CryptoSuite
discoveryProvider apifabclient.DiscoveryProvider
Expand Down Expand Up @@ -66,7 +66,7 @@ func WithConfig(config apiconfig.Config) apiconfig.ConfigProvider {

// fromPkgSuite creates an SDK based on the implementations in the provided pkg suite.
// TODO: For now leaving this method as private until we have more usage.
func fromPkgSuite(configProvider apiconfig.Config, pkgSuite apisdk.PkgSuite, opts ...Option) (*FabricSDK, error) {
func fromPkgSuite(config apiconfig.Config, pkgSuite apisdk.PkgSuite, opts ...Option) (*FabricSDK, error) {
core, err := pkgSuite.Core()
if err != nil {
return nil, errors.WithMessage(err, "Unable to initialize core pkg")
Expand Down Expand Up @@ -100,7 +100,7 @@ func fromPkgSuite(configProvider apiconfig.Config, pkgSuite apisdk.PkgSuite, opt
Session: sess,
Logger: lg,
},
configProvider: configProvider,
config: config,
}

err = initSDK(&sdk, opts)
Expand Down Expand Up @@ -172,7 +172,7 @@ func initSDK(sdk *FabricSDK, opts []Option) error {
logging.InitLogger(sdk.opts.Logger)

// Initialize crypto provider
cs, err := sdk.opts.Core.NewCryptoSuiteProvider(sdk.configProvider)
cs, err := sdk.opts.Core.NewCryptoSuiteProvider(sdk.config)
if err != nil {
return errors.WithMessage(err, "failed to initialize crypto suite")
}
Expand All @@ -183,28 +183,28 @@ func initSDK(sdk *FabricSDK, opts []Option) error {
cryptosuite.SetDefault(cs)

// Initialize state store
store, err := sdk.opts.Core.NewStateStoreProvider(sdk.configProvider)
store, err := sdk.opts.Core.NewStateStoreProvider(sdk.config)
if err != nil {
return errors.WithMessage(err, "failed to initialize state store")
}
sdk.stateStore = store

// Initialize Signing Manager
signingMgr, err := sdk.opts.Core.NewSigningManager(sdk.cryptoSuite, sdk.configProvider)
signingMgr, err := sdk.opts.Core.NewSigningManager(sdk.cryptoSuite, sdk.config)
if err != nil {
return errors.WithMessage(err, "failed to initialize signing manager")
}
sdk.signingManager = signingMgr

// Initialize Fabric Provider
fabricProvider, err := sdk.opts.Core.NewFabricProvider(sdk.configProvider, sdk.stateStore, sdk.cryptoSuite, sdk.signingManager)
fabricProvider, err := sdk.opts.Core.NewFabricProvider(sdk.config, sdk.stateStore, sdk.cryptoSuite, sdk.signingManager)
if err != nil {
return errors.WithMessage(err, "failed to initialize core fabric provider")
}
sdk.fabricProvider = fabricProvider

// Initialize discovery provider
discoveryProvider, err := sdk.opts.Service.NewDiscoveryProvider(sdk.configProvider)
discoveryProvider, err := sdk.opts.Service.NewDiscoveryProvider(sdk.config)
if err != nil {
return errors.WithMessage(err, "failed to initialize discovery provider")
}
Expand All @@ -214,7 +214,7 @@ func initSDK(sdk *FabricSDK, opts []Option) error {
sdk.discoveryProvider = discoveryProvider

// Initialize selection provider (for selecting endorsing peers)
selectionProvider, err := sdk.opts.Service.NewSelectionProvider(sdk.configProvider)
selectionProvider, err := sdk.opts.Service.NewSelectionProvider(sdk.config)
if err != nil {
return errors.WithMessage(err, "failed to initialize selection provider")
}
Expand All @@ -226,10 +226,9 @@ func initSDK(sdk *FabricSDK, opts []Option) error {
return nil
}

// ConfigProvider returns the SDK's configuration.
// TODO rename to Config
func (sdk *FabricSDK) ConfigProvider() apiconfig.Config {
return sdk.configProvider
// Config returns the SDK's configuration.
func (sdk *FabricSDK) Config() apiconfig.Config {
return sdk.config
}

func (sdk *FabricSDK) context() *sdkContext {
Expand All @@ -241,7 +240,7 @@ func (sdk *FabricSDK) context() *sdkContext {

func (sdk *FabricSDK) newUser(orgID string, userName string) (apifabclient.IdentityContext, error) {

credentialMgr, err := sdk.opts.Context.NewCredentialManager(orgID, sdk.configProvider, sdk.cryptoSuite)
credentialMgr, err := sdk.opts.Context.NewCredentialManager(orgID, sdk.config, sdk.cryptoSuite)
if err != nil {
return nil, errors.WithMessage(err, "failed to get credential manager")
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/fabsdk/fabsdk_test.go
View file
Expand Up @@ -315,7 +315,7 @@ func TestNewDefaultTwoValidSDK(t *testing.T) {
}

// Default sdk with two channels
client1, err := sdk1.configProvider.Client()
client1, err := sdk1.config.Client()
if err != nil {
t.Fatalf("Error getting client from config: %s", err)
}
Expand All @@ -324,7 +324,7 @@ func TestNewDefaultTwoValidSDK(t *testing.T) {
t.Fatalf("Unexpected org in config: %s", client1.Organization)
}

client2, err := sdk2.configProvider.Client()
client2, err := sdk2.config.Client()
if err != nil {
t.Fatalf("Error getting client from config: %s", err)
}
Expand Down Expand Up @@ -408,7 +408,7 @@ func TestWithConfigSuccess(t *testing.T) {
t.Fatalf("Error initializing SDK: %s", err)
}

client1, err := sdk.configProvider.Client()
client1, err := sdk.config.Client()
if err != nil {
t.Fatalf("Error getting client from config: %s", err)
}
Expand Down

0 comments on commit 335b2b5

Please sign in to comment.