mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-03-18 07:01:32 -04:00
ee5fc3b986
This puts us on a version that has grpc protocol support. Although we're not actually using that yet, the plugin has handshake changed slightly to allow plugins to declare whether they use the old or new protocols, and so this upgrade allows us to support plugins that were built against newer versions of go-plugin that include this extra field in the handshake. This fixes #15756.
57 lines
2.0 KiB
Go
57 lines
2.0 KiB
Go
// The plugin package exposes functions and helpers for communicating to
|
|
// plugins which are implemented as standalone binary applications.
|
|
//
|
|
// plugin.Client fully manages the lifecycle of executing the application,
|
|
// connecting to it, and returning the RPC client for dispensing plugins.
|
|
//
|
|
// plugin.Serve fully manages listeners to expose an RPC server from a binary
|
|
// that plugin.Client can connect to.
|
|
package plugin
|
|
|
|
import (
|
|
"errors"
|
|
"net/rpc"
|
|
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
// Plugin is the interface that is implemented to serve/connect to an
|
|
// inteface implementation.
|
|
type Plugin interface {
|
|
// Server should return the RPC server compatible struct to serve
|
|
// the methods that the Client calls over net/rpc.
|
|
Server(*MuxBroker) (interface{}, error)
|
|
|
|
// Client returns an interface implementation for the plugin you're
|
|
// serving that communicates to the server end of the plugin.
|
|
Client(*MuxBroker, *rpc.Client) (interface{}, error)
|
|
}
|
|
|
|
// GRPCPlugin is the interface that is implemented to serve/connect to
|
|
// a plugin over gRPC.
|
|
type GRPCPlugin interface {
|
|
// GRPCServer should register this plugin for serving with the
|
|
// given GRPCServer. Unlike Plugin.Server, this is only called once
|
|
// since gRPC plugins serve singletons.
|
|
GRPCServer(*grpc.Server) error
|
|
|
|
// GRPCClient should return the interface implementation for the plugin
|
|
// you're serving via gRPC.
|
|
GRPCClient(*grpc.ClientConn) (interface{}, error)
|
|
}
|
|
|
|
// NetRPCUnsupportedPlugin implements Plugin but returns errors for the
|
|
// Server and Client functions. This will effectively disable support for
|
|
// net/rpc based plugins.
|
|
//
|
|
// This struct can be embedded in your struct.
|
|
type NetRPCUnsupportedPlugin struct{}
|
|
|
|
func (p NetRPCUnsupportedPlugin) Server(*MuxBroker) (interface{}, error) {
|
|
return nil, errors.New("net/rpc plugin protocol not supported")
|
|
}
|
|
|
|
func (p NetRPCUnsupportedPlugin) Client(*MuxBroker, *rpc.Client) (interface{}, error) {
|
|
return nil, errors.New("net/rpc plugin protocol not supported")
|
|
}
|