Merge pull request #24 from hashicorp/fiximport

Fix addr and ID usage for import
hashicorp · Jul 13, 2020 · 505c2b1 · 505c2b1
2 parents 9bfde3e + 67f8ff0
commit 505c2b1
Show file tree

Hide file tree

Showing 15 changed files with 184 additions and 71 deletions.
diff --git a/tfexec/apply_test.go b/tfexec/apply_test.go
@@ -12,12 +12,12 @@ func TestApply(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	err = copyFile(filepath.Join(testFixtureDir, testConfigFileName), filepath.Join(td, testConfigFileName))
+	err = copyFile(filepath.Join(testFixtureDir, "basic/main.tf"), td)
 	if err != nil {
 		t.Fatalf("error copying config file into test dir: %s", err)
 	}
@@ -37,7 +37,7 @@ func TestApplyCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/destroy_test.go b/tfexec/destroy_test.go
@@ -11,7 +11,7 @@ func TestDestroyCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/import.go b/tfexec/import.go
@@ -31,14 +31,6 @@ type ImportOption interface {
 	configureImport(*importConfig)
 }
 
-func (opt *AddrOption) configureImport(conf *importConfig) {
-	conf.addr = opt.addr
-}
-
-func (opt *IdOption) configureImport(conf *importConfig) {
-	conf.id = opt.id
-}
-
 func (opt *BackupOption) configureImport(conf *importConfig) {
 	conf.backup = opt.path
 }
@@ -75,8 +67,8 @@ func (opt *VarFileOption) configureImport(conf *importConfig) {
 	conf.varFile = opt.path
 }
 
-func (t *Terraform) Import(ctx context.Context, opts ...ImportOption) error {
-	importCmd := t.ImportCmd(ctx, opts...)
+func (t *Terraform) Import(ctx context.Context, address, id string, opts ...ImportOption) error {
+	importCmd := t.ImportCmd(ctx, address, id, opts...)
 
 	var errBuf strings.Builder
 	importCmd.Stderr = &errBuf
@@ -89,7 +81,7 @@ func (t *Terraform) Import(ctx context.Context, opts ...ImportOption) error {
 	return nil
 }
 
-func (tf *Terraform) ImportCmd(ctx context.Context, opts ...ImportOption) *exec.Cmd {
+func (tf *Terraform) ImportCmd(ctx context.Context, address, id string, opts ...ImportOption) *exec.Cmd {
 	c := defaultImportOptions
 
 	for _, o := range opts {
@@ -133,5 +125,8 @@ func (tf *Terraform) ImportCmd(ctx context.Context, opts ...ImportOption) *exec.
 		}
 	}
 
+	// required args, always pass
+	args = append(args, address, id)
+
 	return tf.buildTerraformCmd(ctx, args...)
 }
diff --git a/tfexec/import_test.go b/tfexec/import_test.go
@@ -3,32 +3,101 @@ package tfexec
 import (
 	"context"
 	"os"
+	"path/filepath"
 	"strings"
 	"testing"
 )
 
+func TestImport(t *testing.T) {
+	const (
+		expectedID      = "asdlfjksdlfkjsdlfk"
+		resourceAddress = "random_string.random_string"
+	)
+	ctx := context.Background()
+
+	for _, tfv := range []string{
+		// "0.11.14", doesn't support show JSON output, but does support import
+		"0.12.28",
+		"0.13.0-beta3",
+	} {
+		t.Run(tfv, func(t *testing.T) {
+			td := testTempDir(t)
+			defer os.RemoveAll(td)
+
+			err := copyFiles(filepath.Join(testFixtureDir, "import"), td)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			tf, err := NewTerraform(td, tfVersion(t, tfv))
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			err = tf.Init(ctx, Lock(false))
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			err = tf.Import(ctx, resourceAddress, expectedID, DisableBackup(), Lock(false))
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			state, err := tf.StateShow(ctx)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			for _, r := range state.Values.RootModule.Resources {
+				if r.Address != resourceAddress {
+					continue
+				}
+
+				raw, ok := r.AttributeValues["id"]
+				if !ok {
+					t.Fatal("value not found for \"id\" attribute")
+				}
+				actual, ok := raw.(string)
+				if !ok {
+					t.Fatalf("unable to cast %T to string: %#v", raw, raw)
+				}
+
+				if actual != expectedID {
+					t.Fatalf("expected %q, got %q", expectedID, actual)
+				}
+
+				// success
+				return
+			}
+
+			t.Fatalf("imported resource %q not found", resourceAddress)
+		})
+	}
+}
+
 func TestImportCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	// defaults
-	importCmd := tf.ImportCmd(context.Background())
+	importCmd := tf.ImportCmd(context.Background(), "my-addr", "my-id")
 
 	actual := strings.TrimPrefix(cmdString(importCmd), importCmd.Path+" ")
 
-	expected := "import -no-color -input=false -lock-timeout=0s -lock=true"
+	expected := "import -no-color -input=false -lock-timeout=0s -lock=true my-addr my-id"
 
 	if actual != expected {
 		t.Fatalf("expected default arguments of ImportCmd:\n%s\n actual arguments:\n%s\n", expected, actual)
 	}
 
 	// override all defaults
-	importCmd = tf.ImportCmd(context.Background(),
+	importCmd = tf.ImportCmd(context.Background(), "my-addr2", "my-id2",
 		Backup("testbackup"),
 		LockTimeout("200s"),
 		State("teststate"),
@@ -37,11 +106,12 @@ func TestImportCmd(t *testing.T) {
 		Lock(false),
 		Var("var1=foo"),
 		Var("var2=bar"),
-		AllowMissingConfig(true))
+		AllowMissingConfig(true),
+	)
 
 	actual = strings.TrimPrefix(cmdString(importCmd), importCmd.Path+" ")
 
-	expected = "import -no-color -input=false -backup=testbackup -lock-timeout=200s -state=teststate -state-out=teststateout -var-file=testvarfile -lock=false -allow-missing-config -var 'var1=foo' -var 'var2=bar'"
+	expected = "import -no-color -input=false -backup=testbackup -lock-timeout=200s -state=teststate -state-out=teststateout -var-file=testvarfile -lock=false -allow-missing-config -var 'var1=foo' -var 'var2=bar' my-addr2 my-id2"
 
 	if actual != expected {
 		t.Fatalf("expected arguments of ImportCmd:\n%s\n actual arguments:\n%s\n", expected, actual)

diff --git a/tfexec/init_test.go b/tfexec/init_test.go
@@ -11,7 +11,7 @@ func TestInitCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/options.go b/tfexec/options.go
@@ -1,13 +1,5 @@
 package tfexec
 
-type AddrOption struct {
-	addr string
-}
-
-func Addr(addr string) *AddrOption {
-	return &AddrOption{addr}
-}
-
 type AllowMissingConfigOption struct {
 	allowMissingConfig bool
 }
@@ -40,6 +32,11 @@ func Backup(path string) *BackupOption {
 	return &BackupOption{path}
 }
 
+// DisableBackup is a convenience method for Backup("-"), indicating backup state should be disabled.
+func DisableBackup() *BackupOption {
+	return &BackupOption{"-"}
+}
+
 type ConfigOption struct {
 	path string
 }
@@ -97,14 +94,6 @@ func GetPlugins(getPlugins bool) *GetPluginsOption {
 	return &GetPluginsOption{getPlugins}
 }
 
-type IdOption struct {
-	id string
-}
-
-func Id(id string) *IdOption {
-	return &IdOption{id}
-}
-
 type LockOption struct {
 	lock bool
 }

diff --git a/tfexec/output_test.go b/tfexec/output_test.go
@@ -11,7 +11,7 @@ func TestOutputCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/plan_test.go b/tfexec/plan_test.go
@@ -11,7 +11,7 @@ func TestPlanCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/providers_schema_test.go b/tfexec/providers_schema_test.go
@@ -11,7 +11,7 @@ func TestProvidersSchemaCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/tfexec/show_test.go b/tfexec/show_test.go
@@ -16,19 +16,15 @@ func TestStateShow(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	// copy state and config files into test dir
-	err = copyFile(filepath.Join(testFixtureDir, testTerraformStateFileName), filepath.Join(td, testTerraformStateFileName))
+	err = copyFiles(filepath.Join(testFixtureDir, "basic"), td)
 	if err != nil {
-		t.Fatalf("error copying state file into test dir: %s", err)
-	}
-	err = copyFile(filepath.Join(testFixtureDir, testConfigFileName), filepath.Join(td, testConfigFileName))
-	if err != nil {
-		t.Fatalf("error copying config file into test dir: %s", err)
+		t.Fatalf("error copying files into test dir: %s", err)
 	}
 
 	expected := tfjson.State{
@@ -70,12 +66,12 @@ func TestShow_errInitRequired(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	err = copyFile(filepath.Join(testFixtureDir, testTerraformStateFileName), filepath.Join(td, testTerraformStateFileName))
+	err = copyFile(filepath.Join(testFixtureDir, "basic", testTerraformStateFileName), td)
 
 	_, err = tf.StateShow(context.Background())
 	if err == nil {
@@ -92,7 +88,7 @@ func TestStateShowCmd(t *testing.T) {
 	td := testTempDir(t)
 	defer os.RemoveAll(td)
 
-	tf, err := NewTerraform(td, tfPath)
+	tf, err := NewTerraform(td, tfVersion(t, "0.12.28"))
 	if err != nil {
 		t.Fatal(err)
 	}