api

Documentation

Index

• Constants
• func AddOutputData(key string, data interface{})
• func FinishBuild(status Status, msg string)
• func FinishBuildWithErrorCode(status Status, msg string, errorCode int)
• func GenUrl(path string) string
• func GetBkSensitiveConfInfo() map[string]string
• func GetGateWayHost() string
• func GetInputParam(name string) string
• func GetOutputData(key string) interface{}
• func GetPipelineBuildId() string
• func GetPipelineBuildNumber() string
• func GetPipelineId() string
• func GetPipelineName() string
• func GetPipelineStartTimeMills() string
• func GetPipelineStartType() string
• func GetPipelineStartUserId() string
• func GetPipelineStartUserName() string
• func GetPipelineTaskId() string
• func GetPipelineUpdateUserName() string
• func GetPipelineVersion() string
• func GetProjectDisplayName() string
• func GetProjectName() string
• func GetSdkHeader() map[string]string
• func GetTestVersionFlag() string
• func GetWorkspace() string
• func LoadInputParam(v interface{}) error
• func RemoveOutputData(key string)
• func SetAtomOutputType(atomOutputType string)
• func WriteOutput() error
• type ArtifactData
  • func NewArtifactData() *ArtifactData
  • func (a *ArtifactData) AddArtifact(artifact string)
  • func (a *ArtifactData) AddArtifactAll(artifacts []string)
• type AtomBaseParam
• type AtomOutput
  • func NewAtomOutput() *AtomOutput
• type BuildType
• type DataType
• type ReportData
  • func NewReportData(label string, path string, target string) *ReportData
• type SdkEnv
• type Status
• type StringData
  • func NewStringData(value string) *StringData

Constants

const (
	AuthHeaderBuildId              = "X-SODA-BID"
	AuthHeaderProjectId            = "X-SODA-PID"
	AuthHeaderDevopsBuildType      = "X-DEVOPS-BUILD-TYPE"
	AuthHeaderDevopsProjectId      = "X-DEVOPS-PROJECT-ID"
	AuthHeaderDevopsBuildId        = "X-DEVOPS-BUILD-ID"
	AuthHeaderDevopsVmSeqId        = "X-DEVOPS-VM-SID"
	AuthHeaderDevopsAgentId        = "X-DEVOPS-AGENT-ID"
	AuthHeaderDevopsAgentSecretKey = "X-DEVOPS-AGENT-SECRET-KEY"
)

const (
	DataDirEnv    = "bk_data_dir"
	InputFileEnv  = "bk_data_input"
	OutputFileEnv = "bk_data_output"
)

const (
	BuildTypeWorker      = "WORKER"
	BuildTypeAgent       = "AGENT"
	BuildTypePluginAgent = "PLUGIN_AGENT"
	BuildTypeDocker      = "DOCKER"
	BuildTypeDockerHost  = "DOCKER_HOST"
	BuildTypeTstackAgent = "TSTACK_AGENT"
)

Functions

func AddOutputData

func AddOutputData(key string, data interface{})

func FinishBuild

func FinishBuild(status Status, msg string)

func FinishBuildWithErrorCode

func FinishBuildWithErrorCode(status Status, msg string, errorCode int)

func GenUrl

func GenUrl(path string) string

func GetBkSensitiveConfInfo

func GetBkSensitiveConfInfo() map[string]string

func GetGateWayHost

func GetGateWayHost() string

func GetInputParam

func GetInputParam(name string) string

func GetOutputData

func GetOutputData(key string) interface{}

func GetPipelineBuildId

func GetPipelineBuildId() string

func GetPipelineBuildNumber

func GetPipelineBuildNumber() string

func GetPipelineId

func GetPipelineId() string

func GetPipelineName

func GetPipelineName() string

func GetPipelineStartTimeMills

func GetPipelineStartTimeMills() string

func GetPipelineStartType

func GetPipelineStartType() string

func GetPipelineStartUserId

func GetPipelineStartUserId() string

func GetPipelineStartUserName

func GetPipelineStartUserName() string

