recordevents

Documentation

Index

• Constants
• func DeployEventRecordOrFail(ctx context.Context, client *testlib.Client, name string, ...) *corev1.Pod
• func EchoEvent(pod *corev1.Pod, client *testlib.Client) error
• func MatchHeartBeatsImageMessage(expectedMsg string) cetest.EventMatcher
• type EventInfo
  • func (ei *EventInfo) String() string
• type EventInfoMatcher
  • func AllOf(matchers ...EventInfoMatcher) EventInfoMatcher
  • func Any() EventInfoMatcher
  • func HasAdditionalHeader(key, value string) EventInfoMatcher
  • func MatchEvent(evf ...cetest.EventMatcher) EventInfoMatcher
  • func NoError() EventInfoMatcher
• type EventInfoStore
  • func NewEventInfoStore(client *testlib.Client, podName string, podNamespace string) (*EventInfoStore, error)
  • func StartEventRecordOrFail(ctx context.Context, client *testlib.Client, podName string, ...) (*EventInfoStore, *corev1.Pod)
  • func (ei *EventInfoStore) AssertAtLeast(min int, matchers ...EventInfoMatcher) []EventInfo
  • func (ei *EventInfoStore) AssertExact(n int, matchers ...EventInfoMatcher) []EventInfo
  • func (ei *EventInfoStore) AssertInRange(min int, max int, matchers ...EventInfoMatcher) []EventInfo
  • func (ei *EventInfoStore) AssertNot(matchers ...EventInfoMatcher) []EventInfo
  • func (ei *EventInfoStore) Find(matchers ...EventInfoMatcher) ([]EventInfo, SearchedInfo, []error, error)
• type EventLog
• type EventLogs
  • func (e EventLogs) Vent(observed EventInfo) error
• type EventRecordOption
  • func ReplyWithAppendedData(appendData string) EventRecordOption
  • func ReplyWithTransformedEvent(replyEventType string, replyEventSource string, replyEventData string) EventRecordOption
• type SearchedInfo
  • func (s *SearchedInfo) String() string

Constants

const (
	// EventReason is the Kubernetes event reason used for observed events.
	CloudEventObservedReason = "CloudEventObserved"
)

Functions

func DeployEventRecordOrFail

func DeployEventRecordOrFail(ctx context.Context, client *testlib.Client, name string, options ...EventRecordOption) *corev1.Pod

DeployEventRecordOrFail deploys the recordevents image with necessary sa, roles, rb to execute the image

func EchoEvent

func EchoEvent(pod *corev1.Pod, client *testlib.Client) error

EchoEvent is an option to let the recordevents reply with the received event

func MatchHeartBeatsImageMessage

func MatchHeartBeatsImageMessage(expectedMsg string) cetest.EventMatcher

MatchHeartBeatsImageMessage matches that the data field of the event, in the format of the heartbeats image, contains the following msg field

Types

type EventInfo

type EventInfo struct {
	// Set if the http request received by the pod couldn't be decoded or
	// didn't pass validation
	Error string `json:"error,omitempty"`
	// Event received if the cloudevent received by the pod passed validation
	Event *cloudevents.Event `json:"event,omitempty"`
	// HTTPHeaders of the connection that delivered the event
	HTTPHeaders map[string][]string `json:"httpHeaders,omitempty"`
	Origin      string              `json:"origin,omitempty"`
	Observer    string              `json:"observer,omitempty"`
	Time        time.Time           `json:"time,omitempty"`
	Sequence    uint64              `json:"sequence"`
	Dropped     bool                `json:"dropped"`
}

Structure to hold information about an event seen by recordevents pod.

func (*EventInfo) String

func (ei *EventInfo) String() string

Pretty print the event. Meant for debugging.

type EventInfoMatcher

type EventInfoMatcher func(EventInfo) error

Does the provided EventInfo match some criteria

func AllOf

func AllOf(matchers ...EventInfoMatcher) EventInfoMatcher

AllOf combines matchers together

