jenkins

Documentation

Index

• func NewFromCLI(c *cli.Context, tracer opentracing.Tracer) (eventsources.EventSource, error)
• type BuildEvent
  • func (be BuildEvent) IsError() (bool, error)
  • func (be BuildEvent) OperationName() string
  • func (be BuildEvent) ParentSpanID() (*string, error)
  • func (be BuildEvent) SpanID() (string, error)
  • func (be BuildEvent) State(prev *eventsources.EventState) (eventsources.SpanState, error)
  • func (be BuildEvent) String() (string, error)
  • func (be BuildEvent) Tags() (map[string]interface{}, error)
  • func (be BuildEvent) Timings() (eventsources.EventTimings, error)
• type BuildState
• type ScmInfo
• type Source
  • func NewSource(tracer opentracing.Tracer) (*Source, error)
  • func (s *Source) Event(r *http.Request, payload []byte) (eventsources.Event, error)
  • func (s Source) Name() string
  • func (s *Source) SecretKey() []byte
  • func (s *Source) Tracer() opentracing.Tracer
  • func (s *Source) ValidatePayload(r *http.Request, secretKey []byte) ([]byte, error)

Functions

func NewFromCLI

func NewFromCLI(c *cli.Context, tracer opentracing.Tracer) (eventsources.EventSource, error)

Types

type BuildEvent

type BuildEvent struct {
	QueueTime       int               `json:"queueTime"`
	Result          string            `json:"result"`
	CiURL           string            `json:"ciUrl"`
	ContextID       int               `json:"contextId"`
	FullJobName     string            `json:"fullJobName"`
	Parameters      map[string]string `json:"parameters"`
	BuildURL        string            `json:"buildUrl"`
	BuildCause      string            `json:"buildCause"`
	StartTime       int               `json:"startTime"`
	Number          int               `json:"number"`
	StartedUsername string            `json:"startedUsername"`
	JobName         string            `json:"jobName"`
	SlaveInfo       struct {
		SlaveName string `json:"slaveName"`
		Executor  string `json:"executor"`
		Label     string `json:"label"`
	} `json:"slaveInfo"`
	ScmInfo       *ScmInfo `json:"scmInfo,omitempty"`
	StartedUserID string   `json:"startedUserId"`
	Duration      int      `json:"duration"`
	EndTime       int      `json:"endTime"`
}

func (BuildEvent) IsError

func (be BuildEvent) IsError() (bool, error)

func (BuildEvent) OperationName

func (be BuildEvent) OperationName() string

OperationName determines if the event is a `deploy` or a `build` based on the presence of a `type:deploy` tag.

func (BuildEvent) ParentSpanID

func (be BuildEvent) ParentSpanID() (*string, error)

ParentSpanID inspects the Jenkins Event payload to determine what the parent span is. First will check to see if the parent is explicitly specified in build params Then will check if the build is part of SCM

func (BuildEvent) SpanID

func (be BuildEvent) SpanID() (string, error)

func (BuildEvent) State

func (be BuildEvent) State(prev *eventsources.EventState) (eventsources.SpanState, error)

func (BuildEvent) String

func (be BuildEvent) String() (string, error)

func (BuildEvent) Tags

func (be BuildEvent) Tags() (map[string]interface{}, error)

func (BuildEvent) Timings

func (be BuildEvent) Timings() (eventsources.EventTimings, error)

type BuildState

type BuildState int

type ScmInfo

type ScmInfo struct {
	URL    string  `json:"url"`
	Commit string  `json:"commit"`
	Branch *string `json:"branch,omitempty"`
}

type Source

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

func NewSource

func NewSource(tracer opentracing.Tracer) (*Source, error)

func (*Source) Event

func (s *Source) Event(r *http.Request, payload []byte) (eventsources.Event, error)

func (Source) Name

func (s Source) Name() string

func (*Source) SecretKey

func (s *Source) SecretKey() []byte

func (*Source) Tracer

func (s *Source) Tracer() opentracing.Tracer

func (*Source) ValidatePayload

func (s *Source) ValidatePayload(r *http.Request, secretKey []byte) ([]byte, error)