Function init

coderd/database/dbtestutil/cleaner.go:29–46

()

)

func init() {
	// We are hijacking the init() function here to do something very non-standard.
	//
	// We want to be able to run the cleaner as a subprocess of the test process so that it can outlive the test binary
	// and still clean up, even if the test process times out or is killed. So, what we do is in startCleaner() below,
	// which is called in the parent process, we exec our own binary and set a collision-resistant environment variable.
	// Then here in the init(), which will run before main() and therefore before executing tests, we check for the
	// environment variable, and if present we know this is the child process and we exec the cleaner. Instead of
	// returning normally from init() we call os.Exit(). This prevents tests from being re-run in the child process (and
	// recursion).
	//
	// If the magic value is not present, we know we are the parent process and init() returns normally.
	magicValue := os.Getenv(envCleanerMagic)
	if magicValue == envCleanerMagicValue {
		RunCleaner()
		os.Exit(0)
	}
}

// startCleaner starts the cleaner in a subprocess. holdThis is an opaque reference that needs to be kept from being
// garbage collected until we are done with all test databases (e.g. the end of the process).