Skip to content

🌱 Revert v1a3 vm.status.storage.usage to 9.x #930

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🌱 Revert v1a3 vm.status.storage.usage to 9.x #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions api/v1alpha3/conversion_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,3 +280,7 @@ func overrideVirtualMachineImageFieldsFuncs(codecs runtimeserializer.CodecFactor
},
}
}

func ptrOf[T any](v T) *T {
return &v
}
28 changes: 26 additions & 2 deletions api/v1alpha3/virtualmachine_conversion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,43 @@ package v1alpha3
import (
ctrlconversion "sigs.k8s.io/controller-runtime/pkg/conversion"

"github.com/vmware-tanzu/vm-operator/api/utilconversion"
vmopv1 "github.com/vmware-tanzu/vm-operator/api/v1alpha4"
)

// ConvertTo converts this VirtualMachine to the Hub version.
func (src *VirtualMachine) ConvertTo(dstRaw ctrlconversion.Hub) error {
dst := dstRaw.(*vmopv1.VirtualMachine)
return Convert_v1alpha3_VirtualMachine_To_v1alpha4_VirtualMachine(src, dst, nil)
if err := Convert_v1alpha3_VirtualMachine_To_v1alpha4_VirtualMachine(src, dst, nil); err != nil {
return err
}

// Manually restore data.
restored := &vmopv1.VirtualMachine{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}

// BEGIN RESTORE

// TODO(akutz) This is where any future restoration of spec data will go.

// END RESTORE

dst.Status = restored.Status

return nil
}

// ConvertFrom converts the hub version to this VirtualMachine.
func (dst *VirtualMachine) ConvertFrom(srcRaw ctrlconversion.Hub) error {
src := srcRaw.(*vmopv1.VirtualMachine)
return Convert_v1alpha4_VirtualMachine_To_v1alpha3_VirtualMachine(src, dst, nil)
if err := Convert_v1alpha4_VirtualMachine_To_v1alpha3_VirtualMachine(src, dst, nil); err != nil {
return err
}

// Preserve Hub data on down-conversion except for metadata
return utilconversion.MarshalData(src, dst)
}

// ConvertTo converts this VirtualMachineList to the Hub version.
Expand Down
324 changes: 324 additions & 0 deletions api/v1alpha3/virtualmachine_conversion_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
// © Broadcom. All Rights Reserved.
// The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
// SPDX-License-Identifier: Apache-2.0

package v1alpha3_test

import (
"testing"

. "github.com/onsi/gomega"

"github.com/google/go-cmp/cmp"
"github.com/google/uuid"
corev1 "k8s.io/api/core/v1"
apiequality "k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
ctrlconversion "sigs.k8s.io/controller-runtime/pkg/conversion"

vmopv1a3 "github.com/vmware-tanzu/vm-operator/api/v1alpha3"
vmopv1 "github.com/vmware-tanzu/vm-operator/api/v1alpha4"
vmopv1cloudinit "github.com/vmware-tanzu/vm-operator/api/v1alpha4/cloudinit"
vmopv1common "github.com/vmware-tanzu/vm-operator/api/v1alpha4/common"
vmopv1sysprep "github.com/vmware-tanzu/vm-operator/api/v1alpha4/sysprep"
)

