github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/tests/integration
History
Brad Davidson b1a42e5d43 Add ca-cert rotation integration test 
Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
 		2024-10-08 17:03:31 -07:00
..
cacertrotation Add ca-cert rotation integration test 2024-10-08 17:03:31 -07:00
certrotation Containerd restart testlet (#6696) 2023-01-12 13:43:31 -08:00
custometcdargs Add integration tests for etc-snapshot server flags and refactor /tests/integration/integration.go/K3sStartServer (#7300) 2023-04-28 14:07:11 -03:00
dualstack Add int test for flannel-ipv6masq 2024-09-17 12:00:33 +02:00
etcdrestore Fix etcd snapshot integration tests 2023-10-12 15:04:45 -07:00
etcdsnapshot Move etcd snapshot management CLI to request/response 2024-04-09 15:21:26 -07:00
flannelipv6masq Add int test for flannel-ipv6masq 2024-09-17 12:00:33 +02:00
flannelnone Add an integration test for flannel-backend=none 2024-03-01 12:08:09 +01:00
kubeflags Fix CloudDualStackNodeIPs feature-gate inconsistency 2023-10-17 10:40:12 -07:00
localstorage local-storage: Fix permission (#7217) 2023-05-04 10:43:54 -07:00
longhorn Test Coverage Reports for E2E tests (#7526) 2023-06-05 14:15:17 -07:00
secretsencryption [v1.28] CLI Removal for v1.28.0 (#8203) 2023-08-24 22:09:13 -07:00
startup Add tls for kine 2024-03-28 11:12:07 -03:00
Dockerfile.test Bump golang to 1.18.1 2022-05-11 14:39:07 -07:00
README.md Add ca-cert rotation integration test 2024-10-08 17:03:31 -07:00
integration.go Add ca-cert rotation integration test 2024-10-08 17:03:31 -07:00
test-runner.sh Creation of K3s integration test Sonobuoy plugin (#3931) 2021-08-30 08:27:59 -07:00

README.md

Integration Tests

Integration tests should be used to test a specific functionality of k3s that exists across multiple Go packages, either via exported function calls, or more often, CLI commands. Integration tests should be used for "black box" testing.

Framework

All integration tests in K3s follow a Behavior Diven Development (BDD) style. Specifically, K3s uses Ginkgo and Gomega to drive the tests.
To generate an initial test, the command ginkgo bootstrap can be used.

To facilitate K3s CLI testing, see tests/util/cmd.go helper functions.

Format

All integration tests should be placed under tests/integration/<TEST_NAME>.
All integration test files should be named: <TEST_NAME>_int_test.go.
All integration test functions should be named: Test_Integration<TEST_NAME>.
See the local storage test as an example.

Running

Integration tests can be run with no k3s cluster present, each test will spin up and kill the appropriate k3s server it needs.
Note: Integration tests must be run as root, prefix the commands below with sudo -E env "PATH=$PATH" if a sudo user.

go test ./tests/integration/... -run Integration -ginkgo.v -test.v

Additionally, to generate JUnit reporting for the tests, the Ginkgo CLI is used

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

Integration tests can be run on an existing single-node cluster via compile time flag, tests will skip if the server is not configured correctly.

go test -ldflags "-X 'github.com/k3s-io/k3s/tests/integration.existingServer=True'" ./tests/integration/... -run Integration -ginkgo.v -test.v

Integration tests can also be run via a Sonobuoy plugin on an existing single-node cluster.

./scripts/build-tests-sonobuoy
sudo KUBECONFIG=/etc/rancher/k3s/k3s.yaml sonobuoy run --plugin ./dist/artifacts/k3s-int-tests.yaml

Check the sonobuoy status and retrieve results

sudo KUBECONFIG=/etc/rancher/k3s/k3s.yaml sonobuoy status
sudo KUBECONFIG=/etc/rancher/k3s/k3s.yaml sonobuoy retrieve
sudo KUBECONFIG=/etc/rancher/k3s/k3s.yaml sonobuoy results <TAR_FILE_FROM_RETRIEVE>