server

Documentation

Index

• Constants
• func ApiListBuildHistory(inb *miso.Inbound, req ApiListBuildHistoryReq) (miso.PageRes[ApiListBuildHistoryRes], error)
• func ApiListBuildInfos(inb *miso.Inbound, req miso.Paging) (miso.PageRes[ApiListBuildInfoRes], error)
• func ApiListBuildNames(inb *miso.Inbound) ([]string, error)
• func ApiTriggerBuild(inb *miso.Inbound, req ApiTriggerBuildReq) (any, error)
• func BashRun(rail miso.Rail, script []byte) (string, error)
• func BootstrapServer()
• func CheckBuildsConf(bu Builds) error
• func EnableBasicAuth()
• func InitBuildInfo(rail miso.Rail, builds Builds, db *gorm.DB) error
• func InitBuildStatusMap(bu Builds)
• func LastNStr(s string, n int) string
• func ListBuildHistory(rail miso.Rail, req ApiListBuildHistoryReq, db *gorm.DB) (miso.PageRes[ApiListBuildHistoryRes], error)
• func ListBuildInfos(rail miso.Rail, page miso.Paging, db *gorm.DB) (miso.PageRes[ApiListBuildInfoRes], error)
• func LookupBuildScript(path string) ([]byte, error)
• func PostServerBootstrap(rail miso.Rail) error
• func PreServerBootstrap(rail miso.Rail) error
• func RegisterEndpoints(rail miso.Rail)
• func RunBuildCmd(rail miso.Rail, cmd BuildCmd) (string, error)
• func SaveCmdLog(rail miso.Rail, db *gorm.DB, buildNo string, cmd string, status string, ...) error
• func TriggerBuild(rail miso.Rail, req ApiTriggerBuildReq, db *gorm.DB) error
• func UpdateBuildStatus(rail miso.Rail, db *gorm.DB, p UpdateBuildStatusParam) error
• type ApiCmdLogRes
• type ApiListBuildHistoryReq
• type ApiListBuildHistoryRes
• type ApiListBuildInfoRes
• type ApiQryBuildHistDetailReq
• type ApiQryBuildHistDetailRes
  • func ApiQryBuildHistoryDetails(inb *miso.Inbound, req ApiQryBuildHistDetailReq) (ApiQryBuildHistDetailRes, error)
  • func QryBuildHistDetails(rail miso.Rail, db *gorm.DB, req ApiQryBuildHistDetailReq) (ApiQryBuildHistDetailRes, error)
• type ApiTriggerBuildReq
• type BuildCmd
  • func (b BuildCmd) IsEmpty() bool
• type BuildConf
• type Builds
  • func LoadBuilds() Builds
  • func (b Builds) Find(name string) (BuildConf, bool)
• type UpdateBuildStatusParam

Constants

const (
	PropUsername = "auth.basic.username"
	PropPassword = "auth.basic.password"
)

const (
	PropScriptsBaseFolder = "scripts.base-folder"

	StatusSuccessful = "SUCCESSFUL"
	StatusBuilding   = "BUILDING"
	StatusFailed     = "FAILED"
)

Functions

func ApiListBuildHistory

func ApiListBuildHistory(inb *miso.Inbound, req ApiListBuildHistoryReq) (miso.PageRes[ApiListBuildHistoryRes], error)

func ApiListBuildInfos

func ApiListBuildInfos(inb *miso.Inbound, req miso.Paging) (miso.PageRes[ApiListBuildInfoRes], error)

func ApiListBuildNames

func ApiListBuildNames(inb *miso.Inbound) ([]string, error)

func ApiTriggerBuild

func ApiTriggerBuild(inb *miso.Inbound, req ApiTriggerBuildReq) (any, error)

func BashRun

func BashRun(rail miso.Rail, script []byte) (string, error)

func BootstrapServer

func BootstrapServer()

func CheckBuildsConf

func CheckBuildsConf(bu Builds) error

func EnableBasicAuth

func EnableBasicAuth()

func InitBuildInfo

func InitBuildInfo(rail miso.Rail, builds Builds, db *gorm.DB) error

func InitBuildStatusMap

func InitBuildStatusMap(bu Builds)

func LastNStr

func LastNStr(s string, n int) string

func ListBuildHistory

func ListBuildHistory(rail miso.Rail, req ApiListBuildHistoryReq, db *gorm.DB) (miso.PageRes[ApiListBuildHistoryRes], error)

func ListBuildInfos

func ListBuildInfos(rail miso.Rail, page miso.Paging, db *gorm.DB) (miso.PageRes[ApiListBuildInfoRes], error)

