Skip to content

Commit

Permalink
[Tests]Remove usage of WithRunning as it is deprecated
Browse files Browse the repository at this point in the history
Use WithRunStrategy instead to create a running VM in the recommended way.

Signed-off-by: bmordeha <[email protected]>
  • Loading branch information
Barakmor1 committed Sep 29, 2024
1 parent ebe4027 commit e93d010
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 47 deletions.
4 changes: 0 additions & 4 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,6 @@ linters:

issues:
exclude-rules:
# We should steer users towards RunStrategy
- text: 'SA1019: libvmi.WithRunning'
linters:
- staticcheck
- text: 'SA1019: checks.SkipTestIfNoCPUManager'
linters:
- staticcheck
13 changes: 0 additions & 13 deletions pkg/libvmi/vm.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,6 @@ func NewVirtualMachine(vmi *v1.VirtualMachineInstance, opts ...VMOption) *v1.Vir
return vm
}

// Deprecated: WithRunning is deprecated.
// While the running field itself is not deprecated, it is discouraged;
// We try to steer users towards using RunStrategy which allow for greater variation of user states
// To keep this option functional, we nil out RunStrategy to avoid conflict
func WithRunning() VMOption {
return func(vm *v1.VirtualMachine) {
// RunStrategy and running are mutually exclusive, because they can be contradictory
// The API server will reject VirtualMachine resources that define both
vm.Spec.RunStrategy = nil
vm.Spec.Running = pointer.P(true)
}
}

