github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Lightweight Kubernetes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2908 Commits
30 Branches
851 Tags
628 MiB
 
 
 
 
Tree: fe18b1fce9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fe18b1fce9'
${ noResults }
k3s/tests/e2e
Vitor Savian d349c9db6c
Added cluster reset from non bootstrap nodes on snapshot restore e2e test 		1 year ago
..
amd64_resource_files Added multiClusterCIDR E2E test 2 years ago
cis_amd64_resource_files Add scripts to run e2e test using ansible (#5134) 2 years ago
dualstack E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
externalip E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
multiclustercidr E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
privateregistry E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
rotateca E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
s3 fix for etcd-snapshot delete with --etcd-s3 flag (#8110) 1 year ago
scripts fix_get_sha_url (#7187) 2 years ago
secretsencryption CLI + Backend for Secrets Encryption v3 1 year ago
secretsencryption_old Add new encryption test 1 year ago
snapshotrestore Added cluster reset from non bootstrap nodes on snapshot restore e2e test 1 year ago
splitserver Consolidate E2E tests and GH Actions (#6772) 2 years ago
startup E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
tailscale E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
token E2E test for token coverage (#8184) 1 year ago
upgradecluster E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
validatecluster E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago
README.md add private registry e2e test (#7653) 1 year ago
e2e_test_playbook.yaml Add scripts to run e2e test using ansible (#5134) 2 years ago
testutils.go fix for etcd-snapshot delete with --etcd-s3 flag (#8110) 1 year ago
vagrantdefaults.rb E2E: Support GOCOVER for more tests + fixes (#8080) 1 year ago

README.md

End-to-End (E2E) Tests

E2E tests cover multi-node K3s configuration and administration: bringup, update, teardown etc. across a wide range of operating systems. E2E tests are run nightly as part of K3s quality assurance (QA).

Framework

End-to-end tests utilize Ginkgo and Gomega like the integration tests, but rely on Vagrant to provide the underlying cluster configuration.

Currently tested operating systems are:

Format

All E2E tests should be placed under tests/e2e/<TEST_NAME>.
All E2E test functions should be named: Test_E2E<TEST_NAME>.
A E2E test consists of two parts:

  1. Vagrantfile: a vagrant file which describes and configures the VMs upon which the cluster and test will run
  2. <TEST_NAME>.go: A go test file which calls vagrant up and controls the actual testing of the cluster

See the validate cluster test as an example.

Setup

To run the E2E tests, you must first install the following:

  • Vagrant
  • Libvirt
  • Vagrant plugins

Vagrant

Download the latest version (currently 2.2.19) of Vagrant from the website. Do not use built-in packages, they often old or do not include the required ruby library extensions necessary to get certain plugins working.

Libvirt

Follow the OS specific guides to install libvirt/qemu on your host:

  • openSUSE
  • ubuntu 20.04
  • ubuntu 22.04: 
    sudo apt install ruby-libvirt qemu libvirt-daemon-system libvirt-clients ebtables dnsmasq-base libxslt-dev libxml2-dev libvirt-dev zlib1g-dev ruby-dev libguestfs-tools
  • debian
  • fedora

Vagrant plugins

Install the necessary vagrant plugins with the following command:

vagrant plugin install vagrant-libvirt vagrant-scp vagrant-k3s vagrant-reload

Kubectl

For linux

   curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
   sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

If it does not work, or you are on a different system, check the official tutorial

Running

Generally, E2E tests are run as a nightly Jenkins job for QA. They can still be run locally but additional setup may be required. By default, all E2E tests are designed with libvirt as the underlying VM provider. Instructions for installing libvirt and its associated vagrant plugin, vagrant-libvirt can be found here. VirtualBox is also supported as a backup VM provider.

Once setup is complete, all E2E tests can be run with:

go test -timeout=15m ./tests/e2e/... -run E2E

Tests can be run individually with:

go test -timeout=15m ./tests/e2e/validatecluster/... -run E2E
#or
go test -timeout=15m ./tests/e2e/... -run E2EClusterValidation

Additionally, to generate junit reporting for the tests, the Ginkgo CLI is used. Installation instructions can be found here.

To run the all E2E tests and generate JUnit testing reports:

ginkgo --junit-report=result.xml ./tests/e2e/...

Note: The go test default timeout is 10 minutes, thus the -timeout flag should be used. The ginkgo default timeout is 1 hour, no timeout flag is needed.

Debugging

In the event of a test failure, the cluster and VMs are retained in their broken state. Startup logs are retained in vagrant.log.
To see a list of nodes: vagrant status
To ssh into a node: vagrant ssh <NODE>
Once you are done/ready to restart the test, use vagrant destroy -f to remove the broken cluster.