types

type Auth struct {
	Token     string `orm:"pk;size(36)" json:"token"` // Internal token token.
	CreatedAt Time   `orm:"auto_now_add" json:"created_at"`
	User      *User  `orm:"rel(fk)" json:"user"`
	CodeToken string `orm:"null;size(40)" json:"code_token"` // API Token for Code Service. Can be null if auth doesn't support it.
}

type Clock struct {
	Hour   int `json:"hour"`
	Minute int `json:"minute"`
}

type Commit struct {
	ID          uint64 `orm:"pk;auto;column(id)" json:"id,string"`
	CreatedAt   Time   `orm:"auto_now_add;null" json:"created_at"`
	SHA         string `orm:"unique;column(sha)" json:"sha"`
	Message     string `json:"message"`
	Branch      string `json:"branch" orm:"-"`
	AuthorName  string `json:"author_name"`
	AuthorEmail string `json:"author_email"`
	URL         string `orm:"column(url)" json:"url"`
}

type CommitsByID []*Commit

type Config struct {
	ID uint64 `orm:"pk;auto;column(id)" json:"-"`

	// Current mode
	Mode Mode `json:"mode"`

	// JSON string for configuration, like the CloseTime config.
	// See: shared/types/options.go.
	Options Options `json:"options"`
}

type Interval struct {
	// contains filtered or unexported fields
}

type Intervals []Interval

type Job struct {
	ID          uint64    `orm:"pk;auto;column(id)" json:"id,string"`
	StartedAt   Time      `orm:"null" json:"started_at"`
	CompletedAt Time      `orm:"null" json:"completed_at"`
	URL         *string   `orm:"column(url);null" json:"url"` // Link to this job
	Name        string    `json:"name"`                       // e.g. Delivery, Test, Build
	Result      JobResult `json:"result"`                     // Exit status
	Metadata    string    `orm:"null" json:"metadata"`        // JSON data
	Phase       *Phase    `orm:"rel(fk)" json:"-"`
}

type JobResult int

type Jobs []*Job

type JobsByID []*Job

type Metadata struct {
	Namespace string `orm:"pk;unique" json:"key"`
	Data      string `orm:"type(jsonb)" json:"data"`
}

type Mode int

type Moment interface {
	Weekday() time.Weekday
	Clock() (hour, minute, second int)
}

type Options struct {
	// CloseTime is when trains should be automatically closed.
	// This is defined as an array of TimeIntervals.
	// Example: M-F 9-5.
	//  []TimeInterval{
	//      TimeInterval{
	//          Every: []time.Weekday{
	//              time.Monday, time.Tuesday, time.Wednesday, time.Thursday, time.Friday},
	//          StartTime: Clock{Hour: 9, Minute: 0},
	//          EndTime: Clock{Hour: 17, Minute: 0},
	//      },
	//  }
	CloseTime            RepeatingTimeIntervals `json:"close_time"`
	ValidationError      error                  `orm:"-" json:"-"`
	InvalidOptionsString string                 `orm:"-" json:"-"`
}

type Phase struct {
	ID          uint64    `orm:"pk;auto;column(id)" json:"id,string"`
	StartedAt   Time      `orm:"null" json:"started_at"`
	CompletedAt Time      `orm:"null" json:"completed_at"`
	Type        PhaseType `json:"type"` // delivery|verification|deploy
	Error       string    `orm:"null" json:"error"`
	Jobs        Jobs      `orm:"reverse(many)" json:"jobs"`

	// Computed fields
	PhaseGroup *PhaseGroup `orm:"-" json:"-"`
	Train      *Train      `orm:"-" json:"-"`
}

type PhaseGroup struct {
	ID           uint64 `orm:"pk;auto;column(id)" json:"id,string"`
	HeadSHA      string `orm:"column(head_sha)" json:"head_sha"`
	Delivery     *Phase `orm:"rel(fk)" json:"delivery"`
	Verification *Phase `orm:"rel(fk)" json:"verification"`
	Deploy       *Phase `orm:"rel(fk)" json:"deploy"`

	Train *Train `orm:"rel(fk);null" json:"-"`
}