func WithRunStrategy(strategy v1.VirtualMachineRunStrategy) VMOption {
return func(vm *v1.VirtualMachine) {
vm.Spec.RunStrategy = &strategy
Expand Down
2 changes: 1 addition & 1 deletion tests/compute/vmidefaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ var _ = SIGDescribe("VMIDefaults", func() {

It("[test_id:TODO]Should be applied to a device added by AutoattachInputDevice", func() {
By("Creating a VirtualMachine with AutoattachInputDevice enabled")
vm := libvmi.NewVirtualMachine(libvmifact.NewCirros(), libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(libvmifact.NewCirros(), libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm.Spec.Template.Spec.Domain.Devices.AutoattachInputDevice = pointer.P(true)
vm, err := virtClient.VirtualMachine(testsuite.GetTestNamespace(nil)).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down
4 changes: 2 additions & 2 deletions tests/hotplug/affinity.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ var _ = Describe("[sig-compute]VM Affinity", decorators.SigCompute, decorators.S
By("Creating a running VM")
vmi := libvmifact.NewAlpineWithTestTooling(libnet.WithMasqueradeNetworking(), libvmi.WithCPUCount(1, 2, 1))
vmi.Namespace = testsuite.GetTestNamespace(vmi)
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -156,7 +156,7 @@ var _ = Describe("[sig-compute]VM Affinity", decorators.SigCompute, decorators.S
By("Creating a running VM")
vmi := libvmifact.NewAlpineWithTestTooling(libnet.WithMasqueradeNetworking())
vmi.Namespace = testsuite.GetTestNamespace(vmi)
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down
6 changes: 3 additions & 3 deletions tests/hotplug/cpu.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ var _ = Describe("[sig-compute][Serial]CPU Hotplug", decorators.SigCompute, deco
Threads: 1,
MaxSockets: maxSockets,
}
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -239,7 +239,7 @@ var _ = Describe("[sig-compute][Serial]CPU Hotplug", decorators.SigCompute, deco
DedicatedCPUPlacement: true,
MaxSockets: maxSockets,
}
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -333,7 +333,7 @@ var _ = Describe("[sig-compute][Serial]CPU Hotplug", decorators.SigCompute, deco
return policy
}, 30*time.Second, time.Second).ShouldNot(BeNil())

vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down
6 changes: 3 additions & 3 deletions tests/hotplug/memory.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ var _ = Describe("[sig-compute][Serial]Memory Hotplug", decorators.SigCompute, d
}
}

vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
if maxSockets != 0 {
vm.Spec.Template.Spec.Domain.CPU.MaxSockets = maxSockets
}
Expand Down Expand Up @@ -238,7 +238,7 @@ var _ = Describe("[sig-compute][Serial]Memory Hotplug", decorators.SigCompute, d
vmi.Namespace = testsuite.GetTestNamespace(vmi)
vmi.Spec.Domain.Memory = &v1.Memory{}

vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
ExpectWithOffset(1, err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -368,7 +368,7 @@ var _ = Describe("[sig-compute][Serial]Memory Hotplug", decorators.SigCompute, d
vmi.Namespace = testsuite.GetTestNamespace(vmi)
vmi.Spec.Domain.Memory = &v1.Memory{Guest: &guest}

vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, k8smetav1.CreateOptions{})
ExpectWithOffset(1, err).ToNot(HaveOccurred())
Expand Down
2 changes: 1 addition & 1 deletion tests/hotplug/rolloutstrategy.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ var _ = Describe("[Serial][sig-compute]VM Rollout Strategy", decorators.SigCompu
Threads: 1,
MaxSockets: 2,
}
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm, err := virtClient.VirtualMachine(vm.Namespace).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).NotTo(HaveOccurred())
Eventually(func() error {
Expand Down
2 changes: 1 addition & 1 deletion tests/instancetype/instancetype.go
Original file line number Diff line number Diff line change
Expand Up @@ -686,7 +686,7 @@ var _ = Describe("[crit:medium][vendor:[email protected]][level:component][sig-c
Expect(err).ToNot(HaveOccurred())

By("Creating and starting the VM and expecting a failure")
newVM := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning(), libvmi.WithInstancetype(instancetype.Name))
newVM := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(virtv1.RunStrategyAlways), libvmi.WithInstancetype(instancetype.Name))
newVM, err = virtClient.VirtualMachine(testsuite.GetTestNamespace(vm)).Create(context.Background(), newVM, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())

Expand Down
2 changes: 1 addition & 1 deletion tests/monitoring/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ func basicVMLifecycle(virtClient kubecli.KubevirtClient) {

func createAndRunVM(virtClient kubecli.KubevirtClient) *v1.VirtualMachine {
vmi := libvmifact.NewFedora(libvmi.WithNamespace(testsuite.GetTestNamespace(nil)))
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm, err := virtClient.VirtualMachine(testsuite.GetTestNamespace(vm)).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())

Expand Down
4 changes: 2 additions & 2 deletions tests/network/hotplug_bridge.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ var _ = SIGDescribe("bridge nic-hotplug", func() {
libvmi.WithInterface(*v1.DefaultMasqueradeNetworkInterface()),
libvmi.WithNetwork(v1.DefaultPodNetwork()),
)
hotPluggedVM = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
hotPluggedVM = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
var err error
hotPluggedVM, err = kubevirt.Client().VirtualMachine(testsuite.GetTestNamespace(nil)).Create(context.Background(), hotPluggedVM, metav1.CreateOptions{})
Expect(err).NotTo(HaveOccurred())
Expand Down Expand Up @@ -258,7 +258,7 @@ var _ = SIGDescribe("bridge nic-hotunplug", func() {
libvmi.WithNetwork(libvmi.MultusNetwork(linuxBridgeNetworkName2, nadName)),
libvmi.WithInterface(libvmi.InterfaceDeviceWithBridgeBinding(linuxBridgeNetworkName1)),
libvmi.WithInterface(libvmi.InterfaceDeviceWithBridgeBinding(linuxBridgeNetworkName2)))
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))

var err error
vm, err = kubevirt.Client().VirtualMachine(testsuite.GetTestNamespace(nil)).Create(context.Background(), vm, metav1.CreateOptions{})
Expand Down
2 changes: 1 addition & 1 deletion tests/network/hotplug_sriov.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ var _ = SIGDescribe("[Serial] SRIOV nic-hotplug", Serial, decorators.SRIOV, func
libvmi.WithInterface(*v1.DefaultMasqueradeNetworkInterface()),
libvmi.WithNetwork(v1.DefaultPodNetwork()),
)
hotPluggedVM = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
hotPluggedVM = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
var err error
hotPluggedVM, err = kubevirt.Client().VirtualMachine(testsuite.GetTestNamespace(nil)).Create(context.Background(), hotPluggedVM, metav1.CreateOptions{})
Expect(err).NotTo(HaveOccurred())
Expand Down
4 changes: 2 additions & 2 deletions tests/performance/density.go
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ func createBatchRunningVMWithInstancetypeWithRateControl(virtClient kubecli.Kube
createBatchRunningVMWithRateControl(virtClient, vmCount, func() *kvv1.VirtualMachine {
return libvmi.NewVirtualMachine(
libvmifact.NewCirros(),
libvmi.WithRunning(),
libvmi.WithRunStrategy(kvv1.RunStrategyAlways),
libvmi.WithInstancetype(instancetypeName),
libvmi.WithPreference(preferenceName),
)
Expand All @@ -211,7 +211,7 @@ func createBatchRunningVMWithInstancetypeWithRateControl(virtClient kubecli.Kube

func createBatchRunningVMWithResourcesWithRateControl(virtClient kubecli.KubevirtClient, vmCount int) {
createBatchRunningVMWithRateControl(virtClient, vmCount, func() *kvv1.VirtualMachine {
return libvmi.NewVirtualMachine(createVMISpecWithResources(), libvmi.WithRunning())
return libvmi.NewVirtualMachine(createVMISpecWithResources(), libvmi.WithRunStrategy(kvv1.RunStrategyAlways))
})
}

Expand Down
8 changes: 4 additions & 4 deletions tests/storage/migration.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ var _ = SIGDescribe("[Serial]Volumes update with migration", Serial, func() {
libvmi.WithCloudInitNoCloud(libvmifact.WithDummyCloudForFastBoot()),
)
vm := libvmi.NewVirtualMachine(vmi,
libvmi.WithRunning(),
libvmi.WithRunStrategy(virtv1.RunStrategyAlways),
libvmi.WithDataVolumeTemplate(dv),
)
vm, err := virtClient.VirtualMachine(ns).Create(context.Background(), vm, metav1.CreateOptions{})
Expand Down Expand Up @@ -376,7 +376,7 @@ var _ = SIGDescribe("[Serial]Volumes update with migration", Serial, func() {
libvmi.WithPersistentVolumeClaim(volName, srcPVC),
)
vm := libvmi.NewVirtualMachine(vmi,
libvmi.WithRunning(),
libvmi.WithRunStrategy(virtv1.RunStrategyAlways),
)
vm, err := virtClient.VirtualMachine(ns).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -467,7 +467,7 @@ var _ = SIGDescribe("[Serial]Volumes update with migration", Serial, func() {
libvmi.WithCloudInitNoCloud(libvmifact.WithDummyCloudForFastBoot()),
)
vm := libvmi.NewVirtualMachine(vmi,
libvmi.WithRunning(),
libvmi.WithRunStrategy(virtv1.RunStrategyAlways),
libvmi.WithDataVolumeTemplate(dv1),
)
vm, err := virtClient.VirtualMachine(ns).Create(context.Background(), vm, metav1.CreateOptions{})
Expand Down Expand Up @@ -576,7 +576,7 @@ var _ = SIGDescribe("[Serial]Volumes update with migration", Serial, func() {
libvmi.WithNetwork(virtv1.DefaultPodNetwork()),
)
vm := libvmi.NewVirtualMachine(vmi,
libvmi.WithRunning(),
libvmi.WithRunStrategy(virtv1.RunStrategyAlways),
)
vm, err := virtClient.VirtualMachine(ns).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Expand Down
4 changes: 2 additions & 2 deletions tests/subresource_api_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ var _ = Describe("[sig-compute]Subresource Api", decorators.SigCompute, func() {
BeforeEach(func() {
var err error
vmi := libvmifact.NewCirros()
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm, err = virtClient.VirtualMachine(testsuite.GetTestNamespace(vmi)).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Eventually(func() bool {
Expand Down Expand Up @@ -352,7 +352,7 @@ var _ = Describe("[sig-compute]Subresource Api", decorators.SigCompute, func() {
var err error
vmi := libvmifact.NewFedora(libnet.WithMasqueradeNetworking())
vmi.Namespace = testsuite.GetTestNamespace(vmi)
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm, err = virtClient.VirtualMachine(testsuite.GetTestNamespace(vmi)).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
Eventually(func() bool {
Expand Down
14 changes: 7 additions & 7 deletions tests/vm_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -997,7 +997,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com
}

It("[test_id:243][posneg:negative]should create VM only once", decorators.Conformance, func() {
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunning())
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunStrategy(v1.RunStrategyAlways))

By("Creating VM with DataVolumeTemplate entry with k8s client binary")
_, _, err := clientcmd.RunCommand(testsuite.GetTestNamespace(nil), k8sClient, "create", "-f", vmJson)
Expand All @@ -1016,7 +1016,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com

DescribeTable("[release-blocker][test_id:299]should create VM via command line using all supported API versions", decorators.Conformance, func(version string) {
vmi := libvmifact.NewAlpine()
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm.Namespace = testsuite.GetTestNamespace(vm)
vm.APIVersion = version

Expand Down Expand Up @@ -1100,7 +1100,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com
})

DescribeTable("when stopping a VM", func(gracePeriod *int64) {
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunning())
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunStrategy(v1.RunStrategyAlways))

By("Creating VM using k8s client binary")
_, _, err := clientcmd.RunCommand(testsuite.GetTestNamespace(nil), k8sClient, "create", "-f", vmJson)
Expand Down Expand Up @@ -1150,7 +1150,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com
)

It("[test_id:7528]when restarting a VM", func() {
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunning())
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunStrategy(v1.RunStrategyAlways))

By("Creating VM using k8s client binary")
_, _, err := clientcmd.RunCommand(testsuite.GetTestNamespace(nil), k8sClient, "create", "-f", vmJson)
Expand Down Expand Up @@ -1182,7 +1182,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com
})

It("[test_id:232]should create same manifest twice via command line", func() {
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunning())
vm, vmJson := createVMAndGenerateJson(libvmi.WithRunStrategy(v1.RunStrategyAlways))

By("Creating VM using k8s client binary")
_, _, err := clientcmd.RunCommand(testsuite.GetTestNamespace(nil), k8sClient, "create", "-f", vmJson)
Expand Down Expand Up @@ -1350,7 +1350,7 @@ var _ = Describe("[rfe_id:1177][crit:medium][vendor:[email protected]][level:com

BeforeEach(func() {
vmi = libvmifact.NewGuestless()
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunning())
vm = libvmi.NewVirtualMachine(vmi, libvmi.WithRunStrategy(v1.RunStrategyAlways))
Expect(vm.Finalizers).To(BeEmpty())
vm.Finalizers = append(vm.Finalizers, customFinalizer)
})
Expand Down Expand Up @@ -1562,7 +1562,7 @@ func createVM(virtClient kubecli.KubevirtClient, template *v1.VirtualMachineInst

func createRunningVM(virtClient kubecli.KubevirtClient, template *v1.VirtualMachineInstance) *v1.VirtualMachine {
By("Creating running VirtualMachine")
vm := libvmi.NewVirtualMachine(template, libvmi.WithRunning())
vm := libvmi.NewVirtualMachine(template, libvmi.WithRunStrategy(v1.RunStrategyAlways))
vm, err := virtClient.VirtualMachine(testsuite.GetTestNamespace(vm)).Create(context.Background(), vm, metav1.CreateOptions{})
Expect(err).ToNot(HaveOccurred())
return vm
Expand Down

0 comments on commit e93d010

Please sign in to comment.