config

type Bisect struct {
	Checkout     []string `yaml:"checkout,omitempty"`      // builds or restarts the application from the worktree; failing skips the commit
	Ready        []string `yaml:"ready,omitempty"`         // repeated until it succeeds; failing within ready_timeout skips the commit
	Finish       []string `yaml:"finish,omitempty"`        // once at the end, e.g. to start the application from the checkout again
	Timeout      Duration `yaml:"timeout,omitempty"`       // limit of the checkout command; default 10m
	ReadyTimeout Duration `yaml:"ready_timeout,omitempty"` // default 1m
}

type Component struct {
	Driver      string   `yaml:"driver,omitempty"` // mysql (also MariaDB) or postgres; empty: commands
	DSN         Secret   `yaml:"dsn,omitempty"`
	Working     string   `yaml:"working,omitempty"`  // database the application uses
	Pristine    string   `yaml:"pristine,omitempty"` // its pristine copy; default <working>_pristine
	Exclude     []string `yaml:"exclude,omitempty"`  // tables never fingerprinted or restored (globs)
	RowTracking []string `yaml:"row_tracking,omitempty"`
	// AllowRemote lets the database be on a host outside target.allow_hosts.
	// A restore rewrites its tables, so a wrong DSN must not reach a server
	// that is not a copy.
	AllowRemote bool     `yaml:"allow_remote,omitempty"`
	Restore     []string `yaml:"restore,omitempty"`
	Fingerprint []string `yaml:"fingerprint,omitempty"`
}

type Concurrency int

type Config struct {
	Version    int                  `yaml:"version"`
	Project    string               `yaml:"project"`
	Mode       string               `yaml:"mode"`
	Level      string               `yaml:"level"`
	Baselines  string               `yaml:"baselines,omitempty"` // local or git; default: where driftgate.yaml is (Layout)
	Store      string               `yaml:"store,omitempty"`
	Key        secret.Source        `yaml:"key,omitempty"`
	Target     Target               `yaml:"target,omitempty"`  // one service
	Targets    map[string]Target    `yaml:"targets,omitempty"` // several services, by name (an API, a frontend, microservices)
	Identities map[string]Identity  `yaml:"identities,omitempty"`
	Tokens     Tokens               `yaml:"tokens,omitempty"`
	State      map[string]Component `yaml:"state,omitempty"`
	Seed       [][]string           `yaml:"seed,omitempty"`    // load the data into the working state; driftgate seed then copies it to the pristine one
	Prepare    [][]string           `yaml:"prepare,omitempty"` // run after every restore (migrations and the like)
	Guards     []Guard              `yaml:"guards,omitempty"`
	PII        PII                  `yaml:"pii,omitempty"`
	Discover   []discover.Adapter   `yaml:"discover,omitempty"`
	Generate   Generate             `yaml:"generate,omitempty"`
	Templates  []string             `yaml:"templates,omitempty"`
	Params     []Param              `yaml:"params,omitempty"`
	Storage    Storage              `yaml:"storage,omitempty"`
	Observe    []Observe            `yaml:"observe,omitempty"`
	Bisect     Bisect               `yaml:"bisect,omitempty"`
	Data       Data                 `yaml:"data,omitempty"`
	Uploads    Uploads              `yaml:"uploads,omitempty"`
}

type Data struct {
	Driver string `yaml:"driver,omitempty"` // mysql (also MariaDB) or postgres
	Source DataDB `yaml:"source,omitempty"`
	Target DataDB `yaml:"target,omitempty"`
	// AllowRemote lets the target be on a host outside target.allow_hosts.
	// The target is dropped and created again, so a wrong DSN must not
	// reach a server that is not a copy.
	AllowRemote bool `yaml:"allow_remote,omitempty"`
	// Key replaces values deterministically; default: the project key.
	Key secret.Source `yaml:"key,omitempty"`
	// Files is the folder of uploaded files and the folder that receives
	// their placeholders (same names, neutral content); relative to the
	// project root.
	Files DataFiles `yaml:"files,omitempty"`
}

type DataDB struct {
	DSN      Secret `yaml:"dsn,omitempty"`      // the server; for the target, default the source's
	Database string `yaml:"database,omitempty"` // the database on it
}

type DataFiles struct {
	Source string `yaml:"source,omitempty"`
	Target string `yaml:"target,omitempty"`
}

type Duration struct{ time.Duration }

type From struct {
	Request string `yaml:"request" json:"request"`
	Path    string `yaml:"path" json:"path"` // JSON path in its body, e.g. $.entry.id
}

type Generate struct {
	Identity string `yaml:"identity,omitempty"` // for routes that need an authenticated user
}

