webhook

Documentation

Index

• Variables
• func NewEIAuthorizer(db *gorm.DB, ei models.ExternalInitiator) *eiAuthorizer
• func NewExternalInitiatorManager(db *gorm.DB, httpclient HTTPClient) *externalInitiatorManager
• func ValidatedWebhookSpec(tomlString string, externalInitiatorManager ExternalInitiatorManager) (jb job.Job, err error)
• type Authorizer
  • func NewAuthorizer(db *gorm.DB, user *models.User, ei *models.ExternalInitiator) Authorizer
• type AuthorizerConfig
• type Delegate
  • func NewDelegate(runner pipeline.Runner, externalInitiatorManager ExternalInitiatorManager) *Delegate
  • func (d *Delegate) AfterJobCreated(jb job.Job)
  • func (d *Delegate) BeforeJobDeleted(jb job.Job)
  • func (d *Delegate) JobType() job.Type
  • func (d *Delegate) ServicesForSpec(spec job.Job) ([]job.Service, error)
  • func (d *Delegate) WebhookJobRunner() JobRunner
• type ExternalInitiatorManager
• type HTTPClient
• type JobRunner
• type JobSpecNotice
  • func NewJobSpecNotice(initiator models.Initiator, js models.JobSpec) (*JobSpecNotice, error)
• type JobSpecNoticeV2
• type NullExternalInitiatorManager
  • func (NullExternalInitiatorManager) DeleteJob(jobID models.JobID) error
  • func (NullExternalInitiatorManager) DeleteJobV2(int32) error
  • func (NullExternalInitiatorManager) FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)
  • func (NullExternalInitiatorManager) Notify(models.JobSpec) error
  • func (NullExternalInitiatorManager) NotifyV2(int32) error
• type TOMLWebhookSpec
• type TOMLWebhookSpecExternalInitiator

Variables

var ErrJobNotExists = errors.New("job does not exist")

var ErrMissingJobID = errors.New("missing job ID")

Functions

func NewEIAuthorizer

func NewEIAuthorizer(db *gorm.DB, ei models.ExternalInitiator) *eiAuthorizer

func NewExternalInitiatorManager

func NewExternalInitiatorManager(db *gorm.DB, httpclient HTTPClient) *externalInitiatorManager

NewExternalInitiatorManager returns the concrete externalInitiatorManager

func ValidatedWebhookSpec

func ValidatedWebhookSpec(tomlString string, externalInitiatorManager ExternalInitiatorManager) (jb job.Job, err error)

Types

type Authorizer

type Authorizer interface {
	CanRun(ctx context.Context, config AuthorizerConfig, jobUUID uuid.UUID) (bool, error)
}

func NewAuthorizer

func NewAuthorizer(db *gorm.DB, user *models.User, ei *models.ExternalInitiator) Authorizer

type AuthorizerConfig

type AuthorizerConfig interface {
	FeatureExternalInitiators() bool
}

type Delegate

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

func NewDelegate

func NewDelegate(runner pipeline.Runner, externalInitiatorManager ExternalInitiatorManager) *Delegate

func (*Delegate) AfterJobCreated

func (d *Delegate) AfterJobCreated(jb job.Job)

func (*Delegate) BeforeJobDeleted

func (d *Delegate) BeforeJobDeleted(jb job.Job)

func (*Delegate) JobType

func (d *Delegate) JobType() job.Type

func (*Delegate) ServicesForSpec

func (d *Delegate) ServicesForSpec(spec job.Job) ([]job.Service, error)

func (*Delegate) WebhookJobRunner

func (d *Delegate) WebhookJobRunner() JobRunner

type ExternalInitiatorManager

type ExternalInitiatorManager interface {
	Notify(models.JobSpec) error
	NotifyV2(webhookSpecID int32) error
	DeleteJob(jobID models.JobID) error
	DeleteJobV2(webhookSpecID int32) error
	FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)
}

ExternalInitiatorManager manages HTTP requests to remote external initiators

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type JobRunner

type JobRunner interface {
	RunJob(ctx context.Context, jobUUID uuid.UUID, requestBody string, meta pipeline.JSONSerializable) (int64, error)
}

type JobSpecNotice

type JobSpecNotice struct {
	JobID  models.JobID `json:"jobId"`
	Type   string       `json:"type"`
	Params models.JSON  `json:"params,omitempty"`
}

JobSpecNotice is sent to the External Initiator when JobSpecs are created.

func NewJobSpecNotice

func NewJobSpecNotice(initiator models.Initiator, js models.JobSpec) (*JobSpecNotice, error)

NewJobSpecNotice returns a new JobSpec.

type JobSpecNoticeV2

type JobSpecNoticeV2 struct {
	JobID  uuid.UUID   `json:"jobId"`
	Type   string      `json:"type"`
	Params models.JSON `json:"params,omitempty"`
}

JobSpecNotice is sent to the External Initiator when JobSpecs are created.

type NullExternalInitiatorManager

type NullExternalInitiatorManager struct{}

func (NullExternalInitiatorManager) DeleteJob

func (NullExternalInitiatorManager) DeleteJob(jobID models.JobID) error

func (NullExternalInitiatorManager) DeleteJobV2

func (NullExternalInitiatorManager) DeleteJobV2(int32) error

func (NullExternalInitiatorManager) FindExternalInitiatorByName

func (NullExternalInitiatorManager) FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)

func (NullExternalInitiatorManager) Notify

func (NullExternalInitiatorManager) Notify(models.JobSpec) error

func (NullExternalInitiatorManager) NotifyV2

func (NullExternalInitiatorManager) NotifyV2(int32) error

type TOMLWebhookSpec

type TOMLWebhookSpec struct {
	ExternalInitiators []TOMLWebhookSpecExternalInitiator `toml:"externalInitiators"`
}

type TOMLWebhookSpecExternalInitiator

type TOMLWebhookSpecExternalInitiator struct {
	Name string      `toml:"name"`
	Spec models.JSON `toml:"spec"`
}