pulumi/pkg/resource/plugin/context.go
2018-05-22 15:02:47 -07:00

73 lines
2.2 KiB
Go

// Copyright 2016-2018, 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 plugin
import (
"context"
"github.com/opentracing/opentracing-go"
"github.com/pulumi/pulumi/pkg/diag"
"github.com/pulumi/pulumi/pkg/util/rpcutil"
)
// Context is used to group related operations together so that associated OS resources can be cached, shared, and
// reclaimed as appropriate.
type Context struct {
Diag diag.Sink // the diagnostics sink to use for messages.
Host Host // the host that can be used to fetch providers.
Pwd string // the working directory to spawn all plugins in.
tracingSpan opentracing.Span // the OpenTracing span to parent requests within.
}
// NewContext allocates a new context with a given sink and host. Note that the host is "owned" by this context from
// here forwards, such that when the context's resources are reclaimed, so too are the host's.
func NewContext(d diag.Sink, host Host, cfg ConfigSource, events Events,
pwd string, parentSpan opentracing.Span) (*Context, error) {
ctx := &Context{
Diag: d,
Host: host,
Pwd: pwd,
tracingSpan: parentSpan,
}
if host == nil {
h, err := NewDefaultHost(ctx, cfg, events)
if err != nil {
return nil, err
}
ctx.Host = h
}
return ctx, nil
}
// Request allocates a request sub-context.
func (ctx *Context) Request() context.Context {
// TODO[pulumi/pulumi#143]: support cancellation.
return opentracing.ContextWithSpan(context.Background(), ctx.tracingSpan)
}
// Close reclaims all resources associated with this context.
func (ctx *Context) Close() error {
if ctx.tracingSpan != nil {
ctx.tracingSpan.Finish()
}
err := ctx.Host.Close()
if err != nil && !rpcutil.IsBenignCloseErr(err) {
return err
}
return nil
}