func TestVirtualMachineConversion(t *testing.T) {

hubSpokeHub := func(g *WithT, hub, hubAfter ctrlconversion.Hub, spoke ctrlconversion.Convertible) {
hubBefore := hub.DeepCopyObject().(ctrlconversion.Hub)

// First convert hub to spoke
dstCopy := spoke.DeepCopyObject().(ctrlconversion.Convertible)
g.Expect(dstCopy.ConvertFrom(hubBefore)).To(Succeed())

// Convert spoke back to hub and check if the resulting hub is equal to the hub before the round trip
g.Expect(dstCopy.ConvertTo(hubAfter)).To(Succeed())

g.Expect(apiequality.Semantic.DeepEqual(hubBefore, hubAfter)).To(BeTrue(), cmp.Diff(hubBefore, hubAfter))
}

t.Run("VirtualMachine hub-spoke-hub", func(t *testing.T) {
g := NewWithT(t)

hub := vmopv1.VirtualMachine{
Spec: vmopv1.VirtualMachineSpec{
Image: &vmopv1.VirtualMachineImageRef{
Name: "my-name",
},
ImageName: "my-name",
ClassName: "my-class",
StorageClass: "my-storage-class",
Bootstrap: &vmopv1.VirtualMachineBootstrapSpec{
CloudInit: &vmopv1.VirtualMachineBootstrapCloudInitSpec{
CloudConfig: &vmopv1cloudinit.CloudConfig{
Timezone: "my-tz",
Users: []vmopv1cloudinit.User{
{
Name: "not-root",
},
},
},
RawCloudConfig: &vmopv1common.SecretKeySelector{
Name: "cloud-init-secret",
Key: "user-data",
},
SSHAuthorizedKeys: []string{"my-ssh-key"},
UseGlobalNameserversAsDefault: ptrOf(true),
UseGlobalSearchDomainsAsDefault: ptrOf(true),
},
LinuxPrep: &vmopv1.VirtualMachineBootstrapLinuxPrepSpec{
HardwareClockIsUTC: ptrOf(true),
TimeZone: "my-tz",
},
Sysprep: &vmopv1.VirtualMachineBootstrapSysprepSpec{
Sysprep: &vmopv1sysprep.Sysprep{
GUIRunOnce: &vmopv1sysprep.GUIRunOnce{
Commands: []string{"echo", "hello"},
},
GUIUnattended: &vmopv1sysprep.GUIUnattended{
AutoLogon: true,
},
Identification: &vmopv1sysprep.Identification{
DomainAdmin: "my-admin",
},
UserData: vmopv1sysprep.UserData{
FullName: "vmware",
},
},
},
VAppConfig: &vmopv1.VirtualMachineBootstrapVAppConfigSpec{
Properties: []vmopv1common.KeyValueOrSecretKeySelectorPair{
{
Key: "my-key",
Value: vmopv1common.ValueOrSecretKeySelector{
Value: ptrOf("my-value"),
},
},
},
RawProperties: "my-secret",
},
},
Network: &vmopv1.VirtualMachineNetworkSpec{
DomainName: "my-domain.com",
HostName: "my-test-vm",
Disabled: true,
Nameservers: []string{"10.11.12.13", "9.9.9.9"},
SearchDomains: []string{"foo.local", "bar.local"},
Interfaces: []vmopv1.VirtualMachineNetworkInterfaceSpec{
{
Name: "vds-interface",
Network: &vmopv1common.PartialObjectRef{
TypeMeta: metav1.TypeMeta{
Kind: "Network",
APIVersion: "netoperator.vmware.com/v1alpha1",
},
Name: "primary",
},
GuestDeviceName: "eth10",
},
{
Name: "ncp-interface",
Network: &vmopv1common.PartialObjectRef{
TypeMeta: metav1.TypeMeta{
Kind: "VirtualNetwork",
APIVersion: "vmware.com/v1alpha1",
},
Name: "segment1",
},
GuestDeviceName: "eth20",
},
{
Name: "nsx-vpc-subnet-interface",
Network: &vmopv1common.PartialObjectRef{
TypeMeta: metav1.TypeMeta{
Kind: "Subnet",
APIVersion: "crd.nsx.vmware.com/v1alpha1",
},
Name: "segment-subnet",
},
GuestDeviceName: "eth30",
},
{
Name: "nsx-vpc-subnetset-interface",
Network: &vmopv1common.PartialObjectRef{
TypeMeta: metav1.TypeMeta{
Kind: "SubnetSet",
APIVersion: "crd.nsx.vmware.com/v1alpha1",
},
Name: "segment-subnetset",
},
},
{
Name: "my-interface",
Network: &vmopv1common.PartialObjectRef{
TypeMeta: metav1.TypeMeta{
Kind: "Network",
APIVersion: "netoperator.vmware.com/v1alpha1",
},
Name: "secondary",
},
GuestDeviceName: "eth40",
Addresses: []string{"1.1.1.11", "2.2.2.22"},
DHCP4: true,
DHCP6: true,
Gateway4: "1.1.1.1",
Gateway6: "2.2.2.2",
MTU: ptrOf[int64](9000),
Nameservers: []string{"9.9.9.9"},
Routes: []vmopv1.VirtualMachineNetworkRouteSpec{
{
To: "3.3.3.3",
Via: "1.1.1.111",
Metric: 42,
},
},
SearchDomains: []string{"vmware.com"},
},
},
},
PowerState: vmopv1.VirtualMachinePowerStateOff,
PowerOffMode: vmopv1.VirtualMachinePowerOpModeHard,
SuspendMode: vmopv1.VirtualMachinePowerOpModeTrySoft,
NextRestartTime: "tomorrow",
RestartMode: vmopv1.VirtualMachinePowerOpModeSoft,
Volumes: []vmopv1.VirtualMachineVolume{
{
Name: "my-volume",
VirtualMachineVolumeSource: vmopv1.VirtualMachineVolumeSource{
PersistentVolumeClaim: ptrOf(vmopv1.PersistentVolumeClaimVolumeSource{
PersistentVolumeClaimVolumeSource: corev1.PersistentVolumeClaimVolumeSource{
ClaimName: "my-claim",
},
}),
},
},
{
Name: "my-volume-2",
VirtualMachineVolumeSource: vmopv1.VirtualMachineVolumeSource{
PersistentVolumeClaim: ptrOf(vmopv1.PersistentVolumeClaimVolumeSource{
PersistentVolumeClaimVolumeSource: corev1.PersistentVolumeClaimVolumeSource{
ClaimName: "my-claim-2",
},
InstanceVolumeClaim: &vmopv1.InstanceVolumeClaimVolumeSource{
StorageClass: "instance-storage-class",
Size: resource.MustParse("2048k"),
},
}),
},
},
},
ReadinessProbe: &vmopv1.VirtualMachineReadinessProbeSpec{
TCPSocket: &vmopv1.TCPSocketAction{
Host: "some-host",
Port: intstr.FromString("https"),
},
GuestHeartbeat: &vmopv1.GuestHeartbeatAction{
ThresholdStatus: vmopv1.RedHeartbeatStatus,
},
GuestInfo: []vmopv1.GuestInfoAction{
{
Key: "guest-key",
Value: "guest-value",
},
},
TimeoutSeconds: 100,
PeriodSeconds: 200,
},
Advanced: &vmopv1.VirtualMachineAdvancedSpec{
BootDiskCapacity: ptrOf(resource.MustParse("1024k")),
DefaultVolumeProvisioningMode: vmopv1.VirtualMachineVolumeProvisioningModeThickEagerZero,
ChangeBlockTracking: ptrOf(true),
},
Reserved: &vmopv1.VirtualMachineReservedSpec{
ResourcePolicyName: "my-resource-policy",
},
MinHardwareVersion: 42,
InstanceUUID: uuid.NewString(),
BiosUUID: uuid.NewString(),
GuestID: "my-guest-id",
Cdrom: []vmopv1.VirtualMachineCdromSpec{
{
Name: "cdrom1",
Image: vmopv1.VirtualMachineImageRef{
Name: "my-cdrom-image",
Kind: "VirtualMachineImage",
},
AllowGuestControl: ptrOf(true),
Connected: ptrOf(true),
},
},
},
}

hubSpokeHub(g, &hub, &vmopv1.VirtualMachine{}, &vmopv1a3.VirtualMachine{})
})

t.Run("VirtualMachine status.storage", func(t *testing.T) {
t.Run("hub-spoke-hub", func(t *testing.T) {
g := NewWithT(t)
hub := vmopv1.VirtualMachine{
Status: vmopv1.VirtualMachineStatus{
Storage: &vmopv1.VirtualMachineStorageStatus{
Usage: &vmopv1.VirtualMachineStorageStatusUsage{
Total: ptrOf(resource.MustParse("20Gi")),
Disks: ptrOf(resource.MustParse("10Gi")),
Other: ptrOf(resource.MustParse("5Gi")),
},
},
},
}
hubSpokeHub(g, &hub, &vmopv1.VirtualMachine{}, &vmopv1a3.VirtualMachine{})
})

t.Run("hub-spoke", func(t *testing.T) {
g := NewWithT(t)
hub := vmopv1.VirtualMachine{
Status: vmopv1.VirtualMachineStatus{
Storage: &vmopv1.VirtualMachineStorageStatus{
Usage: &vmopv1.VirtualMachineStorageStatusUsage{
Total: ptrOf(resource.MustParse("20Gi")),
Disks: ptrOf(resource.MustParse("10Gi")),
Other: ptrOf(resource.MustParse("5Gi")),
},
},
},
}

var spoke vmopv1a3.VirtualMachine
g.Expect(spoke.ConvertFrom(&hub)).To(Succeed())
g.Expect(spoke.Status.Storage).ToNot(BeNil())
g.Expect(spoke.Status.Storage.Usage).ToNot(BeNil())
g.Expect(spoke.Status.Storage.Usage.Committed).To(BeNil())
g.Expect(spoke.Status.Storage.Usage.Uncommitted).To(BeNil())
g.Expect(spoke.Status.Storage.Usage.Unshared).To(Equal(ptrOf(resource.MustParse("20Gi"))))
})

t.Run("spoke-hub", func(t *testing.T) {
g := NewWithT(t)
spoke := vmopv1a3.VirtualMachine{
Status: vmopv1a3.VirtualMachineStatus{
Storage: &vmopv1a3.VirtualMachineStorageStatus{
Usage: &vmopv1a3.VirtualMachineStorageStatusUsage{
Committed: ptrOf(resource.MustParse("20Gi")),
Uncommitted: ptrOf(resource.MustParse("10Gi")),
Unshared: ptrOf(resource.MustParse("5Gi")),
},
},
},
}

var hub vmopv1.VirtualMachine

g.Expect(spoke.ConvertTo(&hub)).To(Succeed())
g.Expect(hub.Status.Storage).ToNot(BeNil())
g.Expect(hub.Status.Storage.Usage).ToNot(BeNil())
g.Expect(hub.Status.Storage.Usage.Total).To(Equal(ptrOf(resource.MustParse("5Gi"))))
g.Expect(hub.Status.Storage.Usage.Disks).To(BeNil())
g.Expect(hub.Status.Storage.Usage.Other).To(BeNil())
})
})

}
Loading