plugintest

Documentation

Overview

plugintest provides utilities for black-box testing of protoc.Plugin implementations.

Index

• func Cases(t *testing.T, subject protoc.Plugin, cases map[string]Case)
• func WithConfiguration(options ...PluginConfigurationOption) *protoc.PluginConfiguration
• func WithDirectives(items ...string) (d []rule.Directive)
• type Case
  • func (tc *Case) Run(t *testing.T, subject protoc.Plugin)
  • func (tc *Case) RunIntegration(t *testing.T, subject protoc.Plugin, got *protoc.PluginConfiguration, ...)
• type PluginConfigurationOption
  • func WithLabel(t *testing.T, raw string) PluginConfigurationOption
  • func WithOptions(options ...string) PluginConfigurationOption
  • func WithOut(out string) PluginConfigurationOption
  • func WithOutputs(outputs ...string) PluginConfigurationOption

Functions

func Cases

func Cases(t *testing.T, subject protoc.Plugin, cases map[string]Case)

Cases is a utility function that runs a mapping of test cases.

func WithConfiguration

func WithConfiguration(options ...PluginConfigurationOption) *protoc.PluginConfiguration

WithConfiguration creates a new PluginConfiguration and applies all the given options.

func WithDirectives

func WithDirectives(items ...string) (d []rule.Directive)

WithDirectives assigns rule Directives.

Types

type Case

type Case struct {
	// The base name of the proto file to mock parse.  If not set, defaults to 'test' ('test.proto')
	Basename string
	// The relative package path
	Rel string
	// The configuration Name
	PluginName string
	// Optional directives for the package config
	Directives []rule.Directive
	// The input proto file source.  "syntax = proto3" will be automatically prepended.
	Input string
	// The expected value for the final configuration state
	Configuration *protoc.PluginConfiguration
	// Whether to perform integration test portion of the test
	SkipIntegration bool
}

Case holds the inputs and expected outputs for black-box testing of a plugin implementation.

func (*Case) Run

func (tc *Case) Run(t *testing.T, subject protoc.Plugin)

func (*Case) RunIntegration

func (tc *Case) RunIntegration(t *testing.T, subject protoc.Plugin, got *protoc.PluginConfiguration, filename, in string)

type PluginConfigurationOption

type PluginConfigurationOption func(c *protoc.PluginConfiguration)

PluginConfigurationOption modifies a configuration in-place

func WithLabel

func WithLabel(t *testing.T, raw string) PluginConfigurationOption

WithLabel assigns the Label field.

func WithOptions

func WithOptions(options ...string) PluginConfigurationOption

WithOptions assigns the Options field.

func WithOut

func WithOut(out string) PluginConfigurationOption

WithOut assigns the Out field.

func WithOutputs

func WithOutputs(outputs ...string) PluginConfigurationOption

WithOutputs assigns the Outputs field.