From b095d6bd582dc239ea5aa150dd4bcc859ce3ebca Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 14 Oct 2024 14:33:49 +0200 Subject: [PATCH] Add link to testscript pkg documentation Co-authored-by: Andy Feller --- acceptance/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/acceptance/README.md b/acceptance/README.md index 3f2fa2f8d..4160f5e6d 100644 --- a/acceptance/README.md +++ b/acceptance/README.md @@ -1,6 +1,6 @@ ## Acceptance Tests -The acceptance tests are blackbox* tests that are expected to interact with resources on a real GitHub instance. +The acceptance tests are blackbox* tests that are expected to interact with resources on a real GitHub instance. They are built on top of [`go-internal/testscript` module](https://pkg.go.dev/github.com/rogpeppe/go-internal/testscript), which supports a variety of commands for defining filesystem-based tests. *Note: they aren't strictly blackbox because `exec gh` commands delegate to a binary set up by `testscript` that calls into `ghcmd.Main`. However, since our real `func main` is an extremely thin adapter over `ghcmd.Main`, this is reasonable. This tradeoff avoids us building the binary ourselves for the tests, and allows us to get code coverage metrics.