headscale/integration
Kristoffer Dalby c4600346f9
Some checks failed
Build / build-nix (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=linux) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=linux) (push) Has been cancelled
Check Generated Files / check-generated (push) Has been cancelled
NixOS Module Tests / nix-module-check (push) Has been cancelled
Tests / test (push) Has been cancelled
.github/workflows: prebuilt integration test artifacts (#2954)
This PR restructures the integration tests and prebuilds all common assets used in all tests:

Headscale and Tailscale HEAD image
hi binary that is used to run tests
go cache is warmed up for compilation of the test
This essentially means we spend 6-10 minutes building assets before any tests starts, when that is done, all tests can just sprint through.

It looks like we are saving 3-9 minutes per test, and since we are limited to running max 20 concurrent tests across the repo, that means we had a lot of double work.

There is currently 113 checks, so we have to do five runs of 20, and the saving should be quite noticeable! I think the "worst case" saving would be 20+min and "best case" probably towards an hour.
2025-12-12 23:01:52 +01:00
..
dockertestutil cmd/hi: improve test cleanup to reduce CI disk usage (#2881) 2025-11-28 16:59:54 +01:00
dsic integration: replace time.Sleep with assert.EventuallyWithT (#2680) 2025-07-10 23:38:55 +02:00
hsic .github/workflows: prebuilt integration test artifacts (#2954) 2025-12-12 23:01:52 +01:00
integrationutil lint and leftover 2025-09-09 09:40:00 +02:00
tsic .github/workflows: prebuilt integration test artifacts (#2954) 2025-12-12 23:01:52 +01:00
acl_test.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
api_auth_test.go modernize: run gopls modernize to bring up to 1.25 (#2920) 2025-12-01 19:40:25 +01:00
auth_key_test.go golangci-lint: use forbidigo to block time.Sleep (#2946) 2025-12-10 16:45:59 +00:00
auth_oidc_test.go golangci-lint: use forbidigo to block time.Sleep (#2946) 2025-12-10 16:45:59 +00:00
auth_web_flow_test.go stability and race conditions in auth and node store (#2781) 2025-10-16 12:17:43 +02:00
cli_test.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
control.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
derp_verify_endpoint_test.go stability and race conditions in auth and node store (#2781) 2025-10-16 12:17:43 +02:00
dns_test.go stability and race conditions in auth and node store (#2781) 2025-10-16 12:17:43 +02:00
embedded_derp_test.go golangci-lint: use forbidigo to block time.Sleep (#2946) 2025-12-10 16:45:59 +00:00
general_test.go types: add option to disable taildrop, improve tests (#2955) 2025-12-12 11:35:16 +01:00
helpers.go modernize: run gopls modernize to bring up to 1.25 (#2920) 2025-12-01 19:40:25 +01:00
README.md feat: support client verify for derp (add integration tests) (#2046) 2024-11-22 13:23:05 +01:00
route_test.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
run.sh Fix 764 (#2093) 2024-09-03 09:22:17 +02:00
scenario.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
scenario_test.go stability and race conditions in auth and node store (#2781) 2025-10-16 12:17:43 +02:00
ssh_test.go add health command (#2659) 2025-10-16 12:00:11 +00:00
tags_test.go tags: process tags on registration, simplify policy (#2931) 2025-12-08 18:51:07 +01:00
tailscale.go hscontrol/state: allow expired auth keys for node re-registration 2025-11-11 05:12:59 -06:00

Integration testing

Headscale relies on integration testing to ensure we remain compatible with Tailscale.

This is typically performed by starting a Headscale server and running a test "scenario" with an array of Tailscale clients and versions.

Headscale's test framework and the current set of scenarios are defined in this directory.

Tests are located in files ending with _test.go and the framework are located in the rest.

Running integration tests locally

The easiest way to run tests locally is to use act, a local GitHub Actions runner:

act pull_request -W .github/workflows/test-integration.yaml

Alternatively, the docker run command in each GitHub workflow file can be used.

Running integration tests on GitHub Actions

Each test currently runs as a separate workflows in GitHub actions, to add new test, run go generate inside ../cmd/gh-action-integration-generator/ and commit the result.