tests

README

Integration tests

Writing e2e tests

We aim to run e2e tests in parallel by default. As such the following rules should be followed:

• Use cirros and alpine VMs for testing wherever possible. If you have to use another OS, discuss on the PR why it is needed.
• Stay within the boundary of the Testnamespaces which we prove. If you have to create resources outside the test namespaces, discuss potential solutions on such a PR.
• If you really have to run tests serial (destructive tests, infra-tests, ...), mark the test with a [Serial] tag and add the Serial decorator to the test.
• If tests are not using the default cleanup code, additional custom preparations may be necessary.

The following types of tests need to be marked as [Serial] right now:

• Tests which use PVCs or DataVolumes (parallelizing these is on the way).
• Tests which use BeforeAll.

Additional suggestions:

• The [Disruptive] tag is recognized by the test suite but is not yet mandatory. Feel free to set it on destructive tests.
• Conformance tests need to be marked with a [Conformance] tag.
• We try to mark tests that require advanced/special storage capabilities with [storage-req],
  So they are easy to skip when lanes with new storage solutions are introduced.
  At the point of writing this we use rook-ceph-block which certainly qualifies for running them.

Test Namespaces

If tests are executed in parallel, every test gets its unique set of namespaces to test in. If you write a test and reference the namespaces test.NamespaceTestDefault, test.NamespaceTestAlternative or tests.NamespaceTestOperator, you get different values, based on the ginkgo execution node.

For as long as test resources are created by referencing these namespaces, there is no test conflict to expect.

Running integration tests

Integration tests require a running Kubevirt cluster. Once you have a running Kubevirt cluster, you can use the -master and the -kubeconfig flags to point the tests to the cluster.

Running networking tests for outside connectivity

When running the tests with no internet connection, some networking tests ,that test outside connectivity, might fail, and you might want to skip them. For that some additional flags are needed to be passed. In addition, if you'd like to test outside connectivity using different addresses than the default (8.8.8.8, 2001:db8:1::1 and google.com), you can achive that with the designated flags as well.

For each method detailed below, there is note about the needed flags to the outside connectivity tests and how to pass them.

Run them on an arbitrary KubeVirt installation

cd tests # from the git repo root folder
go test -kubeconfig=path/to/my/config -config=default-config.json

outside connectivity tests: The tests will run by default. To skip the outside connectivity tests add -ginkgo.skip='\[outside_connectivity\]' To your go command. To change the IPV4, IPV6 or DNS used for outside connectivity tests, add conn-check-ipv4-address, conn-check-ipv6-address or conn-check-dns to your go command, with the desired value. For example:

go test -kubeconfig=$KUBECONFIG -config=default-config.json \
-conn-check-ipv4-address=8.8.4.4 -conn-check-ipv6-address=2620:119:35::35 \
-conn-check-dns=amazon.com \

Run them on one of the core KubeVirt providers

There is a make target to run this with the config taken from hack/config.sh:

# from the git repo root folder
make functest

outside connectivity tests: The tests will run by default. To skip the tests export KUBEVIRT_E2E_SKIP='\[outside_connectivity\]' environment variable before running the tests. To change the IPV4, IPV6 or DNS used for outside connectivity tests, you can export CONN_CHECK_IPV4_ADDRESS, CONN_CHECK_IPV6_ADDRESS and
CONN_CHECK_DNS with the desired values. For example:

export CONN_CHECK_IPV4_ADDRESS=8.8.4.4
export CONN_CHECK_IPV6_ADDRESS=2620:119:35::35
export CONN_CHECK_DNS=amazon.com

Run them anywhere inside of container

# Create directory for data / results / kubectl binary
mkdir -p /tmp/kubevirt-tests-data
# Make sure that eveybody can write there
setfacl -m d:o:rwx /tmp/kubevirt-tests-data
setfacl -m o:rwx /tmp/kubevirt-tests-data

