plugins

Documentation

Index

• func AvailablePlugins() []string
• func RunIfEnabled(pluginName string, inputsMap, resultsMap *map[string]cty.Value, ...) bool
• type OutputPlugin
• type OutputResults
• type OutputsResults
  • func RunOutputsPlugin(inputsMap *map[string]*map[string]cty.Value) OutputsResults
• type Plugin

Functions

func AvailablePlugins

func AvailablePlugins() []string

AvailablePlugins searches the plugin directories and returns names of each plugin found.

func RunIfEnabled

func RunIfEnabled(pluginName string, inputsMap, resultsMap *map[string]cty.Value, resultsListMap *map[string][]cty.Value) bool

RunIfEnabled takes the name of a plugin, a map of inputs, and an empty map for results, and will run the plugin if its inputs map does not contain plugin_enabled == "false".

Types

type OutputPlugin

type OutputPlugin interface {
	// Run(inputsMap)
	Run(*map[string]*map[string]cty.Value, *OutputsResults)
}

OutputPlugin is an interface for each Plugin to implement. All this includes is a single function, "Run(*map[string]string, *map[string]string)" which takes a map of inputs and an empty map of outputs that the Plugin is expected to populate

type OutputResults

type OutputResults struct {
	XML  string
	JSON string
}

OutputResults holds XML and JSON string representations of a plugin's outputs

type OutputsResults

type OutputsResults struct {
	Results map[string]OutputResults
	AllXML  string
	AllJSON string
}

OutputsResults holds XML and JSON string representations of the combined plugin's outputs as well as a map of the XML/JSON string representations of individual plugins' outputs

func RunOutputsPlugin

func RunOutputsPlugin(inputsMap *map[string]*map[string]cty.Value) OutputsResults

RunOutputsPlugin takes a map of inputs, runs the "outputs" plugin, and returns JSON/XML string representations of the inputs.

type Plugin

type Plugin interface {
	// Run(inputsMap, resultsMap)
	Run(*map[string]cty.Value, *map[string]cty.Value)
}

Plugin is an interface for each Plugin to implement. All this includes is a single function, "Run(*map[string]string, *map[string]string)" which takes a map of inputs and an empty map of outputs that the Plugin is expected to populate