[#197] session: Refactor and document the package

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>

session/test/container.go

@@ -1,27 +0,0 @@
-package sessiontest
-
-import (
-	"math/rand"
-
-	cidtest "github.com/nspcc-dev/neofs-sdk-go/container/id/test"
-	"github.com/nspcc-dev/neofs-sdk-go/session"
-)
-
-// ContainerContext returns session.ContainerContext
-// which applies to random operation on a random container.
-func ContainerContext() *session.ContainerContext {
-	c := session.NewContainerContext()
-
-	setters := []func(){
-		c.ForPut,
-		c.ForDelete,
-		c.ForSetEACL,
-	}
-
-	setters[rand.Uint32()%uint32(len(setters))]()
-
-	cID := cidtest.ID()
-	c.ApplyTo(&cID)
-
-	return c
-}

session/test/doc.go

@@ -0,0 +1,13 @@
+/*
+Package sessiontest provides functions for convenient testing of session package API.
+
+Note that importing the package into source files is highly discouraged.
+
+Random instance generation functions can be useful when testing expects any value, e.g.:
+	import sessiontest "github.com/nspcc-dev/neofs-sdk-go/session/test"
+
+	val := sessiontest.Container()
+	// test the value
+
+*/
+package sessiontest

session/test/object.go

@@ -1,30 +0,0 @@
-package sessiontest
-
-import (
-	"math/rand"
-
-	addresstest "github.com/nspcc-dev/neofs-sdk-go/object/address/test"
-	"github.com/nspcc-dev/neofs-sdk-go/session"
-)
-
-// ObjectContext returns session.ObjectContext
-// which applies to random operation on a random object.
-func ObjectContext() *session.ObjectContext {
-	c := session.NewObjectContext()
-
-	setters := []func(){
-		c.ForPut,
-		c.ForDelete,
-		c.ForHead,
-		c.ForRange,
-		c.ForRangeHash,
-		c.ForSearch,
-		c.ForGet,
-	}
-
-	setters[rand.Uint32()%uint32(len(setters))]()
-
-	c.ApplyTo(addresstest.Address())
-
-	return c
-}

session/test/session.go

@@ -0,0 +1,97 @@
+package sessiontest
+
+import (
+	"crypto/ecdsa"
+	"crypto/elliptic"
+	"crypto/rand"
+
+	"github.com/google/uuid"
+	"github.com/nspcc-dev/neo-go/pkg/crypto/keys"
+	cidtest "github.com/nspcc-dev/neofs-sdk-go/container/id/test"
+	neofsecdsa "github.com/nspcc-dev/neofs-sdk-go/crypto/ecdsa"
+	addresstest "github.com/nspcc-dev/neofs-sdk-go/object/address/test"
+	"github.com/nspcc-dev/neofs-sdk-go/session"
+)
+
+var p ecdsa.PrivateKey
+
+func init() {
+	k, err := keys.NewPrivateKey()
+	if err != nil {
+		panic(err)
+	}
+
+	p = k.PrivateKey
+}
+
+// Container returns random session.Container.
+//
+// Resulting token is unsigned.
+func Container() *session.Container {
+	var tok session.Container
+
+	priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
+	if err != nil {
+		panic(err)
+	}
+
+	tok.ForVerb(session.VerbContainerPut)
+	tok.ApplyOnlyTo(cidtest.ID())
+	tok.SetID(uuid.New())
+	tok.SetAuthKey((*neofsecdsa.PublicKey)(&priv.PublicKey))
+	tok.SetExp(11)
+	tok.SetNbf(22)
+	tok.SetIat(33)
+
+	return &tok
+}
+
+// ContainerSigned returns signed random session.Container.
+//
+// Panics if token could not be signed (actually unexpected).
+func ContainerSigned() *session.Container {
+	tok := Container()
+
+	err := tok.Sign(p)
+	if err != nil {
+		panic(err)
+	}
+
+	return tok
+}
+
+// Object returns random session.Object.
+//
+// Resulting token is unsigned.
+func Object() *session.Object {
+	var tok session.Object
+
+	priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
+	if err != nil {
+		panic(err)
+	}
+
+	tok.ForVerb(session.VerbObjectPut)
+	tok.ApplyTo(*addresstest.Address())
+	tok.SetID(uuid.New())
+	tok.SetAuthKey((*neofsecdsa.PublicKey)(&priv.PublicKey))
+	tok.SetExp(11)
+	tok.SetNbf(22)
+	tok.SetIat(33)
+
+	return &tok
+}
+
+// ObjectSigned returns signed random session.Object.
+//
+// Panics if token could not be signed (actually unexpected).
+func ObjectSigned() *session.Object {
+	tok := Object()
+
+	err := tok.Sign(p)
+	if err != nil {
+		panic(err)
+	}
+
+	return tok
+}

session/test/token.go

@@ -1,69 +0,0 @@
-package sessiontest
-
-import (
-	"crypto/ecdsa"
-	"crypto/elliptic"
-	"crypto/rand"
-
-	"github.com/google/uuid"
-	"github.com/nspcc-dev/neo-go/pkg/crypto/keys"
-	"github.com/nspcc-dev/neofs-sdk-go/session"
-	"github.com/nspcc-dev/neofs-sdk-go/user"
-)
-
-var p *keys.PrivateKey
-
-func init() {
-	var err error
-
-	p, err = keys.NewPrivateKey()
-	if err != nil {
-		panic(err)
-	}
-}
-
-// Token returns random session.Token.
-//
-// Resulting token is unsigned.
-func Token() *session.Token {
-	tok := session.NewToken()
-
-	uid, err := uuid.New().MarshalBinary()
-	if err != nil {
-		panic(err)
-	}
-
-	priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
-	if err != nil {
-		panic(err)
-	}
-
-	var ownerID user.ID
-
-	user.IDFromKey(&ownerID, priv.PublicKey)
-
-	keyBin := p.PublicKey().Bytes()
-
-	tok.SetID(uid)
-	tok.SetOwnerID(&ownerID)
-	tok.SetSessionKey(keyBin)
-	tok.SetExp(11)
-	tok.SetNbf(22)
-	tok.SetIat(33)
-
-	return tok
-}
-
-// SignedToken returns signed random session.Token.
-//
-// Panics if token could not be signed (actually unexpected).
-func SignedToken() *session.Token {
-	tok := Token()
-
-	err := tok.Sign(&p.PrivateKey)
-	if err != nil {
-		panic(err)
-	}
-
-	return tok
-}