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.

Sign up for GitHub

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

feat(vm): add hotplug images to VirtualMachine status #681

Merged
merged 2 commits into from
Feb 11, 2025
Merged

feat(vm): add hotplug images to VirtualMachine status #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e90f8
feat(vm): add hotplug images to `VirtualMachine` status
Jan 30, 2025
d4ce9cd
Merge branch 'main' into feat/vm/add-hotplug-images-to-status
hardcoretime Feb 11, 2025
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
55 changes: 46 additions & 9 deletions images/virtualization-artifact/pkg/controller/vm/internal/block_device.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,18 +287,55 @@ func (h *BlockDeviceHandler) getBlockDeviceStatusRefsFromVMBDA(ctx context.Conte
continue
}

var vd *virtv2.VirtualDisk
vd, err = s.VirtualDisk(ctx, vmbda.Spec.BlockDeviceRef.Name)
if err != nil {
return nil, err
}
var (
cvi *virtv2.ClusterVirtualImage
vi *virtv2.VirtualImage
vd *virtv2.VirtualDisk
bdStatusRef virtv2.BlockDeviceStatusRef
)

switch vmbda.Spec.BlockDeviceRef.Kind {
case virtv2.VMBDAObjectRefKindVirtualDisk:
vd, err = s.VirtualDisk(ctx, vmbda.Spec.BlockDeviceRef.Name)
if err != nil {
return nil, err
}

if vd == nil {
continue
if vd == nil {
continue
}

bdStatusRef = h.getDiskStatusRef(virtv2.DiskDevice, vmbda.Spec.BlockDeviceRef.Name)
bdStatusRef.Size = vd.Status.Capacity
case virtv2.VMBDAObjectRefKindVirtualImage:
vi, err = s.VirtualImage(ctx, vmbda.Spec.BlockDeviceRef.Name)
if err != nil {
return nil, err
}

if vi == nil {
continue
}

bdStatusRef = h.getDiskStatusRef(virtv2.ImageDevice, vmbda.Spec.BlockDeviceRef.Name)
bdStatusRef.Size = vi.Status.Size.Unpacked

case virtv2.VMBDAObjectRefKindClusterVirtualImage:
cvi, err = s.ClusterVirtualImage(ctx, vmbda.Spec.BlockDeviceRef.Name)
if err != nil {
return nil, err
}

if cvi == nil {
continue
}

bdStatusRef = h.getDiskStatusRef(virtv2.ClusterImageDevice, vmbda.Spec.BlockDeviceRef.Name)
bdStatusRef.Size = cvi.Status.Size.Unpacked
default:
return nil, fmt.Errorf("unacceptable `Kind` of `BlockDeviceRef`: %s", vmbda.Spec.BlockDeviceRef.Kind)
}

bdStatusRef := h.getDiskStatusRef(virtv2.DiskDevice, vmbda.Spec.BlockDeviceRef.Name)
bdStatusRef.Size = vd.Status.Capacity
bdStatusRef.Hotplugged = true
bdStatusRef.VirtualMachineBlockDeviceAttachmentName = vmbda.Name

Expand Down
187 changes: 177 additions & 10 deletions images/virtualization-artifact/pkg/controller/vm/internal/block_devices_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package internal

import (
"context"
"fmt"
"log/slog"
"testing"

Expand Down Expand Up @@ -343,6 +344,20 @@ var _ = Describe("BlockDeviceHandler", func() {
})

var _ = Describe("BlockDeviceHandler Handle", func() {
var (
ctx context.Context
recorderMock *eventrecord.EventRecorderLoggerMock
)

BeforeEach(func() {
ctx = logger.ToContext(context.TODO(), slog.Default())

recorderMock = &eventrecord.EventRecorderLoggerMock{
EventFunc: func(_ client.Object, _, _, _ string) {},
EventfFunc: func(_ client.Object, _, _, _ string, _ ...interface{}) {},
}
})

Context("Handle call result based on the number of connected block devices", func() {
okBlockDeviceServiceMock := &BlockDeviceServiceMock{
CountBlockDevicesAttachedToVmFunc: func(_ context.Context, _ *virtv2.VirtualMachine) (int, error) {
Expand All @@ -355,23 +370,14 @@ var _ = Describe("BlockDeviceHandler Handle", func() {
},
}

ctx := logger.ToContext(context.TODO(), slog.Default())

recorderMock := &eventrecord.EventRecorderLoggerMock{
EventFunc: func(_ client.Object, _, _, _ string) {},
EventfFunc: func(_ client.Object, _, _, _ string, _ ...interface{}) {},
}

scheme := apiruntime.NewScheme()
for _, f := range []func(*apiruntime.Scheme) error{
virtv2.AddToScheme,
virtv1.AddToScheme,
corev1.AddToScheme,
} {
err := f(scheme)
if err != nil {
Fail(err.Error())
}
Expect(err).NotTo(HaveOccurred(), "failed to add scheme: %s", err)
}

namespacedName := types.NamespacedName{
Expand Down Expand Up @@ -423,6 +429,167 @@ var _ = Describe("BlockDeviceHandler Handle", func() {
Expect(readyCondition.Reason).To(Equal(vmcondition.ReasonBlockDeviceLimitExceeded.String()))
})
})

Context("When images are hotplugged into a VirtualMachine", func() {
It("checks that `VirtualMachine.Status.BlockDeviceRefs` contains the hotplugged images", func() {
blockDeviceServiceMock := &BlockDeviceServiceMock{
CountBlockDevicesAttachedToVmFunc: func(_ context.Context, _ *virtv2.VirtualMachine) (int, error) {
return 2, nil
},
}

scheme := apiruntime.NewScheme()
for _, f := range []func(*apiruntime.Scheme) error{
virtv2.AddToScheme,
virtv1.AddToScheme,
} {
err := f(scheme)
Expect(err).NotTo(HaveOccurred(), "failed to add scheme: %s", err)
}

namespacedVirtualMachine := types.NamespacedName{
Namespace: "hotplugged",
Name: "vm-with-hotplugged-images",
}

namespacedVirtualImage := types.NamespacedName{
Namespace: "hotplugged",
Name: "vi-hotplug",
}

namespacedClusterVirtualImage := types.NamespacedName{
Name: "cvi-hotplug",
}

vi := &virtv2.VirtualImage{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedVirtualImage.Name,
Namespace: namespacedVirtualImage.Namespace,
},
Spec: virtv2.VirtualImageSpec{},
Status: virtv2.VirtualImageStatus{
Phase: virtv2.ImageReady,
Size: virtv2.ImageStatusSize{
Unpacked: "200Mi",
},
},
}

cvi := &virtv2.ClusterVirtualImage{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedClusterVirtualImage.Name,
},
Spec: virtv2.ClusterVirtualImageSpec{},
Status: virtv2.ClusterVirtualImageStatus{
Phase: virtv2.ImageReady,
Size: virtv2.ImageStatusSize{
Unpacked: "200Mi",
},
},
}

vm := &virtv2.VirtualMachine{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedVirtualMachine.Name,
Namespace: namespacedVirtualMachine.Namespace,
},
Spec: virtv2.VirtualMachineSpec{},
Status: virtv2.VirtualMachineStatus{
Conditions: []metav1.Condition{
{
Status: metav1.ConditionUnknown,
Type: vmcondition.TypeBlockDevicesReady.String(),
Reason: conditions.ReasonUnknown.String(),
Message: "",
},
},
},
}

cviTarget := "sdb"
viTarget := "sdc"
kvvmi := &virtv1.VirtualMachineInstance{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedVirtualMachine.Name,
Namespace: namespacedVirtualMachine.Namespace,
},
Status: virtv1.VirtualMachineInstanceStatus{
VolumeStatus: []virtv1.VolumeStatus{
{
Name: fmt.Sprintf("cvi-%s", namespacedClusterVirtualImage.Name),
Target: cviTarget,
Phase: virtv1.VolumeReady,
},
{
Name: fmt.Sprintf("vi-%s", namespacedVirtualImage.Name),
Target: viTarget,
Phase: virtv1.VolumeReady,
},
},
},
}

vmbdaVi := &virtv2.VirtualMachineBlockDeviceAttachment{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedVirtualImage.Name,
Namespace: namespacedVirtualImage.Namespace,
},
Spec: virtv2.VirtualMachineBlockDeviceAttachmentSpec{
VirtualMachineName: namespacedVirtualMachine.Name,
BlockDeviceRef: virtv2.VMBDAObjectRef{
Kind: virtv2.VMBDAObjectRefKindVirtualImage,
Name: namespacedVirtualImage.Name,
},
},
Status: virtv2.VirtualMachineBlockDeviceAttachmentStatus{
Phase: virtv2.BlockDeviceAttachmentPhaseAttached,
},
}

vmbdaCvi := &virtv2.VirtualMachineBlockDeviceAttachment{
ObjectMeta: metav1.ObjectMeta{
Name: namespacedClusterVirtualImage.Name,
Namespace: namespacedVirtualMachine.Namespace,
},
Spec: virtv2.VirtualMachineBlockDeviceAttachmentSpec{
VirtualMachineName: namespacedVirtualMachine.Name,
BlockDeviceRef: virtv2.VMBDAObjectRef{
Kind: virtv2.VMBDAObjectRefKindClusterVirtualImage,
Name: namespacedClusterVirtualImage.Name,
},
},
Status: virtv2.VirtualMachineBlockDeviceAttachmentStatus{
Phase: virtv2.BlockDeviceAttachmentPhaseAttached,
},
}

fakeClient := fake.NewClientBuilder().WithScheme(scheme).WithObjects(vm, kvvmi, vi, cvi, vmbdaVi, vmbdaCvi).Build()
vmResource := service.NewResource(namespacedVirtualMachine, fakeClient, vmFactoryByVm(vm), vmStatusGetter)
_ = vmResource.Fetch(ctx)
vmState := state.New(fakeClient, vmResource)

handler := NewBlockDeviceHandler(fakeClient, recorderMock, blockDeviceServiceMock)
_, err := handler.Handle(ctx, vmState)
Expect(err).NotTo(HaveOccurred(), "failed to handle VirtualMachineState: %s", err)
vm = vmState.VirtualMachine().Changed()
for _, bd := range vm.Status.BlockDeviceRefs {
Expect(bd.Attached).To(BeTrue(), "`attached` field should be `true`")
Expect(bd.Hotplugged).To(BeTrue(), "`hotplugged` field should be `true`")
switch bd.Kind {
case virtv2.ClusterVirtualImageKind:
Expect(bd.Name).To(Equal(namespacedClusterVirtualImage.Name), "`Name` should be %q", namespacedClusterVirtualImage.Name)
Expect(bd.VirtualMachineBlockDeviceAttachmentName).To(Equal(namespacedClusterVirtualImage.Name), "`VirtualMachineBlockDeviceAttachmentName` should be %q", namespacedClusterVirtualImage.Name)
Expect(bd.Size).To(Equal(cvi.Status.Size.Unpacked), "unpacked size of image should be %s", cvi.Status.Size.Unpacked)
Expect(bd.Target).To(Equal(cviTarget), "`target` field should be %s", cviTarget)
case virtv2.VirtualImageKind:
Expect(bd.Name).To(Equal(namespacedVirtualImage.Name), "`Name` should be %q", namespacedVirtualImage.Name)
Expect(bd.VirtualMachineBlockDeviceAttachmentName).To(Equal(namespacedVirtualImage.Name), "`VirtualMachineBlockDeviceAttachmentName` should be %q", namespacedVirtualImage.Name)
Expect(bd.Size).To(Equal(vi.Status.Size.Unpacked), "unpacked size of image should be %s", vi.Status.Size.Unpacked)
Expect(bd.Target).To(Equal(viTarget), "`target` field should be %s", viTarget)
}
}
})
})
})

