database

Documentation

Overview

Package database contains plain old Go types used by GORM as database models with GORM-specific Go tags.

Index

• Variables
• type Artifact
• type Branch
• type Build
• type BuildParam
• type BuildStatus
  • func (buildStatus BuildStatus) IsValid() bool
• type Log
• type Param
• type Project
• type ProjectOverrides
• type Provider
• type SafeSQLName
• type TestResultDetail
• type TestResultStatus
• type TestResultSummary
• type TimeMetadata
• type Token

Variables

var ArtifactColumns = struct {
	ArtifactID SafeSQLName
	Name       SafeSQLName
	FileName   SafeSQLName
}{
	ArtifactID: "artifact_id",
	Name:       "name",
	FileName:   "file_name",
}

ArtifactColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var ArtifactFields = struct {
	BuildID  string
	Name     string
	FileName string
}{
	BuildID:  "BuildID",
	Name:     "Name",
	FileName: "FileName",
}

ArtifactFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var BranchColumns = struct {
	BranchID SafeSQLName
	Name     SafeSQLName
}{
	BranchID: "branch_id",
	Name:     "name",
}

BranchColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var BranchFields = struct {
	ProjectID string
	Name      string
	Default   string
	TokenID   string
}{
	ProjectID: "ProjectID",
	Name:      "Name",
	Default:   "Default",
	TokenID:   "TokenID",
}

BranchFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var BuildColumns = struct {
	BuildID     SafeSQLName
	StatusID    SafeSQLName
	ScheduledOn SafeSQLName
	StartedOn   SafeSQLName
	CompletedOn SafeSQLName
	GitBranch   SafeSQLName
	Environment SafeSQLName
	Stage       SafeSQLName
	IsInvalid   SafeSQLName
}{
	BuildID:     "build_id",
	StatusID:    "status_id",
	ScheduledOn: "scheduled_on",
	StartedOn:   "started_on",
	CompletedOn: "completed_on",
	GitBranch:   "git_branch",
	Environment: "environment",
	Stage:       "stage",
	IsInvalid:   "is_invalid",
}

BuildColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var BuildFields = struct {
	ProjectID           string
	StatusID            string
	GitBranch           string
	Environment         string
	Stage               string
	IsInvalid           string
	Params              string
	TestResultSummaries string
}{
	ProjectID:           "ProjectID",
	StatusID:            "StatusID",
	GitBranch:           "GitBranch",
	Environment:         "Environment",
	Stage:               "Stage",
	IsInvalid:           "IsInvalid",
	Params:              "Params",
	TestResultSummaries: "TestResultSummaries",
}

BuildFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var BuildParamFields = struct {
	Value string
}{
	Value: "Value",
}

BuildParamFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var ParamFields = struct {
	Value        string
	DefaultValue string
}{
	Value:        "Value",
	DefaultValue: "DefaultValue",
}

ParamFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var ProjectColumns = struct {
	ProjectID       SafeSQLName
	RemoteProjectID SafeSQLName
	Name            SafeSQLName
	GroupName       SafeSQLName
	Description     SafeSQLName
	TokenID         SafeSQLName
	GitURL          SafeSQLName
}{
	ProjectID:       "project_id",
	RemoteProjectID: "remote_project_id",
	Name:            "name",
	GroupName:       "group_name",
	Description:     "description",
	TokenID:         "token_id",
	GitURL:          "git_url",
}

ProjectColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var ProjectFields = struct {
	ProjectID       string
	RemoteProjectID string
	Name            string
	GroupName       string
	Description     string
	AvatarURL       string
	TokenID         string
	Token           string
	ProviderID      string
	Provider        string
	BuildDefinition string
	Branches        string
	GitURL          string
	Overrides       string
}{
	ProjectID:       "ProjectID",
	Name:            "Name",
	GroupName:       "GroupName",
	Description:     "Description",
	AvatarURL:       "AvatarURL",
	TokenID:         "TokenID",
	Token:           "Token",
	ProviderID:      "ProviderID",
	Provider:        "Provider",
	BuildDefinition: "BuildDefinition",
	Branches:        "Branches",
	GitURL:          "GitURL",
	Overrides:       "Overrides",
}

ProjectFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var ProviderColumns = struct {
	ProviderID SafeSQLName
	Name       SafeSQLName
	URL        SafeSQLName
	TokenID    SafeSQLName
}{
	ProviderID: "provider_id",
	Name:       "name",
	URL:        "url",
	TokenID:    "token_id",
}

ProviderColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var ProviderFields = struct {
	ProviderID string
	Name       string
	URL        string
	TokenID    string
}{
	ProviderID: "ProviderID",
	Name:       "Name",
	URL:        "URL",
	TokenID:    "TokenID",
}

ProviderFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var TestResultSummaryFields = struct {
	FileName string
}{
	FileName: "FileName",
}

TestResultSummaryFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

