fake

README

Fake plugin

It provides an API to test pipelines and other plugins.

No config params

API description

In(sourceID pipeline.SourceID, sourceName string, offset int64, bytes []byte)

It sends a test event into the pipeline.

SetCommitFn(fn func(event *pipeline.Event))

It sets up a hook to make sure the test event has been successfully committed.

SetInFn(fn func())

It sets up a hook to make sure the test event has been passed to the plugin.

Generated using insane-doc

Documentation

Index

• func Factory() (pipeline.AnyPlugin, pipeline.AnyConfig)
• type Config
• type Plugin
  • func (p *Plugin) Commit(event *pipeline.Event)
  • func (p *Plugin) In(sourceID pipeline.SourceID, sourceName string, offset int64, bytes []byte)
  • func (p *Plugin) PassEvent(_ *pipeline.Event) bool
  • func (p *Plugin) SetCommitFn(fn func(event *pipeline.Event))
  • func (p *Plugin) SetInFn(fn func())
  • func (p *Plugin) Start(_ pipeline.AnyConfig, params *pipeline.InputPluginParams)
  • func (p *Plugin) Stop()

Functions

func Factory

func Factory() (pipeline.AnyPlugin, pipeline.AnyConfig)

Types

type Config

type Config struct{}

type Plugin

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

func (*Plugin) Commit

func (p *Plugin) Commit(event *pipeline.Event)

func (*Plugin) In

func (p *Plugin) In(sourceID pipeline.SourceID, sourceName string, offset int64, bytes []byte)

> It sends a test event into the pipeline.

func (*Plugin) PassEvent

func (p *Plugin) PassEvent(_ *pipeline.Event) bool

PassEvent decides pass or discard event.

func (*Plugin) SetCommitFn

func (p *Plugin) SetCommitFn(fn func(event *pipeline.Event))

> It sets up a hook to make sure the test event has been successfully committed.

func (*Plugin) SetInFn

func (p *Plugin) SetInFn(fn func())

> It sets up a hook to make sure the test event has been passed to the plugin.

func (*Plugin) Start

func (p *Plugin) Start(_ pipeline.AnyConfig, params *pipeline.InputPluginParams)

func (*Plugin) Stop

func (p *Plugin) Stop()