1
0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00
juanfont.headscale/integration
Kristoffer Dalby e65ce17f7b Add documentation to integration test framework
so tsic, hsic and scenario

Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-02-03 16:25:58 +01:00
..
dockertestutil Improve generated integration tests 2023-01-30 14:43:03 +01:00
hsic Add documentation to integration test framework 2023-02-03 16:25:58 +01:00
integrationutil Remove some very verbose error outputs 2022-11-21 14:37:50 +01:00
tsic Add documentation to integration test framework 2023-02-03 16:25:58 +01:00
auth_oidc_test.go Use pingAll helper for all integration pinging 2023-02-03 09:26:22 +01:00
auth_web_flow_test.go Use pingAll helper for all integration pinging 2023-02-03 09:26:22 +01:00
cli_test.go Improve generated integration tests 2023-01-30 14:43:03 +01:00
control.go
general_test.go Add node expiry test 2023-02-03 09:26:22 +01:00
README.md Add section about running locally 2023-02-03 16:25:58 +01:00
scenario_test.go
scenario.go Add documentation to integration test framework 2023-02-03 16:25:58 +01:00
ssh_test.go
tailscale.go Add node expiry test 2023-02-03 09:26:22 +01:00
utils.go Add node expiry test 2023-02-03 09:26:22 +01: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](INSERT LINK), a local GitHub Actions runner:

act pull_request -W .github/workflows/test-integration-v2-TestPingAllByIP.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.