var TokenColumns = struct {
	TokenID  SafeSQLName
	Token    SafeSQLName
	UserName SafeSQLName
}{
	TokenID:  "token_id",
	Token:    "token",
	UserName: "user_name",
}

TokenColumns holds the DB column names for each field. Useful in GORM .Order() statements to order the results based on a specific column, which does not support the regular Go field names.

var TokenFields = struct {
	TokenID  string
	Token    string
	UserName string
}{
	TokenID:  "TokenID",
	Token:    "Token",
	UserName: "UserName",
}

TokenFields holds the Go struct field names for each field. Useful in GORM .Where() statements to only select certain fields or in GORM Preload statements to select the correct field to preload.

Types

type Artifact

type Artifact struct {
	TimeMetadata
	ArtifactID uint   `gorm:"primaryKey"`
	BuildID    uint   `gorm:"not null;index:artifact_idx_build_id"`
	Build      *Build `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Name       string `gorm:"not null"`
	FileName   string `gorm:"not null;default:''"`
	Data       []byte `gorm:"nullable"`
}

Artifact holds the binary data as well as metadata about that binary such as the file name and which build it belongs to.

type Branch

type Branch struct {
	TimeMetadata
	BranchID  uint     `gorm:"primaryKey"`
	ProjectID uint     `gorm:"not null;index:branch_idx_project_id"`
	Project   *Project `gorm:"foreignKey:ProjectID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Name      string   `gorm:"not null"`
	Default   bool     `gorm:"not null"`
	TokenID   uint     `gorm:"nullable;default:NULL;index:branch_idx_token_id"`
	Token     Token    `gorm:"foreignKey:TokenID;constraint:OnUpdate:RESTRICT,OnDelete:RESTRICT"`
}

Branch is a single branch in the VCS that can be targeted during builds. For example a Git branch.

type Build

type Build struct {
	TimeMetadata
	BuildID             uint                `gorm:"primaryKey"`
	StatusID            BuildStatus         `gorm:"not null"`
	ProjectID           uint                `gorm:"not null;index:build_idx_project_id"`
	Project             *Project            `gorm:"foreignKey:ProjectID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	ScheduledOn         null.Time           `gorm:"nullable;default:NULL"`
	StartedOn           null.Time           `gorm:"nullable;default:NULL"`
	CompletedOn         null.Time           `gorm:"nullable;default:NULL"`
	GitBranch           string              `gorm:"size:300;not null;default:''"`
	Environment         null.String         `gorm:"nullable;size:40" swaggertype:"string"`
	Stage               string              `gorm:"size:40;not null;default:''"`
	Params              []BuildParam        `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	IsInvalid           bool                `gorm:"not null;default:false"`
	TestResultSummaries []TestResultSummary `gorm:"foreignKey:BuildID"`
}

Build holds data about the state of a build. Which parameters was used to start it, what status it holds, et.al.

type BuildParam

type BuildParam struct {
	BuildParamID uint   `gorm:"primaryKey"`
	BuildID      uint   `gorm:"not null;index:buildparam_idx_build_id"`
	Build        *Build `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Name         string `gorm:"not null"`
	Value        string `gorm:"not null;default:''"`
}

BuildParam holds the name and value of an input parameter fed into a build.

type BuildStatus

type BuildStatus int

BuildStatus is an enum of different states for a build.

const (
	// BuildScheduling means the build has been registered, but no code
	// execution has begun yet. This is usually quite an ephemeral state.
	BuildScheduling BuildStatus = iota
	// BuildRunning means the build is executing right now. The execution
	// engine has load in the target code paths and repositories.
	BuildRunning
	// BuildCompleted means the build has finished execution successfully.
	BuildCompleted
	// BuildFailed means that something went wrong with the build. Could be a
	// misconfiguration in the .wharf-ci.yml file, or perhaps a scripting error
	// in some build step.
	BuildFailed
)

func (BuildStatus) IsValid

func (buildStatus BuildStatus) IsValid() bool

IsValid returns false if the underlying type is an unknown enum value.

BuildScheduling.IsValid()   // => true
(BuildStatus(-1)).IsValid() // => false

type Log

type Log struct {
	LogID     uint      `gorm:"primaryKey"`
	BuildID   uint      `gorm:"not null;index:log_idx_build_id"`
	Build     *Build    `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Message   string    `sql:"type:text"`
	Timestamp time.Time `gorm:"not null"`
}

Log is a single logged line for a build.

type Param

type Param struct {
	ParamID      int    `gorm:"primaryKey"`
	Name         string `gorm:"not null"`
	Type         string `gorm:"not null"`
	Value        string `gorm:"not null;default:''"`
	DefaultValue string `gorm:"not null;default:''"`
}

Param holds the definition of an input parameter for a project.

type Project