func vmFactoryByVm(vm *virtv2.VirtualMachine) func() *virtv2.VirtualMachine {
Expand Down
15 changes: 15 additions & 0 deletions images/virtualization-artifact/pkg/controller/vm/internal/state/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ type VirtualMachineState interface {
Pod(ctx context.Context) (*corev1.Pod, error)
VMBDAList(ctx context.Context) ([]virtv2.VirtualMachineBlockDeviceAttachment, error)
VirtualDisk(ctx context.Context, name string) (*virtv2.VirtualDisk, error)
VirtualImage(ctx context.Context, name string) (*virtv2.VirtualImage, error)
ClusterVirtualImage(ctx context.Context, name string) (*virtv2.ClusterVirtualImage, error)
VirtualDisksByName(ctx context.Context) (map[string]*virtv2.VirtualDisk, error)
VirtualImagesByName(ctx context.Context) (map[string]*virtv2.VirtualImage, error)
ClusterVirtualImagesByName(ctx context.Context) (map[string]*virtv2.ClusterVirtualImage, error)
Expand Down Expand Up @@ -193,6 +195,19 @@ func (s *state) VirtualDisk(ctx context.Context, name string) (*virtv2.VirtualDi
}, s.client, &virtv2.VirtualDisk{})
}

func (s *state) VirtualImage(ctx context.Context, name string) (*virtv2.VirtualImage, error) {
return object.FetchObject(ctx, types.NamespacedName{
Name: name,
Namespace: s.vm.Current().GetNamespace(),
}, s.client, &virtv2.VirtualImage{})
}

func (s *state) ClusterVirtualImage(ctx context.Context, name string) (*virtv2.ClusterVirtualImage, error) {
return object.FetchObject(ctx, types.NamespacedName{
Name: name,
}, s.client, &virtv2.ClusterVirtualImage{})
}

func (s *state) VirtualDisksByName(ctx context.Context) (map[string]*virtv2.VirtualDisk, error) {
if s.vm == nil {
return nil, nil
Expand Down
Loading