provider

Documentation

Index

• Variables
• type APIEndpoint
  • func (api *APIEndpoint) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)
  • func (api *APIEndpoint) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)
  • func (api *APIEndpoint) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error
• type APIError
• type EventProvider
• type EventProviderManager
  • func NewEventProviderManager(configFile string, skipMonitor bool) *EventProviderManager
  • func (m *EventProviderManager) Close()
  • func (m *EventProviderManager) ConstructEventURI(t string, k string, a string, values map[string]string) (string, error)
  • func (m *EventProviderManager) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)
  • func (m *EventProviderManager) GetType(eventType string, eventKind string) (*model.EventType, error)
  • func (m *EventProviderManager) GetTypes() []model.EventType
  • func (m *EventProviderManager) MatchType(event string) (*model.EventType, error)
  • func (m *EventProviderManager) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)
  • func (m *EventProviderManager) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error
• type EventProviderService
  • func NewEventProviderEndpoint(url string) EventProviderService
• type Mock
  • func NewEventProviderMock() *Mock
  • func (c *Mock) ConstructEventURI(t string, k string, a string, values map[string]string) (string, error)
  • func (c *Mock) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)
  • func (c *Mock) GetType(t string, k string) (*model.EventType, error)
  • func (c *Mock) GetTypes() []model.EventType
  • func (c *Mock) MatchType(eventURI string) (*model.EventType, error)
  • func (c *Mock) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)
  • func (c *Mock) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error

Variables

var ErrNotImplemented = errors.New("method not implemented")

ErrNotImplemented error

Types

type APIEndpoint

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

APIEndpoint Event Provider API endpoint

func (*APIEndpoint) GetEventInfo

func (api *APIEndpoint) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)

GetEventInfo get EventInfo from Event Provider passing event URI

func (*APIEndpoint) SubscribeToEvent

func (api *APIEndpoint) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)

SubscribeToEvent configure remote system through event provider to subscribe for desired event

func (*APIEndpoint) UnsubscribeFromEvent

func (api *APIEndpoint) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error

UnsubscribeFromEvent configure remote system through event provider to unsubscribe for desired event

type APIError

type APIError struct {
	Message string `json:"error,omitempty"`
}

APIError api error message

type EventProvider

type EventProvider interface {
	GetTypes() []model.EventType
	MatchType(eventURI string) (*model.EventType, error)
	GetType(t string, k string) (*model.EventType, error)
	GetEventInfo(ctx context.Context, eventURI string, secret string) (*model.EventInfo, error)
	SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)
	UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error
	ConstructEventURI(t string, k string, a string, values map[string]string) (string, error)
}

EventProvider describes installed and configured Trigger Event Providers

type EventProviderManager

type EventProviderManager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

EventProviderManager is responsible for discovering new Trigger Event Providers

func NewEventProviderManager

func NewEventProviderManager(configFile string, skipMonitor bool) *EventProviderManager

NewEventProviderManager return new Event Handler Manager (singleton) Event Handler Manager discoveres all registered Event Handlers and can describe them

func (*EventProviderManager) Close

func (m *EventProviderManager) Close()

Close - free file watcher resources

func (*EventProviderManager) ConstructEventURI

func (m *EventProviderManager) ConstructEventURI(t string, k string, a string, values map[string]string) (string, error)

ConstructEventURI construct event URI from type/kind, account and values map

func (*EventProviderManager) GetEventInfo

func (m *EventProviderManager) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)

GetEventInfo get event info from event provider

func (*EventProviderManager) GetType

func (m *EventProviderManager) GetType(eventType string, eventKind string) (*model.EventType, error)

GetType get individual event provider type (by type and kind)

func (*EventProviderManager) GetTypes

func (m *EventProviderManager) GetTypes() []model.EventType

GetTypes get discovered event provider types

func (*EventProviderManager) MatchType

func (m *EventProviderManager) MatchType(event string) (*model.EventType, error)

MatchType match event type by uri

func (*EventProviderManager) SubscribeToEvent

func (m *EventProviderManager) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)

SubscribeToEvent subscribe to remote event through event provider

func (*EventProviderManager) UnsubscribeFromEvent

func (m *EventProviderManager) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error

UnsubscribeFromEvent unsubscribe from remote event through event provider

type EventProviderService

type EventProviderService interface {
	GetEventInfo(ctx context.Context, event, secret string) (*model.EventInfo, error)
	SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)
	UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error
}

EventProviderService Codefresh Service

func NewEventProviderEndpoint

func NewEventProviderEndpoint(url string) EventProviderService

NewEventProviderEndpoint create new Event Provider API endpoint from url and API token

type Mock

type Mock struct {
	mock.Mock
}

Mock mock

func NewEventProviderMock

func NewEventProviderMock() *Mock

NewEventProviderMock create EventProvider API mock

func (*Mock) ConstructEventURI

func (c *Mock) ConstructEventURI(t string, k string, a string, values map[string]string) (string, error)

ConstructEventURI mock

func (*Mock) GetEventInfo

func (c *Mock) GetEventInfo(ctx context.Context, event string, secret string) (*model.EventInfo, error)

GetEventInfo mock

func (*Mock) GetType

func (c *Mock) GetType(t string, k string) (*model.EventType, error)

GetType mock

func (*Mock) GetTypes

func (c *Mock) GetTypes() []model.EventType

GetTypes mock

func (*Mock) MatchType

func (c *Mock) MatchType(eventURI string) (*model.EventType, error)

MatchType mock

func (*Mock) SubscribeToEvent

func (c *Mock) SubscribeToEvent(ctx context.Context, event, secret string, credentials map[string]string) (*model.EventInfo, error)

SubscribeToEvent mock

func (*Mock) UnsubscribeFromEvent

func (c *Mock) UnsubscribeFromEvent(ctx context.Context, event string, credentials map[string]string) error

UnsubscribeFromEvent mock