func Any

func Any() EventInfoMatcher

Matcher that never fails

func HasAdditionalHeader

func HasAdditionalHeader(key, value string) EventInfoMatcher

Convert a matcher that checks valid messages to a function that checks EventInfo structures, returning an error for any that don't contain valid events.

func MatchEvent

func MatchEvent(evf ...cetest.EventMatcher) EventInfoMatcher

Convert a matcher that checks valid messages to a function that checks EventInfo structures, returning an error for any that don't contain valid events.

func NoError

func NoError() EventInfoMatcher

Matcher that fails if there is an error in the EventInfo

type EventInfoStore

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

Stateful store of events received by the recordevents pod it is pointed at. This pulls events from the pod during any Find or Wait call, storing them locally and trimming them from the remote pod store.

func NewEventInfoStore

func NewEventInfoStore(client *testlib.Client, podName string, podNamespace string) (*EventInfoStore, error)

Creates an EventInfoStore that is used to iteratively download events recorded by the recordevents pod.

func StartEventRecordOrFail

func StartEventRecordOrFail(ctx context.Context, client *testlib.Client, podName string, options ...EventRecordOption) (*EventInfoStore, *corev1.Pod)

Deploys a new recordevents pod and start the associated EventInfoStore

func (*EventInfoStore) AssertAtLeast

func (ei *EventInfoStore) AssertAtLeast(min int, matchers ...EventInfoMatcher) []EventInfo

Assert that there are at least min number of match for the provided matchers. This method fails the test if the assert is not fulfilled.

func (*EventInfoStore) AssertExact

func (ei *EventInfoStore) AssertExact(n int, matchers ...EventInfoMatcher) []EventInfo

Assert that there are exactly n matches for the provided matchers. This method fails the test if the assert is not fulfilled.

func (*EventInfoStore) AssertInRange

func (ei *EventInfoStore) AssertInRange(min int, max int, matchers ...EventInfoMatcher) []EventInfo

Assert that there are at least min number of matches and at most max number of matches for the provided matchers. This method fails the test if the assert is not fulfilled.

func (*EventInfoStore) AssertNot

func (ei *EventInfoStore) AssertNot(matchers ...EventInfoMatcher) []EventInfo

Assert that there aren't any matches for the provided matchers. This method fails the test if the assert is not fulfilled.

func (*EventInfoStore) Find

func (ei *EventInfoStore) Find(matchers ...EventInfoMatcher) ([]EventInfo, SearchedInfo, []error, error)

Find all events received by the recordevents pod that match the provided matchers, returning all matching events as well as a SearchedInfo structure including the last 5 events seen and the total events matched. This SearchedInfo structure is primarily to ease debugging in failure printouts. The provided function is guaranteed to be called exactly once on each EventInfo from the pod. The error array contains the eventual match errors, while the last return error contains an eventual communication error while trying to get the events from the recordevents pod

type EventLog

type EventLog interface {
	Vent(observed EventInfo) error
}

EventLog is the contract for an event logger to vent an event.

type EventLogs

type EventLogs []EventLog

func (EventLogs) Vent

func (e EventLogs) Vent(observed EventInfo) error

type EventRecordOption

type EventRecordOption = func(*corev1.Pod, *testlib.Client) error

func ReplyWithAppendedData

func ReplyWithAppendedData(appendData string) EventRecordOption

ReplyWithAppendedData is an option to let the recordevents reply with the transformed event with appended data

func ReplyWithTransformedEvent

func ReplyWithTransformedEvent(replyEventType string, replyEventSource string, replyEventData string) EventRecordOption

ReplyWithTransformedEvent is an option to let the recordevents reply with the transformed event

type SearchedInfo

type SearchedInfo struct {
	TotalEvent int
	LastNEvent []EventInfo
	// contains filtered or unexported fields
}

This is mainly used for providing better failure messages

func (*SearchedInfo) String

func (s *SearchedInfo) String() string

Pretty print the SearchedInfor for error messages