/
pluginhost.go
444 lines (384 loc) 路 11.7 KB
/
pluginhost.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
// 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 deploytest
import (
"context"
"errors"
"fmt"
"io"
"path/filepath"
"sync"
"github.com/blang/semver"
pbempty "github.com/golang/protobuf/ptypes/empty"
"google.golang.org/grpc"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
"github.com/pulumi/pulumi/sdk/v3/go/common/tokens"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/rpcutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
)
var UseGrpcPluginsByDefault = false
type LoadPluginFunc func(opts interface{}) (interface{}, error)
type LoadPluginWithHostFunc func(opts interface{}, host plugin.Host) (interface{}, error)
type LoadProviderFunc func() (plugin.Provider, error)
type LoadProviderWithHostFunc func(host plugin.Host) (plugin.Provider, error)
type LoadAnalyzerFunc func(opts *plugin.PolicyAnalyzerOptions) (plugin.Analyzer, error)
type LoadAnalyzerWithHostFunc func(opts *plugin.PolicyAnalyzerOptions, host plugin.Host) (plugin.Analyzer, error)
type PluginOption func(p *PluginLoader)
func WithoutGrpc(p *PluginLoader) {
p.useGRPC = false
}
func WithGrpc(p *PluginLoader) {
p.useGRPC = true
}
func WithPath(path string) func(p *PluginLoader) {
return func(p *PluginLoader) {
p.path = path
}
}
type PluginLoader struct {
kind workspace.PluginKind
name string
version semver.Version
load LoadPluginFunc
loadWithHost LoadPluginWithHostFunc
path string
useGRPC bool
}
type ProviderOption = PluginOption
type ProviderLoader = PluginLoader
func NewProviderLoader(pkg tokens.Package, version semver.Version, load LoadProviderFunc,
opts ...ProviderOption) *ProviderLoader {
p := &ProviderLoader{
kind: workspace.ResourcePlugin,
name: string(pkg),
version: version,
load: func(_ interface{}) (interface{}, error) { return load() },
useGRPC: UseGrpcPluginsByDefault,
}
for _, o := range opts {
o(p)
}
return p
}
func NewProviderLoaderWithHost(pkg tokens.Package, version semver.Version,
load LoadProviderWithHostFunc, opts ...ProviderOption) *ProviderLoader {
p := &ProviderLoader{
kind: workspace.ResourcePlugin,
name: string(pkg),
version: version,
loadWithHost: func(_ interface{}, host plugin.Host) (interface{}, error) { return load(host) },
useGRPC: UseGrpcPluginsByDefault,
}
for _, o := range opts {
o(p)
}
return p
}
func NewAnalyzerLoader(name string, load LoadAnalyzerFunc, opts ...PluginOption) *PluginLoader {
p := &PluginLoader{
kind: workspace.AnalyzerPlugin,
name: name,
load: func(optsI interface{}) (interface{}, error) {
opts, _ := optsI.(*plugin.PolicyAnalyzerOptions)
return load(opts)
},
}
for _, o := range opts {
o(p)
}
return p
}
func NewAnalyzerLoaderWithHost(name string, load LoadAnalyzerWithHostFunc, opts ...PluginOption) *PluginLoader {
p := &PluginLoader{
kind: workspace.AnalyzerPlugin,
name: name,
loadWithHost: func(optsI interface{}, host plugin.Host) (interface{}, error) {
opts, _ := optsI.(*plugin.PolicyAnalyzerOptions)
return load(opts, host)
},
}
for _, o := range opts {
o(p)
}
return p
}
type nopCloserT int
func (nopCloserT) Close() error { return nil }
var nopCloser io.Closer = nopCloserT(0)
type grpcWrapper struct {
stop chan bool
}
func (w *grpcWrapper) Close() error {
go func() { w.stop <- true }()
return nil
}
func wrapProviderWithGrpc(provider plugin.Provider) (plugin.Provider, io.Closer, error) {
wrapper := &grpcWrapper{stop: make(chan bool)}
port, _, err := rpcutil.Serve(0, wrapper.stop, []func(*grpc.Server) error{
func(srv *grpc.Server) error {
pulumirpc.RegisterResourceProviderServer(srv, plugin.NewProviderServer(provider))
return nil
},
}, nil)
if err != nil {
return nil, nil, fmt.Errorf("could not start resource provider service: %w", err)
}
conn, err := grpc.Dial(
fmt.Sprintf("127.0.0.1:%v", port),
grpc.WithInsecure(),
grpc.WithUnaryInterceptor(rpcutil.OpenTracingClientInterceptor()),
grpc.WithStreamInterceptor(rpcutil.OpenTracingStreamClientInterceptor()),
rpcutil.GrpcChannelOptions(),
)
if err != nil {
contract.IgnoreClose(wrapper)
return nil, nil, fmt.Errorf("could not connect to resource provider service: %v", err)
}
wrapped := plugin.NewProviderWithClient(nil, provider.Pkg(), pulumirpc.NewResourceProviderClient(conn), false)
return wrapped, wrapper, nil
}
type hostEngine struct {
sink diag.Sink
statusSink diag.Sink
address string
stop chan bool
}
func (e *hostEngine) Log(_ context.Context, req *pulumirpc.LogRequest) (*pbempty.Empty, error) {
var sev diag.Severity
switch req.Severity {
case pulumirpc.LogSeverity_DEBUG:
sev = diag.Debug
case pulumirpc.LogSeverity_INFO:
sev = diag.Info
case pulumirpc.LogSeverity_WARNING:
sev = diag.Warning
case pulumirpc.LogSeverity_ERROR:
sev = diag.Error
default:
return nil, fmt.Errorf("Unrecognized logging severity: %v", req.Severity)
}
if req.Ephemeral {
e.statusSink.Logf(sev, diag.StreamMessage(resource.URN(req.Urn), req.Message, req.StreamId))
} else {
e.sink.Logf(sev, diag.StreamMessage(resource.URN(req.Urn), req.Message, req.StreamId))
}
return &pbempty.Empty{}, nil
}
func (e *hostEngine) GetRootResource(_ context.Context,
req *pulumirpc.GetRootResourceRequest) (*pulumirpc.GetRootResourceResponse, error) {
return nil, errors.New("unsupported")
}
func (e *hostEngine) SetRootResource(_ context.Context,
req *pulumirpc.SetRootResourceRequest) (*pulumirpc.SetRootResourceResponse, error) {
return nil, errors.New("unsupported")
}
type pluginHost struct {
pluginLoaders []*ProviderLoader
languageRuntime plugin.LanguageRuntime
sink diag.Sink
statusSink diag.Sink
engine *hostEngine
providers []plugin.Provider
analyzers []plugin.Analyzer
plugins map[interface{}]io.Closer
closed bool
m sync.Mutex
}
func NewPluginHost(sink, statusSink diag.Sink, languageRuntime plugin.LanguageRuntime,
pluginLoaders ...*ProviderLoader) plugin.Host {
engine := &hostEngine{
sink: sink,
statusSink: statusSink,
stop: make(chan bool),
}
port, _, err := rpcutil.Serve(0, engine.stop, []func(*grpc.Server) error{
func(srv *grpc.Server) error {
pulumirpc.RegisterEngineServer(srv, engine)
return nil
},
}, nil)
if err != nil {
panic(fmt.Errorf("could not start engine service: %v", err))
}
engine.address = fmt.Sprintf("127.0.0.1:%v", port)
return &pluginHost{
pluginLoaders: pluginLoaders,
languageRuntime: languageRuntime,
sink: sink,
statusSink: statusSink,
engine: engine,
plugins: map[interface{}]io.Closer{},
}
}
func (host *pluginHost) isClosed() bool {
host.m.Lock()
defer host.m.Unlock()
return host.closed
}
func (host *pluginHost) plugin(kind workspace.PluginKind, name string, version *semver.Version,
opts interface{}) (interface{}, error) {
var best *PluginLoader
for _, l := range host.pluginLoaders {
if l.kind != kind || l.name != name {
continue
}
if version != nil {
if l.version.EQ(*version) {
best = l
break
}
} else if best == nil || l.version.GT(best.version) {
best = l
}
}
if best == nil {
return nil, nil
}
load := best.load
if load == nil {
load = func(opts interface{}) (interface{}, error) {
return best.loadWithHost(opts, host)
}
}
plug, err := load(opts)
if err != nil {
return nil, err
}
closer := nopCloser
if best.useGRPC {
plug, closer, err = wrapProviderWithGrpc(plug.(plugin.Provider))
if err != nil {
return nil, err
}
}
host.m.Lock()
defer host.m.Unlock()
switch kind {
case workspace.AnalyzerPlugin:
host.analyzers = append(host.analyzers, plug.(plugin.Analyzer))
case workspace.ResourcePlugin:
host.providers = append(host.providers, plug.(plugin.Provider))
}
host.plugins[plug] = closer
return plug, nil
}
func (host *pluginHost) Provider(pkg tokens.Package, version *semver.Version) (plugin.Provider, error) {
plug, err := host.plugin(workspace.ResourcePlugin, string(pkg), version, nil)
if err != nil {
return nil, err
}
if plug == nil {
v := "nil"
if version != nil {
v = version.String()
}
return nil, fmt.Errorf("Could not find plugin for (%s, %s)", pkg.String(), v)
}
return plug.(plugin.Provider), nil
}
func (host *pluginHost) LanguageRuntime(
root, runtime string, options map[string]interface{}) (plugin.LanguageRuntime, error) {
return host.languageRuntime, nil
}
func (host *pluginHost) SignalCancellation() error {
host.m.Lock()
defer host.m.Unlock()
var err error
for _, prov := range host.providers {
if pErr := prov.SignalCancellation(); pErr != nil {
err = pErr
}
}
return err
}
func (host *pluginHost) Close() error {
host.m.Lock()
defer host.m.Unlock()
var err error
for _, closer := range host.plugins {
if pErr := closer.Close(); pErr != nil {
err = pErr
}
}
go func() { host.engine.stop <- true }()
host.closed = true
return err
}
func (host *pluginHost) ServerAddr() string {
return host.engine.address
}
func (host *pluginHost) Log(sev diag.Severity, urn resource.URN, msg string, streamID int32) {
if !host.isClosed() {
host.sink.Logf(sev, diag.StreamMessage(urn, msg, streamID))
}
}
func (host *pluginHost) LogStatus(sev diag.Severity, urn resource.URN, msg string, streamID int32) {
if !host.isClosed() {
host.statusSink.Logf(sev, diag.StreamMessage(urn, msg, streamID))
}
}
func (host *pluginHost) Analyzer(nm tokens.QName) (plugin.Analyzer, error) {
return host.PolicyAnalyzer(nm, "", nil)
}
func (host *pluginHost) CloseProvider(provider plugin.Provider) error {
host.m.Lock()
defer host.m.Unlock()
delete(host.plugins, provider)
return nil
}
func (host *pluginHost) EnsurePlugins(plugins []workspace.PluginSpec, kinds plugin.Flags) error {
return nil
}
func (host *pluginHost) ResolvePlugin(
kind workspace.PluginKind, name string, version *semver.Version) (*workspace.PluginInfo, error) {
for _, v := range host.pluginLoaders {
if v.kind == kind && v.name == name {
// TODO: for multi-version testing, support multiple versions of plugins concurrently. Not
// allowed at present time.
return &workspace.PluginInfo{
Kind: kind,
Name: name,
Path: v.path,
Version: &v.version,
SchemaPath: filepath.Join(v.path, name+".json"),
// SchemaTime not set as caching is indefinite.
}, nil
}
}
return nil, nil
}
func (host *pluginHost) GetRequiredPlugins(info plugin.ProgInfo,
kinds plugin.Flags) ([]workspace.PluginSpec, error) {
return host.languageRuntime.GetRequiredPlugins(info)
}
func (host *pluginHost) GetProjectPlugins() []workspace.ProjectPlugin {
return nil
}
func (host *pluginHost) PolicyAnalyzer(name tokens.QName, path string,
opts *plugin.PolicyAnalyzerOptions) (plugin.Analyzer, error) {
plug, err := host.plugin(workspace.AnalyzerPlugin, string(name), nil, opts)
if err != nil || plug == nil {
return nil, err
}
return plug.(plugin.Analyzer), nil
}
func (host *pluginHost) ListAnalyzers() []plugin.Analyzer {
host.m.Lock()
defer host.m.Unlock()
return host.analyzers
}