func LookupBuildScript

func LookupBuildScript(path string) ([]byte, error)

Lookup build script under the specified folder.

func PostServerBootstrap

func PostServerBootstrap(rail miso.Rail) error

func PreServerBootstrap

func PreServerBootstrap(rail miso.Rail) error

func RegisterEndpoints

func RegisterEndpoints(rail miso.Rail)

func RunBuildCmd

func RunBuildCmd(rail miso.Rail, cmd BuildCmd) (string, error)

func SaveCmdLog

func SaveCmdLog(rail miso.Rail, db *gorm.DB, buildNo string, cmd string, status string, remark string) error

func TriggerBuild

func TriggerBuild(rail miso.Rail, req ApiTriggerBuildReq, db *gorm.DB) error

func UpdateBuildStatus

func UpdateBuildStatus(rail miso.Rail, db *gorm.DB, p UpdateBuildStatusParam) error

Types

type ApiCmdLogRes

type ApiCmdLogRes struct {
	Id      int    `desc:"command log id"`
	Command string `desc:"command"`
	Remark  string `desc:"remark"`
	Status  string `desc:"execution status"`
}

type ApiListBuildHistoryReq

type ApiListBuildHistoryReq struct {
	Name   string `desc:"build name" vaild:"notEmpty"`
	Paging miso.Paging
}

type ApiListBuildHistoryRes

type ApiListBuildHistoryRes struct {
	Id        int        `desc:"build history id"`
	Name      string     `desc:"build name"`
	BuildNo   string     `desc:"build no"`
	CommitId  string     `desc:"build commit id"`
	Tag       string     `desc:"tag"`
	Status    string     `desc:"built status"`
	StartTime util.ETime `desc:"build start time"`
	EndTime   util.ETime `desc:"build end time"`
}

type ApiListBuildInfoRes

type ApiListBuildInfoRes struct {
	Id          int        `desc:"build info id"`
	Name        string     `desc:"build name"`
	Status      string     `desc:"last build status"`
	Ctime       util.ETime `desc:"create time"`
	Utime       util.ETime `desc:"update time"`
	CommitId    string     `desc:"last build commit id"`
	Tag         string     `desc:"tag"`
	BuildSteps  []string   `gorm:"-" desc:"build steps"`
	Triggerable bool       `gorm:"-" desc:"whether the build is triggerable"`
}

type ApiQryBuildHistDetailReq

type ApiQryBuildHistDetailReq struct {
	BuildNo string `desc:"build no" vaild:"notEmpty"`
}

type ApiQryBuildHistDetailRes

type ApiQryBuildHistDetailRes struct {
	Id          int            `desc:"build history id"`
	Name        string         `desc:"build name"`
	BuildNo     string         `desc:"build no"`
	CommitId    string         `desc:"build commit id"`
	Tag         string         `desc:"tag"`
	Status      string         `desc:"built status"`
	StartTime   util.ETime     `desc:"build start time"`
	EndTime     util.ETime     `desc:"build end time"`
	Remark      string         `desc:"remark"`
	CommandLogs []ApiCmdLogRes `desc:"commands execution log"`
}

func ApiQryBuildHistoryDetails

func ApiQryBuildHistoryDetails(inb *miso.Inbound, req ApiQryBuildHistDetailReq) (ApiQryBuildHistDetailRes, error)

func QryBuildHistDetails

func QryBuildHistDetails(rail miso.Rail, db *gorm.DB, req ApiQryBuildHistDetailReq) (ApiQryBuildHistDetailRes, error)

type ApiTriggerBuildReq

type ApiTriggerBuildReq struct {
	Name string `desc:"build name" vaild:"notEmpty"`
}

type BuildCmd

type BuildCmd struct {
	Script  string
	Command string
}

func (BuildCmd) IsEmpty

func (b BuildCmd) IsEmpty() bool

type BuildConf

type BuildConf struct {
	Name    string
	GitRepo string `mapstructure:"git-repo"`
	Steps   []BuildCmd
}

type Builds

type Builds struct {
	Builds []BuildConf `mapstructure:"build"`
}

func LoadBuilds

func LoadBuilds() Builds

func (Builds) Find

func (b Builds) Find(name string) (BuildConf, bool)

type UpdateBuildStatusParam

type UpdateBuildStatusParam struct {
	BuildNo   string
	Name      string
	Status    string
	Remark    string
	CommitId  string
	Tag       string
	StartTime util.ETime
	EndTime   util.ETime
}