pulumi/pkg/resource/plugin/provider_plugin.go
joeduffy a6caef973a Make assets and archives 1st class
This change recognizes assets and archives as 1st class resource
property values.  This is necessary to support them in the new bridge
work, and lays the foundation for fixing pulumi/lumi#153.

I also took the opportunity to clean up some old cruft in the
resource properties area.
2017-07-14 12:28:43 -07:00

255 lines
8.6 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package plugin
import (
"fmt"
"path/filepath"
"strings"
"github.com/golang/glog"
"github.com/pkg/errors"
"github.com/pulumi/lumi/pkg/resource"
"github.com/pulumi/lumi/pkg/tokens"
"github.com/pulumi/lumi/pkg/util/contract"
"github.com/pulumi/lumi/pkg/workspace"
"github.com/pulumi/lumi/sdk/go/pkg/lumirpc"
)
const ProviderPluginPrefix = "lumi-resource-"
// provider reflects a resource plugin, loaded dynamically for a single package.
type provider struct {
ctx *Context
pkg tokens.Package
plug *plugin
client lumirpc.ResourceProviderClient
}
// NewProvider attempts to bind to a given package's resource plugin and then creates a gRPC connection to it. If the
// plugin could not be found, or an error occurs while creating the child process, an error is returned.
func NewProvider(host Host, ctx *Context, pkg tokens.Package) (Provider, error) {
// Setup the search paths; first, the naked name (found on the PATH); next, the fully qualified name.
srvexe := ProviderPluginPrefix + strings.Replace(string(pkg), tokens.QNameDelimiter, "_", -1)
paths := []string{
srvexe, // naked PATH.
filepath.Join(
workspace.InstallRoot(), workspace.InstallRootLibdir, string(pkg), srvexe), // qualified name.
}
// Now go ahead and attempt to load the plugin.
plug, err := newPlugin(host, ctx, paths, fmt.Sprintf("resource[%v]", pkg))
if err != nil {
return nil, err
}
return &provider{
ctx: ctx,
pkg: pkg,
plug: plug,
client: lumirpc.NewResourceProviderClient(plug.Conn),
}, nil
}
func (p *provider) Pkg() tokens.Package { return p.pkg }
// Check validates that the given property bag is valid for a resource of the given type.
func (p *provider) Check(t tokens.Type, props resource.PropertyMap) ([]CheckFailure, error) {
glog.V(7).Infof("resource[%v].Check(t=%v,#props=%v) executing", p.pkg, t, len(props))
pstr, unks := MarshalPropertiesWithUnknowns(props, MarshalOptions{
OldURNs: true, // permit old URNs, since this is pre-update.
RawResources: true, // pre-create, resource.IDs won't be ready, just ship over the URNs.
})
req := &lumirpc.CheckRequest{
Type: string(t),
Properties: pstr,
Unknowns: unks,
}
resp, err := p.client.Check(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].Check(t=%v,...) failed: err=%v", p.pkg, t, err)
return nil, err
}
var failures []CheckFailure
for _, failure := range resp.GetFailures() {
failures = append(failures, CheckFailure{resource.PropertyKey(failure.Property), failure.Reason})
}
glog.V(7).Infof("resource[%v].Check(t=%v,...) success: failures=#%v", p.pkg, t, len(failures))
return failures, nil
}
// Name names a given resource.
func (p *provider) Name(t tokens.Type, props resource.PropertyMap) (tokens.QName, error) {
contract.Assert(t != "")
contract.Assert(props != nil)
glog.V(7).Infof("resource[%v].Name(t=%v,#props=%v) executing", p.pkg, t, len(props))
pstr, unks := MarshalPropertiesWithUnknowns(props, MarshalOptions{
OldURNs: true, // permit old URNs, since this is pre-update.
RawResources: true, // pre-create, resource.IDs won't be ready, just ship over the URNs.
})
req := &lumirpc.NameRequest{
Type: string(t),
Properties: pstr,
Unknowns: unks,
}
resp, err := p.client.Name(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].Name(t=%v,...) failed: err=%v", p.pkg, t, err)
return "", err
}
name := tokens.QName(resp.GetName())
glog.V(7).Infof("resource[%v].Name(t=%v,...) success: name=%v", p.pkg, t, name)
return name, nil
}
// Create allocates a new instance of the provided resource and assigns its unique resource.ID afterwards.
func (p *provider) Create(t tokens.Type, props resource.PropertyMap) (resource.ID, resource.Status, error) {
contract.Assert(t != "")
contract.Assert(props != nil)
glog.V(7).Infof("resource[%v].Create(t=%v,#props=%v) executing", p.pkg, t, len(props))
req := &lumirpc.CreateRequest{
Type: string(t),
Properties: MarshalProperties(props, MarshalOptions{}),
}
resp, err := p.client.Create(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].Create(t=%v,...) failed: err=%v", p.pkg, t, err)
return "", resource.StatusUnknown, err
}
id := resource.ID(resp.GetId())
glog.V(7).Infof("resource[%v].Create(t=%v,...) success: id=%v", p.pkg, t, id)
if id == "" {
return "", resource.StatusUnknown,
errors.Errorf("plugin for package '%v' returned empty resource.ID from create '%v'", p.pkg, t)
}
return id, resource.StatusOK, nil
}
// Get reads the instance state identified by res, and copies into the resource object.
func (p *provider) Get(t tokens.Type, id resource.ID) (resource.PropertyMap, error) {
contract.Assert(t != "")
contract.Assert(id != "")
glog.V(7).Infof("resource[%v].Get(id=%v,t=%v) executing", p.pkg, id, t)
req := &lumirpc.GetRequest{
Type: string(t),
Id: string(id),
}
resp, err := p.client.Get(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].Get(id=%v,t=%v) failed: err=%v", p.pkg, id, t, err)
return nil, err
}
props := UnmarshalProperties(resp.GetProperties(), MarshalOptions{})
glog.V(7).Infof("resource[%v].Get(id=%v,t=%v) success: #outs=%v", p.pkg, t, id, len(props))
return props, nil
}
// InspectChange checks what impacts a hypothetical update will have on the resource's properties.
func (p *provider) InspectChange(t tokens.Type, id resource.ID,
olds resource.PropertyMap, news resource.PropertyMap) ([]resource.PropertyKey, resource.PropertyMap, error) {
contract.Assert(t != "")
contract.Assert(id != "")
contract.Assert(news != nil)
contract.Assert(olds != nil)
glog.V(7).Infof("resource[%v].InspectChange(id=%v,t=%v,#olds=%v,#news=%v) executing",
p.pkg, id, t, len(olds), len(news))
newpstr, newunks := MarshalPropertiesWithUnknowns(news, MarshalOptions{
RawResources: true, // pre-change, resource.IDs won't be ready, ship over URNs.
})
req := &lumirpc.InspectChangeRequest{
Id: string(id),
Type: string(t),
Olds: MarshalProperties(olds, MarshalOptions{
RawResources: true, // just leave these as-is, so they match the news.
}),
News: newpstr,
Unknowns: newunks,
}
resp, err := p.client.InspectChange(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].InspectChange(id=%v,t=%v,...) failed: %v", p.pkg, id, t, err)
return nil, nil, err
}
var replaces []resource.PropertyKey
for _, replace := range resp.GetReplaces() {
replaces = append(replaces, resource.PropertyKey(replace))
}
changes := UnmarshalProperties(resp.GetChanges(), MarshalOptions{RawResources: true})
glog.V(7).Infof("resource[%v].Update(id=%v,t=%v,...) success: #replaces=%v #changes=%v",
p.pkg, id, t, len(replaces), len(changes))
if glog.V(9) {
for i, repl := range replaces {
glog.V(9).Infof("resource[%v].Update(id=%v,t=%v,...) repace #%v: %v", p.pkg, id, t, i, repl)
}
}
return replaces, changes, nil
}
// Update updates an existing resource with new values.
func (p *provider) Update(t tokens.Type, id resource.ID,
olds resource.PropertyMap, news resource.PropertyMap) (resource.Status, error) {
contract.Assert(t != "")
contract.Assert(id != "")
contract.Assert(news != nil)
contract.Assert(olds != nil)
glog.V(7).Infof("resource[%v].Update(id=%v,t=%v,#olds=%v,#news=%v) executing",
p.pkg, id, t, len(olds), len(news))
req := &lumirpc.UpdateRequest{
Id: string(id),
Type: string(t),
Olds: MarshalProperties(olds, MarshalOptions{
OldURNs: true, // permit old URNs since these are the old values.
}),
News: MarshalProperties(news, MarshalOptions{}),
}
_, err := p.client.Update(p.ctx.Request(), req)
if err != nil {
glog.V(7).Infof("resource[%v].Update(id=%v,t=%v,...) failed: %v", p.pkg, id, t, err)
return resource.StatusUnknown, err
}
glog.V(7).Infof("resource[%v].Update(id=%v,t=%v,...) success", p.pkg, id, t)
return resource.StatusOK, nil
}
// Delete tears down an existing resource.
func (p *provider) Delete(t tokens.Type, id resource.ID) (resource.Status, error) {
contract.Assert(t != "")
contract.Assert(id != "")
glog.V(7).Infof("resource[%v].Delete(id=%v,t=%v) executing", p.pkg, id, t)
req := &lumirpc.DeleteRequest{
Id: string(id),
Type: string(t),
}
if _, err := p.client.Delete(p.ctx.Request(), req); err != nil {
glog.V(7).Infof("resource[%v].Delete(id=%v,t=%v) failed: %v", p.pkg, id, t, err)
return resource.StatusUnknown, err
}
glog.V(7).Infof("resource[%v].Delete(id=%v,t=%v) success", p.pkg, id, t)
return resource.StatusOK, nil
}
// Close tears down the underlying plugin RPC connection and process.
func (p *provider) Close() error {
return p.plug.Close()
}