feat: add context in tests as well

Signed-off-by: Boris Glimcher <[email protected]>
opiproject · Oct 6, 2023 · 15e8f28 · 15e8f28
1 parent 8edbef6
commit 15e8f28
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 50 deletions.
diff --git a/cmd/main.go b/cmd/main.go
@@ -7,25 +7,28 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"log"
 
 	"github.com/opiproject/gospdk/spdk"
 )
 
 func main() {
+	ctx := context.Background()
+
 	var spdkAddress string
 	flag.StringVar(&spdkAddress, "spdk_addr", "/var/tmp/spdk.sock", "Points to SPDK unix socket/tcp socket to interact with")
 	flag.Parse()
 
 	// use like this:
 	jsonRPC := spdk.NewSpdkJSONRPC(spdkAddress)
-	version := jsonRPC.GetVersion()
+	version := jsonRPC.GetVersion(ctx)
 	log.Printf("Received from SPDK: %v", version)
 
 	// or like this:
 	var ver spdk.GetVersionResult
-	err := jsonRPC.Call("spdk_get_version", nil, &ver)
+	err := jsonRPC.Call(ctx, "spdk_get_version", nil, &ver)
 	if err != nil {
 		log.Fatalf("failed to get SPDK version: %v", err)
 	}

diff --git a/spdk/accel.service.go b/spdk/accel.service.go
@@ -4,9 +4,13 @@
 // Package spdk implements the spdk json-rpc protocol
 package spdk
 
+import (
+	"context"
+)
+
 type AccelService interface {
-	CryptoKeyCreate(name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error)
-	CryptoKeyDestroy(*AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error)
-	CryptoKeyList(*AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error)
-	GetStats(*NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
+	CryptoKeyCreate(ctx context.Context, name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error)
+	CryptoKeyDestroy(context.Context, *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error)
+	CryptoKeyList(context.Context, *AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error)
+	GetStats(context.Context, *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
 }
diff --git a/spdk/accel.service.impl.go b/spdk/accel.service.impl.go
@@ -12,16 +12,15 @@ import (
 )
 
 type AccelServiceImpl struct {
-	ctx    context.Context
 	client JSONRPC
 }
 
-func NewAccelService(ctx context.Context) AccelService {
+func NewAccelService() AccelService {
 	// client := spdk.NewSpdkJSONRPC(spdkAddress)
-	return &AccelServiceImpl{ctx, nil}
+	return &AccelServiceImpl{nil}
 }
 
-func (p *AccelServiceImpl) CryptoKeyCreate(name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error) {
+func (p *AccelServiceImpl) CryptoKeyCreate(ctx context.Context, name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error) {
 	// TBD
 	keyHalf := len(key) / 2
 	params := AccelCryptoKeyCreateParams{
@@ -31,7 +30,7 @@ func (p *AccelServiceImpl) CryptoKeyCreate(name string, cipher string, key []byt
 		Name:   name,
 	}
 	var result AccelCryptoKeyCreateResult
-	err := p.client.Call("accel_crypto_key_create", &params, &result)
+	err := p.client.Call(ctx, "accel_crypto_key_create", &params, &result)
 	if err != nil {
 		log.Printf("error: %v", err)
 		return nil, err
@@ -45,17 +44,17 @@ func (p *AccelServiceImpl) CryptoKeyCreate(name string, cipher string, key []byt
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) CryptoKeyDestroy(params *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error) {
+func (p *AccelServiceImpl) CryptoKeyDestroy(_ context.Context, params *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) CryptoKeyList(params *AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error) {
+func (p *AccelServiceImpl) CryptoKeyList(_ context.Context, params *AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) GetStats(params *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error) {
+func (p *AccelServiceImpl) GetStats(_ context.Context, params *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error) {
 	// TBD
 	return nil, nil
 }
diff --git a/spdk/jsonrpc.go b/spdk/jsonrpc.go
@@ -7,6 +7,7 @@ package spdk
 
 import (
 	"bufio"
+	"context"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -29,9 +30,9 @@ var (
 // JSONRPC represents an interface to execute JSON RPC to SPDK
 type JSONRPC interface {
 	GetID() uint64
-	GetVersion() string
+	GetVersion(context.Context) string
 	StartUnixListener() net.Listener
-	Call(method string, args, result interface{}) error
+	Call(ctx context.Context, method string, args, result interface{}) error
 }
 
 type SpdkJSONRPC struct {
@@ -40,6 +41,9 @@ type SpdkJSONRPC struct {
 	id        uint64
 }
 
+// build time check that struct implements interface
+var _ JSONRPC = (*SpdkJSONRPC)(nil)
+
 // NewSpdkJSONRPC creates a new instance of JSONRPC which is capable to
 // interact with either unix domain socket, e.g.: /var/tmp/spdk.sock
 // or with tcp connection ip and port tuple, e.g.: 10.1.1.2:1234
@@ -65,9 +69,9 @@ func (r *SpdkJSONRPC) GetID() uint64 {
 }
 
 // GetVersion implements low level rpc request/response handling
-func (r *SpdkJSONRPC) GetVersion() string {
+func (r *SpdkJSONRPC) GetVersion(ctx context.Context) string {
 	var ver GetVersionResult
-	err := r.Call("spdk_get_version", nil, &ver)
+	err := r.Call(ctx, "spdk_get_version", nil, &ver)
 	if err != nil {
 		msg := fmt.Sprintf("Could not get spdk version: %v", err)
 		log.Print(msg)
@@ -90,7 +94,7 @@ func (r *SpdkJSONRPC) StartUnixListener() net.Listener {
 }
 
 // Call implements low level rpc request/response handling
-func (r *SpdkJSONRPC) Call(method string, args, result interface{}) error {
+func (r *SpdkJSONRPC) Call(_ context.Context, method string, args, result interface{}) error {
 	id := atomic.AddUint64(&r.id, 1)
 	request := RPCRequest{
 		RPCVersion: JSONRPCVersion,

diff --git a/spdk/lvol.service.go b/spdk/lvol.service.go
@@ -4,17 +4,21 @@
 // Package spdk implements the spdk json-rpc protocol
 package spdk
 
+import (
+	"context"
+)
+
 type LvolService interface {
-	CreateLvstore(*NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
-	DeleteLvstore(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	GetLvstores(page int, limit int) (*NvmfGetSubsystemsResult, error)
-	RenameLvstore(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	GrowLvstore(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	CreateLvstore(context.Context, *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
+	DeleteLvstore(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	GetLvstores(ctx context.Context, page int, limit int) (*NvmfGetSubsystemsResult, error)
+	RenameLvstore(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	GrowLvstore(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
 
-	CreateLvol(*NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
-	SnapshotLvol(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	CloneLvol(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	RenameLvol(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	ResizeLvol(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	DeleteLvol(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	CreateLvol(context.Context, *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
+	SnapshotLvol(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	CloneLvol(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	RenameLvol(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	ResizeLvol(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	DeleteLvol(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
 }
diff --git a/spdk/nvmf.service.go b/spdk/nvmf.service.go
@@ -4,13 +4,17 @@
 // Package spdk implements the spdk json-rpc protocol
 package spdk
 
+import (
+	"context"
+)
+
 type NvmfService interface {
-	CreateSubsystem(nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error)
-	DeleteSubsystem(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
-	GetSubsystems(page int, limit int) (*NvmfGetSubsystemsResult, error)
-	GetStats(page int, limit int) (*NvmfGetSubsystemStatsResult, error)
-	AddListener(*NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error)
-	RemoveListener(*NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error)
-	AddNamespace(*NvmfSubsystemAddNsParams) (*NvmfSubsystemAddNsResult, error)
-	RemoveNamespace(*NvmfSubsystemRemoveNsParams) (*NvmfSubsystemRemoveNsResult, error)
+	CreateSubsystem(ctx context.Context, nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error)
+	DeleteSubsystem(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)
+	GetSubsystems(ctx context.Context, page int, limit int) (*NvmfGetSubsystemsResult, error)
+	GetStats(ctx context.Context, page int, limit int) (*NvmfGetSubsystemStatsResult, error)
+	AddListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error)
+	RemoveListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error)
+	AddNamespace(context.Context, *NvmfSubsystemAddNsParams) (*NvmfSubsystemAddNsResult, error)
+	RemoveNamespace(context.Context, *NvmfSubsystemRemoveNsParams) (*NvmfSubsystemRemoveNsResult, error)
 }
diff --git a/spdk/nvmf.service.impl.go b/spdk/nvmf.service.impl.go
@@ -11,16 +11,15 @@ import (
 )
 
 type NvmfServiceImpl struct {
-	ctx    context.Context
 	client JSONRPC
 }
 
-func NewNvmfService(ctx context.Context) NvmfService {
+func NewNvmfService() NvmfService {
 	// client := spdk.NewSpdkJSONRPC(spdkAddress)
-	return &NvmfServiceImpl{ctx, nil}
+	return &NvmfServiceImpl{nil}
 }
 
-func (p *NvmfServiceImpl) CreateSubsystem(nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error) {
+func (p *NvmfServiceImpl) CreateSubsystem(ctx context.Context, nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error) {
 	// TBD
 	params := NvmfCreateSubsystemParams{
 		Nqn:           nqn,
@@ -30,7 +29,7 @@ func (p *NvmfServiceImpl) CreateSubsystem(nqn string, serial string, model strin
 		MaxNamespaces: ns,
 	}
 	var result NvmfCreateSubsystemResult
-	err := p.client.Call("nvmf_create_subsystem", &params, &result)
+	err := p.client.Call(ctx, "nvmf_create_subsystem", &params, &result)
 	if err != nil {
 		log.Printf("error: %v", err)
 		return nil, err
@@ -44,37 +43,37 @@ func (p *NvmfServiceImpl) CreateSubsystem(nqn string, serial string, model strin
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) DeleteSubsystem(*NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error) {
+func (p *NvmfServiceImpl) DeleteSubsystem(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) GetSubsystems(page int, limit int) (*NvmfGetSubsystemsResult, error) {
+func (p *NvmfServiceImpl) GetSubsystems(_ context.Context, page int, limit int) (*NvmfGetSubsystemsResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) GetStats(page int, limit int) (*NvmfGetSubsystemStatsResult, error) {
+func (p *NvmfServiceImpl) GetStats(_ context.Context, page int, limit int) (*NvmfGetSubsystemStatsResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) AddListener(*NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
+func (p *NvmfServiceImpl) AddListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) RemoveListener(*NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
+func (p *NvmfServiceImpl) RemoveListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) AddNamespace(*NvmfSubsystemAddNsParams) (*NvmfSubsystemAddNsResult, error) {
+func (p *NvmfServiceImpl) AddNamespace(context.Context, *NvmfSubsystemAddNsParams) (*NvmfSubsystemAddNsResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *NvmfServiceImpl) RemoveNamespace(*NvmfSubsystemRemoveNsParams) (*NvmfSubsystemRemoveNsResult, error) {
+func (p *NvmfServiceImpl) RemoveNamespace(context.Context, *NvmfSubsystemRemoveNsParams) (*NvmfSubsystemRemoveNsResult, error) {
 	// TBD
 	return nil, nil
 }