-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
func rpc.Provider(rpc.ResourceProviderServer) p.Provider
`rpc.Provider` provides a thunking layer to allow a pulumi-go-provider based provider to wrap a `rpc.ResourceProviderServer`. This will allow piece-wise transfer of native providers to the pulumi-go-provider framework. Unlike the pulumi-terraform-bridge's [muxer](https://github.com/pulumi/pulumi-terraform-bridge/tree/master/x/muxer), `rpc.Provider` does not split at the RPC level directly. Instead it converts the shim layer provided by https://github.com/pulumi/pulumi-go-provider back into "github.com/pulumi/pulumi/sdk/v3/proto/go". This makes wrapped rpc providers able to interact with `integration` based tests and to benefit from intercepting middleware (like `cancel` and `schema`). Fixes #216
- Loading branch information
Showing
3 changed files
with
1,288 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,354 @@ | ||
// Copyright 2024, Pulumi Corporation. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package rpc | ||
|
||
import ( | ||
"errors" | ||
|
||
structpb "github.com/golang/protobuf/ptypes/struct" | ||
"github.com/pulumi/pulumi/sdk/v3/go/common/resource" | ||
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin" | ||
rpc "github.com/pulumi/pulumi/sdk/v3/proto/go" | ||
"google.golang.org/protobuf/types/known/emptypb" | ||
|
||
p "github.com/pulumi/pulumi-go-provider" | ||
) | ||
|
||
// Provider projects a [rpc.ResourceProviderServer] into a [p.Provider]. | ||
// | ||
// It is intended that Provider is used to wrap legacy native provider implementations | ||
// while they are gradually transferred over to pulumi-go-provider based implementations. | ||
// | ||
// Construct, Call and StreamInvoke are not supported and will always return | ||
// unimplemented. | ||
func Provider(server rpc.ResourceProviderServer) p.Provider { | ||
var runtime runtime // the runtime configuration of the server | ||
return p.Provider{ | ||
GetSchema: func(ctx p.Context, req p.GetSchemaRequest) (p.GetSchemaResponse, error) { | ||
s, err := server.GetSchema(ctx, &rpc.GetSchemaRequest{ | ||
Version: int32(req.Version), | ||
}) | ||
return p.GetSchemaResponse{ | ||
Schema: s.GetSchema(), | ||
}, err | ||
}, | ||
Cancel: func(ctx p.Context) error { | ||
_, err := server.Cancel(ctx, &emptypb.Empty{}) | ||
return err | ||
}, | ||
CheckConfig: func(ctx p.Context, req p.CheckRequest) (p.CheckResponse, error) { | ||
olds, err := runtime.propertyToRPC(req.Olds) | ||
if err != nil { | ||
return p.CheckResponse{}, err | ||
} | ||
|
||
news, err := runtime.propertyToRPC(req.News) | ||
if err != nil { | ||
return p.CheckResponse{}, err | ||
} | ||
|
||
return checkResponse(server.CheckConfig(ctx, &rpc.CheckRequest{ | ||
Urn: string(req.Urn), | ||
Olds: olds, | ||
News: news, | ||
RandomSeed: req.RandomSeed, | ||
})) | ||
}, | ||
DiffConfig: func(ctx p.Context, req p.DiffRequest) (p.DiffResponse, error) { | ||
ignoreChanges := make([]string, len(req.IgnoreChanges)) | ||
for i, v := range req.IgnoreChanges { | ||
ignoreChanges[i] = string(v) | ||
} | ||
olds, err := runtime.propertyToRPC(req.Olds) | ||
if err != nil { | ||
return p.DiffResponse{}, err | ||
} | ||
news, err := runtime.propertyToRPC(req.News) | ||
if err != nil { | ||
return p.DiffResponse{}, err | ||
} | ||
|
||
return diffResponse(server.DiffConfig(ctx, &rpc.DiffRequest{ | ||
Id: req.ID, | ||
Urn: string(req.Urn), | ||
Olds: olds, | ||
News: news, | ||
IgnoreChanges: ignoreChanges, | ||
})) | ||
}, | ||
Configure: func(ctx p.Context, req p.ConfigureRequest) error { | ||
args, err := runtime.propertyToRPC(req.Args) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
runtime.configuration, err = server.Configure(ctx, &rpc.ConfigureRequest{ | ||
Variables: req.Variables, | ||
Args: args, | ||
AcceptSecrets: true, | ||
AcceptResources: true, | ||
}) | ||
return err | ||
}, | ||
Invoke: func(ctx p.Context, req p.InvokeRequest) (p.InvokeResponse, error) { | ||
|
||
args, err := runtime.propertyToRPC(req.Args) | ||
if err != nil { | ||
return p.InvokeResponse{}, err | ||
} | ||
|
||
resp, err := server.Invoke(ctx, &rpc.InvokeRequest{ | ||
Tok: string(req.Token), | ||
Args: args, | ||
}) | ||
ret, err := rpcToProperty(resp.GetReturn(), err) | ||
return p.InvokeResponse{ | ||
Return: ret, | ||
Failures: checkFailures(resp.GetFailures()), | ||
}, err | ||
}, | ||
Check: func(ctx p.Context, req p.CheckRequest) (p.CheckResponse, error) { | ||
olds, err := runtime.propertyToRPC(req.Olds) | ||
if err != nil { | ||
return p.CheckResponse{}, err | ||
} | ||
|
||
news, err := runtime.propertyToRPC(req.News) | ||
if err != nil { | ||
return p.CheckResponse{}, err | ||
} | ||
|
||
return checkResponse(server.Check(ctx, &rpc.CheckRequest{ | ||
Urn: string(req.Urn), | ||
Olds: olds, | ||
News: news, | ||
RandomSeed: req.RandomSeed, | ||
})) | ||
}, | ||
Diff: func(ctx p.Context, req p.DiffRequest) (p.DiffResponse, error) { | ||
ignoreChanges := make([]string, len(req.IgnoreChanges)) | ||
for i, v := range req.IgnoreChanges { | ||
ignoreChanges[i] = string(v) | ||
} | ||
olds, err := runtime.propertyToRPC(req.Olds) | ||
if err != nil { | ||
return p.DiffResponse{}, err | ||
} | ||
|
||
news, err := runtime.propertyToRPC(req.News) | ||
if err != nil { | ||
return p.DiffResponse{}, err | ||
} | ||
|
||
return diffResponse(server.Diff(ctx, &rpc.DiffRequest{ | ||
Id: req.ID, | ||
Urn: string(req.Urn), | ||
Olds: olds, | ||
News: news, | ||
IgnoreChanges: ignoreChanges, | ||
})) | ||
}, | ||
Create: func(ctx p.Context, req p.CreateRequest) (p.CreateResponse, error) { | ||
if req.Preview && runtime.configuration != nil && !runtime.configuration.SupportsPreview { | ||
return p.CreateResponse{}, nil | ||
} | ||
|
||
inProperties, err := runtime.propertyToRPC(req.Properties) | ||
if err != nil { | ||
return p.CreateResponse{}, err | ||
} | ||
|
||
resp, err := server.Create(ctx, &rpc.CreateRequest{ | ||
Urn: string(req.Urn), | ||
Properties: inProperties, | ||
Timeout: req.Timeout, | ||
Preview: req.Preview, | ||
}) | ||
properties, err := rpcToProperty(resp.GetProperties(), err) | ||
return p.CreateResponse{ | ||
ID: resp.GetId(), | ||
Properties: properties, | ||
}, err | ||
}, | ||
Read: func(ctx p.Context, req p.ReadRequest) (p.ReadResponse, error) { | ||
inProperties, err := runtime.propertyToRPC(req.Properties) | ||
if err != nil { | ||
return p.ReadResponse{}, err | ||
} | ||
inInputs, err := runtime.propertyToRPC(req.Inputs) | ||
if err != nil { | ||
return p.ReadResponse{}, err | ||
} | ||
|
||
resp, err := server.Read(ctx, &rpc.ReadRequest{ | ||
Id: req.ID, | ||
Urn: string(req.Urn), | ||
Properties: inProperties, | ||
Inputs: inInputs, | ||
}) | ||
properties, err := rpcToProperty(resp.GetProperties(), err) | ||
inputs, err := rpcToProperty(resp.GetInputs(), err) | ||
return p.ReadResponse{ | ||
ID: resp.GetId(), | ||
Properties: properties, | ||
Inputs: inputs, | ||
}, err | ||
}, | ||
Update: func(ctx p.Context, req p.UpdateRequest) (p.UpdateResponse, error) { | ||
if req.Preview && runtime.configuration != nil && !runtime.configuration.SupportsPreview { | ||
return p.UpdateResponse{}, nil | ||
} | ||
ignoreChanges := make([]string, len(req.IgnoreChanges)) | ||
for i, v := range req.IgnoreChanges { | ||
ignoreChanges[i] = string(v) | ||
} | ||
|
||
inOlds, err := runtime.propertyToRPC(req.Olds) | ||
if err != nil { | ||
return p.UpdateResponse{}, err | ||
} | ||
|
||
inNews, err := runtime.propertyToRPC(req.News) | ||
if err != nil { | ||
return p.UpdateResponse{}, err | ||
} | ||
|
||
resp, err := server.Update(ctx, &rpc.UpdateRequest{ | ||
Id: req.ID, | ||
Urn: string(req.Urn), | ||
Olds: inOlds, | ||
News: inNews, | ||
Timeout: req.Timeout, | ||
IgnoreChanges: ignoreChanges, | ||
Preview: req.Preview, | ||
}) | ||
|
||
properties, err := rpcToProperty(resp.GetProperties(), err) | ||
return p.UpdateResponse{ | ||
Properties: properties, | ||
}, err | ||
}, | ||
Delete: func(ctx p.Context, req p.DeleteRequest) error { | ||
properties, err := runtime.propertyToRPC(req.Properties) | ||
if err != nil { | ||
return err | ||
} | ||
_, err = server.Delete(ctx, &rpc.DeleteRequest{ | ||
Id: req.ID, | ||
Urn: string(req.Urn), | ||
Properties: properties, | ||
Timeout: req.Timeout, | ||
}) | ||
return err | ||
}, | ||
} | ||
} | ||
|
||
func checkResponse(resp *rpc.CheckResponse, err error) (p.CheckResponse, error) { | ||
inputs, err := rpcToProperty(resp.GetInputs(), err) | ||
return p.CheckResponse{ | ||
Inputs: inputs, | ||
Failures: checkFailures(resp.GetFailures()), | ||
}, err | ||
} | ||
|
||
func diffResponse(resp *rpc.DiffResponse, err error) (p.DiffResponse, error) { | ||
detailedDiff := make(map[string]p.PropertyDiff, len(resp.GetDetailedDiff())) | ||
if resp.GetHasDetailedDiff() { | ||
for k, v := range resp.GetDetailedDiff() { | ||
var kind p.DiffKind | ||
switch v.Kind { | ||
case rpc.PropertyDiff_ADD: | ||
kind = p.Add | ||
case rpc.PropertyDiff_ADD_REPLACE: | ||
kind = p.AddReplace | ||
case rpc.PropertyDiff_DELETE: | ||
kind = p.Delete | ||
case rpc.PropertyDiff_DELETE_REPLACE: | ||
kind = p.DeleteReplace | ||
case rpc.PropertyDiff_UPDATE: | ||
kind = p.Update | ||
case rpc.PropertyDiff_UPDATE_REPLACE: | ||
kind = p.UpdateReplace | ||
} | ||
detailedDiff[k] = p.PropertyDiff{ | ||
Kind: kind, | ||
InputDiff: v.InputDiff, | ||
} | ||
} | ||
} else { | ||
// We need to emulate support for a non-detailed diff | ||
|
||
for _, update := range resp.GetDiffs() { | ||
detailedDiff[update] = p.PropertyDiff{Kind: p.Update} | ||
} | ||
for _, replace := range resp.GetReplaces() { | ||
detailedDiff[replace] = p.PropertyDiff{Kind: p.UpdateReplace} | ||
} | ||
} | ||
if len(detailedDiff) == 0 { | ||
detailedDiff = nil | ||
} | ||
return p.DiffResponse{ | ||
DeleteBeforeReplace: resp.GetDeleteBeforeReplace(), | ||
HasChanges: resp.GetChanges() == rpc.DiffResponse_DIFF_SOME, | ||
DetailedDiff: detailedDiff, | ||
}, err | ||
} | ||
|
||
func checkFailures(resp []*rpc.CheckFailure) []p.CheckFailure { | ||
if resp == nil { | ||
return nil | ||
} | ||
arr := make([]p.CheckFailure, len(resp)) | ||
for i, v := range resp { | ||
arr[i] = p.CheckFailure{ | ||
Property: v.Property, | ||
Reason: v.Reason, | ||
} | ||
} | ||
return arr | ||
} | ||
|
||
type runtime struct { | ||
configuration *rpc.ConfigureResponse | ||
} | ||
|
||
func (r runtime) propertyToRPC(m resource.PropertyMap) (*structpb.Struct, error) { | ||
if r.configuration == nil { | ||
r.configuration = &rpc.ConfigureResponse{} | ||
} | ||
s, err := plugin.MarshalProperties(m, plugin.MarshalOptions{ | ||
KeepUnknowns: r.configuration.SupportsPreview, | ||
KeepSecrets: r.configuration.AcceptSecrets, | ||
KeepResources: r.configuration.AcceptResources, | ||
KeepOutputValues: r.configuration.AcceptOutputs, | ||
}) | ||
return s, err | ||
} | ||
|
||
func rpcToProperty(s *structpb.Struct, previousError error) (resource.PropertyMap, error) { | ||
if s == nil { | ||
return nil, previousError | ||
} | ||
m, err := plugin.UnmarshalProperties(s, plugin.MarshalOptions{ | ||
SkipNulls: false, | ||
KeepUnknowns: true, | ||
KeepSecrets: true, | ||
KeepResources: true, | ||
KeepOutputValues: true, | ||
}) | ||
return m, errors.Join(err, previousError) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.