IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2025-02-25 18:45:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

Introduces cloudproto1 plugin interface

Browse Source
This commit is contained in:
Brandon Croft 2023-06-30 14:46:16 -06:00
parent fec1ca69ac
commit 539e140d3e
No known key found for this signature in database
GPG Key ID: B01E32423322EB9D
5 changed files with 543 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
internal/cloudplugin/cloudplugin1/grpc_client.go Normal file
View File

@ -0,0 +1,72 @@
package cloudplugin1
import (
"context"
"fmt"
"io"
"log"
"github.com/hashicorp/terraform/internal/cloudplugin"
"github.com/hashicorp/terraform/internal/cloudplugin/cloudproto1"
)
// GRPCCloudClient is the client interface for interacting with terraform-cloudplugin
type GRPCCloudClient struct {
client cloudproto1.CommandServiceClient
context context.Context
}
// Proof that GRPCCloudClient fulfills the go-plugin interface
var _ cloudplugin.Cloud1 = GRPCCloudClient{}
// Execute sends the client Execute request and waits for the plugin to return
// an exit code response before returning
func (c GRPCCloudClient) Execute(args []string, stdout, stderr io.Writer) int {
client, err := c.client.Execute(c.context, &cloudproto1.CommandRequest{
Args: args,
})
if err != nil {
fmt.Fprint(stderr, err.Error())
return 1
}
for {
// cloudplugin streams output as multiple CommandResponse value. Each
// value will either contain stdout bytes, stderr bytes, or an exit code.
response, err := client.Recv()
if err == io.EOF {
log.Print("[DEBUG] received EOF from cloudplugin")
break
} else if err != nil {
fmt.Fprintf(stderr, "Failed to receive command response from cloudplugin: %s", err)
return 1
}
if bytes := response.GetStdout(); len(bytes) > 0 {
_, err := fmt.Fprint(stdout, string(bytes))
if err != nil {
log.Printf("[ERROR] Failed to write cloudplugin output to stdout: %s", err)
return 1
}
} else if bytes := response.GetStderr(); len(bytes) > 0 {
fmt.Fprint(stderr, string(bytes))
if err != nil {
log.Printf("[ERROR] Failed to write cloudplugin output to stderr: %s", err)
return 1
}
} else {
exitCode := response.GetExitCode()
log.Printf("[TRACE] received exit code: %d", exitCode)
if exitCode < 0 || exitCode > 255 {
log.Printf("[ERROR] cloudplugin returned an invalid error code %d", exitCode)
return 255
}
return int(exitCode)
}
}
// This should indicate a bug in the plugin
fmt.Fprint(stderr, "cloudplugin exited without responding with an error code")
return 1
}

45
internal/cloudplugin/cloudplugin1/grpc_plugin.go Normal file
View File

