webhook

Documentation

Index

• Variables
• func NewEIAuthorizer(ds sqlutil.DataSource, ei bridges.ExternalInitiator) *eiAuthorizer
• func NewExternalInitiatorManager(ds sqlutil.DataSource, httpclient HTTPClient) *externalInitiatorManager
• func ValidatedWebhookSpec(ctx context.Context, tomlString string, ...) (jb job.Job, err error)
• type Authorizer
  • func NewAuthorizer(ds sqlutil.DataSource, user *sessions.User, ei *bridges.ExternalInitiator) Authorizer
• type AuthorizerConfig
• type Delegate
  • func NewDelegate(runner pipeline.Runner, externalInitiatorManager ExternalInitiatorManager, ...) *Delegate
  • func (d *Delegate) AfterJobCreated(jb job.Job)
  • func (d *Delegate) BeforeJobCreated(spec job.Job)
  • func (d *Delegate) BeforeJobDeleted(spec job.Job)
  • func (d *Delegate) JobType() job.Type
  • func (d *Delegate) OnDeleteJob(context.Context, job.Job) error
  • func (d *Delegate) ServicesForSpec(ctx context.Context, spec job.Job) ([]job.ServiceCtx, error)
  • func (d *Delegate) WebhookJobRunner() JobRunner
• type ExternalInitiatorManager
• type HTTPClient
• type JobRunner
• type JobSpecNotice
• type NullExternalInitiatorManager
  • func (NullExternalInitiatorManager) DeleteJob(context.Context, int32) error
  • func (NullExternalInitiatorManager) FindExternalInitiatorByName(ctx context.Context, name string) (bridges.ExternalInitiator, error)
  • func (NullExternalInitiatorManager) Notify(context.Context, int32) error
• type TOMLWebhookSpec
• type TOMLWebhookSpecExternalInitiator

Variables

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

Functions

func NewEIAuthorizer

func NewEIAuthorizer(ds sqlutil.DataSource, ei bridges.ExternalInitiator) *eiAuthorizer

func NewExternalInitiatorManager

func NewExternalInitiatorManager(ds sqlutil.DataSource, httpclient HTTPClient) *externalInitiatorManager

NewExternalInitiatorManager returns the concrete externalInitiatorManager

func ValidatedWebhookSpec

func ValidatedWebhookSpec(ctx context.Context, 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(ds sqlutil.DataSource, user *sessions.User, ei *bridges.ExternalInitiator) Authorizer

type AuthorizerConfig

type AuthorizerConfig interface {
	ExternalInitiatorsEnabled() bool
}

type Delegate

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

func NewDelegate

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

func (*Delegate) AfterJobCreated

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

func (*Delegate) BeforeJobCreated

func (d *Delegate) BeforeJobCreated(spec job.Job)

func (*Delegate) BeforeJobDeleted

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

func (*Delegate) JobType

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

func (*Delegate) OnDeleteJob

func (d *Delegate) OnDeleteJob(context.Context, job.Job) error

func (*Delegate) ServicesForSpec

func (d *Delegate) ServicesForSpec(ctx context.Context, spec job.Job) ([]job.ServiceCtx, error)

ServicesForSpec satisfies the job.Delegate interface.

func (*Delegate) WebhookJobRunner

func (d *Delegate) WebhookJobRunner() JobRunner

type ExternalInitiatorManager

type ExternalInitiatorManager interface {
	Notify(ctx context.Context, webhookSpecID int32) error
	DeleteJob(ctx context.Context, webhookSpecID int32) error
	FindExternalInitiatorByName(ctx context.Context, name string) (bridges.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 jsonserializable.JSONSerializable) (int64, error)
}

type JobSpecNotice

type JobSpecNotice 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(context.Context, int32) error

func (NullExternalInitiatorManager) FindExternalInitiatorByName

func (NullExternalInitiatorManager) FindExternalInitiatorByName(ctx context.Context, name string) (bridges.ExternalInitiator, error)

func (NullExternalInitiatorManager) Notify

func (NullExternalInitiatorManager) Notify(context.Context, 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"`
}