Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add csi-sanity tests #2254

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ issues:
- path: tests/e2e
linters:
- gosec
- path: tests/sanity
linters:
- gosec
linters-settings:
revive:
rules:
Expand Down
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ cluster/uninstall: bin/helm bin/aws
## E2E targets
# Targets to run e2e tests

.PHONY: sanity
sanity:
go test -v -race ./tests/sanity/...

.PHONY: e2e/single-az
e2e/single-az: bin/helm bin/ginkgo
AWS_AVAILABILITY_ZONES=us-west-2a \
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ require (
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/klauspost/compress v1.17.11 // indirect
github.com/kubernetes-csi/csi-test/v5 v5.3.1
github.com/kylelemons/godebug v1.1.0 // indirect
github.com/mailru/easyjson v0.9.0 // indirect
github.com/moby/spdystream v0.5.0 // indirect
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ github.com/kubernetes-csi/csi-proxy/client v1.1.3 h1:FdGU7NtxGhQX2wTfnuscmThG920
github.com/kubernetes-csi/csi-proxy/client v1.1.3/go.mod h1:SfK4HVKQdMH5KrffivddAWgX5hl3P5KmnuOTBbDNboU=
github.com/kubernetes-csi/csi-proxy/v2 v2.0.0-alpha.1 h1:tVPvlL5N5X598hrO3g9rhyoi6h0LP4RpSJlGHItsbEE=
github.com/kubernetes-csi/csi-proxy/v2 v2.0.0-alpha.1/go.mod h1:pacx+PW7lLlu6kAvpr8Lgq/5fdiAsKxOtXXFHMaLMb8=
github.com/kubernetes-csi/csi-test/v5 v5.3.1 h1:Wiukp1In+kif+BFo6q2ExjgB+MbrAz4jZWzGfijypuY=
github.com/kubernetes-csi/csi-test/v5 v5.3.1/go.mod h1:7hA2cSYJ6T8CraEZPA6zqkLZwemjBD54XAnPsPC3VpA=
github.com/kubernetes-csi/external-snapshotter/client/v4 v4.2.0 h1:nHHjmvjitIiyPlUHk/ofpgvBcNcawJLtf4PYHORLjAA=
github.com/kubernetes-csi/external-snapshotter/client/v4 v4.2.0/go.mod h1:YBCo4DoEeDndqvAn6eeu0vWM7QdXmHEeI9cFWplmBys=
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
Expand Down
2 changes: 2 additions & 0 deletions pkg/driver/controller_modify_volume.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ func executeModifyVolumeRequest(c cloud.Cloud) func(string, modifyVolumeRequest)
if err != nil {
if errors.Is(err, cloud.ErrInvalidArgument) {
return 0, status.Errorf(codes.InvalidArgument, "Could not modify volume (invalid argument) %q: %v", volumeID, err)
} else if errors.Is(err, cloud.ErrNotFound) {
return 0, status.Errorf(codes.NotFound, "Could not modify volume (not found) %q: %v", volumeID, err)
}
return 0, status.Errorf(codes.Internal, "Could not modify volume %q: %v", volumeID, err)
} else {
Expand Down
7 changes: 3 additions & 4 deletions pkg/driver/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ func (d *NodeService) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol

source, err := d.mounter.FindDevicePath(devicePath, volumeID, partition, d.metadata.GetRegion())
if err != nil {
return nil, status.Errorf(codes.Internal, "Failed to find device path %s. %v", devicePath, err)
return nil, status.Errorf(codes.NotFound, "Failed to find device path %s. %v", devicePath, err)
}

klog.V(4).InfoS("NodeStageVolume: find device path", "devicePath", devicePath, "source", source)
Expand Down Expand Up @@ -387,15 +387,14 @@ func (d *NodeService) NodeExpandVolume(ctx context.Context, req *csi.NodeExpandV
return &csi.NodeExpandVolumeResponse{CapacityBytes: bcap}, nil
}
}

deviceName, _, err := d.mounter.GetDeviceNameFromMount(volumePath)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to get device name from mount %s: %v", volumePath, err)
}

devicePath, err := d.mounter.FindDevicePath(deviceName, volumeID, "", d.metadata.GetRegion())
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to find device path for device name %s for mount %s: %v", deviceName, req.GetVolumePath(), err)
return nil, status.Errorf(codes.NotFound, "failed to find device path for device name %s for mount %s: %v", deviceName, req.GetVolumePath(), err)
}