@ -0,0 +1,45 @@
package cloudplugin1
import (
"context"
"errors"
"net/rpc"
"github.com/hashicorp/go-plugin"
"github.com/hashicorp/terraform/internal/cloudplugin"
"github.com/hashicorp/terraform/internal/cloudplugin/cloudproto1"
"google.golang.org/grpc"
)
// GRPCCloudPlugin is the go-plugin implementation, but only the client
// implementation exists in this package.
type GRPCCloudPlugin struct {
plugin.GRPCPlugin
Impl cloudplugin.Cloud1
}
// Server always returns an error; we're only implementing the GRPCPlugin
// interface, not the Plugin interface.
func (p *GRPCCloudPlugin) Server(*plugin.MuxBroker) (interface{}, error) {
return nil, errors.New("cloudplugin only implements gRPC clients")
}
// Client always returns an error; we're only implementing the GRPCPlugin
// interface, not the Plugin interface.
func (p *GRPCCloudPlugin) Client(*plugin.MuxBroker, *rpc.Client) (interface{}, error) {
return nil, errors.New("cloudplugin only implements gRPC clients")
}
// GRPCServer always returns an error; we're only implementing the client
// interface, not the server.
func (p *GRPCCloudPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error {
return errors.New("cloudplugin only implements gRPC clients")
}
// GRPCClient returns a new GRPC client for interacting with the cloud plugin server.
func (p *GRPCCloudPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
return &GRPCCloudClient{
client: cloudproto1.NewCommandServiceClient(c),
context: ctx,
}, nil
}

390
internal/cloudplugin/cloudproto1/cloudproto1.pb.go Normal file
View File

@ -0,0 +1,390 @@
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.28.1
// protoc v3.15.6
// source: cloudproto1.proto
package cloudproto1
import (
context "context"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// CommandRequest is used to request the execution of a specific command with
// provided flags. It is the raw args from the terraform cloud command.
type CommandRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Args []string `protobuf:"bytes,1,rep,name=args,proto3" json:"args,omitempty"`
}
func (x *CommandRequest) Reset() {
*x = CommandRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_cloudproto1_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *CommandRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*CommandRequest) ProtoMessage() {}
func (x *CommandRequest) ProtoReflect() protoreflect.Message {
mi := &file_cloudproto1_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use CommandRequest.ProtoReflect.Descriptor instead.
func (*CommandRequest) Descriptor() ([]byte, []int) {
return file_cloudproto1_proto_rawDescGZIP(), []int{0}
}
func (x *CommandRequest) GetArgs() []string {
if x != nil {
return x.Args
}
return nil
}
// CommandResponse contains the result of the command execution, including any
// output or errors.
type CommandResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Types that are assignable to Data:
//
// *CommandResponse_ExitCode
// *CommandResponse_Stdout
// *CommandResponse_Stderr
Data isCommandResponse_Data `protobuf_oneof:"data"`
}
func (x *CommandResponse) Reset() {
*x = CommandResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_cloudproto1_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *CommandResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*CommandResponse) ProtoMessage() {}
func (x *CommandResponse) ProtoReflect() protoreflect.Message {
mi := &file_cloudproto1_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use CommandResponse.ProtoReflect.Descriptor instead.
func (*CommandResponse) Descriptor() ([]byte, []int) {
return file_cloudproto1_proto_rawDescGZIP(), []int{1}
}
func (m *CommandResponse) GetData() isCommandResponse_Data {
if m != nil {
return m.Data
}
return nil
}
func (x *CommandResponse) GetExitCode() int32 {
if x, ok := x.GetData().(*CommandResponse_ExitCode); ok {
return x.ExitCode
}
return 0
}
func (x *CommandResponse) GetStdout() []byte {
if x, ok := x.GetData().(*CommandResponse_Stdout); ok {
return x.Stdout
}
return nil
}
func (x *CommandResponse) GetStderr() []byte {
if x, ok := x.GetData().(*CommandResponse_Stderr); ok {
return x.Stderr
}
return nil
}
type isCommandResponse_Data interface {
isCommandResponse_Data()
}
type CommandResponse_ExitCode struct {
ExitCode int32 `protobuf:"varint,1,opt,name=exitCode,proto3,oneof"`
}
type CommandResponse_Stdout struct {
Stdout []byte `protobuf:"bytes,2,opt,name=stdout,proto3,oneof"`
}
type CommandResponse_Stderr struct {
Stderr []byte `protobuf:"bytes,3,opt,name=stderr,proto3,oneof"`
}
func (*CommandResponse_ExitCode) isCommandResponse_Data() {}
func (*CommandResponse_Stdout) isCommandResponse_Data() {}
func (*CommandResponse_Stderr) isCommandResponse_Data() {}
var File_cloudproto1_proto protoreflect.FileDescriptor
var file_cloudproto1_proto_rawDesc = []byte{
0x0a, 0x11, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x31, 0x2e, 0x70, 0x72,
0x6f, 0x74, 0x6f, 0x12, 0x0b, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x31,
0x22, 0x24, 0x0a, 0x0e, 0x43, 0x6f, 0x6d, 0x6d, 0x61, 0x6e, 0x64, 0x52, 0x65, 0x71, 0x75, 0x65,
0x73, 0x74, 0x12, 0x12, 0x0a, 0x04, 0x61, 0x72, 0x67, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x09,
0x52, 0x04, 0x61, 0x72, 0x67, 0x73, 0x22, 0x6b, 0x0a, 0x0f, 0x43, 0x6f, 0x6d, 0x6d, 0x61, 0x6e,
0x64, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x1c, 0x0a, 0x08, 0x65, 0x78, 0x69,
0x74, 0x43, 0x6f, 0x64, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x05, 0x48, 0x00, 0x52, 0x08, 0x65,
0x78, 0x69, 0x74, 0x43, 0x6f, 0x64, 0x65, 0x12, 0x18, 0x0a, 0x06, 0x73, 0x74, 0x64, 0x6f, 0x75,
0x74, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0c, 0x48, 0x00, 0x52, 0x06, 0x73, 0x74, 0x64, 0x6f, 0x75,
0x74, 0x12, 0x18, 0x0a, 0x06, 0x73, 0x74, 0x64, 0x65, 0x72, 0x72, 0x18, 0x03, 0x20, 0x01, 0x28,
0x0c, 0x48, 0x00, 0x52, 0x06, 0x73, 0x74, 0x64, 0x65, 0x72, 0x72, 0x42, 0x06, 0x0a, 0x04, 0x64,
0x61, 0x74, 0x61, 0x32, 0x5a, 0x0a, 0x0e, 0x43, 0x6f, 0x6d, 0x6d, 0x61, 0x6e, 0x64, 0x53, 0x65,
0x72, 0x76, 0x69, 0x63, 0x65, 0x12, 0x48, 0x0a, 0x07, 0x45, 0x78, 0x65, 0x63, 0x75, 0x74, 0x65,
0x12, 0x1b, 0x2e, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x31, 0x2e, 0x43,
0x6f, 0x6d, 0x6d, 0x61, 0x6e, 0x64, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x1c, 0x2e,
0x63, 0x6c, 0x6f, 0x75, 0x64, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x31, 0x2e, 0x43, 0x6f, 0x6d, 0x6d,
0x61, 0x6e, 0x64, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x00, 0x30, 0x01, 0x42,
0x41, 0x5a, 0x3f, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61,
0x73, 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72,
0x6d, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64,
0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x70, 0x72, 0x6f, 0x74,
0x6f, 0x31, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
}
var (
file_cloudproto1_proto_rawDescOnce sync.Once
file_cloudproto1_proto_rawDescData = file_cloudproto1_proto_rawDesc
)
func file_cloudproto1_proto_rawDescGZIP() []byte {
file_cloudproto1_proto_rawDescOnce.Do(func() {
file_cloudproto1_proto_rawDescData = protoimpl.X.CompressGZIP(file_cloudproto1_proto_rawDescData)
})
return file_cloudproto1_proto_rawDescData
}
var file_cloudproto1_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
var file_cloudproto1_proto_goTypes = []interface{}{
(*CommandRequest)(nil), // 0: cloudproto1.CommandRequest
(*CommandResponse)(nil), // 1: cloudproto1.CommandResponse
}
var file_cloudproto1_proto_depIdxs = []int32{
0, // 0: cloudproto1.CommandService.Execute:input_type -> cloudproto1.CommandRequest
1, // 1: cloudproto1.CommandService.Execute:output_type -> cloudproto1.CommandResponse
1, // [1:2] is the sub-list for method output_type
0, // [0:1] is the sub-list for method input_type
0, // [0:0] is the sub-list for extension type_name
0, // [0:0] is the sub-list for extension extendee
0, // [0:0] is the sub-list for field type_name
}
func init() { file_cloudproto1_proto_init() }
func file_cloudproto1_proto_init() {
if File_cloudproto1_proto != nil {
return
}
if !protoimpl.UnsafeEnabled {
file_cloudproto1_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*CommandRequest); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_cloudproto1_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*CommandResponse); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
}
file_cloudproto1_proto_msgTypes[1].OneofWrappers = []interface{}{
(*CommandResponse_ExitCode)(nil),
(*CommandResponse_Stdout)(nil),
(*CommandResponse_Stderr)(nil),
}
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: file_cloudproto1_proto_rawDesc,
NumEnums: 0,
NumMessages: 2,
NumExtensions: 0,
NumServices: 1,
},
GoTypes: file_cloudproto1_proto_goTypes,
DependencyIndexes: file_cloudproto1_proto_depIdxs,
MessageInfos: file_cloudproto1_proto_msgTypes,
}.Build()
File_cloudproto1_proto = out.File
file_cloudproto1_proto_rawDesc = nil
file_cloudproto1_proto_goTypes = nil
file_cloudproto1_proto_depIdxs = nil
}
// Reference imports to suppress errors if they are not otherwise used.
var _ context.Context
var _ grpc.ClientConnInterface
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
const _ = grpc.SupportPackageIsVersion6
// CommandServiceClient is the client API for CommandService service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type CommandServiceClient interface {
// Execute runs a specific command with the provided flags and returns the result.
Execute(ctx context.Context, in *CommandRequest, opts ...grpc.CallOption) (CommandService_ExecuteClient, error)
}
type commandServiceClient struct {
cc grpc.ClientConnInterface
}
func NewCommandServiceClient(cc grpc.ClientConnInterface) CommandServiceClient {
return &commandServiceClient{cc}
}
func (c *commandServiceClient) Execute(ctx context.Context, in *CommandRequest, opts ...grpc.CallOption) (CommandService_ExecuteClient, error) {
stream, err := c.cc.NewStream(ctx, &_CommandService_serviceDesc.Streams[0], "/cloudproto1.CommandService/Execute", opts...)
if err != nil {
return nil, err
}
x := &commandServiceExecuteClient{stream}
if err := x.ClientStream.SendMsg(in); err != nil {
return nil, err
}
if err := x.ClientStream.CloseSend(); err != nil {
return nil, err
}
return x, nil
}
type CommandService_ExecuteClient interface {
Recv() (*CommandResponse, error)
grpc.ClientStream
}
type commandServiceExecuteClient struct {
grpc.ClientStream
}
func (x *commandServiceExecuteClient) Recv() (*CommandResponse, error) {
m := new(CommandResponse)
if err := x.ClientStream.RecvMsg(m); err != nil {
return nil, err
}
return m, nil
}
// CommandServiceServer is the server API for CommandService service.
type CommandServiceServer interface {
// Execute runs a specific command with the provided flags and returns the result.
Execute(*CommandRequest, CommandService_ExecuteServer) error
}
// UnimplementedCommandServiceServer can be embedded to have forward compatible implementations.
type UnimplementedCommandServiceServer struct {
}
func (*UnimplementedCommandServiceServer) Execute(*CommandRequest, CommandService_ExecuteServer) error {
return status.Errorf(codes.Unimplemented, "method Execute not implemented")
}
func RegisterCommandServiceServer(s *grpc.Server, srv CommandServiceServer) {
s.RegisterService(&_CommandService_serviceDesc, srv)
}
func _CommandService_Execute_Handler(srv interface{}, stream grpc.ServerStream) error {
m := new(CommandRequest)
if err := stream.RecvMsg(m); err != nil {
return err
}
return srv.(CommandServiceServer).Execute(m, &commandServiceExecuteServer{stream})
}
type CommandService_ExecuteServer interface {
Send(*CommandResponse) error
grpc.ServerStream
}
type commandServiceExecuteServer struct {
grpc.ServerStream
}
func (x *commandServiceExecuteServer) Send(m *CommandResponse) error {
return x.ServerStream.SendMsg(m)
}
var _CommandService_serviceDesc = grpc.ServiceDesc{
ServiceName: "cloudproto1.CommandService",
HandlerType: (*CommandServiceServer)(nil),
Methods: []grpc.MethodDesc{},
Streams: []grpc.StreamDesc{
{
StreamName: "Execute",
Handler: _CommandService_Execute_Handler,
ServerStreams: true,
},
},
Metadata: "cloudproto1.proto",
}

27
internal/cloudplugin/cloudproto1/cloudproto1.proto Normal file
View File

@ -0,0 +1,27 @@
syntax = "proto3";
package cloudproto1;
option go_package = "github.com/hashicorp/terraform/internal/cloudplugin/cloudproto1";
// CommandRequest is used to request the execution of a specific command with
// provided flags. It is the raw args from the terraform cloud command.
message CommandRequest {
repeated string args = 1;
}
// CommandResponse contains the result of the command execution, including any
// output or errors.
message CommandResponse {
oneof data {
int32 exitCode = 1;
bytes stdout = 2;
bytes stderr = 3;
}
}
// PluginService defines the gRPC service to handle available commands and
// their execution.
service CommandService {
// Execute runs a specific command with the provided flags and returns the result.
rpc Execute(CommandRequest) returns (stream CommandResponse) {}
}

9
internal/cloudplugin/interface.go Normal file
View File

@ -0,0 +1,9 @@
package cloudplugin
import (
"io"
)
type Cloud1 interface {
Execute(args []string, stdout, stderr io.Writer) int
}