common

Documentation

Overview

Package common contains structs and methods that are shared across different gateways.

Index

• Constants
• Variables
• func FormatWebhookEndpoint(endpoint string) string
• func GenerateFormattedURL(w *Webhook) string
• func GetAWSCreds(client kubernetes.Interface, namespace string, ...) (*credentials.Credentials, error)
• func GetAWSSession(creds *credentials.Credentials, region string) (*session.Session, error)
• func GetAWSSessionWithoutCreds(region string) (*session.Session, error)
• func InitRouteChannels(helper *WebhookHelper)
• func ProcessRoute(routeManager RouteManager, helper *WebhookHelper, ...) error
• func ValidateGatewayEventSource(eventSource *gateways.EventSource, version string, ...) (*gateways.ValidEventSource, error)
• func ValidateWebhook(w *Webhook) error
• type Endpoint
• type FakeGRPCStream
  • func (f *FakeGRPCStream) Context() context.Context
  • func (f *FakeGRPCStream) RecvMsg(m interface{}) error
  • func (f *FakeGRPCStream) Send(event *gateways.Event) error
  • func (f *FakeGRPCStream) SendHeader(metadata.MD) error
  • func (f *FakeGRPCStream) SendMsg(m interface{}) error
  • func (f *FakeGRPCStream) SetHeader(metadata.MD) error
  • func (f *FakeGRPCStream) SetTrailer(metadata.MD)
• type FakeHttpWriter
  • func (f *FakeHttpWriter) Header() http.Header
  • func (f *FakeHttpWriter) Write(body []byte) (int, error)
  • func (f *FakeHttpWriter) WriteHeader(status int)
• type FakeRouteConfig
  • func (f *FakeRouteConfig) GetRoute() *Route
  • func (f *FakeRouteConfig) PostStart() error
  • func (f *FakeRouteConfig) PostStop() error
  • func (f *FakeRouteConfig) RouteHandler(writer http.ResponseWriter, request *http.Request)
• type Route
  • func GetFakeRoute() *Route
• type RouteManager
• type WatchPathConfig
  • func (c *WatchPathConfig) Validate() error
• type Webhook
• type WebhookHelper
  • func NewWebhookHelper() *WebhookHelper

Constants

const EventSourceDir = "../../../examples/event-sources"

Variables

var (
	ErrNilEventSource = fmt.Errorf("event source can't be nil")
)

var Hook = &Webhook{
	Endpoint: "/fake",
	Port:     "12000",
	URL:      "test-url",
}

Functions

func FormatWebhookEndpoint

func FormatWebhookEndpoint(endpoint string) string

func GenerateFormattedURL

func GenerateFormattedURL(w *Webhook) string

func GetAWSCreds

func GetAWSCreds(client kubernetes.Interface, namespace string, access *corev1.SecretKeySelector, secret *corev1.SecretKeySelector) (*credentials.Credentials, error)

GetAWSCreds reads credential stored in Kubernetes secrets and return it.

func GetAWSSession

func GetAWSSession(creds *credentials.Credentials, region string) (*session.Session, error)

func GetAWSSessionWithoutCreds

func GetAWSSessionWithoutCreds(region string) (*session.Session, error)

func InitRouteChannels

func InitRouteChannels(helper *WebhookHelper)

InitRouteChannels initializes route channels so they can activate and deactivate routes.

func ProcessRoute

func ProcessRoute(routeManager RouteManager, helper *WebhookHelper, eventStream gateways.Eventing_StartEventSourceServer) error

func ValidateGatewayEventSource

func ValidateGatewayEventSource(eventSource *gateways.EventSource, version string, parseEventSource func(string) (interface{}, error), validateEventSource func(interface{}) error) (*gateways.ValidEventSource, error)

func ValidateWebhook

func ValidateWebhook(w *Webhook) error

Types

type Endpoint

type Endpoint struct {
	// whether endpoint is active
	Active bool
	// data channel to receive data on this endpoint
	DataCh chan []byte
}

endpoint contains state of an http endpoint

type FakeGRPCStream

type FakeGRPCStream struct {
	SentData *gateways.Event
	Ctx      context.Context
}

func (*FakeGRPCStream) Context

func (f *FakeGRPCStream) Context() context.Context

func (*FakeGRPCStream) RecvMsg

