Skip to content

Commit

Permalink
test: testing NvmeTransports
Browse files Browse the repository at this point in the history 
Signed-off-by: Artsiom Koltun <[email protected]>
  • Loading branch information
@artek-koltun @glimchb
artek-koltun authored and glimchb committed Sep 25, 2023
1 parent 0a1f926 commit 7eedb99
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 26 deletions.
86 changes: 72 additions & 14 deletions pkg/frontend/nvme_controller_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package frontend

import (
"errors"
"fmt"
"net"
"reflect"
Expand All @@ -19,6 +20,7 @@ import (
"google.golang.org/protobuf/types/known/fieldmaskpb"
"google.golang.org/protobuf/types/known/wrapperspb"

"github.com/opiproject/gospdk/spdk"
pb "github.com/opiproject/opi-api/storage/v1alpha1/gen/go"
"github.com/opiproject/opi-spdk-bridge/pkg/server"
)
Expand All @@ -40,17 +42,31 @@ var (
}
)

type stubNvmeTransport struct {
err error
}

func (t *stubNvmeTransport) Params(_ *pb.NvmeController, _ string) (spdk.NvmfSubsystemAddListenerParams, error) {
return spdk.NvmfSubsystemAddListenerParams{}, t.err
}

var (
alwaysValidNvmeTransport = &stubNvmeTransport{}
alwaysFailedNvmeTransport = &stubNvmeTransport{errors.New("some transport error")}
)

