plugin

Documentation

Overview

Package plugin contains general interfaces and types relevant to plugins. It also provides the methods for registering plugins.

Index

• func IsPluginSupportedForCurrentPlatform(log log.T, pluginName string) (bool, string)
• func RegisteredLongRunningPlugins(context context.T) runpluginutil.PluginRegistry
• func RegisteredWorkerPlugins(context context.T) runpluginutil.PluginRegistry
• type Mock
  • func (m *Mock) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, ...) (res contracts.PluginResult)

Functions

func IsPluginSupportedForCurrentPlatform

func IsPluginSupportedForCurrentPlatform(log log.T, pluginName string) (bool, string)

IsPluginSupportedForCurrentPlatform always returns true because currently, there is no plugin that particular linux version doesn't support while other linux version does.

func RegisteredLongRunningPlugins

func RegisteredLongRunningPlugins(context context.T) runpluginutil.PluginRegistry

LongRunningPlugins returns a map of long running plugins and their respective handlers

func RegisteredWorkerPlugins

func RegisteredWorkerPlugins(context context.T) runpluginutil.PluginRegistry

RegisteredWorkerPlugins returns all registered core plugins.

Types

type Mock

type Mock struct {
	mock.Mock
}

Mock stands for a mocked plugin.

func (*Mock) Execute

func (m *Mock) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, subDocumentRunner runpluginutil.PluginRunner) (res contracts.PluginResult)

Execute mocks a plugin execution.