func (f *FakeGRPCStream) RecvMsg(m interface{}) error

func (*FakeGRPCStream) Send

func (f *FakeGRPCStream) Send(event *gateways.Event) error

func (*FakeGRPCStream) SendHeader

func (f *FakeGRPCStream) SendHeader(metadata.MD) error

func (*FakeGRPCStream) SendMsg

func (f *FakeGRPCStream) SendMsg(m interface{}) error

func (*FakeGRPCStream) SetHeader

func (f *FakeGRPCStream) SetHeader(metadata.MD) error

func (*FakeGRPCStream) SetTrailer

func (f *FakeGRPCStream) SetTrailer(metadata.MD)

type FakeHttpWriter

type FakeHttpWriter struct {
	HeaderStatus int
	Payload      []byte
}

func (*FakeHttpWriter) Header

func (f *FakeHttpWriter) Header() http.Header

func (*FakeHttpWriter) Write

func (f *FakeHttpWriter) Write(body []byte) (int, error)

func (*FakeHttpWriter) WriteHeader

func (f *FakeHttpWriter) WriteHeader(status int)

type FakeRouteConfig

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

func (*FakeRouteConfig) GetRoute

func (f *FakeRouteConfig) GetRoute() *Route

func (*FakeRouteConfig) PostStart

func (f *FakeRouteConfig) PostStart() error

func (*FakeRouteConfig) PostStop

func (f *FakeRouteConfig) PostStop() error

func (*FakeRouteConfig) RouteHandler

func (f *FakeRouteConfig) RouteHandler(writer http.ResponseWriter, request *http.Request)

type Route

type Route struct {
	Webhook     *Webhook
	Logger      *logrus.Logger
	StartCh     chan struct{}
	EventSource *gateways.EventSource
}

Route contains common information for a route

func GetFakeRoute

func GetFakeRoute() *Route

type RouteManager

type RouteManager interface {
	GetRoute() *Route
	RouteHandler(writer http.ResponseWriter, request *http.Request)
	PostStart() error
	PostStop() error
}

RouteManager is an interface to manage the configuration for a route

type WatchPathConfig

type WatchPathConfig struct {
	// Directory to watch for events
	Directory string `json:"directory"`
	// Path is relative path of object to watch with respect to the directory
	Path string `json:"path,omitempty"`
	// PathRegexp is regexp of relative path of object to watch with respect to the directory
	PathRegexp string `json:"pathRegexp,omitempty"`
}

func (*WatchPathConfig) Validate

func (c *WatchPathConfig) Validate() error

Validate validates WatchPathConfig

type Webhook

type Webhook struct {
	// REST API endpoint
	Endpoint string `json:"endpoint" protobuf:"bytes,1,name=endpoint"`
	// Method is HTTP request method that indicates the desired action to be performed for a given resource.
	// See RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
	Method string `json:"method" protobuf:"bytes,2,name=method"`
	// Port on which HTTP server is listening for incoming events.
	Port string `json:"port" protobuf:"bytes,3,name=port"`
	// URL is the url of the server.
	URL string `json:"url" protobuf:"bytes,4,name=url"`
	// ServerCertPath refers the file that contains the cert.
	ServerCertPath string `json:"serverCertPath,omitempty" protobuf:"bytes,4,opt,name=serverCertPath"`
	// ServerKeyPath refers the file that contains private key
	ServerKeyPath string `json:"serverKeyPath,omitempty" protobuf:"bytes,5,opt,name=serverKeyPath"`
	// contains filtered or unexported fields
}

Webhook is a general purpose REST API

type WebhookHelper

type WebhookHelper struct {
	// Mutex synchronizes ActiveServers
	Mutex sync.Mutex
	// ActiveServers keeps track of currently running http servers.
	ActiveServers map[string]*activeServer
	// ActiveEndpoints keep track of endpoints that are already registered with server and their status active or inactive
	ActiveEndpoints map[string]*Endpoint
	// RouteActivateChan handles assigning new route to server.
	RouteActivateChan chan RouteManager
	// RouteDeactivateChan handles deactivating existing route
	RouteDeactivateChan chan RouteManager
}

WebhookHelper is a helper struct

func NewWebhookHelper

func NewWebhookHelper() *WebhookHelper

NewWebhookHelper returns new Webhook helper