func TestFrontEnd_CreateNvmeController(t *testing.T) {
t.Cleanup(checkGlobalTestProtoObjectsNotChanged(t, t.Name()))
tests := map[string]struct {
id string
in *pb.NvmeController
out *pb.NvmeController
spdk []string
errCode codes.Code
errMsg string
exist bool
subsys string
id string
in *pb.NvmeController
out *pb.NvmeController
spdk []string
errCode codes.Code
errMsg string
exist bool
subsys string
transport NvmeTransport
}{
"illegal resource_id": {
"CapitalLettersNotAllowed",
Expand All @@ -66,6 +82,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("user-settable ID must only contain lowercase, numbers and hyphens (%v)", "got: 'C' in position 0"),
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"valid request with invalid SPDK response": {
testControllerID,
Expand All @@ -81,6 +98,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("Could not create CTRL: %v", testControllerName),
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"valid request with empty SPDK response": {
testControllerID,
Expand All @@ -96,6 +114,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("nvmf_subsystem_add_listener: %v", "EOF"),
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"valid request with ID mismatch SPDK response": {
testControllerID,
Expand All @@ -111,6 +130,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("nvmf_subsystem_add_listener: %v", "json response ID mismatch"),
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"valid request with error code from SPDK response": {
testControllerID,
Expand All @@ -126,6 +146,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("nvmf_subsystem_add_listener: %v", "json response error: Invalid parameters"),
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"valid request with valid SPDK response": {
testControllerID,
Expand All @@ -150,6 +171,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
"",
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"already exists": {
testControllerID,
Expand All @@ -165,6 +187,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
"",
true,
testSubsystemName,
alwaysValidNvmeTransport,
},
"malformed subsystem name": {
testControllerID,
Expand All @@ -180,6 +203,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
fmt.Sprintf("segment '%s': not a valid DNS name", "-ABC-DEF"),
false,
"-ABC-DEF",
alwaysValidNvmeTransport,
},
"no required ctrl field": {
testControllerID,
Expand All @@ -190,6 +214,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
"missing required field: nvme_controller",
false,
testSubsystemName,
alwaysValidNvmeTransport,
},
"no required parent field": {
testControllerID,
Expand All @@ -204,6 +229,18 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
"missing required field: parent",
false,
"",
alwaysValidNvmeTransport,
},
"failing transport": {
testControllerID,
&testController,
nil,
[]string{},
codes.InvalidArgument,
alwaysFailedNvmeTransport.err.Error(),
false,
testSubsystemName,
alwaysFailedNvmeTransport,
},
}

Expand All @@ -213,6 +250,7 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
testEnv := createTestEnvironment(tt.spdk)
defer testEnv.Close()

testEnv.opiSpdkServer.Nvme.transport = tt.transport
testEnv.opiSpdkServer.Nvme.Subsystems[testSubsystemName] = server.ProtoClone(&testSubsystem)
testEnv.opiSpdkServer.Nvme.Namespaces[testNamespaceName] = server.ProtoClone(&testNamespace)
if tt.exist {
Expand Down Expand Up @@ -248,12 +286,13 @@ func TestFrontEnd_CreateNvmeController(t *testing.T) {
func TestFrontEnd_DeleteNvmeController(t *testing.T) {
t.Cleanup(checkGlobalTestProtoObjectsNotChanged(t, t.Name()))
tests := map[string]struct {
in string
out *emptypb.Empty
spdk []string
errCode codes.Code
errMsg string
missing bool
in string
out *emptypb.Empty
spdk []string
errCode codes.Code
errMsg string
missing bool
transport NvmeTransport
}{
"valid request with invalid SPDK response": {
testControllerName,
Expand All @@ -262,6 +301,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.InvalidArgument,
fmt.Sprintf("Could not delete NQN:ID %v", "nqn.2022-09.io.spdk:opi3:17"),
false,
alwaysValidNvmeTransport,
},
"valid request with empty SPDK response": {
testControllerName,
Expand All @@ -270,6 +310,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.Unknown,
fmt.Sprintf("nvmf_subsystem_remove_listener: %v", "EOF"),
false,
alwaysValidNvmeTransport,
},
"valid request with ID mismatch SPDK response": {
testControllerName,
Expand All @@ -278,6 +319,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.Unknown,
fmt.Sprintf("nvmf_subsystem_remove_listener: %v", "json response ID mismatch"),
false,
alwaysValidNvmeTransport,
},
"valid request with error code from SPDK response": {
testControllerName,
Expand All @@ -286,6 +328,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.Unknown,
fmt.Sprintf("nvmf_subsystem_remove_listener: %v", "json response error: myopierr"),
false,
alwaysValidNvmeTransport,
},
"valid request with valid SPDK response": {
testControllerName,
Expand All @@ -294,6 +337,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.OK,
"",
false,
alwaysValidNvmeTransport,
},
"valid request with unknown key": {
ResourceIDToControllerName(testSubsystemID, "unknown-controller-id"),
Expand All @@ -302,6 +346,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.NotFound,
fmt.Sprintf("unable to find key %v", ResourceIDToControllerName(testSubsystemID, "unknown-controller-id")),
false,
alwaysValidNvmeTransport,
},
"unknown key with missing allowed": {
ResourceIDToControllerName(testSubsystemID, "unknown-id"),
Expand All @@ -310,6 +355,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.OK,
"",
true,
alwaysValidNvmeTransport,
},
"malformed name": {
"-ABC-DEF",
Expand All @@ -318,6 +364,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.Unknown,
fmt.Sprintf("segment '%s': not a valid DNS name", "-ABC-DEF"),
false,
alwaysValidNvmeTransport,
},
"no required field": {
"",
Expand All @@ -326,6 +373,16 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
codes.Unknown,
"missing required field: name",
false,
alwaysValidNvmeTransport,
},
"failing transport": {
testControllerName,
&emptypb.Empty{},
[]string{},
codes.InvalidArgument,
alwaysFailedNvmeTransport.err.Error(),
false,
alwaysFailedNvmeTransport,
},
}

Expand All @@ -334,6 +391,7 @@ func TestFrontEnd_DeleteNvmeController(t *testing.T) {
t.Run(name, func(t *testing.T) {
testEnv := createTestEnvironment(tt.spdk)
defer testEnv.Close()
testEnv.opiSpdkServer.Nvme.transport = tt.transport
testEnv.opiSpdkServer.Nvme.Subsystems[testSubsystemName] = server.ProtoClone(&testSubsystem)
testEnv.opiSpdkServer.Nvme.Controllers[testControllerName] = server.ProtoClone(&testController)

Expand Down
75 changes: 63 additions & 12 deletions pkg/kvm/nvme_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,20 +97,71 @@ func TestNewNvmeVfiouserTransport(t *testing.T) {
}

func TestNewNvmeVfiouserTransportParams(t *testing.T) {
tmpDir := os.TempDir()
wantParams := spdk.NvmfSubsystemAddListenerParams{}
wantParams.Nqn = "nqn.2014-08.org.nvmexpress:uuid:1630a3a6-5bac-4563-a1a6-d2b0257c282a"
wantParams.ListenAddress.Trtype = "vfiouser"
wantParams.ListenAddress.Traddr = filepath.Join(tmpDir, testSubsystemID)
tmpDir := t.TempDir()
tests := map[string]struct {
pf int32
vf int32
port int32
wantErr bool
wantParams spdk.NvmfSubsystemAddListenerParams
}{
"not allowed vf": {
pf: 0,
vf: 1,
port: 0,
wantErr: true,
wantParams: spdk.NvmfSubsystemAddListenerParams{},
},
"not allowed port": {
pf: 0,
vf: 0,
port: 2,
wantErr: true,
wantParams: spdk.NvmfSubsystemAddListenerParams{},
},
"successful params": {
pf: 3,
vf: 0,
port: 0,
wantErr: false,
wantParams: spdk.NvmfSubsystemAddListenerParams{
Nqn: "nqn.2014-08.org.nvmexpress:uuid:1630a3a6-5bac-4563-a1a6-d2b0257c282a",
ListenAddress: struct {
Trtype string "json:\"trtype\""
Traddr string "json:\"traddr\""
Trsvcid string "json:\"trsvcid,omitempty\""
Adrfam string "json:\"adrfam,omitempty\""
}{
Trtype: "vfiouser",
Traddr: filepath.Join(tmpDir, "subsys0"),
Trsvcid: "",
Adrfam: "",
},
},
},
}

vfiouserNvmeTransport := NewNvmeVfiouserTransport(tmpDir)
gotParams := vfiouserNvmeTransport.Params(&pb.NvmeController{
Name: testNvmeControllerName,
Spec: &pb.NvmeControllerSpec{},
}, "nqn.2014-08.org.nvmexpress:uuid:1630a3a6-5bac-4563-a1a6-d2b0257c282a")
for testName, tt := range tests {
t.Run(testName, func(t *testing.T) {
vfiouserTransport := NewNvmeVfiouserTransport(tmpDir)
gotParams, err := vfiouserTransport.Params(&pb.NvmeController{
Name: frontend.ResourceIDToControllerName("subsys0", "nvme-1"),
Spec: &pb.NvmeControllerSpec{
PcieId: &pb.PciEndpoint{
PortId: wrapperspb.Int32(tt.port),
PhysicalFunction: wrapperspb.Int32(tt.pf),
VirtualFunction: wrapperspb.Int32(tt.vf),
},
},
}, "nqn.2014-08.org.nvmexpress:uuid:1630a3a6-5bac-4563-a1a6-d2b0257c282a")

if !reflect.DeepEqual(wantParams, gotParams) {
t.Errorf("Expect %v, received %v", wantParams, gotParams)
if (err != nil) != tt.wantErr {
t.Errorf("Expect error: %v, received: %v", nil, err)
}
if !reflect.DeepEqual(tt.wantParams, gotParams) {
t.Errorf("Expect %v, received %v", tt.wantParams, gotParams)
}
})
}
}

Expand Down

0 comments on commit 7eedb99

Please sign in to comment.