-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
import.go
641 lines (571 loc) 路 21.1 KB
/
import.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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
// Copyright 2016-2022, 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 main
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"strings"
"github.com/blang/semver"
"github.com/hashicorp/hcl/v2"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/v3/backend"
"github.com/pulumi/pulumi/pkg/v3/backend/display"
"github.com/pulumi/pulumi/pkg/v3/codegen/importer"
"github.com/pulumi/pulumi/pkg/v3/codegen/pcl"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
"github.com/pulumi/pulumi/pkg/v3/engine"
"github.com/pulumi/pulumi/pkg/v3/resource/deploy"
"github.com/pulumi/pulumi/pkg/v3/resource/stack"
"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/cmdutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/result"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
javagen "github.com/pulumi/pulumi-java/pkg/codegen/java"
yamlgen "github.com/pulumi/pulumi-yaml/pkg/pulumiyaml/codegen"
"github.com/pulumi/pulumi/pkg/v3/codegen/dotnet"
gogen "github.com/pulumi/pulumi/pkg/v3/codegen/go"
"github.com/pulumi/pulumi/pkg/v3/codegen/nodejs"
"github.com/pulumi/pulumi/pkg/v3/codegen/python"
)
func parseResourceSpec(spec string) (string, resource.URN, error) {
equals := strings.Index(spec, "=")
if equals == -1 {
return "", "", fmt.Errorf("spec must be of the form name=URN")
}
name, urn := spec[:equals], spec[equals+1:]
if name == "" || urn == "" {
return "", "", fmt.Errorf("spec must be of the form name=URN")
}
return name, resource.URN(urn), nil
}
func makeImportFile(
typ, name, id string,
properties []string,
parentSpec, providerSpec, version string) (importFile, error) {
nameTable := map[string]resource.URN{}
resource := importSpec{
Type: tokens.Type(typ),
Name: tokens.QName(name),
ID: resource.ID(id),
Version: version,
Properties: properties,
}
if parentSpec != "" {
parentName, parentURN, err := parseResourceSpec(parentSpec)
if err != nil {
return importFile{}, fmt.Errorf("could not parse parent spec '%v': %w", parentSpec, err)
}
nameTable[parentName] = parentURN
resource.Parent = parentName
}
if providerSpec != "" {
providerName, providerURN, err := parseResourceSpec(providerSpec)
if err != nil {
return importFile{}, fmt.Errorf("could not parse provider spec '%v': %w", providerSpec, err)
}
nameTable[providerName] = providerURN
resource.Provider = providerName
}
return importFile{
NameTable: nameTable,
Resources: []importSpec{resource},
}, nil
}
type importSpec struct {
Type tokens.Type `json:"type"`
Name tokens.QName `json:"name"`
ID resource.ID `json:"id"`
Parent string `json:"parent"`
Provider string `json:"provider"`
Version string `json:"version"`
Properties []string `json:"properties"`
}
type importFile struct {
NameTable map[string]resource.URN `json:"nameTable"`
Resources []importSpec `json:"resources"`
}
func readImportFile(p string) (importFile, error) {
f, err := os.Open(p)
if err != nil {
return importFile{}, err
}
defer contract.IgnoreClose(f)
var result importFile
if err = json.NewDecoder(f).Decode(&result); err != nil {
return importFile{}, err
}
return result, nil
}
func parseImportFile(f importFile, protectResources bool) ([]deploy.Import, importer.NameTable, error) {
// Build the name table.
names := importer.NameTable{}
for name, urn := range f.NameTable {
names[urn] = name
}
imports := make([]deploy.Import, len(f.Resources))
for i, spec := range f.Resources {
imp := deploy.Import{
Type: spec.Type,
Name: spec.Name,
ID: spec.ID,
Protect: protectResources,
Properties: spec.Properties,
}
if spec.Parent != "" {
urn, ok := f.NameTable[spec.Parent]
if !ok {
return nil, nil, fmt.Errorf("the parent '%v' for resource '%v' of type '%v' has no name",
spec.Parent, spec.Name, spec.Type)
}
imp.Parent = urn
}
if spec.Provider != "" {
urn, ok := f.NameTable[spec.Provider]
if !ok {
return nil, nil, fmt.Errorf("the provider '%v' for resource '%v' of type '%v' has no name",
spec.Provider, spec.Name, spec.Type)
}
imp.Provider = urn
}
if spec.Version != "" {
v, err := semver.ParseTolerant(spec.Version)
if err != nil {
return nil, nil, fmt.Errorf("could not parse version '%v' for resource '%v' of type '%v': %w",
spec.Version, spec.Name, spec.Type, err)
}
imp.Version = &v
}
imports[i] = imp
}
return imports, names, nil
}
func getCurrentDeploymentForStack(
ctx context.Context,
s backend.Stack) (*deploy.Snapshot, error) {
deployment, err := s.ExportDeployment(ctx)
if err != nil {
return nil, err
}
snap, err := stack.DeserializeUntypedDeployment(ctx, deployment, stack.DefaultSecretsProvider)
if err != nil {
switch err {
case stack.ErrDeploymentSchemaVersionTooOld:
return nil, fmt.Errorf("the stack '%s' is too old to be used by this version of the Pulumi CLI",
s.Ref().Name())
case stack.ErrDeploymentSchemaVersionTooNew:
return nil, fmt.Errorf("the stack '%s' is newer than what this version of the Pulumi CLI understands. "+
"Please update your version of the Pulumi CLI", s.Ref().Name())
}
return nil, fmt.Errorf("could not deserialize deployment: %w", err)
}
return snap, err
}
type programGeneratorFunc func(p *pcl.Program) (map[string][]byte, hcl.Diagnostics, error)
func generateImportedDefinitions(out io.Writer, stackName tokens.Name, projectName tokens.PackageName,
snap *deploy.Snapshot, programGenerator programGeneratorFunc, names importer.NameTable,
imports []deploy.Import, protectResources bool) (bool, error) {
defer func() {
v := recover()
if v != nil {
errMsg := strings.Builder{}
errMsg.WriteString("Your resource has been imported into Pulumi state, but there was an error generating the import code.\n") //nolint:lll
errMsg.WriteString("\n")
if strings.Contains(fmt.Sprintf("%v", v), "invalid Go source code:") {
errMsg.WriteString("You will need to copy and paste the generated code into your Pulumi application and manually edit it to correct any errors.\n\n") //nolint:lll
}
errMsg.WriteString(fmt.Sprintf("%v\n", v))
fmt.Print(errMsg.String())
}
}()
resourceTable := map[resource.URN]*resource.State{}
for _, r := range snap.Resources {
if !r.Delete {
resourceTable[r.URN] = r
}
}
var resources []*resource.State
for _, i := range imports {
var parentType tokens.Type
if i.Parent != "" {
parentType = i.Parent.QualifiedType()
}
urn := resource.NewURN(stackName.Q(), projectName, parentType, i.Type, i.Name)
if state, ok := resourceTable[urn]; ok {
// Copy the state and override the protect bit.
s := *state
s.Protect = protectResources
resources = append(resources, &s)
}
}
if len(resources) == 0 {
return false, nil
}
cwd, err := os.Getwd()
if err != nil {
return false, err
}
sink := cmdutil.Diag()
ctx, err := plugin.NewContext(sink, sink, nil, nil, cwd, nil, true, nil)
if err != nil {
return false, err
}
loader := schema.NewPluginLoader(ctx.Host)
return true, importer.GenerateLanguageDefinitions(out, loader, func(w io.Writer, p *pcl.Program) error {
files, _, err := programGenerator(p)
if err != nil {
return err
}
var contents []byte
for _, v := range files {
contents = v
}
if _, err := w.Write(contents); err != nil {
return err
}
return nil
}, resources, names)
}
func newImportCmd() *cobra.Command {
var parentSpec string
var providerSpec string
var importFilePath string
var outputFilePath string
var generateCode bool
var debug bool
var message string
var stack string
var execKind string
var execAgent string
// Flags for engine.UpdateOptions.
var diffDisplay bool
var eventLogPath string
var parallel int
var showConfig bool
var skipPreview bool
var suppressOutputs bool
var suppressPermalink string
var yes bool
var protectResources bool
var properties []string
cmd := &cobra.Command{
Use: "import [type] [name] [id]",
Args: cmdutil.MaximumNArgs(3),
Short: "Import resources into an existing stack",
Long: "Import resources into an existing stack.\n" +
"\n" +
"Resources that are not managed by Pulumi can be imported into a Pulumi stack\n" +
"using this command. A definition for each resource will be printed to stdout\n" +
"in the language used by the project associated with the stack; these definitions\n" +
"should be added to the Pulumi program. The resources are protected from deletion\n" +
"by default.\n" +
"\n" +
"Should you want to import your resource(s) without protection, you can pass\n" +
"`--protect=false` as an argument to the command. This will leave all resources unprotected." +
"\n" +
"\n" +
"A single resource may be specified in the command line arguments or a set of\n" +
"resources may be specified by a JSON file. This file must contain an object\n" +
"of the following form:\n" +
"\n" +
" {\n" +
" \"nameTable\": {\n" +
" \"provider-or-parent-name-0\": \"provider-or-parent-urn-0\",\n" +
" ...\n" +
" \"provider-or-parent-name-n\": \"provider-or-parent-urn-n\",\n" +
" },\n" +
" \"resources\": [\n" +
" {\n" +
" \"type\": \"type-token\",\n" +
" \"name\": \"name\",\n" +
" \"id\": \"resource-id\",\n" +
" \"parent\": \"optional-parent-name\",\n" +
" \"provider\": \"optional-provider-name\",\n" +
" \"version\": \"optional-provider-version\",\n" +
" \"properties\": [\"optional-property-names\"],\n" +
" },\n" +
" ...\n" +
" {\n" +
" ...\n" +
" }\n" +
" ]\n" +
" }\n" +
"\n" +
"The name table maps language names to parent and provider URNs. These names are\n" +
"used in the generated definitions, and should match the corresponding declarations\n" +
"in the source program. This table is required if any parents or providers are\n" +
"specified by the resources to import.\n" +
"\n" +
"The resources list contains the set of resources to import. Each resource is\n" +
"specified as a triple of its type, name, and ID. The format of the ID is specific\n" +
"to the resource type. Each resource may specify the name of a parent or provider;\n" +
"these names must correspond to entries in the name table. If a resource does not\n" +
"specify a provider, it will be imported using the default provider for its type. A\n" +
"resource that does specify a provider may specify the version of the provider\n" +
"that will be used for its import.\n" +
"Each resource may specify which input properties to import with;\n" +
"If a resource does not specify any properties the default behaviour is to\n" +
"import using all required properties.\n",
Run: cmdutil.RunResultFunc(func(cmd *cobra.Command, args []string) result.Result {
ctx := commandContext()
var importFile importFile
if importFilePath != "" {
if len(args) != 0 || parentSpec != "" || providerSpec != "" || len(properties) != 0 {
return result.Errorf("an inline resource may not be specified in conjunction with an import file")
}
f, err := readImportFile(importFilePath)
if err != nil {
return result.FromError(fmt.Errorf("could not read import file: %w", err))
}
importFile = f
} else {
if len(args) < 3 {
return result.Errorf("an inline resource must be specified if no import file is used")
}
f, err := makeImportFile(args[0], args[1], args[2], properties, parentSpec, providerSpec, "")
if err != nil {
return result.FromError(err)
}
importFile = f
}
if !generateCode && outputFilePath != "" {
fmt.Fprintln(os.Stderr, "Output file will not be used as --generate-code is false.")
}
var outputResult bytes.Buffer
output := io.Writer(&outputResult)
if outputFilePath != "" {
f, err := os.Create(outputFilePath)
if err != nil {
return result.Errorf("could not open output file: %v", err)
}
defer contract.IgnoreClose(f)
output = f
}
imports, nameTable, err := parseImportFile(importFile, protectResources)
if err != nil {
return result.FromError(err)
}
yes = yes || skipPreview || skipConfirmations()
interactive := cmdutil.Interactive()
if !interactive && !yes {
return result.FromError(
errors.New("--yes or --skip-preview must be passed in to proceed when running in non-interactive mode"))
}
opts, err := updateFlagsToOptions(interactive, skipPreview, yes)
if err != nil {
return result.FromError(err)
}
var displayType = display.DisplayProgress
if diffDisplay {
displayType = display.DisplayDiff
}
opts.Display = display.Options{
Color: cmdutil.GetGlobalColorization(),
ShowConfig: showConfig,
SuppressOutputs: suppressOutputs,
IsInteractive: interactive,
Type: displayType,
EventLogPath: eventLogPath,
Debug: debug,
}
// we only suppress permalinks if the user passes true. the default is an empty string
// which we pass as 'false'
if suppressPermalink == "true" {
opts.Display.SuppressPermalink = true
} else {
opts.Display.SuppressPermalink = false
}
filestateBackend, err := isFilestateBackend(opts.Display)
if err != nil {
return result.FromError(err)
}
// by default, we are going to suppress the permalink when using self-managed backends
// this can be re-enabled by explicitly passing "false" to the `suppress-permalink` flag
if suppressPermalink != "false" && filestateBackend {
opts.Display.SuppressPermalink = true
}
// Fetch the project.
proj, root, err := readProject()
if err != nil {
return result.FromError(err)
}
var programGenerator programGeneratorFunc
switch proj.Runtime.Name() {
case "dotnet": // nolint: goconst
programGenerator = dotnet.GenerateProgram
case "go":
programGenerator = gogen.GenerateProgram
case "nodejs": // nolint: goconst
programGenerator = nodejs.GenerateProgram
case "python":
programGenerator = python.GenerateProgram
case "java":
programGenerator = javagen.GenerateProgram
case "yaml":
programGenerator = yamlgen.GenerateProgram
default:
return result.Errorf("cannot generate resource definitions for %v", proj.Runtime.Name())
}
// Fetch the current stack.
s, err := requireStack(ctx, stack, false, opts.Display, false /*setCurrent*/)
if err != nil {
return result.FromError(err)
}
m, err := getUpdateMetadata(message, root, execKind, execAgent, false)
if err != nil {
return result.FromError(fmt.Errorf("gathering environment metadata: %w", err))
}
sm, err := getStackSecretsManager(s)
if err != nil {
return result.FromError(fmt.Errorf("getting secrets manager: %w", err))
}
cfg, err := getStackConfiguration(ctx, s, proj, sm)
if err != nil {
return result.FromError(fmt.Errorf("getting stack configuration: %w", err))
}
decrypter, err := sm.Decrypter()
if err != nil {
return result.FromError(fmt.Errorf("getting stack decrypter: %w", err))
}
configErr := workspace.ValidateStackConfigAndApplyProjectConfig(stack, proj, cfg.Config, decrypter)
if configErr != nil {
return result.FromError(fmt.Errorf("validating stack config: %w", configErr))
}
opts.Engine = engine.UpdateOptions{
Parallel: parallel,
Debug: debug,
UseLegacyDiff: useLegacyDiff(),
}
_, res := s.Import(ctx, backend.UpdateOperation{
Proj: proj,
Root: root,
M: m,
Opts: opts,
StackConfiguration: cfg,
SecretsManager: sm,
Scopes: cancellationScopes,
}, imports)
if generateCode {
deployment, err := getCurrentDeploymentForStack(ctx, s)
if err != nil {
return result.FromError(err)
}
validImports, err := generateImportedDefinitions(
output, s.Ref().Name(), proj.Name, deployment, programGenerator, nameTable, imports,
protectResources)
if err != nil {
if _, ok := err.(*importer.DiagnosticsError); ok {
err = fmt.Errorf("internal error: %w", err)
}
return result.FromError(err)
}
if validImports {
// we only want to output the helper string if there is a set of valid imports to convert into code
// this protects against invalid package types or import errors that will not actually result in
// in a codegen call
// It's a little bit more memory but is a better experience that writing to stdout and then an error
// occurring
if outputFilePath == "" {
fmt.Print("Please copy the following code into your Pulumi application. Not doing so\n" +
"will cause Pulumi to report that an update will happen on the next update command.\n\n")
if protectResources {
fmt.Print(("Please note that the imported resources are marked as protected. " +
"To destroy them\n" +
"you will need to remove the `protect` option and run `pulumi update` *before*\n" +
"the destroy will take effect.\n\n"))
}
fmt.Print(outputResult.String())
}
}
}
if res != nil {
if res.Error() == context.Canceled {
return result.FromError(errors.New("import cancelled"))
}
return PrintEngineResult(res)
}
return nil
}),
}
cmd.PersistentFlags().StringVar(
//nolint:lll
&parentSpec, "parent", "", "The name and URN of the parent resource in the format name=urn, where name is the variable name of the parent resource")
cmd.PersistentFlags().StringVar(
//nolint:lll
&providerSpec, "provider", "", "The name and URN of the provider to use for the import in the format name=urn, where name is the variable name for the provider resource")
cmd.PersistentFlags().StringSliceVar(
//nolint:lll
&properties, "properties", nil, "The property names to use for the import in the format name1,name2")
cmd.PersistentFlags().StringVarP(
&importFilePath, "file", "f", "", "The path to a JSON-encoded file containing a list of resources to import")
cmd.PersistentFlags().StringVarP(
&outputFilePath, "out", "o", "", "The path to the file that will contain the generated resource declarations")
cmd.PersistentFlags().BoolVar(
&generateCode, "generate-code", true, "Generate resource declaration code for the imported resources")
cmd.PersistentFlags().BoolVarP(
&debug, "debug", "d", false,
"Print detailed debugging output during resource operations")
cmd.PersistentFlags().StringVarP(
&message, "message", "m", "",
"Optional message to associate with the update operation")
cmd.PersistentFlags().StringVarP(
&stack, "stack", "s", "",
"The name of the stack to operate on. Defaults to the current stack")
cmd.PersistentFlags().StringVar(
&stackConfigFile, "config-file", "",
"Use the configuration values in the specified file rather than detecting the file name")
// Flags for engine.UpdateOptions.
cmd.PersistentFlags().BoolVar(
&diffDisplay, "diff", false,
"Display operation as a rich diff showing the overall change")
cmd.PersistentFlags().IntVarP(
¶llel, "parallel", "p", defaultParallel,
"Allow P resource operations to run in parallel at once (1 for no parallelism). Defaults to unbounded.")
cmd.PersistentFlags().BoolVar(
&skipPreview, "skip-preview", false,
"Do not calculate a preview before performing the import")
cmd.PersistentFlags().BoolVar(
&suppressOutputs, "suppress-outputs", false,
"Suppress display of stack outputs (in case they contain sensitive values)")
cmd.PersistentFlags().StringVar(
&suppressPermalink, "suppress-permalink", "",
"Suppress display of the state permalink")
cmd.Flag("suppress-permalink").NoOptDefVal = "false"
cmd.PersistentFlags().BoolVarP(
&yes, "yes", "y", false,
"Automatically approve and perform the import after previewing it")
cmd.PersistentFlags().BoolVarP(
&protectResources, "protect", "", true,
"Allow resources to be imported with protection from deletion enabled")
if hasDebugCommands() {
cmd.PersistentFlags().StringVar(
&eventLogPath, "event-log", "",
"Log events to a file at this path")
}
// internal flags
cmd.PersistentFlags().StringVar(&execKind, "exec-kind", "", "")
// ignore err, only happens if flag does not exist
_ = cmd.PersistentFlags().MarkHidden("exec-kind")
cmd.PersistentFlags().StringVar(&execAgent, "exec-agent", "", "")
// ignore err, only happens if flag does not exist
_ = cmd.PersistentFlags().MarkHidden("exec-agent")
return cmd
}