headscale/integration
Christopher Johnstone 205a008013 Allow use of the preferred_username OIDC claim
Previously, Headscale would only use the `email` OIDC
claim to set the Headscale user. In certain cases
(self-hosted SSO), it may be useful to instead use the
`preferred_username` to set the Headscale username.
This also closes #938.

This adds a config setting to use this claim instead.
The OIDC docs have been updated to include this entry as well.
In addition, this adds an Authelia OIDC example to the docs.

Added OIDC claim integration tests.

Updated the MockOIDC wrapper to take an environment variable that
lets you set the username/email claims to return.

Added two integration tests, TestOIDCEmailGrant and
TestOIDCUsernameGrant, which check the username by checking the FQDN of
clients.

Updated the HTML template shown after OIDC login to show whatever
username is used, based on the Headscale settings.
2023-10-29 16:55:20 -04:00
..
dockertestutil give ci more tollerance for timeouts 2023-09-19 10:20:21 -05:00
hsic Rename Machine to Node (#1553) 2023-09-24 06:42:05 -05:00
integrationutil Add go profiling flag, and enable on integration tests (#1382) 2023-04-27 16:57:11 +02:00
tsic give ci more tollerance for timeouts 2023-09-19 10:20:21 -05:00
acl_test.go General fixups discovered by checking errors 2023-09-05 08:47:43 +02:00
auth_oidc_test.go Allow use of the preferred_username OIDC claim 2023-10-29 16:55:20 -04:00
auth_web_flow_test.go introduce a version subset we must test against 2023-09-05 08:47:43 +02:00
cli_test.go Rename Machine to Node (#1553) 2023-09-24 06:42:05 -05:00
control.go Rename Machine to Node (#1553) 2023-09-24 06:42:05 -05:00
embedded_derp_test.go add lock around saving ts clients 2023-09-19 10:20:21 -05:00
general_test.go Rename Machine to Node (#1553) 2023-09-24 06:42:05 -05:00
README.md Add section about running locally 2023-02-03 16:25:58 +01:00
run.sh add script to run integration tests 2023-09-05 08:47:43 +02:00
scenario.go Upgrade Go 1.21, Tailscale 1.50 and add Capability version support (#1563) 2023-09-28 12:33:53 -07:00
scenario_test.go Handle errors in integration test setups 2023-09-05 08:47:43 +02:00
ssh_test.go General fixups discovered by checking errors 2023-09-05 08:47:43 +02:00
tailscale.go General fixups discovered by checking errors 2023-09-05 08:47:43 +02:00
utils.go give ci more tollerance for timeouts 2023-09-19 10:20:21 -05: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.