// TODO: lock per volume ID to have some idempotency
Expand Down Expand Up @@ -626,7 +625,7 @@ func (d *NodeService) nodePublishVolumeForBlock(req *csi.NodePublishVolumeReques

source, err := d.mounter.FindDevicePath(devicePath, volumeID, partition, d.metadata.GetRegion())
if err != nil {
return status.Errorf(codes.Internal, "Failed to find device path %s. %v", devicePath, err)
return status.Errorf(codes.NotFound, "Failed to find device path %s. %v", devicePath, err)
}

klog.V(4).InfoS("NodePublishVolume [block]: find device path", "devicePath", devicePath, "source", source)
Expand Down
6 changes: 3 additions & 3 deletions pkg/driver/node_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ func TestNodeStageVolume(t *testing.T) {
m.EXPECT().GetRegion().Return("us-west-2")
return m
},
expectedErr: status.Errorf(codes.Internal, "Failed to find device path %s. %v", "/dev/xvdba", errors.New("find device path error")),
expectedErr: status.Errorf(codes.NotFound, "Failed to find device path %s. %v", "/dev/xvdba", errors.New("find device path error")),
},
{
name: "path_exists_error",
Expand Down Expand Up @@ -1743,7 +1743,7 @@ func TestNodePublishVolume(t *testing.T) {
m.EXPECT().GetRegion().Return("us-west-2")
return m
},
expectedErr: status.Error(codes.Internal, "Failed to find device path /dev/xvdba. device path error"),
expectedErr: status.Error(codes.NotFound, "Failed to find device path /dev/xvdba. device path error"),
},
}
for _, tc := range testCases {
Expand Down Expand Up @@ -2271,7 +2271,7 @@ func TestNodeExpandVolume(t *testing.T) {
return m
},
expectedResp: nil,
expectedErr: status.Error(codes.Internal, "failed to find device path for device name device-name for mount /volume/path: failed to find device path"),
expectedErr: status.Error(codes.NotFound, "failed to find device path for device name device-name for mount /volume/path: failed to find device path"),
},
{
name: "resize_error",
Expand Down
219 changes: 219 additions & 0 deletions tests/sanity/fake_sanity_cloud.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
// Copyright 2024 The Kubernetes Authors.
//
// 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 sanity

import (
"context"
"fmt"
"math/rand"
"strconv"
"time"

"github.com/aws/aws-sdk-go-v2/service/ec2"
"github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/cloud"
"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/cloud/metadata"
"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/util"
)

var (
disks = make(map[string]*cloud.Disk)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

np: Can make these members of FakeCloud, instead of package level fields.

snapshots = make(map[string]*cloud.Snapshot)
snapshotNameToID = make(map[string]string)
)

type FakeCloud struct {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

np: can make this package-internal fakeCloud if we're not going to be using it outside of this package.

fakeMetadata metadata.Metadata
mountPath string
}

func newFakeCloud(fmd metadata.Metadata, mp string) *FakeCloud {
return &FakeCloud{
fakeMetadata: fmd,
mountPath: mp,
}
}

func (d *FakeCloud) CreateDisk(ctx context.Context, volumeID string, diskOptions *cloud.DiskOptions) (*cloud.Disk, error) {
for _, existingDisk := range disks {
if existingDisk.VolumeID == volumeID && existingDisk.CapacityGiB != util.BytesToGiB(diskOptions.CapacityBytes) {
return nil, cloud.ErrAlreadyExists
}
}

if diskOptions.SnapshotID != "" {
if _, exists := snapshots[diskOptions.SnapshotID]; !exists {
return nil, cloud.ErrNotFound
}
newDisk := &cloud.Disk{
SnapshotID: diskOptions.SnapshotID,
VolumeID: volumeID,
AvailabilityZone: diskOptions.AvailabilityZone,
CapacityGiB: util.BytesToGiB(diskOptions.CapacityBytes),
}
disks[volumeID] = newDisk
return newDisk, nil
}

newDisk := &cloud.Disk{
VolumeID: volumeID,
AvailabilityZone: diskOptions.AvailabilityZone,
CapacityGiB: util.BytesToGiB(diskOptions.CapacityBytes),
}
disks[volumeID] = newDisk
return newDisk, nil
}
func (d *FakeCloud) DeleteDisk(ctx context.Context, volumeID string) (bool, error) {
_, exists := disks[volumeID]
if !exists {
return false, cloud.ErrNotFound
}
delete(disks, volumeID)
return true, nil
}

func (d *FakeCloud) GetDiskByID(ctx context.Context, volumeID string) (*cloud.Disk, error) {
disk, exists := disks[volumeID]
if !exists {
return nil, cloud.ErrNotFound
}
return disk, nil
}

func (d *FakeCloud) CreateSnapshot(ctx context.Context, volumeID string, opts *cloud.SnapshotOptions) (*cloud.Snapshot, error) {
snapshotID := fmt.Sprintf("snapshot-%d", rand.New(rand.NewSource(time.Now().UnixNano())).Uint64())

_, exists := snapshots[snapshotID]
if exists {
return nil, cloud.ErrAlreadyExists
}
newSnapshot := &cloud.Snapshot{
SnapshotID: snapshotID,
SourceVolumeID: volumeID,
CreationTime: time.Now(),
ReadyToUse: true,
}
snapshots[snapshotID] = newSnapshot
snapshotNameToID[opts.Tags["CSIVolumeSnapshotName"]] = snapshotID
return newSnapshot, nil
}

func (d *FakeCloud) DeleteSnapshot(ctx context.Context, snapshotID string) (bool, error) {
if _, exists := snapshots[snapshotID]; !exists {
return false, cloud.ErrNotFound
}
for name, id := range snapshotNameToID {
if id == snapshotID {
delete(snapshotNameToID, name)
break
}
}
delete(snapshots, snapshotID)
return true, nil
}
func (d *FakeCloud) GetSnapshotByID(ctx context.Context, snapshotID string) (*cloud.Snapshot, error) {
snapshot, exists := snapshots[snapshotID]
if !exists {
return nil, cloud.ErrNotFound
}
return snapshot, nil
}

func (d *FakeCloud) GetSnapshotByName(ctx context.Context, name string) (*cloud.Snapshot, error) {
if snapshotID, exists := snapshotNameToID[name]; exists {
return snapshots[snapshotID], nil
}
return nil, cloud.ErrNotFound
}

func (d *FakeCloud) ListSnapshots(ctx context.Context, sourceVolumeID string, maxResults int32, nextToken string) (*cloud.ListSnapshotsResponse, error) {
var s []*cloud.Snapshot
startIndex := 0
var err error

if nextToken != "" {
startIndex, err = strconv.Atoi(nextToken)
if err != nil {
return nil, fmt.Errorf("invalid next token %s", nextToken)
}
}
var nextTokenStr string
count := 0
for _, snap := range snapshots {
if snap.SourceVolumeID == sourceVolumeID || sourceVolumeID == "" {
if startIndex <= count {
s = append(s, snap)
if maxResults > 0 && int32(len(s)) >= maxResults {
nextTokenStr = strconv.Itoa(startIndex + int(maxResults))
break
}
}
count++
}
}

return &cloud.ListSnapshotsResponse{
Snapshots: s,
NextToken: nextTokenStr,
}, nil
}

func (d *FakeCloud) AttachDisk(ctx context.Context, volumeID string, instanceID string) (string, error) {
_, diskExists := disks[volumeID]
if !diskExists || instanceID != d.fakeMetadata.InstanceID {
return "", cloud.ErrNotFound
}
return d.mountPath, nil
}

func (d *FakeCloud) DetachDisk(ctx context.Context, volumeID string, instanceID string) error {
_, diskExists := disks[volumeID]
if !diskExists || instanceID != d.fakeMetadata.InstanceID {
return cloud.ErrNotFound
}
return nil
}

func (d *FakeCloud) ResizeOrModifyDisk(ctx context.Context, volumeID string, newSizeBytes int64, modifyOptions *cloud.ModifyDiskOptions) (int32, error) {
disk, exists := disks[volumeID]
if !exists {
return 0, cloud.ErrNotFound
}
newSizeGiB := util.BytesToGiB(newSizeBytes)
disk.CapacityGiB = newSizeGiB
disks[volumeID] = disk
realSizeGiB := newSizeGiB
return realSizeGiB, nil
}

func (d *FakeCloud) AvailabilityZones(ctx context.Context) (map[string]struct{}, error) {
return map[string]struct{}{}, nil
}

func (d *FakeCloud) EnableFastSnapshotRestores(ctx context.Context, availabilityZones []string, snapshotID string) (*ec2.EnableFastSnapshotRestoresOutput, error) {
return &ec2.EnableFastSnapshotRestoresOutput{}, nil
}

func (d *FakeCloud) GetDiskByName(ctx context.Context, name string, capacityBytes int64) (*cloud.Disk, error) {
return &cloud.Disk{}, nil
}

func (d *FakeCloud) ModifyTags(ctx context.Context, volumeID string, tagOptions cloud.ModifyTagsOptions) error {
return nil
}

func (d *FakeCloud) WaitForAttachmentState(ctx context.Context, volumeID, expectedState, expectedInstance, expectedDevice string, alreadyAssigned bool) (*types.VolumeAttachment, error) {
return &types.VolumeAttachment{}, nil
}
Loading
Loading