docker run \
    -v /tmp/kubevirt-tests-data:/home/kubevirt-tests/data:rw,z --rm \
    kubevirt/tests:latest \
        --kubeconfig=data/openshift-master.kubeconfig \
        --container-tag=latest \
        --container-prefix=quay.io/kubevirt \
        --test.timeout 180m \
        --junit-output=data/results/junit.xml \
        --deploy-testing-infra \
        --path-to-testing-infra-manifests=data/manifests

Documentation

Overview

* This file is part of the KubeVirt project * * 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. * * Copyright 2021 Red Hat, Inc. *

Index

• Constants
• func CheckCloudInitMetaData(vmi *v1.VirtualMachineInstance, testFile, testData string)
• func CreateErrorDisk(nodeName string) (address string, device string)
• func CreatePVandPVCwithFaultyDisk(nodeName, devicePath, namespace string) (*corev1.PersistentVolume, *corev1.PersistentVolumeClaim, error)
• func CreatePVandPVCwithSCSIDisk(nodeName, devicePath, namespace, storageClass, pvName, pvcName string) (*corev1.PersistentVolume, *corev1.PersistentVolumeClaim, error)
• func CreatePVwithSCSIDisk(storageClass, pvName, nodeName, devicePath string) (*corev1.PersistentVolume, error)
• func CreateSCSIDisk(nodeName string, opts []string) (address string, device string)
• func ExecuteCommandInVirtHandlerPod(nodeName string, args []string) (stdout string, err error)
• func FixErrorDevice(nodeName string)
• func GetRunningVMIDomainSpec(vmi *v1.VirtualMachineInstance) (*launcherApi.DomainSpec, error)
• func GetRunningVirtualMachineInstanceDomainXML(virtClient kubecli.KubevirtClient, vmi *v1.VirtualMachineInstance) (string, error)
• func NodeNameWithHandler() string
• func RemoveSCSIDisk(nodeName, address string)

Constants

const (
	UsrBinVirtChroot = "/usr/bin/virt-chroot"
	Mount            = "--mount"
	Proc1NsMnt       = "/proc/1/ns/mnt"
)

Functions

func CheckCloudInitMetaData

func CheckCloudInitMetaData(vmi *v1.VirtualMachineInstance, testFile, testData string)

func CreateErrorDisk

func CreateErrorDisk(nodeName string) (address string, device string)

The tests using the function CreateErrorDisk need to be run serially as it relies on the kernel scsi_debug module

func CreatePVandPVCwithFaultyDisk

func CreatePVandPVCwithFaultyDisk(nodeName, devicePath, namespace string) (*corev1.PersistentVolume, *corev1.PersistentVolumeClaim, error)

func CreatePVandPVCwithSCSIDisk

func CreatePVandPVCwithSCSIDisk(nodeName, devicePath, namespace, storageClass, pvName, pvcName string) (*corev1.PersistentVolume, *corev1.PersistentVolumeClaim, error)

func CreatePVwithSCSIDisk

func CreatePVwithSCSIDisk(storageClass, pvName, nodeName, devicePath string) (*corev1.PersistentVolume, error)

func CreateSCSIDisk

func CreateSCSIDisk(nodeName string, opts []string) (address string, device string)

CreateSCSIDisk creates a SCSI disk using the scsi_debug module. This function should be used only to check SCSI disk functionalities and not for creating a filesystem or any data. The disk is stored in ram and it isn't suitable for storing large amount of data. If a test uses this function, it needs to be run serially. The device is created directly on the node and the addition and removal of the scsi_debug kernel module could create flakiness

func ExecuteCommandInVirtHandlerPod

func ExecuteCommandInVirtHandlerPod(nodeName string, args []string) (stdout string, err error)

func FixErrorDevice

func FixErrorDevice(nodeName string)

func GetRunningVMIDomainSpec

func GetRunningVMIDomainSpec(vmi *v1.VirtualMachineInstance) (*launcherApi.DomainSpec, error)

func GetRunningVirtualMachineInstanceDomainXML

func GetRunningVirtualMachineInstanceDomainXML(virtClient kubecli.KubevirtClient, vmi *v1.VirtualMachineInstance) (string, error)

func NodeNameWithHandler

func NodeNameWithHandler() string

func RemoveSCSIDisk

func RemoveSCSIDisk(nodeName, address string)