Skip to content
This repository was archived by the owner on Apr 25, 2025. It is now read-only.

Commit 6d3307f

Browse files
biljanaLukovicbiljanaLukovic
committed
[FAB-3231] Renamed user accessor methods
Change-Id: I4064ab31d99c97549608ab0623a00329888296a4 Signed-off-by: biljana lukovic <biljana.lukovic@securekey.com>
1 parent b920301 commit 6d3307f

File tree

7 files changed

+59
-59
lines changed

7 files changed

+59
-59
lines changed

‎fabric-client/chain.go‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -493,9 +493,9 @@ func (c *chain) JoinChannel(request *JoinChannelRequest) error {
493493
return fmt.Errorf("Error unmarshalling block: %s", err)
494494
}
495495
// Get user enrolment info and serialize for signing requests
496-
user, err := c.clientContext.GetUserContext("")
496+
user, err := c.clientContext.LoadUserFromStateStore("")
497497
if err != nil {
498-
return fmt.Errorf("GetUserContext returned error: %s", err)
498+
return fmt.Errorf("LoadUserFromStateStore returned error: %s", err)
499499
}
500500
creatorID, err := getSerializedIdentity(user.GetEnrollmentCertificate())
501501
if err != nil {
@@ -867,9 +867,9 @@ func (c *chain) CreateTransactionProposal(chaincodeName string, chainID string,
867867
Type: pb.ChaincodeSpec_GOLANG, ChaincodeId: &pb.ChaincodeID{Name: chaincodeName},
868868
Input: &pb.ChaincodeInput{Args: argsArray}}}
869869

870-
user, err := c.clientContext.GetUserContext("")
870+
user, err := c.clientContext.LoadUserFromStateStore("")
871871
if err != nil {
872-
return nil, fmt.Errorf("GetUserContext return error: %s", err)
872+
return nil, fmt.Errorf("LoadUserFromStateStore return error: %s", err)
873873
}
874874

875875
creatorID, err := getSerializedIdentity(user.GetEnrollmentCertificate())
@@ -1136,9 +1136,9 @@ func (c *chain) SendInstallProposal(chaincodeName string, chaincodePath string,
11361136
Type: pb.ChaincodeSpec_GOLANG, ChaincodeId: &pb.ChaincodeID{Name: chaincodeName, Path: chaincodePath, Version: chaincodeVersion}},
11371137
CodePackage: chaincodePackage, EffectiveDate: &google_protobuf.Timestamp{Seconds: int64(now.Second()), Nanos: int32(now.Nanosecond())}}
11381138

1139-
user, err := c.clientContext.GetUserContext("")
1139+
user, err := c.clientContext.LoadUserFromStateStore("")
11401140
if err != nil {
1141-
return nil, "", fmt.Errorf("GetUserContext return error: %s", err)
1141+
return nil, "", fmt.Errorf("LoadUserFromStateStore return error: %s", err)
11421142
}
11431143

11441144
creatorID, err := getSerializedIdentity(user.GetEnrollmentCertificate())
@@ -1208,9 +1208,9 @@ func (c *chain) SendInstantiateProposal(chaincodeName string, chainID string,
12081208
Type: pb.ChaincodeSpec_GOLANG, ChaincodeId: &pb.ChaincodeID{Name: chaincodeName, Path: chaincodePath, Version: chaincodeVersion},
12091209
Input: &pb.ChaincodeInput{Args: argsArray}}}
12101210

1211-
user, err := c.clientContext.GetUserContext("")
1211+
user, err := c.clientContext.LoadUserFromStateStore("")
12121212
if err != nil {
1213-
return nil, "", fmt.Errorf("GetUserContext return error: %s", err)
1213+
return nil, "", fmt.Errorf("LoadUserFromStateStore return error: %s", err)
12141214
}
12151215

