laws

type AbsentMount struct {
	// Name       string
	Spec       string
	MountPoint string `yaml:"mount_point"`
	Type       string
	Options    string
	Freq       int64
	Pass       int64

	// CommonFields
	Name   string
	Before []string
	After  []string
}

type Container struct {
	// Name          string
	Image         string
	Running       bool
	Volumes       map[string]string
	Environment   map[string]string
	Labels        map[string]string
	LogDriver     string
	Hostname      string
	Network       string // bridge|none|container:<name|id>|host|<network-name|network-id>
	HealthCheck   HealthCheckOpts
	Privileged    bool
	PublishAll    bool
	Publish       map[string]string
	RestartPolicy string // no|on-failure[:max-retries]|always|unless-stopped

	// CommonFields
	Name   string
	Before []string
	After  []string
}

type FileChange struct {
	Search  string   `yaml:"search"`            // line to search for
	Replace string   `yaml:"replace,omitempty"` // line to replace with
	Done    string   `yaml:"done"`
	If      []string // should probably convert this into some template logic
	// contains filtered or unexported fields
}

type FileInsert struct {

	// Name       string
	// MakeDir    bool `yaml:"make_dir"` // make the parent dir
	AfterLine  string
	BeforeLine string
	LineNum    int64
	Text       string
	// contains filtered or unexported fields
}

type FileLink struct {
	Target   string `yaml:"target"` // the target of the link
	Symbolic bool   `yaml:"symbolic"`
	// contains filtered or unexported fields
}

type FileTemplate struct {

	// Name         string      // file path
	// MakeDir      bool        `yaml:"make_dir"` // make the parent dir
	// User         string      // user/uid owner of the file
	// Group        string      // group/gid owner of the file
	// Mode         fs.FileMode // file mode TODO maybe default to 400?
	Text         string // text template
	TemplatePath string // path to a file to use instead of Text (unimpl)
	// contains filtered or unexported fields
}

type Group struct {
	// Name   string
	GID    uint64
	System bool
	// CommonFields
	Name   string
	Before []string
	After  []string
}

type HealthCheckOpts struct {
	Enabled     bool
	Command     string
	Interval    string
	Retries     int
	StartPeriod string
	Timeout     string
}

type Law interface {
	Ensure(bool) error
}

type LawNode struct {
	Law   Law
	Group string
	Type  string
	Name  string
}

type Laws3 struct {
	Users struct {
		Present []*User
	}
	Groups struct {
		Present []*Group
	}
	Packages struct {
		Installed []*Package
	}
	PackageRepos struct {
		Present []*PackageRepo
	} `yaml:"package_repos"`
	Containers struct {
		// FIXME revisit this naming
		Running []*Container
	}
	Scripts struct {
		Run []*Script
	}
	Files struct {
		Templates []*FileTemplate
		Inserts   []*FileInsert
		Changes   []*FileChange
		Links     []*FileLink
	}
	Mounts struct {
		Exists []*Mount
		Absent []*AbsentMount
	}
	Services struct {
		Enabled []*Service
	}
	SSH struct {
		AuthorizedKeys []*SSHKey `yaml:"authorized_keys"`
	} `yaml:"ssh"`
}

type LogOpts struct {
	Driver string // none|json-file|syslog|journald|gelf|fluentd|awslogs|splunk
	Opt    map[string]string
}

type Mount struct {
	// Name       string
	Spec       string
	MountPoint string `yaml:"mount_point"`
	Type       string
	Options    string
	Freq       int64
	Pass       int64
	Present    bool

	// CommonFields
	Name   string
	Before []string
	After  []string
}

type Package struct {
	// Name    string
	Version   string `yaml:",omitempty"`
	Installed bool   `yaml:",omitempty"` // whether the package should be installed or removed

	// CommonFields
	Name   string
	Before []string
	After  []string
}

type PackageRepo struct {
	// Name     string
	Key      string `yaml:"key"` // (gpg|etc) key to fetch and load into the system store
	Contents string // the repo URL usually
	// CommonFields
	Name   string // unique identifier, not used in the actual repo
	Before []string
	After  []string
}

type RetryOpts struct {
	Attempts uint // how many times to try to apply the law
	Until    bool // ??? copied from Salt, probably not necessary
	Interval uint // how long to wait between tries
	Splay    uint // how much variance to add to the interval, useful for thundering herd type scenarios
}

type Root struct {
	Name string
}

type SSHKey struct {
	Name   string
	Key    string
	User   string
	Before []string
	After  []string
}

type Script struct {
	// Name       string
	Shell      string
	Script     string
	Env        []string
	Args       []string
	WorkingDir string
	Creates    []string
	RunAs      string
	// CommonFields
	Name   string
	Before []string
	After  []string
}

type Service struct {
	// Name       string
	State      string `yaml:",omitempty"`
	Persistent bool   `yaml:",omitempty"`
	RunLevel   string `yaml:",omitempty"`

	// CommonFields
	Name   string
	Before []string
	After  []string
}

type User struct {
	// Name           string   “                       // the user's name
	UID            uint64   `yaml:",omitempty"`      // the user's UID, uint64 matches
	GID            uint64   `yaml:",omitempty"`      // The primary group ID
	Fullname       string   ``                       // part of the GECOS string
	Password       string   ``                       // the encrypted password
	HomeDir        string   ``                       // the user's $HOME
	Shell          string   ``                       // the system shell
	System         bool     ``                       // whether this is a system user or not
	Exists         bool     ``                       // Whether the user should exist on the system or not
	ExtraGroups    []string ``                       // required extra group names
	OptionalGroups []string `yaml:"optional_groups"` // if these groups exist already, add the user to them, otherwise ignore
	// CommonFields            //`yaml:",inline"` // CommonFields `yaml:"commonfields,inline"` // fields that are supported for everything, mostly dep related
	Name   string
	Before []string
	After  []string
}