model

type DockerRegistry struct {
	Id                   string `json:"id"`
	Name                 string `json:"name"`
	Url                  string `json:"url"`
	User                 string `json:"user"`
	Password             string `json:"password"`
	LastModificationTime string `json:"lastModificationTime"`
}

type DockerRegistryUpdate struct {
	DockerRegistry
	ChangedFields []string `json:"changedFields"`
}

type Event struct {
	Type        EventType `json:"type"`
	ExecutionId string    `json:"execution-id"`
	Value       string    `json:"value"`
}

type EventType string

type ExecutionStatus string

type GitConfig struct {
	HttpAuth *HttpAuthConfig `json:"httpAuth"`
	SshAuth  *SshAuthConfig  `json:"sshAuth"`
}

type HttpAuthConfig struct {
	Url      string `json:"url"`
	User     string `json:"user"`
	Password string `json:"password"`
}

type Image struct {
	Name       string // Name of the image
	RegistryId string // external key to a registry configuration
	Registry   *DockerRegistry
}

type Job struct {
	Id              []byte         `json:"id"`              // id of the job
	Name            string         `json:"name"`            // simple label used for display
	GitConf         GitConfig      `json:"gitConfig"`       // repository configuration
	Steps           []Step         `json:"steps"`           // job steps execution
	Executions      []JobExecution `json:"executions"`      // list of past executions that are still available
	RemoveWorkspace bool           `json:"removeWorkspace"` // if true, the workspace is removed after every execution of the job
}

type JobExecution struct {
	Id         string // the id of this execution Job. Used to update on particular execution
	BranchName string
	VolumeName string           // the name of the volume where the workspace is stored
	Steps      []*StepExecution // execution of step related to that job execution
	Date       time.Time        // the instant when the job execution has start
	Duration   time.Duration    // global duration of the job execution
}

type Login struct {
	Id       string `json:"id"`
	Password string `json:"password"`
}

type Port struct {
	Num       int
	Prototype string
}

type PublicModel interface {
	ToPublicModel()
}

type Service struct {
	Name         string  // name under wich the service will be available during the step
	Image        Image   // container image
	ExposedPorts []*Port // exposed ports
}

type SshAuthConfig struct {
	Url         string `json:"url"`
	Key         string `json:"key"`
	KeyPassword string `json:"keyPassword"`
}

type Step struct {
	Name          string // display name of the step
	Image         Image  // the image that contains the needed dependencies for this step (node, golang, java, etc...)
	Envs          map[string]string
	Command       []string   // the command of the step
	MountingPoint string     // the place where the volume should be mounted. TODO think of a default value ?
	Services      []*Service // services that are needed for this step. For example a Database for an integration tests step.
}

type StepExecution struct {
	Name     string
	Status   ExecutionStatus // status of the step execution
	Duration time.Duration   // global duration of the step execution
	Logs     string          // logs attached to the step
}

type Token struct {
	Value string `json:"value"`
}

type User struct {
	Login    string `json:"login"`
	Password []byte // unexported and excluded from json marshaling
}