build

Documentation

Index

• type Build
  • func (b *Build) Get() error
  • func (b *Build) GetResult(name string) (Result, error)
  • func (b *Build) IsFinished() bool
  • func (b *Build) PrintLogs() error
  • func (b *Build) Start(phase string, inputValues Values) error
• type ClMock
  • func (c *ClMock) SendRequest(method string, url string, bdy io.Reader, hdr http.Header, ...) (*http.Response, error)
  • func (c *ClMock) SetOptions(opts piperhttp.ClientOptions)
• type Connector
  • func (conn Connector) Download(appendum string, downloadPath string) error
  • func (conn Connector) Get(appendum string) ([]byte, error)
  • func (conn *Connector) GetToken(appendum string) error
  • func (conn *Connector) InitAAKaaS(aAKaaSEndpoint string, username string, password string, ...)
  • func (conn *Connector) InitBuildFramework(config ConnectorConfiguration, com abaputils.Communication, ...) error
  • func (conn Connector) Post(appendum string, importBody string) ([]byte, error)
  • func (conn Connector) UploadSarFile(appendum string, sarFile []byte) error
  • func (conn Connector) UploadSarFileInChunks(appendum string, fileName string, sarFile []byte) error
• type ConnectorConfiguration
• type DownloadClientMock
  • func (dc *DownloadClientMock) DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error
  • func (dc *DownloadClientMock) SetOptions(opts piperhttp.ClientOptions)
• type Result
  • func (result *Result) Download(downloadPath string) error
• type RunState
• type Value
  • func (v Value) String() string
• type Values
  • func (vs Values) String() string

Types

type Build

type Build struct {
	Connector   Connector
	BuildID     string      `json:"build_id"`
	RunState    RunState    `json:"run_state"`
	ResultState resultState `json:"result_state"`
	Phase       string      `json:"phase"`
	Entitytype  string      `json:"entitytype"`
	Startedby   string      `json:"startedby"`
	StartedAt   string      `json:"started_at"`
	FinishedAt  string      `json:"finished_at"`
	Tasks       []task
	Values      []Value
}

Build : Information for all data comming from Build Framework

func (*Build) Get

func (b *Build) Get() error

Get : Get all Build tasks

func (*Build) GetResult

func (b *Build) GetResult(name string) (Result, error)

GetResult : Returns the last Build artefact created from build step

func (*Build) IsFinished

func (b *Build) IsFinished() bool

IsFinished : Returns Build run state

func (*Build) PrintLogs

func (b *Build) PrintLogs() error

PrintLogs : Returns the Build logs

func (*Build) Start

func (b *Build) Start(phase string, inputValues Values) error

Start : Starts the Build Framework

type ClMock

type ClMock struct {
	Token      string
	StatusCode int
	Error      error
}

ClMock : Mock for Build Framework Client used for BF test

func (*ClMock) SendRequest

func (c *ClMock) SendRequest(method string, url string, bdy io.Reader, hdr http.Header, cookies []*http.Cookie) (*http.Response, error)

SendRequest : BF Send Fake request

func (*ClMock) SetOptions

func (c *ClMock) SetOptions(opts piperhttp.ClientOptions)

SetOptions : BF Client options

type Connector

type Connector struct {
	Client         piperhttp.Sender
	DownloadClient piperhttp.Downloader
	Header         map[string][]string
	Baseurl        string
}

Connector : Connector Utility Wrapping http client

func (Connector) Download

func (conn Connector) Download(appendum string, downloadPath string) error

Download : download a file via http

func (Connector) Get

func (conn Connector) Get(appendum string) ([]byte, error)

Get : http get request

func (*Connector) GetToken

func (conn *Connector) GetToken(appendum string) error

GetToken : Get the X-CRSF Token from ABAP Backend for later post

func (*Connector) InitAAKaaS

func (conn *Connector) InitAAKaaS(aAKaaSEndpoint string, username string, password string, inputclient piperhttp.Sender)

InitAAKaaS : initialize Connector for communication with AAKaaS backend

func (*Connector) InitBuildFramework

func (conn *Connector) InitBuildFramework(config ConnectorConfiguration, com abaputils.Communication, inputclient piperhttp.Sender) error

InitBuildFramework : initialize Connector for communication with ABAP SCP instance

func (Connector) Post

func (conn Connector) Post(appendum string, importBody string) ([]byte, error)

Post : http post request

func (Connector) UploadSarFile

func (conn Connector) UploadSarFile(appendum string, sarFile []byte) error

UploadSarFile : upload *.sar file

func (Connector) UploadSarFileInChunks

func (conn Connector) UploadSarFileInChunks(appendum string, fileName string, sarFile []byte) error

UploadSarFileInChunks : upload *.sar file in chunks

type ConnectorConfiguration

type ConnectorConfiguration struct {
	CfAPIEndpoint       string
	CfOrg               string
	CfSpace             string
	CfServiceInstance   string
	CfServiceKeyName    string
	Host                string
	Username            string
	Password            string
	AddonDescriptor     string
	MaxRuntimeInMinutes int
}

ConnectorConfiguration : Handover Structure for Connector Creation

type DownloadClientMock

type DownloadClientMock struct{}

DownloadClientMock : Mock for Download Client used for artefact test

func (*DownloadClientMock) DownloadFile

func (dc *DownloadClientMock) DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error

DownloadFile : Empty file download

func (*DownloadClientMock) SetOptions

func (dc *DownloadClientMock) SetOptions(opts piperhttp.ClientOptions)

SetOptions : Download Client options

type Result

type Result struct {
	BuildID        string `json:"build_id"`
	TaskID         int    `json:"task_id"`
	Name           string `json:"name"`
	AdditionalInfo string `json:"additional_info"`
	Mimetype       string `json:"mimetype"`
	// contains filtered or unexported fields
}

Result : Artefact from Build Framework step

func (*Result) Download

func (result *Result) Download(downloadPath string) error

Download : Provides the atrefact of build step

type RunState

type RunState string

RunState : Current Status of the Build

const (

	// Initializing : Build Framework prepared
	Initializing RunState = "INITIALIZING"
	// Accepted : Build Framework triggered
	Accepted RunState = "ACCEPTED"
	// Running : Build Framework performs build
	Running RunState = "RUNNING"
	// Finished : Build Framework ended successful
	Finished RunState = "FINISHED"
	// Failed : Build Framework endded with error
	Failed RunState = "FAILED"
)

type Value

type Value struct {
	BuildID string `json:"build_id"`
	ValueID string `json:"value_id"`
	Value   string `json:"value"`
	// contains filtered or unexported fields
}

Value : Returns Build Runtime Value

func (Value) String

func (v Value) String() string

******** parsing ********

type Values

type Values struct {
	Values []Value `json:"results"`
}

Values : Returns Build Runtime Values

func (Values) String

func (vs Values) String() string