From b3a0c4a63b3aafc5d3af9fcdfbe49f43215a06fd Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Fri, 6 Jan 2023 11:51:00 +0100 Subject: [PATCH] Add integration readme Signed-off-by: Kristoffer Dalby --- integration/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 integration/README.md diff --git a/integration/README.md b/integration/README.md new file mode 100644 index 00000000..e5e6b9f6 --- /dev/null +++ b/integration/README.md @@ -0,0 +1,16 @@ +# 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 on GitHub Actions + +Each test currently runs as a separate workflows in GitHub actions, to add new test, add +the new test to the list in `../cmd/gh-action-integration-generator/main.go` and run +`go generate` inside `../cmd/gh-action-integration-generator/` and commit the result.