config

type Config struct {
	Runner    runner.Options `yaml:"runner"`
	Flatstack Flatstack      `yaml:"flatstack"`
	Routes    Routes         `yaml:"routes"`
	Server    Server         `yaml:"server"`
	Telemetry Telemetry      `yaml:"telemetry"`
	Test      Test           `yaml:"test"`
	Env       []string       `yaml:"env"`

	// Mail configures the mail servers mail() and `new Mail($name)` deliver
	// through, keyed by the name a script asks for.
	Mail Mail `yaml:"mail"`

	// DocumentRoot is the directory beneath the application root that is
	// served over HTTP. It is "public" and almost never worth setting; it
	// exists for a site whose tree already names that directory something
	// else.
	DocumentRoot string `yaml:"document_root"`

	// Autoindex answers a directory that has no index page with a listing of
	// what is in it, the way nginx's autoindex does. It is off, because
	// publishing every file below the document root is a decision a site
	// makes and not one it should arrive at by leaving an index.html out.
	Autoindex bool `yaml:"autoindex"`

	// VirtualHost is the list of sites this server routes by domain. Each
	// entry names an application root whose phpscript.yml is the
	// configuration that site runs under.
	VirtualHost []VirtualHost `yaml:"virtualhost"`
}

type Flatstack struct {
	Enabled bool `yaml:"enabled"`
}

type Hooks struct {
	// Setup runs once before any fixture below this suite root: the schema its
	// fixtures query and the rows they read. A failure fails the run before a
	// fixture executes, because a suite whose fixtures all fail on missing
	// state reports the same thing many times and names none of it.
	Setup string `yaml:"setup"`

	// Teardown runs once after those fixtures, whether they passed or failed,
	// so state a suite created outside its own database is still released by a
	// run that ended badly.
	Teardown string `yaml:"teardown"`
}

type Mail map[string]mail.Config

type Routes struct {
	Enabled bool `yaml:"enabled"`
}

type Server struct {
	// Addr is the address the HTTP server listens on.
	Addr string `yaml:"addr"`

	// Quiet turns down platform lifecycle logging.
	Quiet bool `yaml:"quiet"`

	// Modules limits which platform modules load, by name. An empty list
	// loads all of them.
	Modules []string `yaml:"modules"`

	// PidFile is the file the server records its process id in, and the one
	// -s reload reads it back from. Empty writes none. The path resolves
	// against the working directory, so -s needs the same -w.
	PidFile string `yaml:"pid_file"`
}

type Telemetry struct {
	telemetry.Options `yaml:",inline"`
	Driver            string `yaml:"driver"`
	StoragePath       string `yaml:"storage_path"`
}

type Test struct {
	// Include names a file included ahead of every fixture below this suite
	// root, once per session, for the functions and classes the fixtures expect
	// to be there: a composer autoloader, a bootstrap file. It is the --include
	// flag, which overrides this. A file that is not there is skipped.
	Include string `yaml:"include"`

	// Hooks are the PHP files the session runs around the fixtures.
	Hooks Hooks `yaml:"hooks"`

	// Parallel is how many fixtures of one area may run at once, the
	// --parallel flag.
	Parallel int `yaml:"parallel"`

	// Cache is how far a parsed include and a compiled expression travel,
	// worker or off, the --cache flag.
	Cache string `yaml:"cache"`

	// SkipPHP leaves the php binary out of a matrix run, the --skip-php flag.
	SkipPHP bool `yaml:"skip_php"`
}

type TestSuite struct {
	// Dir is the suite root, the directory holding the file. It is the
	// application root the fixtures below resolve their prelude and their hooks
	// against.
	Dir string

	// Config is the file read over the configuration the run started with.
	Config Config

	// Declared holds the keys the file itself named, so a caller can tell a
	// setting the suite asked for from one it inherited.
	Declared map[string]any
}

type VirtualHost struct {
	// Domain is the Host headers this entry answers for, separated by
	// spaces. Every name reaches the same site, not a copy of it: one
	// application root, one configuration, one set of connections and one
	// recorder, no matter which name a request arrived under. The usual case
	// is a bare domain and its www form, "example.com www.example.com".
	//
	// The first name is the site's own, the one it is reported under.
	Domain string `yaml:"domain"`

	// Root is the application root, the directory holding the site's
	// phpscript.yml.
	Root string `yaml:"root"`

	// DocumentRoot is the directory under Root served over HTTP. It defaults
	// to public and rarely needs setting: it is here for a site whose tree
	// already names that directory something else, not a field an operator is
	// expected to fill in.
	DocumentRoot string `yaml:"document_root"`
}