appprotoexec

Documentation

Overview

Package appprotoexec provides protoc plugin handling and execution.

Note this is currently implicitly tested through buf's protoc command. If this were split out into a separate package, testing would need to be moved to this package.

Index

• Variables
• func NewHandler(logger *zap.Logger, storageosProvider storageos.Provider, ...) (appproto.Handler, error)
• type GenerateOption
  • func GenerateWithPluginPath(pluginPath string) GenerateOption
• type Generator
  • func NewGenerator(logger *zap.Logger, storageosProvider storageos.Provider, ...) Generator
• type HandlerOption
  • func HandlerWithPluginPath(pluginPath string) HandlerOption
  • func HandlerWithProtocPath(protocPath string) HandlerOption

Variables

var (
	// ProtocProxyPluginNames are the names of the plugins that should be proxied through protoc
	// in the absence of a binary.
	ProtocProxyPluginNames = map[string]struct{}{
		"cpp":    {},
		"csharp": {},
		"java":   {},
		"js":     {},
		"objc":   {},
		"php":    {},
		"python": {},
		"pyi":    {},
		"ruby":   {},
		"kotlin": {},
	}

	// DefaultVersion represents the default version to use as compiler version for codegen requests.
	DefaultVersion = newVersion(
		defaultMajorVersion,
		defaultMinorVersion,
		defaultPatchVersion,
		defaultSuffixVersion,
	)
)

Functions

func NewHandler

func NewHandler(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	runner command.Runner,
	pluginName string,
	options ...HandlerOption,
) (appproto.Handler, error)

NewHandler returns a new Handler based on the plugin name and optional path.

protocPath and pluginPath are optional.

• If the plugin path is set, this returns a new binary handler for that path.
• If the plugin path is unset, this does exec.LookPath for a binary named protoc-gen-pluginName, and if one is found, a new binary handler is returned for this.
• Else, if the name is in ProtocProxyPluginNames, this returns a new protoc proxy handler.
• Else, this returns error.

Types

type GenerateOption

type GenerateOption func(*generateOptions)

GenerateOption is an option for Generate.

func GenerateWithPluginPath

func GenerateWithPluginPath(pluginPath string) GenerateOption

GenerateWithPluginPath returns a new GenerateOption that uses the given path to the plugin.

type Generator

type Generator interface {
	// Generate generates a CodeGeneratorResponse for the given pluginName. The
	// pluginName must be available on the system's PATH or one of the plugins
	// built-in to protoc. The plugin path can be overridden via the
	// GenerateWithPluginPath option.
	Generate(
		ctx context.Context,
		container app.EnvStderrContainer,
		pluginName string,
		requests []*pluginpb.CodeGeneratorRequest,
		options ...GenerateOption,
	) (*pluginpb.CodeGeneratorResponse, error)
}

Generator is used to generate code with plugins found on the local filesystem.

func NewGenerator

func NewGenerator(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	runner command.Runner,
) Generator

NewGenerator returns a new Generator.

type HandlerOption

type HandlerOption func(*handlerOptions)

HandlerOption is an option for a new Handler.

func HandlerWithPluginPath

func HandlerWithPluginPath(pluginPath string) HandlerOption

HandlerWithPluginPath returns a new HandlerOption that sets the path to the plugin binary.

The default is to do exec.LookPath on "protoc-gen-" + pluginName.

func HandlerWithProtocPath

func HandlerWithProtocPath(protocPath string) HandlerOption

HandlerWithProtocPath returns a new HandlerOption that sets the path to the protoc binary.

The default is to do exec.LookPath on "protoc".