Skip to content

Commit 8fb7337

Browse files
daeMOn63daeMOn63
committed
Renamed memoryStore -> inMemoryStore
1 parent 8f52277 commit 8fb7337

File tree

4 files changed

+68
-35
lines changed

4 files changed

+68
-35
lines changed

‎client_test.go

+43-14
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@ func TestNewClientSymKey(t *testing.T) {
4141
rand.Read(id)
4242
rand.Read(k)
4343

44-
c, err := NewClient(&SymIDAndKey{ID: id, Key: k}, NewMemoryStore(nil))
44+
c, err := NewClient(&SymIDAndKey{
45+
ID: id,
46+
Key: k,
47+
}, NewInMemoryStore(nil))
4548
if err != nil {
4649
t.Fatal(err)
4750
}
@@ -77,7 +80,9 @@ func TestNewClientSymKey(t *testing.T) {
7780
}
7881

7982
func TestProtectUnprotectMessageSymKey(t *testing.T) {
80-
client, err := NewClient(&SymIDAndKey{Key: e4crypto.RandomKey()}, NewMemoryStore(nil))
83+
client, err := NewClient(&SymIDAndKey{
84+
Key: e4crypto.RandomKey(),
85+
}, NewInMemoryStore(nil))
8186
if err != nil {
8287
t.Fatalf("Failed to create client: %v", err)
8388
}
@@ -98,7 +103,7 @@ func TestProtectUnprotectMessagePubKey(t *testing.T) {
98103
ID: clientID,
99104
Key: privateKey,
100105
C2PubKey: generateCurve25519PubKey(t),
101-
}, NewMemoryStore(nil))
106+
}, NewInMemoryStore(nil))
102107
if err != nil {
103108
t.Fatalf("Failed to create client: %v", err)
104109
}
@@ -200,7 +205,10 @@ func TestKeyTransition(t *testing.T) {
200205
clientKey := e4crypto.RandomKey()
201206
topic := "topic"
202207

203-
c, err := NewClient(&SymIDAndKey{ID: clientID, Key: clientKey}, NewMemoryStore(nil))
208+
c, err := NewClient(&SymIDAndKey{
209+
ID: clientID,
210+
Key: clientKey,
211+
}, NewInMemoryStore(nil))
204212
if err != nil {
205213
t.Fatalf("Failed to create client: %v", err)
206214
}
@@ -257,8 +265,10 @@ func TestKeyTransition(t *testing.T) {
257265
}
258266

259267
func TestClientWriteRead(t *testing.T) {
260-
store := NewMemoryStore(nil)
261-
gc, err := NewClient(&SymIDAndKey{Key: e4crypto.RandomKey()}, store)
268+
store := NewInMemoryStore(nil)
269+
gc, err := NewClient(&SymIDAndKey{
270+
Key: e4crypto.RandomKey(),
271+
}, store)
262272
if err != nil {
263273
t.Fatalf("Failed to create client: %v", err)
264274
}
@@ -321,7 +331,11 @@ func TestProtectUnprotectCommandsPubKey(t *testing.T) {
321331
}
322332

323333
clientID := e4crypto.RandomID()
324-
gc, err := NewClient(&PubIDAndKey{ID: clientID, Key: clientEdSk, C2PubKey: c2PublicCurveKey}, NewMemoryStore(nil))
334+
gc, err := NewClient(&PubIDAndKey{
335+
ID: clientID,
336+
Key: clientEdSk,
337+
C2PubKey: c2PublicCurveKey,
338+
}, NewInMemoryStore(nil))
325339
if err != nil {
326340
t.Fatalf("Failed to create client: %v", err)
327341
}
@@ -354,7 +368,7 @@ func TestClientPubKeys(t *testing.T) {
354368
t.Fatalf("failed to get pubkey from config: %v", err)
355369
}
356370

357-
store := NewMemoryStore(nil)
371+
store := NewInMemoryStore(nil)
358372
c, err := NewClient(config, store)
359373
if err != nil {
360374
t.Fatalf("Failed to create client: %v", err)
@@ -449,7 +463,7 @@ func TestClientPubKeys(t *testing.T) {
449463
t.Fatalf("failed to get pubkey from config: %v", err)
450464
}
451465

452-
c, err := NewClient(config, NewMemoryStore(nil))
466+
c, err := NewClient(config, NewInMemoryStore(nil))
453467
if err != nil {
454468
t.Fatalf("Failed to create client: %v", err)
455469
}
@@ -473,7 +487,10 @@ func TestClientPubKeys(t *testing.T) {
473487
})
474488

475489
t.Run("symClient must return unsupported operations on pubKey methods", func(t *testing.T) {
476-
symClient, err := NewClient(&SymNameAndPassword{Name: "testClient", Password: "passwordTestRandom"}, NewMemoryStore(nil))
490+
symClient, err := NewClient(&SymNameAndPassword{
491+
Name: "testClient",
492+
Password: "passwordTestRandom",
493+
}, NewInMemoryStore(nil))
477494
if err != nil {
478495
t.Fatalf("Failed to create symClient: %v", err)
479496
}
@@ -498,7 +515,10 @@ func TestClientPubKeys(t *testing.T) {
498515

499516
func TestClientTopics(t *testing.T) {
500517
t.Run("topic key operations properly update client state", func(t *testing.T) {
501-
symClient, err := NewClient(&SymNameAndPassword{Name: "clientID", Password: "passwordTestRandom"}, NewMemoryStore(nil))
518+
symClient, err := NewClient(&SymNameAndPassword{
519+
Name: "clientID",
520+
Password: "passwordTestRandom",
521+
}, NewInMemoryStore(nil))
502522
if err != nil {
503523
t.Fatalf("Failed to create client: %v", err)
504524
}
@@ -550,7 +570,10 @@ func TestClientTopics(t *testing.T) {
550570
})
551571

552572
t.Run("topic key operations returns errors when invoked with bad topic hashes", func(t *testing.T) {
553-
symClient, err := NewClient(&SymNameAndPassword{Name: "clientID", Password: "passwordTestRandom"}, NewMemoryStore(nil))
573+
symClient, err := NewClient(&SymNameAndPassword{
574+
Name: "clientID",
575+
Password: "passwordTestRandom",
576+
}, NewInMemoryStore(nil))
554577
if err != nil {
555578
t.Fatalf("Failed to create client: %v", err)
556579
}
@@ -572,7 +595,10 @@ func TestClientSetIDKey(t *testing.T) {
572595
validKey := e4crypto.RandomKey()
573596
invalidKey := make([]byte, e4crypto.KeyLen)
574597

575-
c, err := NewClient(&SymIDAndKey{ID: clientID, Key: validKey}, NewMemoryStore(nil))
598+
c, err := NewClient(&SymIDAndKey{
599+
ID: clientID,
600+
Key: validKey,
601+
}, NewInMemoryStore(nil))
576602
if err != nil {
577603
t.Fatalf("Failed to create client: %v", err)
578604
}
@@ -588,7 +614,10 @@ func TestCommandsSymClient(t *testing.T) {
588614
clientKey := e4crypto.RandomKey()
589615
topic := "topic1"
590616

591-
c, err := NewClient(&SymIDAndKey{ID: clientID, Key: clientKey}, NewMemoryStore(nil))
617+
c, err := NewClient(&SymIDAndKey{
618+
ID: clientID,
619+
Key: clientKey,
620+
}, NewInMemoryStore(nil))
592621
if err != nil {
593622
t.Fatalf("Failed to create client: %v", err)
594623
}

‎example_test.go

+15-11
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ import (
2424
)
2525

2626
func ExampleNewClient_symIDAndKey() {
27-
client, err := e4.NewClient(&e4.SymIDAndKey{ID: []byte("clientID"), Key: e4crypto.RandomKey()}, e4.NewMemoryStore(nil))
27+
client, err := e4.NewClient(&e4.SymIDAndKey{
28+
ID: []byte("clientID"),
29+
Key: e4crypto.RandomKey(),
30+
}, e4.NewInMemoryStore(nil))
2831
if err != nil {
2932
panic(err)
3033
}
@@ -33,7 +36,6 @@ func ExampleNewClient_symIDAndKey() {
3336
if err != nil {
3437
panic(err)
3538
}
36-
3739
fmt.Printf("Protected message: %v", protectedMessage)
3840
}
3941

@@ -44,7 +46,10 @@ func ExampleNewClient_fileStorage() {
4446
}
4547
defer f.Close()
4648

47-
client, err := e4.NewClient(&e4.SymIDAndKey{ID: []byte("clientID"), Key: e4crypto.RandomKey()}, f)
49+
client, err := e4.NewClient(&e4.SymIDAndKey{
50+
ID: []byte("clientID"),
51+
Key: e4crypto.RandomKey(),
52+
}, f)
4853
if err != nil {
4954
panic(err)
5055
}
@@ -53,12 +58,14 @@ func ExampleNewClient_fileStorage() {
5358
if err != nil {
5459
panic(err)
5560
}
56-
5761
fmt.Printf("Protected message: %v", protectedMessage)
5862
}
5963

6064
func ExampleNewClient_symNameAndPassword() {
61-
client, err := e4.NewClient(&e4.SymNameAndPassword{Name: "clientName", Password: "verySecretPassword"}, e4.NewMemoryStore(nil))
65+
client, err := e4.NewClient(&e4.SymNameAndPassword{
66+
Name: "clientName",
67+
Password: "verySecretPassword",
68+
}, e4.NewInMemoryStore(nil))
6269
if err != nil {
6370
panic(err)
6471
}
@@ -67,7 +74,6 @@ func ExampleNewClient_symNameAndPassword() {
6774
if err != nil {
6875
panic(err)
6976
}
70-
7177
fmt.Printf("Protected message: %v", protectedMessage)
7278
}
7379

@@ -86,7 +92,7 @@ func ExampleNewClient_pubIDAndKey() {
8692
ID: []byte("clientID"),
8793
Key: privateKey,
8894
C2PubKey: c2PubKey,
89-
}, e4.NewMemoryStore(nil))
95+
}, e4.NewInMemoryStore(nil))
9096

9197
if err != nil {
9298
panic(err)
@@ -96,7 +102,6 @@ func ExampleNewClient_pubIDAndKey() {
96102
if err != nil {
97103
panic(err)
98104
}
99-
100105
fmt.Printf("Protected message: %v", protectedMessage)
101106
}
102107

@@ -105,13 +110,13 @@ func ExampleNewClient_pubNameAndPassword() {
105110
if err != nil {
106111
panic(err)
107112
}
113+
108114
config := &e4.PubNameAndPassword{
109115
Name: "clientName",
110116
Password: "verySecretPassword",
111117
C2PubKey: c2PubKey,
112118
}
113-
114-
client, err := e4.NewClient(config, e4.NewMemoryStore(nil))
119+
client, err := e4.NewClient(config, e4.NewInMemoryStore(nil))
115120
if err != nil {
116121
panic(err)
117122
}
@@ -127,6 +132,5 @@ func ExampleNewClient_pubNameAndPassword() {
127132
if err != nil {
128133
panic(err)
129134
}
130-
131135
fmt.Printf("Protected message: %v", protectedMessage)
132136
}

‎storage.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@ type ReadWriteSeeker interface {
2727
io.ReadWriteSeeker
2828
}
2929

30-
type memoryStore struct {
30+
type inMemoryStore struct {
3131
buf *bytes.Buffer
3232
index int64
3333
}
3434

35-
var _ ReadWriteSeeker = (*memoryStore)(nil)
35+
var _ ReadWriteSeeker = (*inMemoryStore)(nil)
3636

37-
// NewMemoryStore creates a new ReadWriteSeeker in memory
38-
func NewMemoryStore(buf []byte) ReadWriteSeeker {
39-
return &memoryStore{
37+
// NewInMemoryStore creates a new ReadWriteSeeker in memory
38+
func NewInMemoryStore(buf []byte) ReadWriteSeeker {
39+
return &inMemoryStore{
4040
buf: bytes.NewBuffer(buf),
4141
}
4242
}
4343

44-
func (s *memoryStore) Write(p []byte) (n int, err error) {
44+
func (s *inMemoryStore) Write(p []byte) (n int, err error) {
4545
if s.index < 0 {
4646
return 0, io.EOF
4747
}
@@ -59,7 +59,7 @@ func (s *memoryStore) Write(p []byte) (n int, err error) {
5959
return n, err
6060
}
6161

62-
func (s *memoryStore) Read(b []byte) (n int, err error) {
62+
func (s *inMemoryStore) Read(b []byte) (n int, err error) {
6363
if len(b) == 0 {
6464
return 0, nil
6565
}
@@ -74,7 +74,7 @@ func (s *memoryStore) Read(b []byte) (n int, err error) {
7474
return n, err
7575
}
7676

77-
func (s *memoryStore) Seek(offset int64, whence int) (idx int64, err error) {
77+
func (s *inMemoryStore) Seek(offset int64, whence int) (idx int64, err error) {
7878
var abs int64
7979
switch whence {
8080
case io.SeekStart:

‎storage_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020
"testing"
2121
)
2222

23-
func TestMemoryStore(t *testing.T) {
24-
store := NewMemoryStore(nil)
23+
func TestInMemoryStore(t *testing.T) {
24+
store := NewInMemoryStore(nil)
2525

2626
expected := []byte("abcde")
2727

0 commit comments

Comments
 (0)