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 d1cd3399a6 Fix etcd snapshot integration tests 
Snapshot delete/prune tests were only working because the delete command
would report success even when deleting a snapshot that didn't exist,
and the test regex was finding the snapshot name multiple times in
the list output and deleting it twice.

Snapshot restore tests seem to have expected the deployment to be rolled out
immediately, which is not a reasonable expectation.

Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
(cherry picked from commit 7c5b69ca1d)
Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
 		2023-10-13 12:28:56 -07:00
..
certrotation Containerd restart testlet (#6696) 2023-05-02 10:12:00 -03:00
custometcdargs Add integration tests for etc-snapshot server flags and refactor /tests/integration/integration.go/K3sStartServer (#7300) 2023-05-02 10:12:00 -03:00
dualstack Add integration tests for etc-snapshot server flags and refactor /tests/integration/integration.go/K3sStartServer (#7300) 2023-05-02 10:12:00 -03:00
etcdrestore Fix etcd snapshot integration tests 2023-10-13 12:28:56 -07:00
etcdsnapshot Fix etcd snapshot integration tests 2023-10-13 12:28:56 -07:00
kubeflags Fix for Kubeflag Integration test (#8154) 2023-09-25 09:23:32 -07:00
localstorage local-storage: Fix permission (#7217) (#7473) 2023-05-10 11:53:40 -07:00
longhorn Take IPFamily precedence based on order 2023-10-02 18:40:56 +02:00
secretsencryption Containerd restart testlet (#6696) 2023-05-02 10:12:00 -03:00
startup Added advertise address integration test 2023-10-05 17:11:14 -03:00
Dockerfile.test Bump golang to 1.18.1 2022-05-11 14:39:07 -07:00
README.md Remove codespell from Drone, add to GH Actions (#6004) 2022-08-18 09:21:56 -07:00
integration.go Fix etcd snapshot integration tests 2023-10-13 12:28:56 -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

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

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>