-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
import.go
1089 lines (980 loc) 路 36 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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016-2023, 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/go-multierror"
"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/convert"
"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/importer"
"github.com/pulumi/pulumi/pkg/v3/resource/deploy"
"github.com/pulumi/pulumi/pkg/v3/resource/deploy/providers"
"github.com/pulumi/pulumi/pkg/v3/resource/stack"
pkgWorkspace "github.com/pulumi/pulumi/pkg/v3/workspace"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag"
"github.com/pulumi/pulumi/sdk/v3/go/common/env"
"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"
)
func parseResourceSpec(spec string) (string, resource.URN, error) {
equals := strings.Index(spec, "=")
if equals == -1 {
return "", "", errors.New("spec must be of the form name=URN")
}
name, urn := spec[:equals], resource.URN(spec[equals+1:])
if name == "" || urn == "" {
return "", "", errors.New("spec must be of the form name=URN")
}
if !urn.IsValid() {
if ref, err := providers.ParseReference(string(urn)); err == nil {
return "", "", fmt.Errorf("expected a URN but got a Provider Reference, use '%s' instead", ref.URN())
}
return "", "", fmt.Errorf("expected a URN but got '%s'", urn)
}
return name, urn, nil
}
func makeImportFileFromResourceList(resources []plugin.ResourceImport) (importFile, error) {
nameTable := map[string]resource.URN{}
specs := make([]importSpec, len(resources))
for i, res := range resources {
specs[i] = importSpec{
Type: tokens.Type(res.Type),
Name: res.Name,
ID: resource.ID(res.ID),
Version: res.Version,
PluginDownloadURL: res.PluginDownloadURL,
Component: res.IsComponent,
Remote: res.IsRemote,
LogicalName: res.LogicalName,
}
}
return importFile{
NameTable: nameTable,
Resources: specs,
}, nil
}
func makeImportFile(
typ, name, id string,
properties []string,
parentSpec, providerSpec, version string,
) (importFile, error) {
nameTable := map[string]resource.URN{}
res := importSpec{
Type: tokens.Type(typ),
Name: name,
ID: resource.ID(id),
Version: version,
Properties: properties,
}
if parentSpec != "" {
parentName, parentURN, err := parseResourceSpec(parentSpec)
if err != nil {
parentName = "parent"
parentURN = resource.URN(parentSpec)
if !parentURN.IsValid() {
return importFile{}, fmt.Errorf("invalid parent URN: '%s'", parentURN)
}
}
nameTable[parentName] = parentURN
res.Parent = parentName
}
if providerSpec != "" {
providerName, providerURN, err := parseResourceSpec(providerSpec)
if err != nil {
providerName = "provider"
providerURN = resource.URN(providerSpec)
}
if _, exists := nameTable[providerName]; exists {
return importFile{}, fmt.Errorf("provider and parent must have distinct names, both were '%s'", providerName)
}
nameTable[providerName] = providerURN
res.Provider = providerName
}
return importFile{
NameTable: nameTable,
Resources: []importSpec{res},
}, nil
}
type importSpec struct {
Type tokens.Type `json:"type"`
Name string `json:"name"`
ID resource.ID `json:"id,omitempty"`
Parent string `json:"parent,omitempty"`
Provider string `json:"provider,omitempty"`
Version string `json:"version,omitempty"`
PluginDownloadURL string `json:"pluginDownloadUrl,omitempty"`
Properties []string `json:"properties,omitempty"`
Component bool `json:"component,omitempty"`
Remote bool `json:"remote,omitempty"`
// LogicalName is the resources Pulumi name (i.e. the first argument to `new Resource`).
LogicalName string `json:"logicalName,omitempty"`
}
type importFile struct {
NameTable map[string]resource.URN `json:"nameTable,omitempty"`
Resources []importSpec `json:"resources,omitempty"`
}
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 writeImportFile(v importFile, f io.Writer) error {
enc := json.NewEncoder(f)
enc.SetEscapeHTML(false)
enc.SetIndent("", " ")
err := enc.Encode(v)
return err
}
func writeImportFileToTemp(v importFile) (string, error) {
wd, err := os.Getwd()
if err != nil {
return "", fmt.Errorf("working directory: %w", err)
}
f, err := os.CreateTemp(wd, "pulumi-import-*.json")
if err != nil {
return "", fmt.Errorf("create temp file: %w", err)
}
path := f.Name()
defer contract.IgnoreClose(f)
err = writeImportFile(v, f)
if err != nil {
return "", errors.Join(err, f.Close(), os.Remove(path))
}
return path, f.Close()
}
func parseImportFile(
f importFile, stack tokens.StackName, proj tokens.PackageName, protectResources bool,
) ([]deploy.Import, importer.NameTable, error) {
// First check for uniqueness and ambiguity, takenNames tracks both that a name is used (it's in the map) and if
// it's ambiguous (it's true).
takenNames := map[string]bool{}
// takenURNs simply tracks that a URN is used, it's not possible for a URN to be ambiguous. We fill this
// later because it requires parents to be resolved.
takenURNs := map[resource.URN]struct{}{}
// Prefill takenNames with all the resource names so we can do quick uniqueness checks below
for _, spec := range f.Resources {
takenNames[spec.Name] = false
}
// TODO: When Go 1.21 is released, switch to errors.Join.
var errs error
pusherrf := func(format string, args ...interface{}) {
errs = multierror.Append(errs, fmt.Errorf(format, args...))
}
// Attempts to generate a human-readable description of the given import spec
// for use in error messages using whatever information is available.
// For example:
//
// resource 'foo' of type 'aws:ec2/vpc:Vpc'
// resource 'foo'
// resource 3 of type 'aws:ec2/vpc:Vpc'
// resource 3
describeResource := func(idx int, spec importSpec) string {
var sb strings.Builder
sb.WriteString("resource ")
switch {
case spec.Name != "":
fmt.Fprintf(&sb, "'%v'", spec.Name)
case spec.ID != "":
fmt.Fprintf(&sb, "'%v'", spec.ID)
default:
fmt.Fprintf(&sb, "%d", idx)
}
if spec.Type != "" {
fmt.Fprintf(&sb, " of type '%v'", spec.Type)
}
return sb.String()
}
for i, spec := range f.Resources {
// We default LogicalName and Name to each other if either is missing.
if spec.LogicalName == "" {
f.Resources[i].LogicalName = spec.Name
}
if spec.Name == "" {
f.Resources[i].Name = spec.LogicalName
}
}
// Sanity check some basic constraints that names and types etc are filled in.
for i, spec := range f.Resources {
if spec.Type == "" {
pusherrf("%v has no type", describeResource(i, spec))
}
if spec.Name == "" {
pusherrf("%v has no name", describeResource(i, spec))
}
if !spec.Component && spec.ID == "" {
pusherrf("%v has no ID", describeResource(i, spec))
} else if spec.Component && spec.ID != "" {
pusherrf("%v has an ID, but is marked as a component", describeResource(i, spec))
}
if spec.Remote && !spec.Component {
pusherrf("%v is marked as remote, but not as a component", describeResource(i, spec))
}
// Check if any earlier resource has this name, if so mark it as ambiguous this is only an error if
// something tries to use it (checked later on).
for j, other := range f.Resources {
if i > j && spec.Name == other.Name {
takenNames[spec.Name] = true
}
}
}
// If we've got errors already just exit
if errs != nil {
return nil, nil, errs
}
// A mapping from name to URN, prefilled with emptys and what was in the name table so we can do existence checks
// for expected names.
urnMapping := make(map[string]resource.URN)
// The opposite of urnMapping, a mapping from URN to name.
names := importer.NameTable{}
for name, urn := range f.NameTable {
names[urn] = name
urnMapping[name] = urn
// We can add these URNs to the taken set, it's not an error to add them twice at this point.
takenURNs[urn] = struct{}{}
}
for _, spec := range f.Resources {
urnMapping[spec.Name] = ""
}
// We need to keep going till all the resources are resolved.
dones := make([]bool, len(f.Resources))
done := func() bool {
if errs != nil {
return true
}
for _, done := range dones {
if !done {
return false
}
}
return true
}
for !done() {
for i, spec := range f.Resources {
// If we've already done this URN no need to do it again
if dones[i] {
continue
}
var parentType tokens.Type
if spec.Parent != "" {
// We can find the parent type by looking up the parent by name then finding it's type
// takenNames will be true if this name is ambiguous, in which case we can't use it as a
// parent but we just let the rest of the code below run so we can collect further errors.
if takenNames[spec.Parent] {
pusherrf("%v has an ambiguous parent",
describeResource(i, spec))
}
// Is this name already in the name table?
if urn, ok := f.NameTable[spec.Parent]; ok {
parentType = urn.QualifiedType()
} else {
// Not in the name table, is it in the urn mapping yet?
urn, ok := urnMapping[spec.Parent]
// There's three cases to cover here:
// 1. We didn't find the parent, in which case just push an error
// 2. We found the parent but it's urn is currently blank, in which case we'll loop around
// 3. We found the parent and got it's URN
if !ok {
pusherrf("the parent '%v' for %v has no entry in 'nameTable'",
spec.Parent, describeResource(i, spec))
} else if urn == "" {
// Skip this resource for now, we'll have to loop again to get it once it's parent URN is worked out
continue
} else {
parentType = urn.QualifiedType()
}
}
}
urn := resource.NewURN(stack.Q(), proj, parentType, spec.Type, spec.LogicalName)
// Check if this URN is unique and if not add an error
if _, ok := takenURNs[urn]; ok {
pusherrf("%v has an ambiguous URN, set name (or logical name) to be unique", describeResource(i, spec))
}
urnMapping[spec.Name] = urn
takenURNs[urn] = struct{}{}
// This might clash with earlier entries in the name table (unique urn, but duplicate name) that's
// fine and the code generators should deal with it.
names[urn] = spec.Name
// Mark this resource as done
dones[i] = true
}
}
// If we've got errors already just exit
if errs != nil {
return nil, nil, errs
}
imports := make([]deploy.Import, len(f.Resources))
for i, spec := range f.Resources {
imp := deploy.Import{
Type: spec.Type,
Name: spec.LogicalName,
ID: spec.ID,
Protect: protectResources,
Properties: spec.Properties,
PluginDownloadURL: spec.PluginDownloadURL,
Component: spec.Component,
Remote: spec.Remote,
}
if spec.Parent != "" {
urn, ok := urnMapping[spec.Parent]
if ok {
// No need to add errors here, we'll have done that above when building URNs
imp.Parent = urn
}
}
if spec.Provider != "" {
if takenNames[spec.Provider] {
pusherrf("%v has an ambiguous provider",
describeResource(i, spec))
}
urn, ok := f.NameTable[spec.Provider]
if !ok {
pusherrf("the provider '%v' for %v has no entry in 'nameTable'",
spec.Provider, describeResource(i, spec))
} else {
imp.Provider = urn
}
}
if spec.Version != "" {
v, err := semver.ParseTolerant(spec.Version)
if err != nil {
pusherrf("could not parse version '%v' for %v: %w",
spec.Version, describeResource(i, spec), err)
} else {
imp.Version = &v
}
}
imports[i] = imp
}
return imports, names, errs
}
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,
loader schema.ReferenceLoader,
) (map[string][]byte, hcl.Diagnostics, error)
func generateImportedDefinitions(ctx *plugin.Context,
out io.Writer, stackName tokens.StackName, 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
}
fmt.Fprintf(&errMsg, "%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.Copy()
s.Protect = protectResources
resources = append(resources, s)
}
}
if len(resources) == 0 {
return false, nil
}
loader := schema.NewPluginLoader(ctx.Host)
return true, importer.GenerateLanguageDefinitions(out, loader, func(w io.Writer, p *pcl.Program) error {
files, _, err := programGenerator(p, loader)
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 stackName string
var execKind string
var execAgent string
// Flags for engine.UpdateOptions.
var diffDisplay bool
var eventLogPath string
var parallel int
var previewOnly bool
var showConfig bool
var skipPreview bool
var suppressOutputs bool
var suppressProgress bool
var suppressPermalink string
var yes bool
var protectResources bool
var properties []string
var from string
cmd := &cobra.Command{
Use: "import [type] [name] [id]",
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.\n" +
"\n" +
"If using the command line args directly, the type token, name, id and optional flags\n" +
"must be provided. For example:\n" +
"\n" +
" pulumi import 'aws:iam/user:User' name id\n" +
"\n" +
"The type token and property used for resource lookup are available in the Import section of\n" +
"the resource's API documentation in the Pulumi Registry (https://www.pulumi.com/registry/)." +
"\n" +
"To fully specify parent and/or provider, subsitute the <urn> for each into the following:\n" +
"\n" +
" pulumi import 'aws:iam/user:User' name id --parent 'parent=<urn>' --provider 'admin=<urn>'\n" +
"\n" +
"If using the JSON file format to define the imported resource(s), use this instead:\n" +
"\n" +
" pulumi import -f import.json\n" +
"\n" +
"Where import.json is a file that matches the following JSON format:\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" +
" \"pluginDownloadUrl\": \"optional-provider-plugin-url\",\n" +
" \"logicalName\": \"optionalLogicalName\",\n" +
" \"properties\": [\"optional-property-names\"],\n" +
" \"component\": false,\n" +
" \"remote\": false,\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" +
"\n" +
"A resource can define a logical name as well as its name for the name table.\n" +
"If a logical name is given, it will be used to name the resource in the Pulumi state.\n" +
"\n" +
"A resource can also be declared as a \"component\" (and optionally as \"remote\"). These resources\n" +
"don't have an id set and instead just create an empty placeholder component resource in the Pulumi state.\n" +
"\n" +
"Each resource may specify which input properties to import with;\n" +
"\n" +
"If a resource does not specify any properties the default behaviour is to\n" +
"import using all required properties.\n" +
"\n" +
"You can use `pulumi preview` with the `--import-file` option to emit an import file\n" +
"for all resources that need creating from the preview. This will fill in all the name,\n" +
"type, parent and provider information for you and just require you to fill in resource\n" +
"IDs and any properties.\n",
Run: cmdutil.RunResultFunc(func(cmd *cobra.Command, args []string) result.Result {
ctx := cmd.Context()
cwd, err := os.Getwd()
if err != nil {
return result.FromError(fmt.Errorf("get working directory: %w", err))
}
sink := cmdutil.Diag()
pCtx, err := plugin.NewContext(sink, sink, nil, nil, cwd, nil, true, nil)
if err != nil {
return result.FromError(fmt.Errorf("create plugin context: %w", err))
}
var importFile importFile
if importFilePath != "" {
if len(args) != 0 || parentSpec != "" || providerSpec != "" || len(properties) != 0 {
contract.IgnoreError(cmd.Help())
return result.Errorf("an inline resource may not be specified in conjunction with an import file")
}
if from != "" {
contract.IgnoreError(cmd.Help())
return result.Errorf("a converter 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 from != "" {
log := func(sev diag.Severity, msg string) {
pCtx.Diag.Logf(sev, diag.RawMessage("", msg))
}
converter, err := loadConverterPlugin(pCtx, from, log)
if err != nil {
return result.Errorf("load converter plugin: %w", err)
}
defer contract.IgnoreClose(converter)
installProvider := func(provider tokens.Package) *semver.Version {
// If auto plugin installs are disabled just return nil, the mapper will still carry on
if env.DisableAutomaticPluginAcquisition.Value() {
return nil
}
log := func(sev diag.Severity, msg string) {
pCtx.Diag.Logf(sev, diag.RawMessage("", msg))
}
pluginSpec := workspace.PluginSpec{
Name: string(provider),
Kind: apitype.ResourcePlugin,
}
version, err := pkgWorkspace.InstallPlugin(pluginSpec, log)
if err != nil {
pCtx.Diag.Warningf(diag.Message("", "failed to install provider %q: %v"), provider, err)
return nil
}
return version
}
mapper, err := convert.NewPluginMapper(
convert.DefaultWorkspace(), convert.ProviderFactoryFromHost(pCtx.Host),
from, nil, installProvider)
if err != nil {
return result.FromError(err)
}
mapperServer := convert.NewMapperServer(mapper)
grpcServer, err := plugin.NewServer(pCtx, convert.MapperRegistration(mapperServer))
if err != nil {
return result.FromError(err)
}
resp, err := converter.ConvertState(ctx, &plugin.ConvertStateRequest{
MapperTarget: grpcServer.Addr(),
Args: args,
})
if err != nil {
return result.FromError(err)
}
printDiagnostics(sink, resp.Diagnostics)
if resp.Diagnostics.HasErrors() {
// If we've got error diagnostics then state conversion failed, we've printed the error above so
// just return a plain message here.
return result.Error("conversion failed")
}
f, err := makeImportFileFromResourceList(resp.Resources)
if err != nil {
return result.FromError(err)
}
importFile = f
} else {
msg := "an inline resource must be specified if no converter or import file is used, missing "
if len(args) == 0 {
contract.IgnoreError(cmd.Help())
return result.Errorf(msg + "type, name, and id")
}
if len(args) == 1 {
contract.IgnoreError(cmd.Help())
return result.Errorf(msg + "name and id")
}
if len(args) == 2 {
contract.IgnoreError(cmd.Help())
return result.Errorf(msg + "id")
}
if len(args) > 3 {
contract.IgnoreError(cmd.Help())
return result.Errorf("only expected at most three arguments")
}
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
}
// Fetch the project.
proj, root, err := readProject()
if err != nil {
return result.FromError(err)
}
yes = yes || skipPreview || skipConfirmations()
interactive := cmdutil.Interactive()
if !interactive && !yes && !previewOnly {
return result.FromError(
errors.New("--yes or --skip-preview or --preview-only" +
" must be passed in to proceed when running in non-interactive mode"))
}
opts, err := updateFlagsToOptions(interactive, skipPreview, yes, previewOnly)
if err != nil {
return result.FromError(err)
}
displayType := display.DisplayProgress
if diffDisplay {
displayType = display.DisplayDiff
}
opts.Display = display.Options{
Color: cmdutil.GetGlobalColorization(),
ShowConfig: showConfig,
SuppressOutputs: suppressOutputs,
SuppressProgress: suppressProgress,
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
}
isDIYBackend, err := isDIYBackend(opts.Display)
if err != nil {
return result.FromError(err)
}
// by default, we are going to suppress the permalink when using DIY backends
// this can be re-enabled by explicitly passing "false" to the `suppress-permalink` flag
if suppressPermalink != "false" && isDIYBackend {
opts.Display.SuppressPermalink = true
}
// Fetch the current stack.
s, err := requireStack(ctx, stackName, stackLoadOnly, opts.Display)
if err != nil {
return result.FromError(err)
}
imports, nameTable, err := parseImportFile(importFile, s.Ref().Name(), proj.Name, protectResources)
if err != nil {
return result.FromError(err)
}
wrapper := func(
f func(*pcl.Program) (map[string][]byte, hcl.Diagnostics, error),
) func(*pcl.Program, schema.ReferenceLoader) (map[string][]byte, hcl.Diagnostics, error) {
return func(p *pcl.Program, loader schema.ReferenceLoader) (map[string][]byte, hcl.Diagnostics, error) {
return f(p)
}
}
var programGenerator programGeneratorFunc
switch proj.Runtime.Name() {
case "dotnet":
programGenerator = wrapper(dotnet.GenerateProgram)
case "java":
programGenerator = wrapper(javagen.GenerateProgram)
case "yaml":
programGenerator = wrapper(yamlgen.GenerateProgram)
default:
programGenerator = func(
program *pcl.Program, loader schema.ReferenceLoader,
) (map[string][]byte, hcl.Diagnostics, error) {
cwd, err := os.Getwd()
if err != nil {
return nil, nil, err
}
sink := cmdutil.Diag()
ctx, err := plugin.NewContext(sink, sink, nil, nil, cwd, nil, true, nil)
if err != nil {
return nil, nil, err
}
defer contract.IgnoreClose(pCtx.Host)
programInfo := plugin.NewProgramInfo(cwd, cwd, "entry", nil)
languagePlugin, err := ctx.Host.LanguageRuntime(proj.Runtime.Name(), programInfo)
if err != nil {
return nil, nil, err
}
loaderServer := schema.NewLoaderServer(loader)
grpcServer, err := plugin.NewServer(pCtx, schema.LoaderRegistration(loaderServer))
if err != nil {
return nil, nil, err
}
defer contract.IgnoreClose(grpcServer)
files, diagnostics, err := languagePlugin.GenerateProgram(program.Source(), grpcServer.Addr())
if err != nil {
return nil, nil, err
}
return files, diagnostics, nil
}
}
m, err := getUpdateMetadata(message, root, execKind, execAgent, false, cmd.Flags())
if err != nil {
return result.FromError(fmt.Errorf("gathering environment metadata: %w", err))
}
cfg, sm, err := getStackConfiguration(ctx, s, proj, nil)
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))
}
encrypter, err := sm.Encrypter()
if err != nil {
return result.FromError(fmt.Errorf("getting stack encrypter: %w", err))
}
stackName := s.Ref().Name().String()
configErr := workspace.ValidateStackConfigAndApplyProjectConfig(
ctx,
stackName,
proj,
cfg.Environment,
cfg.Config,
encrypter,
decrypter)
if configErr != nil {
return result.FromError(fmt.Errorf("validating stack config: %w", configErr))
}
opts.Engine = engine.UpdateOptions{
Parallel: parallel,
Debug: debug,
UseLegacyDiff: useLegacyDiff(),
Experimental: hasExperimentalCommands(),
}
_, res := s.Import(ctx, backend.UpdateOperation{
Proj: proj,
Root: root,
M: m,
Opts: opts,
StackConfiguration: cfg,
SecretsManager: sm,
SecretsProvider: stack.DefaultSecretsProvider,
Scopes: backend.CancellationScopes,
}, imports)
if generateCode {
deployment, err := getCurrentDeploymentForStack(ctx, s)
if err != nil {
return result.FromError(err)
}
validImports, err := generateImportedDefinitions(
pCtx, 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"))
}
// If we did a conversion import (i.e. from!="") then lets write the file we've built out to the local
// directory so if there's any issues users can manually edit the file and try again with --file
if from != "" {
path, err := writeImportFileToTemp(importFile)
if err != nil {
return result.FromError(err)
}