205a008013
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. |
||
---|---|---|
.. | ||
dockertestutil | ||
hsic | ||
integrationutil | ||
tsic | ||
acl_test.go | ||
auth_oidc_test.go | ||
auth_web_flow_test.go | ||
cli_test.go | ||
control.go | ||
embedded_derp_test.go | ||
general_test.go | ||
README.md | ||
run.sh | ||
scenario.go | ||
scenario_test.go | ||
ssh_test.go | ||
tailscale.go | ||
utils.go |
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.