Documentation
¶
Overview ¶
Package hermetictest gives every test binary in this module the same guarantee: nothing a test runs can read or write the real developer's home, XDG config, or XDG cache directories.
Production code resolves several per-user directories straight from the OS (os.UserHomeDir, os.UserConfigDir, os.UserCacheDir — see pkg/chat.DefaultChatStorePath, pkg/chat (tilde export path expansion), pkg/accesspolicies.ResolveDir, pkg/executionstore.ResolvePrivateDir, pkg/personalqueries.ResolveProjectDir, pkg/auth/gauth's file store, and pkg/auth/device's insecure file-store fallback), and so does at least one dependency: github.com/ingitdb/dalgo2ingitdb locks its file cache under os.UserCacheDir()/dalgo2ingitdb/locks and offers no environment variable or option to redirect it.
On every OS os.UserHomeDir, os.UserConfigDir and os.UserCacheDir bottom out in $HOME (and, off Darwin, $XDG_CONFIG_HOME / $XDG_CACHE_HOME first). Pointing all three at a fresh, empty, per-test-binary temp directory before any test runs — and removing it once they finish — is therefore enough to keep every test in a package hermetic, including tests that exercise a seam (e.g. accesspolicies.DirEnv) that itself falls back to one of these functions, and including this dependency that offers no override at all.
scripts/check-hermetic-tests.sh is the enforcement backstop: it runs `go test ./...` with HOME/XDG_CONFIG_HOME/XDG_CACHE_HOME set to one more fresh empty directory of its own and fails the build if anything appears there afterward. A package that forgets to call Main here — or a production code path that starts resolving a new per-user directory without going through a seam this package's Main can redirect — shows up as a leftover file in that script's directory, not as a silent write into a real developer's home.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Main ¶
func Main(m runner) int
Main points HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME at a fresh temporary directory, runs m, removes the directory, and returns the exit code — call it from a package's TestMain as:
func TestMain(m *testing.M) { os.Exit(hermetictest.Main(m)) }
A package whose own TestMain needs to do other setup should call Setup directly instead and defer its cleanup function.
func Setup ¶
func Setup() (cleanup func(), err error)
Setup points HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME at a fresh, empty temporary directory and returns a cleanup function that restores the previous environment and removes the directory. Callers that need to combine hermetic isolation with other TestMain setup call this directly; everyone else should prefer Main.
Types ¶
This section is empty.
Source Files