12161216
creatorID, err := getSerializedIdentity(user.GetEnrollmentCertificate())
@@ -1247,9 +1247,9 @@ func (c *chain) SendInstantiateProposal(chaincodeName string, chainID string,
12471247

12481248
func (c *chain) SignPayload(payload []byte) (*SignedEnvelope, error) {
12491249
//Get user info
1250-
user, err := c.clientContext.GetUserContext("")
1250+
user, err := c.clientContext.LoadUserFromStateStore("")
12511251
if err != nil {
1252-
return nil, fmt.Errorf("GetUserContext returned error: %s", err)
1252+
return nil, fmt.Errorf("LoadUserFromStateStore returned error: %s", err)
12531253
}
12541254

12551255
signature, err := c.signObjectWithKey(payload, user.GetPrivateKey(),
@@ -1381,9 +1381,9 @@ func (c *chain) signObjectWithKey(object []byte, key bccsp.Key,
13811381
}
13821382

13831383
func (c *chain) signProposal(proposal *pb.Proposal) (*pb.SignedProposal, error) {
1384-
user, err := c.clientContext.GetUserContext("")
1384+
user, err := c.clientContext.LoadUserFromStateStore("")
13851385
if err != nil {
1386-
return nil, fmt.Errorf("GetUserContext return error: %s", err)
1386+
return nil, fmt.Errorf("LoadUserFromStateStore return error: %s", err)
13871387
}
13881388

13891389
proposalBytes, err := protos_utils.GetBytesProposal(proposal)
@@ -1402,9 +1402,9 @@ func (c *chain) signProposal(proposal *pb.Proposal) (*pb.SignedProposal, error)
14021402
// fetchGenesisBlock fetches the configuration block for this channel
14031403
func (c *chain) fetchGenesisBlock() (*common.Block, error) {
14041404
// Get user enrolment info and serialize for signing requests
1405-
user, err := c.clientContext.GetUserContext("")
1405+
user, err := c.clientContext.LoadUserFromStateStore("")
14061406
if err != nil {
1407-
return nil, fmt.Errorf("GetUserContext returned error: %s", err)
1407+
return nil, fmt.Errorf("LoadUserFromStateStore returned error: %s", err)
14081408
}
14091409
creatorID, err := getSerializedIdentity(user.GetEnrollmentCertificate())
14101410
if err != nil {
@@ -1848,9 +1848,9 @@ func (c *chain) getBlock(pos *ab.SeekPosition) (*common.Block, error) {
18481848
return nil, fmt.Errorf("error when generating nonce: %v", err)
18491849
}
18501850

1851-
user, err := c.clientContext.GetUserContext("")
1851+
user, err := c.clientContext.LoadUserFromStateStore("")
18521852
if err != nil {
1853-
return nil, fmt.Errorf("GetUserContext return error: %s", err)
1853+
return nil, fmt.Errorf("LoadUserFromStateStore return error: %s", err)
18541854
}
18551855

18561856
creator, err := getSerializedIdentity(user.GetEnrollmentCertificate())

‎fabric-client/chain_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ func setupTestChain() (Chain, error) {
417417
client := NewClient()
418418
user := NewUser("test")
419419
cryptoSuite := &mocks.MockCryptoSuite{}
420-
client.SetUserContext(user, true)
420+
client.SaveUserToStateStore(user, true)
421421
client.SetCryptoSuite(cryptoSuite)
422422
return NewChain("testChain", client)
423423
}

‎fabric-client/client.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ type Client interface {
5555
GetStateStore() kvs.KeyValueStore
5656
SetCryptoSuite(cryptoSuite bccsp.BCCSP)
5757
GetCryptoSuite() bccsp.BCCSP
58-
SetUserContext(user User, skipPersistence bool) error
59-
GetUserContext(name string) (User, error)
58+
SaveUserToStateStore(user User, skipPersistence bool) error
59+
LoadUserFromStateStore(name string) (User, error)
6060
}
6161

6262
type client struct {
@@ -169,15 +169,15 @@ func (c *client) GetCryptoSuite() bccsp.BCCSP {
169169
return c.cryptoSuite
170170
}
171171

172-
// SetUserContext ...
172+
// SaveUserToStateStore ...
173173
/*
174174
* Sets an instance of the User class as the security context of this client instance. This user’s credentials (ECert) will be
175175
* used to conduct transactions and queries with the blockchain network. Upon setting the user context, the SDK saves the object
176176
* in a persistence cache if the “state store” has been set on the Client instance. If no state store has been set,
177177
* this cache will not be established and the application is responsible for setting the user context again when the application
178178
* crashed and is recovered.
179179
*/
180-
func (c *client) SetUserContext(user User, skipPersistence bool) error {
180+
func (c *client) SaveUserToStateStore(user User, skipPersistence bool) error {
181181
if user == nil {
182182
return fmt.Errorf("user is nil")
183183
}
@@ -197,22 +197,22 @@ func (c *client) SetUserContext(user User, skipPersistence bool) error {
197197
}
198198
err = c.stateStore.SetValue(user.GetName(), data)
199199
if err != nil {
200-
return fmt.Errorf("stateStore SetValue return error: %v", err)
200+
return fmt.Errorf("stateStore SaveUserToStateStore return error: %v", err)
201201
}
202202
}
203203
return nil
204204

205205
}
206206

207-
// GetUserContext ...
207+
// LoadUserFromStateStore ...
208208
/*
209209
* The client instance can have an optional state store. The SDK saves enrolled users in the storage which can be accessed by
210210
* authorized users of the application (authentication is done by the application outside of the SDK).
211211
* This function attempts to load the user by name from the local storage (via the KeyValueStore interface).
212212
* The loaded user object must represent an enrolled user with a valid enrollment certificate signed by a trusted CA
213213
* (such as the COP server).
214214
*/
215-
func (c *client) GetUserContext(name string) (User, error) {
215+
func (c *client) LoadUserFromStateStore(name string) (User, error) {
216216
if c.userContext != nil {
217217
return c.userContext, nil
218218
}

‎fabric-client/client_test.go‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,57 +45,57 @@ func TestClientMethods(t *testing.T) {
4545
t.Fatalf("Client getCryptoSuite should not be nil after setCryptoSuite")
4646
}
4747

48-
//Client tests: getUserContext successful nill user
49-
user, err := client.GetUserContext("")
48+
//Client tests: LoadUserFromStateStore successful nill user
49+
user, err := client.LoadUserFromStateStore("")
5050
if err != nil {
51-
t.Fatalf("client.GetUserContext return error[%s]", err)
51+
t.Fatalf("client.LoadUserFromStateStore return error[%s]", err)
5252
}
5353
if user != nil {
54-
t.Fatalf("client.GetUserContext should return nil user")
54+
t.Fatalf("client.LoadUserFromStateStore should return nil user")
5555
}
5656

5757
//Client tests: Should return error "user is nil"
58-
err = client.SetUserContext(nil, false)
58+
err = client.SaveUserToStateStore(nil, false)
5959
if err == nil {
60-
t.Fatalf("client.SetUserContext didn't return error")
60+
t.Fatalf("client.SaveUserToStateStore didn't return error")
6161
}
6262
if err.Error() != "user is nil" {
63-
t.Fatalf("client.SetUserContext didn't return right error")
63+
t.Fatalf("client.SaveUserToStateStore didn't return right error")
6464
}
6565

66-
//Client tests: getUserContext with no context in memory or persisted returns nil
67-
user, err = client.GetUserContext("someUser")
66+
//Client tests: LoadUserFromStateStore with no context in memory or persisted returns nil
67+
user, err = client.LoadUserFromStateStore("someUser")
6868
if err != nil {
69-
t.Fatalf("client.GetUserContext return error[%s]", err)
69+
t.Fatalf("client.LoadUserFromStateStore return error[%s]", err)
7070
}
7171
if user != nil {
72-
t.Fatalf("client.GetUserContext should return nil user")
72+
t.Fatalf("client.LoadUserFromStateStore should return nil user")
7373
}
7474

75-
//Client tests: successfully setUserContext with skipPersistence true
75+
//Client tests: successfully SaveUserToStateStore with skipPersistence true
7676
user = NewUser("someUser")
77-
err = client.SetUserContext(user, true)
77+
err = client.SaveUserToStateStore(user, true)
7878
if err != nil {
79-
t.Fatalf("client.SetUserContext return error[%s]", err)
79+
t.Fatalf("client.SaveUserToStateStore return error[%s]", err)
8080
}
81-
user, err = client.GetUserContext("someUser")
81+
user, err = client.LoadUserFromStateStore("someUser")
8282
if err != nil {
83-
t.Fatalf("client.GetUserContext return error[%s]", err)
83+
t.Fatalf("client.LoadUserFromStateStore return error[%s]", err)
8484
}
8585
if user == nil {
86-
t.Fatalf("client.GetUserContext return nil user")
86+
t.Fatalf("client.LoadUserFromStateStore return nil user")
8787
}
8888
if user.GetName() != "someUser" {
89-
t.Fatalf("client.GetUserContext didn't return the right user")
89+
t.Fatalf("client.LoadUserFromStateStore didn't return the right user")
9090
}
9191

9292
//Client tests: Should throw "stateStore is nil"
93-
err = client.SetUserContext(user, false)
93+
err = client.SaveUserToStateStore(user, false)
9494
if err == nil {
95-
t.Fatalf("client.SetUserContext didn't return error")
95+
t.Fatalf("client.SaveUserToStateStore didn't return error")
9696
}
9797
if err.Error() != "stateStore is nil" {
98-
t.Fatalf("client.SetUserContext didn't return right error")
98+
t.Fatalf("client.SaveUserToStateStore didn't return right error")
9999
}
100100

101101
//Client tests: Create new chain

‎fabric-client/helpers/client.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ func GetClient(name string, pwd string, stateStorePath string) (fabricClient.Cli
9494
return nil, fmt.Errorf("CreateNewFileKeyValueStore return error[%s]", err)
9595
}
9696
client.SetStateStore(stateStore)
97-
user, err := client.GetUserContext(name)
97+
user, err := client.LoadUserFromStateStore(name)
9898
if err != nil {
99-
return nil, fmt.Errorf("client.GetUserContext return error: %v", err)
99+
return nil, fmt.Errorf("client.LoadUserFromStateStore return error: %v", err)
100100
}
101101
if user == nil {
102102
fabricCAClient, err1 := fabricCAClient.NewFabricCAClient()
@@ -115,9 +115,9 @@ func GetClient(name string, pwd string, stateStorePath string) (fabricClient.Cli
115115
}
116116
user.SetPrivateKey(k)
117117
user.SetEnrollmentCertificate(cert)
118-
err = client.SetUserContext(user, false)
118+
err = client.SaveUserToStateStore(user, false)
119119
if err != nil {
120-
return nil, fmt.Errorf("client.SetUserContext return error: %v", err)
120+
return nil, fmt.Errorf("client.SaveUserToStateStore return error: %v", err)
121121
}
122122
}
123123

@@ -128,9 +128,9 @@ func GetClient(name string, pwd string, stateStorePath string) (fabricClient.Cli
128128
// Utility method gets serialized enrollment certificate
129129
func getCreatorID(client fabricClient.Client) ([]byte, error) {
130130

131-
user, err := client.GetUserContext("")
131+
user, err := client.LoadUserFromStateStore("")
132132
if err != nil {
133-
return nil, fmt.Errorf("GetUserContext returned error: %s", err)
133+
return nil, fmt.Errorf("LoadUserFromStateStore returned error: %s", err)
134134
}
135135
serializedIdentity := &msp.SerializedIdentity{Mspid: config.GetFabricCAID(),
136136
IdBytes: user.GetEnrollmentCertificate()}

‎fabric-client/keyvaluestore/filekeyvaluestore_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func TestFKVSMethods(t *testing.T) {
3131
stateStore.SetValue("testvalue", []byte("data"))
3232
value, err := stateStore.GetValue("testvalue")
3333
if err != nil {
34-
t.Fatalf("stateStore.SetValue return error[%s]", err)
34+
t.Fatalf("stateStore.GetValue return error[%s]", err)
3535
}
3636
if string(value) != "data" {
3737
t.Fatalf("stateStore.GetValue didn't return the right value")

‎test/integration/fabric_ca_test.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ func TestRegisterEnrollRevoke(t *testing.T) {
7777
}
7878

7979
// Admin user is used to register, enrol and revoke a test user
80-
adminUser, err := client.GetUserContext("admin")
80+
adminUser, err := client.LoadUserFromStateStore("admin")
8181

8282
if err != nil {
83-
t.Fatalf("client.GetUserContext return error: %v", err)
83+
t.Fatalf("client.LoadUserFromStateStore return error: %v", err)
8484
}
8585
if adminUser == nil {
8686
key, cert, err := caClient.Enroll("admin", "adminpw")
@@ -118,16 +118,16 @@ func TestRegisterEnrollRevoke(t *testing.T) {
118118
}
119119
adminUser.SetPrivateKey(k)
120120
adminUser.SetEnrollmentCertificate(cert)
121-
err = client.SetUserContext(adminUser, false)
121+
err = client.SaveUserToStateStore(adminUser, false)
122122
if err != nil {
123-
t.Fatalf("client.SetUserContext return error: %v", err)
123+
t.Fatalf("client.SaveUserToStateStore return error: %v", err)
124124
}
125-
adminUser, err = client.GetUserContext("admin")
125+
adminUser, err = client.LoadUserFromStateStore("admin")
126126
if err != nil {
127-
t.Fatalf("client.GetUserContext return error: %v", err)
127+
t.Fatalf("client.LoadUserFromStateStore return error: %v", err)
128128
}
129129
if adminUser == nil {
130-
t.Fatalf("client.GetUserContext return nil")
130+
t.Fatalf("client.LoadUserFromStateStore return nil")
131131
}
132132
}
133133

0 commit comments

Comments
 (0)
⚡