type Guard struct {
	Name    string   `yaml:"name"`
	Command []string `yaml:"command"`
}

type Identity struct {
	Env string `yaml:"env,omitempty"`
	Op  string `yaml:"op,omitempty"`
}

type Layout struct {
	Mode      string // BaselinesLocal or BaselinesGit
	Root      string // the project folder (.gitignore, .env and the application's files)
	Config    string // driftgate.yaml
	Dir       string // the folder of the catalog, allowlist, routes, exclusions and baselines
	Catalog   string // catalog.json
	Allowlist string // allowlist.yaml
	Baselines string // the folder of the baselines, one folder each

	// The local store: captures, encrypted private bodies, pristine
	// records, the last comparisons and the lock. Empty when store: is not
	// usable; StoreDir says why.
	Store    string
	Captures string // one folder per tag
	Private  string // encrypted private bodies
	Pristine string // records of the pristine copies
	Lock     string // the lock of the commands that write the store

	// Key is the key file; empty when the key comes from elsewhere only
	// (the environment, 1Password, the macOS Keychain).
	Key string
	// Ignored is the folder git must ignore before anything sensitive is
	// written into it (the key, captures, private bodies, baselines); empty
	// when none of them is inside the project.
	Ignored string
}

type Observe struct {
	Target string `yaml:"target,omitempty"` // only requests of this service
	Match  string `yaml:"match"`            // glob over "METHOD /route/path", "/route/path" or the request ID
	Reason string `yaml:"reason,omitempty"` // why it cannot be compared
}

type PII struct {
	Allow []string `yaml:"allow,omitempty"` // regular expressions of values that may appear in public bodies
}

type Param struct {
	Target  string   `yaml:"target,omitempty"` // only routes of this service
	Name    string   `yaml:"name"`
	Route   string   `yaml:"route,omitempty"` // glob over route paths; empty: every route with the parameter
	Value   string   `yaml:"value,omitempty"`
	Values  []string `yaml:"values,omitempty"`
	SQL     string   `yaml:"sql,omitempty"`
	State   string   `yaml:"state,omitempty"` // component the query runs on; default: the only database
	From    *From    `yaml:"from,omitempty"`
	Foreach bool     `yaml:"foreach,omitempty"` // one request per value instead of the first value only
}

type Project struct {
	Config
	Root   string // the project folder; driftgate.yaml is in it or in its .driftgate/
	Level  compare.Level
	Layout Layout // where the project's files are
	// contains filtered or unexported fields
}

type RateLimit struct {
	Match     string `yaml:"match"`
	PerMinute int    `yaml:"per_minute"`
}

type Secret struct {
	Env string `yaml:"env,omitempty"`
	Op  string `yaml:"op,omitempty"`
	// A file of the project, relative to its root, by its format; Key says
	// where the setting is in it and Host replaces its host[:port].
	Dotenv      string `yaml:"dotenv,omitempty"`
	AppSettings string `yaml:"appsettings,omitempty"`
	Properties  string `yaml:"properties,omitempty"`
	YAML        string `yaml:"yaml,omitempty"`
	PHP         string `yaml:"php,omitempty"`
	Python      string `yaml:"python,omitempty"`
	Compose     string `yaml:"compose,omitempty"`
	Key         string `yaml:"key,omitempty"`
	Host        string `yaml:"host,omitempty"`
}

type Storage struct {
	Default string   `yaml:"default,omitempty"`
	Public  []string `yaml:"public,omitempty"`
}

type Switch struct {
	From *Project // the project as it is laid out now
	To   Layout   // where its files go
	// contains filtered or unexported fields
}

type Target struct {
	BaseURL         string      `yaml:"base_url,omitempty"`
	AllowHosts      []string    `yaml:"allow_hosts,omitempty"` // host names or CIDR ranges; default: local and private
	UserAgent       string      `yaml:"user_agent,omitempty"`
	Timeout         Duration    `yaml:"timeout,omitempty"`
	Concurrency     Concurrency `yaml:"concurrency,omitempty"`
	FollowRedirects bool        `yaml:"follow_redirects,omitempty"`
	RateLimits      []RateLimit `yaml:"rate_limits,omitempty"`
	// Aliases are other origins under which the application writes its
	// own URLs. A comparison of sets captured from different origins takes
	// every side's own origin and these as the same.
	Aliases []string `yaml:"aliases,omitempty"`
}

type Tokens struct {
	Command []string `yaml:"command,omitempty"`
	File    string   `yaml:"file,omitempty"`
}

type Uploads struct {
	Dir string `yaml:"dir,omitempty"` // ~/ is the home folder; relative to the project root otherwise
}