bcc5c4a8bd
Driver plugin framework to facilitate development of driver plugins.
Implementing plugins only need to implement the DriverPlugin interface.
The framework proxies this interface to the go-plugin GRPC interface generated
from the driver.proto spec.
A testing harness is provided to allow implementing drivers to test the full
lifecycle of the driver plugin. An example use:
func TestMyDriver(t *testing.T) {
harness := NewDriverHarness(t, &MyDiverPlugin{})
// The harness implements the DriverPlugin interface and can be used as such
taskHandle, err := harness.StartTask(...)
}
69 lines
1.9 KiB
Go
69 lines
1.9 KiB
Go
package base
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"reflect"
|
|
|
|
plugin "github.com/hashicorp/go-plugin"
|
|
"github.com/hashicorp/nomad/plugins/base/proto"
|
|
"github.com/ugorji/go/codec"
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
const (
|
|
// PluginTypeBase implements the base plugin interface
|
|
PluginTypeBase = "base"
|
|
|
|
// PluginTypeDriver implements the driver plugin interface
|
|
PluginTypeDriver = "driver"
|
|
|
|
// PluginTypeDevice implements the device plugin interface
|
|
PluginTypeDevice = "device"
|
|
)
|
|
|
|
var (
|
|
// Handshake is a common handshake that is shared by all plugins and Nomad.
|
|
Handshake = plugin.HandshakeConfig{
|
|
ProtocolVersion: 1,
|
|
MagicCookieKey: "NOMAD_PLUGIN_MAGIC_COOKIE",
|
|
MagicCookieValue: "e4327c2e01eabfd75a8a67adb114fb34a757d57eee7728d857a8cec6e91a7255",
|
|
}
|
|
)
|
|
|
|
// PluginBase is wraps a BasePlugin and implements go-plugins GRPCPlugin
|
|
// interface to expose the interface over gRPC.
|
|
type PluginBase struct {
|
|
plugin.NetRPCUnsupportedPlugin
|
|
Impl BasePlugin
|
|
}
|
|
|
|
func (p *PluginBase) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error {
|
|
proto.RegisterBasePluginServer(s, &basePluginServer{
|
|
impl: p.Impl,
|
|
broker: broker,
|
|
})
|
|
return nil
|
|
}
|
|
|
|
func (p *PluginBase) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
|
|
return &BasePluginClient{Client: proto.NewBasePluginClient(c)}, nil
|
|
}
|
|
|
|
// MsgpackHandle is a shared handle for encoding/decoding of structs
|
|
var MsgpackHandle = func() *codec.MsgpackHandle {
|
|
h := &codec.MsgpackHandle{RawToString: true}
|
|
h.MapType = reflect.TypeOf(map[string]interface{}(nil))
|
|
return h
|
|
}()
|
|
|
|
// MsgPackDecode is used to decode a MsgPack encoded object
|
|
func MsgPackDecode(buf []byte, out interface{}) error {
|
|
return codec.NewDecoder(bytes.NewReader(buf), MsgpackHandle).Decode(out)
|
|
}
|
|
|
|
// MsgPackEncode is used to encode an object to MsgPack
|
|
func MsgPackEncode(b *[]byte, in interface{}) error {
|
|
return codec.NewEncoderBytes(b, MsgpackHandle).Encode(in)
|
|
}
|