intel-device-plugins-for-ku.../cmd/qat_plugin/dpdkdrv/dpdkdrv_test.go
Hyeongju Johannes Lee 8fc5df7e37 Add govet-fieldalignment
Add govet-fieldalignment to .golangci.yml
Fix errors that come from adding govet-fieldalignment
- by reordering the fields of structs
- by putting nolint:govet annotations

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2021-09-20 20:59:04 +03:00

479 lines
16 KiB
Go

// Copyright 2018 Intel Corporation. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dpdkdrv
import (
"flag"
"os"
"path"
"testing"
"github.com/pkg/errors"
pluginapi "k8s.io/kubelet/pkg/apis/deviceplugin/v1beta1"
)
func init() {
_ = flag.Set("v", "4") //Enable debug output
}
func createTestFiles(prefix string, dirs []string, files map[string][]byte, symlinks map[string]string) error {
for _, dir := range dirs {
err := os.MkdirAll(path.Join(prefix, dir), 0750)
if err != nil {
return errors.Wrap(err, "Failed to create fake device directory")
}
}
for filename, body := range files {
err := os.WriteFile(path.Join(prefix, filename), body, 0600)
if err != nil {
return errors.Wrap(err, "Failed to create fake vendor file")
}
}
for link, target := range symlinks {
err := os.MkdirAll(path.Join(prefix, target), 0750)
if err != nil {
return errors.Wrap(err, "Failed to create fake symlink target directory")
}
err = os.Symlink(path.Join(prefix, target), path.Join(prefix, link))
if err != nil {
return errors.Wrap(err, "Failed to create fake symlink")
}
}
return nil
}
func TestNewDevicePlugin(t *testing.T) {
tcases := []struct {
name string
dpdkDriver string
kernelVfDrivers string
expectedErr bool
}{
{
name: "Wrong dpdkDriver",
dpdkDriver: "uio",
kernelVfDrivers: "c6xxvf",
expectedErr: true,
},
{
name: "Correct dpdkDriver, wrong kernelVfDrivers",
dpdkDriver: "vfio-pci",
kernelVfDrivers: "c6xxxvf",
expectedErr: true,
},
{
name: "Correct dpdkDriver, kernelVfDrivers separated wrong",
dpdkDriver: "vfio-pci",
kernelVfDrivers: "c6xxvf:d15xxvf",
expectedErr: true,
},
{
name: "No errors",
dpdkDriver: "vfio-pci",
kernelVfDrivers: "c6xxvf,d15xxvf",
expectedErr: false,
},
}
for _, tt := range tcases {
t.Run(tt.name, func(t *testing.T) {
_, err := NewDevicePlugin(1, tt.kernelVfDrivers, tt.dpdkDriver)
if tt.expectedErr && err == nil {
t.Errorf("Test case '%s': expected error", tt.name)
}
if !tt.expectedErr && err != nil {
t.Errorf("Test case '%s': expected success", tt.name)
}
})
}
}
func TestScanPrivate(t *testing.T) {
tcases := []struct {
name string
dpdkDriver string
dirs []string
files map[string][]byte
symlinks map[string]string
kernelVfDrivers []string
expectedErr bool
maxDevNum int
expectedDevNum int
}{
{
name: "No error returned for uninitialized device plugin",
},
{
name: "igb_uio DPDKdriver with one DPDK bound device where vfdevID cannot be determined",
dpdkDriver: "igb_uio",
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/igb_uio/0000:02:01.0",
"sys/bus/pci/devices/0000:02:01.0/uio/sometestfile",
"sys/bus/pci/devices/0000:02:00.0",
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedErr: true,
},
{
name: "igb_uio DPDKdriver with one kernel bound device, but unbindable",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:01.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedErr: true,
},
{
name: "Broken igb_uio DPDKdriver with one kernel bound device",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/devices/0000:02:01.0/uio/sometestfile",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 0,
},
{
name: "igb_uio DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9) where reading uioDirPath for obtaining device file fails ",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/igb_uio",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/igb_uio/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedErr: true,
},
{
name: "igb_uio DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9) but no uio device is found",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/igb_uio",
"sys/bus/pci/devices/0000:02:01.0/uio",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/igb_uio/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedErr: true,
},
{
name: "igb_uio DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9) where the available devices on the system are 2 but maxNumDevices=1] ",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/igb_uio",
"sys/bus/pci/devices/0000:02:01.0/uio/sometestfile",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:01.1/uio/sometestfile",
"sys/bus/pci/devices/0000:02:01.1/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/igb_uio/new_id": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.1/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.1/device": []byte("0x37c9"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn1": "sys/bus/pci/devices/0000:02:01.1",
},
maxDevNum: 1,
expectedDevNum: 1,
},
{
name: "igb_uio DPDKdriver with one kernel bound device (not QAT device) where vfdevID is not equal to qatDevId (37c9)",
dpdkDriver: "igb_uio",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/igb_uio",
"sys/bus/pci/devices/0000:02:01.0/uio/sometestfile",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("some junk"),
"sys/bus/pci/drivers/igb_uio/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 0,
},
{
name: "vfio-pci DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9)",
dpdkDriver: "vfio-pci",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/vfio-pci",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/vfio-pci/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/devices/0000:02:01.0/iommu_group": "sys/kernel/iommu_groups/vfiotestfile",
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 1,
},
{
name: "vfio-pci DPDKdriver with no kernel bound driver and where vfdevID is equal to qatDevId (37c9)",
dpdkDriver: "vfio-pci",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/vfio-pci",
"sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:01.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/vfio-pci/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/devices/0000:02:01.0/iommu_group": "sys/kernel/iommu_groups/vfiotestfile",
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 1,
},
{
name: "vfio-pci DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId not enabbled in kernelVfDrivers",
dpdkDriver: "vfio-pci",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/drivers/vfio-pci",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x6f55"),
"sys/bus/pci/drivers/vfio-pci/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/devices/0000:02:01.0/iommu_group": "sys/kernel/iommu_groups/vfiotestfile",
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 0,
},
{
name: "vfio-pci DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9) but symlink is broken",
dpdkDriver: "vfio-pci",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/vfio-pci",
"sys/bus/pci/drivers/c6xx",
"sys/bus/pci/devices/0000:02:01.0/driver",
"sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:01.0/vfio-pci/vfiotestfile",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/vfio-pci/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/drivers/c6xx/0000:02:00.0": "sys/bus/pci/devices/0000:02:00.0",
"sys/bus/pci/devices/0000:02:00.0/virtfn0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedErr: true,
},
{
name: "vfio-pci DPDKdriver with one kernel bound device (QAT device) where vfdevID is equal to qatDevId (37c9), running in a VM",
dpdkDriver: "vfio-pci",
kernelVfDrivers: []string{"c6xxvf"},
dirs: []string{
"sys/bus/pci/drivers/c6xxvf",
"sys/bus/pci/drivers/vfio-pci",
"sys/bus/pci/devices/0000:02:01.0/driver",
},
files: map[string][]byte{
"sys/bus/pci/devices/0000:02:01.0/driver/unbind": []byte("some junk"),
"sys/bus/pci/devices/0000:02:01.0/device": []byte("0x37c9"),
"sys/bus/pci/drivers/vfio-pci/new_id": []byte("some junk"),
},
symlinks: map[string]string{
"sys/bus/pci/devices/0000:02:01.0/iommu_group": "sys/kernel/iommu_groups/vfiotestfile",
"sys/bus/pci/drivers/c6xxvf/0000:02:01.0": "sys/bus/pci/devices/0000:02:01.0",
},
maxDevNum: 1,
expectedDevNum: 1,
},
}
for _, tt := range tcases {
t.Run(tt.name, func(t *testing.T) {
tmpdir, err := os.MkdirTemp("/tmp/", "qatplugin-TestScanPrivate-*")
if err != nil {
t.Fatal(err)
}
if err = createTestFiles(tmpdir, tt.dirs, tt.files, tt.symlinks); err != nil {
t.Fatalf("%+v", err)
}
dp := &DevicePlugin{
maxDevices: tt.maxDevNum,
pciDriverDir: path.Join(tmpdir, "sys/bus/pci/drivers"),
pciDeviceDir: path.Join(tmpdir, "sys/bus/pci/devices"),
dpdkDriver: tt.dpdkDriver,
kernelVfDrivers: tt.kernelVfDrivers,
}
tree, err := dp.scan()
if tt.expectedErr && err == nil {
t.Errorf("expected error, but got success")
}
if !tt.expectedErr && err != nil {
t.Errorf("got unexpected error: %+v", err)
}
if len(tree) != tt.expectedDevNum {
t.Errorf("expected %d, but got %d devices", tt.expectedDevNum, len(tree))
}
if err = os.RemoveAll(tmpdir); err != nil {
t.Fatal(err)
}
})
}
}
func eleInSlice(a string, list []string) bool {
for _, b := range list {
if b == a {
return true
}
}
return false
}
func TestPostAllocate(t *testing.T) {
response := new(pluginapi.AllocateResponse)
cresp := new(pluginapi.ContainerAllocateResponse)
response.ContainerResponses = append(response.ContainerResponses, cresp)
testMap := map[string]string{
"QAT29": "03:04.1",
"QAT13": "03:04.2",
"QAT6": "03:04.3",
"QAT21": "03:04.4",
}
response.ContainerResponses[0].Envs = testMap
resultKey := []string{
"QAT0",
"QAT1",
"QAT2",
"QAT3",
}
expectedValues := map[string]struct{}{
"03:04.1": {},
"03:04.2": {},
"03:04.3": {},
"03:04.4": {},
}
dp := &DevicePlugin{}
if err := dp.PostAllocate(response); err != nil {
t.Errorf("Unexpected error: %+v", err)
}
if len(response.ContainerResponses[0].Envs) != 4 {
t.Fatal("Set wrong number of Environment Variables")
}
for k := range response.ContainerResponses[0].Envs {
if !eleInSlice(k, resultKey) {
t.Fatalf("Set wrong key: %s. The key should be in the range %v", k, resultKey)
}
}
for _, key := range resultKey {
if value, ok := response.ContainerResponses[0].Envs[key]; ok {
if _, ok := expectedValues[value]; ok {
delete(expectedValues, value)
} else {
t.Errorf("Unexpected value %s", value)
}
}
}
}