type Project struct {
	TimeMetadata
	ProjectID       uint      `gorm:"primaryKey"`
	RemoteProjectID string    `gorm:"not null;default:''"`
	Name            string    `gorm:"size:500;not null"`
	GroupName       string    `gorm:"size:500;not null;default:''"`
	Description     string    `gorm:"size:500;not null;default:''"`
	AvatarURL       string    `gorm:"size:500;not null;default:''"`
	TokenID         *uint     `gorm:"nullable;default:NULL;index:project_idx_token_id"`
	Token           *Token    `gorm:"foreignKey:TokenID;constraint:OnUpdate:RESTRICT,OnDelete:RESTRICT"`
	ProviderID      *uint     `gorm:"nullable;default:NULL;index:project_idx_provider_id"`
	Provider        *Provider `gorm:"foreignKey:ProviderID;constraint:OnUpdate:RESTRICT,OnDelete:RESTRICT"`
	BuildDefinition string    `gorm:"not null;default:''"`
	Branches        []Branch  `gorm:"foreignKey:ProjectID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	GitURL          string    `gorm:"not null;default:''"`

	Overrides ProjectOverrides `gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
}

Project holds data about an imported project. A lot of the data is expected to be populated with data from the remote provider, such as the description and avatar.

type ProjectOverrides

type ProjectOverrides struct {
	ProjectOverridesID uint   `gorm:"primaryKey"`
	ProjectID          uint   `gorm:"foreignKey:ProjectID;uniqueIndex:project_overrides_idx_project_id"`
	Description        string `gorm:"size:500;not null;default:''"`
	AvatarURL          string `gorm:"size:500;not null;default:''"`
	GitURL             string `gorm:"not null;default:''"`
}

ProjectOverrides holds data about a project's overridden values.

type Provider

type Provider struct {
	TimeMetadata
	ProviderID uint   `gorm:"primaryKey"`
	Name       string `gorm:"size:20;not null"`
	URL        string `gorm:"size:500;not null"`
	TokenID    uint   `gorm:"nullable;default:NULL;index:provider_idx_token_id"`
	Token      *Token `gorm:"foreignKey:TokenID;constraint:OnUpdate:RESTRICT,OnDelete:RESTRICT"`
}

Provider holds metadata about a connection to a remote provider. Some of importance are the URL field of where to find the remote, and the token field used to authenticate.

type SafeSQLName

type SafeSQLName string

SafeSQLName represents a value that is safe to use as an SQL table or column name without the need of escaping.

It is merely semantical and has no validation attached. Values of this type should never be constructed from user input.

type TestResultDetail

type TestResultDetail struct {
	TimeMetadata
	TestResultDetailID uint             `gorm:"primaryKey"`
	ArtifactID         uint             `gorm:"not null;index:testresultdetail_idx_artifact_id"`
	Artifact           *Artifact        `gorm:"foreignKey:ArtifactID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL"`
	BuildID            uint             `gorm:"not null;index:testresultdetail_idx_build_id"`
	Build              *Build           `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Name               string           `gorm:"not null"`
	Message            null.String      `gorm:"nullable"`
	StartedOn          null.Time        `gorm:"nullable;default:NULL;"`
	CompletedOn        null.Time        `gorm:"nullable;default:NULL;"`
	Status             TestResultStatus `gorm:"not null"`
}

TestResultDetail contains data about a single test in a test result file.

type TestResultStatus

type TestResultStatus string

TestResultStatus is an enum of different states a test result can be in.

const (
	// TestResultStatusSuccess means the test succeeded.
	TestResultStatusSuccess TestResultStatus = "Success"
	// TestResultStatusFailed means the test failed.
	TestResultStatusFailed TestResultStatus = "Failed"
	// TestResultStatusSkipped means the test was skipped.
	TestResultStatusSkipped TestResultStatus = "Skipped"
)

type TestResultSummary

type TestResultSummary struct {
	TimeMetadata
	TestResultSummaryID uint      `gorm:"primaryKey"`
	FileName            string    `gorm:"not null;default:''"`
	ArtifactID          uint      `gorm:"not null;index:testresultsummary_idx_artifact_id"`
	Artifact            *Artifact `gorm:"foreignKey:ArtifactID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL"`
	BuildID             uint      `gorm:"not null;index:testresultsummary_idx_build_id"`
	Build               *Build    `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Total               uint      `gorm:"not null"`
	Failed              uint      `gorm:"not null"`
	Passed              uint      `gorm:"not null"`
	Skipped             uint      `gorm:"not null"`
}

TestResultSummary contains data about a single test result file.

type TimeMetadata

type TimeMetadata struct {
	CreatedAt *time.Time `gorm:"nullable"`
	UpdatedAt *time.Time `gorm:"nullable"`
}

TimeMetadata contains fields that GORM will recognize and update automatically for us.

Docs: https://gorm.io/docs/models.html#Creating-Updating-Time-Unix-Milli-Nano-Seconds-Tracking

type Token

type Token struct {
	TimeMetadata
	TokenID  uint   `gorm:"primaryKey"`
	Token    string `gorm:"size:500;not null"`
	UserName string `gorm:"size:500;not null;default:''"`
}

Token holds credentials for a remote provider.