func GetPipelineTaskId

func GetPipelineTaskId() string

func GetPipelineUpdateUserName

func GetPipelineUpdateUserName() string

func GetPipelineVersion

func GetPipelineVersion() string

func GetProjectDisplayName

func GetProjectDisplayName() string

func GetProjectName

func GetProjectName() string

func GetSdkHeader

func GetSdkHeader() map[string]string

func GetTestVersionFlag

func GetTestVersionFlag() string

func GetWorkspace

func GetWorkspace() string

func LoadInputParam

func LoadInputParam(v interface{}) error

func RemoveOutputData

func RemoveOutputData(key string)

func SetAtomOutputType

func SetAtomOutputType(atomOutputType string)

func WriteOutput

func WriteOutput() error

Types

type ArtifactData

type ArtifactData struct {
	Type  DataType `json:"type"`
	Value []string `json:"value"`
}

func NewArtifactData

func NewArtifactData() *ArtifactData

func (*ArtifactData) AddArtifact

func (a *ArtifactData) AddArtifact(artifact string)

func (*ArtifactData) AddArtifactAll

func (a *ArtifactData) AddArtifactAll(artifacts []string)

type AtomBaseParam

type AtomBaseParam struct {
	PipelineVersion        string            `json:"BK_CI_PIPELINE_VERSION"`
	ProjectName            string            `json:"BK_CI_PROJECT_NAME"`
	ProjectNameCn          string            `json:"BK_CI_PROJECT_NAME_CN"`
	PipelineId             string            `json:"BK_CI_PIPELINE_ID"`
	PipelineBuildNum       string            `json:"BK_CI_BUILD_NUM"`
	PipelineBuildId        string            `json:"BK_CI_BUILD_ID"`
	PipelineName           string            `json:"BK_CI_PIPELINE_NAME"`
	PipelineStartTimeMills string            `json:"BK_CI_BUILD_START_TIME"`
	PipelineStartType      string            `json:"BK_CI_START_TYPE"`
	PipelineStartUserId    string            `json:"BK_CI_START_USER_ID"`
	PipelineStartUserName  string            `json:"BK_CI_START_USER_NAME"`
	BkWorkspace            string            `json:"bkWorkspace"`
	TestVersionFlag        string            `json:"testVersionFlag"`
	BkSensitiveConfInfo    map[string]string `json:"bkSensitiveConfInfo"`
	PipelineTaskId         string            `json:"BK_CI_BUILD_TASK_ID"`
	PipelineUpdateUserName string            `json:"BK_CI_PIPELINE_UPDATE_USER"`
}

type AtomOutput

type AtomOutput struct {
	Status    Status                 `json:"status"`
	Message   string                 `json:"message"`
	ErrorCode int                    `json:"errorCode"`
	Type      string                 `json:"type"`
	Data      map[string]interface{} `json:"data"`
}

func NewAtomOutput

func NewAtomOutput() *AtomOutput

type BuildType

type BuildType string

type DataType

type DataType string

const (
	DataTypeString   DataType = "string"
	DataTypeArtifact DataType = "artifact"
	DataTypeReport   DataType = "report"
)

type ReportData

type ReportData struct {
	Type   DataType `json:"type"`
	Label  string   `json:"label"`
	Path   string   `json:"path"`
	Target string   `json:"target"`
}

func NewReportData

func NewReportData(label string, path string, target string) *ReportData

type SdkEnv

type SdkEnv struct {
	BuildType string `json:"buildType"`
	ProjectId string `json:"projectId"`
	AgentId   string `json:"agentId"`
	SecretKey string `json:"secretKey"`
	Gateway   string `json:"gateway"`
	BuildId   string `json:"buildId"`
	VmSeqId   string `json:"vmSeqId"`
}

type Status

type Status string

const (
	StatusSuccess Status = "success"
	StatusFailure Status = "failure"
	StatusError   Status = "error"
)

type StringData

type StringData struct {
	Type  DataType `json:"type"`
	Value string   `json:"value"`
}

func NewStringData

func NewStringData(value string) *StringData