mirror of
https://github.com/juanfont/headscale.git
synced 2025-12-09 20:04:54 +01:00
22ee2bfc9c
This PR investigates, adds tests and aims to correctly implement Tailscale's model for how Tags should be accepted, assigned and used to identify nodes in the Tailscale access and ownership model. When evaluating in Headscale's policy, Tags are now only checked against a nodes "tags" list, which defines the source of truth for all tags for a given node. This simplifies the code for dealing with tags greatly, and should help us have less access bugs related to nodes belonging to tags or users. A node can either be owned by a user, or a tag. Next, to ensure the tags list on the node is correctly implemented, we first add tests for every registration scenario and combination of user, pre auth key and pre auth key with tags with the same registration expectation as observed by trying them all with the Tailscale control server. This should ensure that we implement the correct behaviour and that it does not change or break over time. Lastly, the missing parts of the auth has been added, or changed in the cases where it was wrong. This has in large parts allowed us to delete and simplify a lot of code. Now, tags can only be changed when a node authenticates or if set via the CLI/API. Tags can only be fully overwritten/replaced and any use of either auth or CLI will replace the current set if different. A user owned device can be converted to a tagged device, but it cannot be changed back. A tagged device can never remove the last tag either, it has to have a minimum of one. |
||
|---|---|---|
| .. | ||
| dockertestutil | ||
| dsic | ||
| hsic | ||
| integrationutil | ||
| tsic | ||
| acl_test.go | ||
| api_auth_test.go | ||
| auth_key_test.go | ||
| auth_oidc_test.go | ||
| auth_web_flow_test.go | ||
| cli_test.go | ||
| control.go | ||
| derp_verify_endpoint_test.go | ||
| dns_test.go | ||
| embedded_derp_test.go | ||
| general_test.go | ||
| helpers.go | ||
| README.md | ||
| route_test.go | ||
| run.sh | ||
| scenario_test.go | ||
| scenario.go | ||
| ssh_test.go | ||
| tags_test.go | ||
| tailscale.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, 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.