type PhaseType int

type RepeatingTimeInterval struct {
	Every     []time.Weekday `json:"every"`
	StartTime Clock          `json:"start_time"`
	EndTime   Clock          `json:"end_time"`
}

type RepeatingTimeIntervals []RepeatingTimeInterval

type Search struct {
	Params  map[string]string `json:"params"`
	Results interface{}       `json:"results"`
}

type Ticket struct {
	ID            uint64    `orm:"pk;auto;column(id)" json:"id,string"`
	Key           string    `json:"key"`
	Summary       string    `json:"summary"`
	AssigneeEmail string    `json:"assignee_email"`
	AssigneeName  string    `json:"assignee_name"`
	URL           string    `orm:"column(url)" json:"url"`
	CreatedAt     Time      `orm:"auto_now_add" json:"created_at"`
	ClosedAt      Time      `orm:"null" json:"closed_at"`
	DeletedAt     Time      `orm:"null" json:"deleted_at"`
	Commits       []*Commit `orm:"rel(m2m)" json:"commits"`
	Train         *Train    `orm:"rel(fk)" json:"-"`
}

type TicketsByID []*Ticket

type Time struct {
	Value time.Time
}

type TimeInterval interface {
	Includes(time.Time) bool
}

type Train struct {
	ID               uint64        `orm:"pk;auto;column(id)" json:"id,string"`
	Engineer         *User         `orm:"rel(fk);null" json:"engineer"`
	CreatedAt        Time          `orm:"auto_now_add" json:"created_at"`
	DeployedAt       Time          `orm:"null" json:"deployed_at"`
	CancelledAt      Time          `orm:"null" json:"cancelled_at"`
	Closed           bool          `json:"closed"`
	ScheduleOverride bool          `json:"schedule_override"`
	Blocked          bool          `json:"blocked"`
	BlockedReason    *string       `orm:"null" json:"blocked_reason"`
	Branch           string        `json:"branch"`
	HeadSHA          string        `orm:"column(head_sha)" json:"head_sha"`
	TailSHA          string        `orm:"column(tail_sha)" json:"tail_sha"`
	Commits          []*Commit     `orm:"rel(m2m)" json:"commits"`      // Commits on this train.
	Tickets          []*Ticket     `orm:"reverse(many)" json:"tickets"` // Who's got a ticket to ride?
	ActivePhases     *PhaseGroup   `orm:"rel(fk)" json:"active_phases"`
	AllPhaseGroups   []*PhaseGroup `orm:"reverse(many)" json:"all_phase_groups"`

	// Computed fields
	ActivePhase         PhaseType `orm:"-" json:"active_phase"`
	LastDeliveredSHA    *string   `orm:"-" json:"last_delivered_sha"` // SHA for last successful delivery.
	PreviousID          *uint64   `orm:"-" json:"previous_id,string"`
	NextID              *uint64   `orm:"-" json:"next_id,string"`
	NotDeployableReason *string   `orm:"-" json:"not_deployable_reason"`
	Done                bool      `orm:"-" json:"done"`
	PreviousTrainDone   bool      `orm:"-" json:"previous_train_done"`
	CanRollback         bool      `orm:"-" json:"can_rollback"`
}

type User struct {
	ID        uint64 `orm:"pk;auto;column(id)" json:"id,string"`
	CreatedAt Time   `orm:"auto_now_add" json:"created_at"`
	Name      string `json:"name"`
	Email     string `orm:"unique" json:"email"`
	AvatarURL string `orm:"column(avatar_url)" json:"avatar_url"`
	Token     string `orm:"-" json:"-"`
	IsAdmin   bool   `orm:"-" json:"is_admin"`
}