Renamed memoryStore -> inMemoryStore

teserakt-io · Feb 3, 2020 · 8fb7337 · 8fb7337
1 parent 8f52277
commit 8fb7337
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 35 deletions.
diff --git a/client_test.go b/client_test.go
@@ -41,7 +41,10 @@ func TestNewClientSymKey(t *testing.T) {
 	rand.Read(id)
 	rand.Read(k)
 
-	c, err := NewClient(&SymIDAndKey{ID: id, Key: k}, NewMemoryStore(nil))
+	c, err := NewClient(&SymIDAndKey{
+		ID:  id,
+		Key: k,
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -77,7 +80,9 @@ func TestNewClientSymKey(t *testing.T) {
 }
 
 func TestProtectUnprotectMessageSymKey(t *testing.T) {
-	client, err := NewClient(&SymIDAndKey{Key: e4crypto.RandomKey()}, NewMemoryStore(nil))
+	client, err := NewClient(&SymIDAndKey{
+		Key: e4crypto.RandomKey(),
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -98,7 +103,7 @@ func TestProtectUnprotectMessagePubKey(t *testing.T) {
 		ID:       clientID,
 		Key:      privateKey,
 		C2PubKey: generateCurve25519PubKey(t),
-	}, NewMemoryStore(nil))
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -200,7 +205,10 @@ func TestKeyTransition(t *testing.T) {
 	clientKey := e4crypto.RandomKey()
 	topic := "topic"
 
-	c, err := NewClient(&SymIDAndKey{ID: clientID, Key: clientKey}, NewMemoryStore(nil))
+	c, err := NewClient(&SymIDAndKey{
+		ID:  clientID,
+		Key: clientKey,
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -257,8 +265,10 @@ func TestKeyTransition(t *testing.T) {
 }
 
 func TestClientWriteRead(t *testing.T) {
-	store := NewMemoryStore(nil)
-	gc, err := NewClient(&SymIDAndKey{Key: e4crypto.RandomKey()}, store)
+	store := NewInMemoryStore(nil)
+	gc, err := NewClient(&SymIDAndKey{
+		Key: e4crypto.RandomKey(),
+	}, store)
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -321,7 +331,11 @@ func TestProtectUnprotectCommandsPubKey(t *testing.T) {
 	}
 
 	clientID := e4crypto.RandomID()
-	gc, err := NewClient(&PubIDAndKey{ID: clientID, Key: clientEdSk, C2PubKey: c2PublicCurveKey}, NewMemoryStore(nil))
+	gc, err := NewClient(&PubIDAndKey{
+		ID:       clientID,
+		Key:      clientEdSk,
+		C2PubKey: c2PublicCurveKey,
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -354,7 +368,7 @@ func TestClientPubKeys(t *testing.T) {
 			t.Fatalf("failed to get pubkey from config: %v", err)
 		}
 
-		store := NewMemoryStore(nil)
+		store := NewInMemoryStore(nil)
 		c, err := NewClient(config, store)
 		if err != nil {
 			t.Fatalf("Failed to create client: %v", err)
@@ -449,7 +463,7 @@ func TestClientPubKeys(t *testing.T) {
 			t.Fatalf("failed to get pubkey from config: %v", err)
 		}
 
-		c, err := NewClient(config, NewMemoryStore(nil))
+		c, err := NewClient(config, NewInMemoryStore(nil))
 		if err != nil {
 			t.Fatalf("Failed to create client: %v", err)
 		}
@@ -473,7 +487,10 @@ func TestClientPubKeys(t *testing.T) {
 	})
 
 	t.Run("symClient must return unsupported operations on pubKey methods", func(t *testing.T) {
-		symClient, err := NewClient(&SymNameAndPassword{Name: "testClient", Password: "passwordTestRandom"}, NewMemoryStore(nil))
+		symClient, err := NewClient(&SymNameAndPassword{
+			Name:     "testClient",
+			Password: "passwordTestRandom",
+		}, NewInMemoryStore(nil))
 		if err != nil {
 			t.Fatalf("Failed to create symClient: %v", err)
 		}
@@ -498,7 +515,10 @@ func TestClientPubKeys(t *testing.T) {
 
 func TestClientTopics(t *testing.T) {
 	t.Run("topic key operations properly update client state", func(t *testing.T) {
-		symClient, err := NewClient(&SymNameAndPassword{Name: "clientID", Password: "passwordTestRandom"}, NewMemoryStore(nil))
+		symClient, err := NewClient(&SymNameAndPassword{
+			Name:     "clientID",
+			Password: "passwordTestRandom",
+		}, NewInMemoryStore(nil))
 		if err != nil {
 			t.Fatalf("Failed to create client: %v", err)
 		}
@@ -550,7 +570,10 @@ func TestClientTopics(t *testing.T) {
 	})
 
 	t.Run("topic key operations returns errors when invoked with bad topic hashes", func(t *testing.T) {
-		symClient, err := NewClient(&SymNameAndPassword{Name: "clientID", Password: "passwordTestRandom"}, NewMemoryStore(nil))
+		symClient, err := NewClient(&SymNameAndPassword{
+			Name:     "clientID",
+			Password: "passwordTestRandom",
+		}, NewInMemoryStore(nil))
 		if err != nil {
 			t.Fatalf("Failed to create client: %v", err)
 		}
@@ -572,7 +595,10 @@ func TestClientSetIDKey(t *testing.T) {
 	validKey := e4crypto.RandomKey()
 	invalidKey := make([]byte, e4crypto.KeyLen)
 
-	c, err := NewClient(&SymIDAndKey{ID: clientID, Key: validKey}, NewMemoryStore(nil))
+	c, err := NewClient(&SymIDAndKey{
+		ID:  clientID,
+		Key: validKey,
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}
@@ -588,7 +614,10 @@ func TestCommandsSymClient(t *testing.T) {
 	clientKey := e4crypto.RandomKey()
 	topic := "topic1"
 
-	c, err := NewClient(&SymIDAndKey{ID: clientID, Key: clientKey}, NewMemoryStore(nil))
+	c, err := NewClient(&SymIDAndKey{
+		ID:  clientID,
+		Key: clientKey,
+	}, NewInMemoryStore(nil))
 	if err != nil {
 		t.Fatalf("Failed to create client: %v", err)
 	}

diff --git a/example_test.go b/example_test.go
@@ -24,7 +24,10 @@ import (
 )
 
 func ExampleNewClient_symIDAndKey() {
-	client, err := e4.NewClient(&e4.SymIDAndKey{ID: []byte("clientID"), Key: e4crypto.RandomKey()}, e4.NewMemoryStore(nil))
+	client, err := e4.NewClient(&e4.SymIDAndKey{
+		ID:  []byte("clientID"),
+		Key: e4crypto.RandomKey(),
+	}, e4.NewInMemoryStore(nil))
 	if err != nil {
 		panic(err)
 	}
@@ -33,7 +36,6 @@ func ExampleNewClient_symIDAndKey() {
 	if err != nil {
 		panic(err)
 	}
-
 	fmt.Printf("Protected message: %v", protectedMessage)
 }
 
@@ -44,7 +46,10 @@ func ExampleNewClient_fileStorage() {
 	}
 	defer f.Close()
 
-	client, err := e4.NewClient(&e4.SymIDAndKey{ID: []byte("clientID"), Key: e4crypto.RandomKey()}, f)
+	client, err := e4.NewClient(&e4.SymIDAndKey{
+		ID:  []byte("clientID"),
+		Key: e4crypto.RandomKey(),
+	}, f)
 	if err != nil {
 		panic(err)
 	}
@@ -53,12 +58,14 @@ func ExampleNewClient_fileStorage() {
 	if err != nil {
 		panic(err)
 	}
-
 	fmt.Printf("Protected message: %v", protectedMessage)
 }
 
 func ExampleNewClient_symNameAndPassword() {
-	client, err := e4.NewClient(&e4.SymNameAndPassword{Name: "clientName", Password: "verySecretPassword"}, e4.NewMemoryStore(nil))
+	client, err := e4.NewClient(&e4.SymNameAndPassword{
+		Name:     "clientName",
+		Password: "verySecretPassword",
+	}, e4.NewInMemoryStore(nil))
 	if err != nil {
 		panic(err)
 	}
@@ -67,7 +74,6 @@ func ExampleNewClient_symNameAndPassword() {
 	if err != nil {
 		panic(err)
 	}
-
 	fmt.Printf("Protected message: %v", protectedMessage)
 }
 
@@ -86,7 +92,7 @@ func ExampleNewClient_pubIDAndKey() {
 		ID:       []byte("clientID"),
 		Key:      privateKey,
 		C2PubKey: c2PubKey,
-	}, e4.NewMemoryStore(nil))
+	}, e4.NewInMemoryStore(nil))
 
 	if err != nil {
 		panic(err)
@@ -96,7 +102,6 @@ func ExampleNewClient_pubIDAndKey() {
 	if err != nil {
 		panic(err)
 	}
-
 	fmt.Printf("Protected message: %v", protectedMessage)
 }
 
@@ -105,13 +110,13 @@ func ExampleNewClient_pubNameAndPassword() {
 	if err != nil {
 		panic(err)
 	}
+
 	config := &e4.PubNameAndPassword{
 		Name:     "clientName",
 		Password: "verySecretPassword",
 		C2PubKey: c2PubKey,
 	}
-
-	client, err := e4.NewClient(config, e4.NewMemoryStore(nil))
+	client, err := e4.NewClient(config, e4.NewInMemoryStore(nil))
 	if err != nil {
 		panic(err)
 	}
@@ -127,6 +132,5 @@ func ExampleNewClient_pubNameAndPassword() {
 	if err != nil {
 		panic(err)
 	}
-
 	fmt.Printf("Protected message: %v", protectedMessage)
 }
diff --git a/storage.go b/storage.go
@@ -27,21 +27,21 @@ type ReadWriteSeeker interface {
 	io.ReadWriteSeeker
 }
 
-type memoryStore struct {
+type inMemoryStore struct {
 	buf   *bytes.Buffer
 	index int64
 }
 
-var _ ReadWriteSeeker = (*memoryStore)(nil)
+var _ ReadWriteSeeker = (*inMemoryStore)(nil)
 
-// NewMemoryStore creates a new ReadWriteSeeker in memory
-func NewMemoryStore(buf []byte) ReadWriteSeeker {
-	return &memoryStore{
+// NewInMemoryStore creates a new ReadWriteSeeker in memory
+func NewInMemoryStore(buf []byte) ReadWriteSeeker {
+	return &inMemoryStore{
 		buf: bytes.NewBuffer(buf),
 	}
 }
 
-func (s *memoryStore) Write(p []byte) (n int, err error) {
+func (s *inMemoryStore) Write(p []byte) (n int, err error) {
 	if s.index < 0 {
 		return 0, io.EOF
 	}
@@ -59,7 +59,7 @@ func (s *memoryStore) Write(p []byte) (n int, err error) {
 	return n, err
 }
 
-func (s *memoryStore) Read(b []byte) (n int, err error) {
+func (s *inMemoryStore) Read(b []byte) (n int, err error) {
 	if len(b) == 0 {
 		return 0, nil
 	}
@@ -74,7 +74,7 @@ func (s *memoryStore) Read(b []byte) (n int, err error) {
 	return n, err
 }
 
-func (s *memoryStore) Seek(offset int64, whence int) (idx int64, err error) {
+func (s *inMemoryStore) Seek(offset int64, whence int) (idx int64, err error) {
 	var abs int64
 	switch whence {
 	case io.SeekStart:

diff --git a/storage_test.go b/storage_test.go
@@ -20,8 +20,8 @@ import (
 	"testing"
 )
 
-func TestMemoryStore(t *testing.T) {
-	store := NewMemoryStore(nil)
+func TestInMemoryStore(t *testing.T) {
+	store := NewInMemoryStore(nil)
 
 	expected := []byte("abcde")