internal/command/arguments/init_test.go - main - githubmirror/terraform

internal/command/arguments/init_test.go
487 строк15 KB
Sarah French
command/init: Make validation of positional arguments happen in the `arguments` package. Refactor away unneeded code. (#38692)
10 июн 2026, 15:13
Не верифицирован
10 июн 2026, 15:1306a9b5e
// Copyright IBM Corp. 2014, 2026
// SPDX-License-Identifier: BUSL-1.1

package arguments

import (
	"fmt"
	"os"
	"strings"
	"testing"
	"time"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
)

func TestParseInit_basicValid(t *testing.T) {
	var flagNameValue []FlagNameValue
	testCases := map[string]struct {
		args []string
		want *Init
	}{
		"with default options": {
			nil,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             false,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               true,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        false,
				StateStoreProviderLockFile: "",
			},
		},
		"setting multiple options": {
			[]string{
				"-backend=false", "-force-copy=true",
				"-from-module=./main-dir", "-json", "-get=false",
				"-lock=false", "-lock-timeout=10s", "-reconfigure=true",
				"-upgrade=true", "-compact-warnings=true",
				"-ignore-remote-version=true", "-test-directory=./test-dir",
			},
			&Init{
				FromModule:          "./main-dir",
				Lockfile:            "",
				TestsDirectory:      "./test-dir",
				ViewType:            ViewJSON,
				Backend:             false,
				Cloud:               false,
				Get:                 false,
				ForceInitCopy:       true,
				StateLock:           false,
				StateLockTimeout:    time.Duration(10) * time.Second,
				Reconfigure:         true,
				MigrateState:        false,
				Upgrade:             true,
				Json:                true,
				IgnoreRemoteVersion: true,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               true,
				CompactWarnings:            true,
				TargetFlags:                nil,
				EnablePssExperiment:        false,
				StateStoreProviderLockFile: "",
			},
		},
		"with cloud option": {
			[]string{"-cloud=false", "-input=false", "-target=foo_bar.baz", "-backend-config", "backend.config"},
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             false,
				Cloud:               false,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             false,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &[]FlagNameValue{{Name: "-backend-config", Value: "backend.config"}},
				},
				Vars:                       &Vars{},
				InputEnabled:               false,
				CompactWarnings:            false,
				TargetFlags:                []string{"foo_bar.baz"},
				EnablePssExperiment:        false,
				StateStoreProviderLockFile: "",
			},
		},
	}

	cmpOpts := cmpopts.IgnoreUnexported(Vars{})

	for name, tc := range testCases {
		t.Run(name, func(t *testing.T) {
			experimentsEnabled := false
			got, diags := ParseInit(tc.args, experimentsEnabled)
			if len(diags) > 0 {
				t.Fatalf("unexpected diags: %v", diags)
			}

			if diff := cmp.Diff(tc.want, got, cmpOpts); diff != "" {
				t.Errorf("unexpected result\n%s", diff)
			}
		})
	}
}

func TestParseInit_stateProviderLockFile(t *testing.T) {
	td := t.TempDir()
	t.Chdir(td)

	// Create a dummy lock file to test with
	lockFileName := ".terraform.lock.hcl"
	if err := os.WriteFile(lockFileName, []byte("content doesn't matter!"), 0600); err != nil {
		t.Fatalf("unable to create dependency lock file: %v", err)
	}

	// Create an existing file with an incorrect file name
	invalidLockFileName := "foobar.lock.hcl"
	if err := os.WriteFile(invalidLockFileName, []byte("content doesn't matter!"), 0600); err != nil {
		t.Fatalf("unable to create dependency lock file: %v", err)
	}

	var flagNameValue []FlagNameValue
	testCases := map[string]struct {
		args      []string
		expectErr bool
		want      *Init
	}{
		"error when -state-provider-lock-file is used alongside -input=true": {
			[]string{"-state-provider-lock-file=foobar.lock.hcl", "-upgrade", "-input=true", "-enable-pluggable-state-storage-experiment"},
			true,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             true,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               true,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        true,
				StateStoreProviderLockFile: "foobar.lock.hcl",
			},
		},
		"error when -state-provider-lock-file is used alongside -upgrade": {
			[]string{"-state-provider-lock-file=foobar.lock.hcl", "-upgrade", "-input=false", "-enable-pluggable-state-storage-experiment"},
			true,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             true,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               false,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        true,
				StateStoreProviderLockFile: "foobar.lock.hcl",
			},
		},
		"error when -state-provider-lock-file references a non-existent file": {
			[]string{"-state-provider-lock-file=nonexistent.lock.hcl", "-input=false", "-enable-pluggable-state-storage-experiment"},
			true,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             false,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               false,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        true,
				StateStoreProviderLockFile: "nonexistent.lock.hcl",
			},
		},
		"error when -state-provider-lock-file references a file that is not called .terraform.lock.hcl": {
			[]string{fmt.Sprintf("-state-provider-lock-file=%s", invalidLockFileName), "-input=false", "-enable-pluggable-state-storage-experiment"},
			true,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             false,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               false,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        true,
				StateStoreProviderLockFile: invalidLockFileName,
			},
		},
		"valid when -state-provider-lock-file references a file that exists": {
			[]string{fmt.Sprintf("-state-provider-lock-file=%s", lockFileName), "-input=false", "-enable-pluggable-state-storage-experiment"},
			false,
			&Init{
				FromModule:          "",
				Lockfile:            "",
				TestsDirectory:      "tests",
				ViewType:            ViewHuman,
				Backend:             true,
				Cloud:               true,
				Get:                 true,
				ForceInitCopy:       false,
				StateLock:           true,
				StateLockTimeout:    0,
				Reconfigure:         false,
				MigrateState:        false,
				Upgrade:             false,
				Json:                false,
				IgnoreRemoteVersion: false,
				BackendConfig: FlagNameValueSlice{
					FlagName: "-backend-config",
					Items:    &flagNameValue,
				},
				Vars:                       &Vars{},
				InputEnabled:               false,
				CompactWarnings:            false,
				TargetFlags:                nil,
				EnablePssExperiment:        true,
				StateStoreProviderLockFile: lockFileName,
			},
		},
	}

	cmpOpts := cmpopts.IgnoreUnexported(Vars{})

	for name, tc := range testCases {
		t.Run(name, func(t *testing.T) {
			experimentsEnabled := true
			got, diags := ParseInit(tc.args, experimentsEnabled)
			if len(diags) > 0 {
				if !tc.expectErr {
					t.Fatalf("unexpected diags: %v", diags)
				}
			}
			if tc.expectErr && len(diags) == 0 {
				t.Fatal("expected error diags but got none")
			}

			if diff := cmp.Diff(tc.want, got, cmpOpts); diff != "" {
				t.Errorf("unexpected result\n%s", diff)
			}
		})
	}
}

func TestParseInit_invalid(t *testing.T) {
	testCases := map[string]struct {
		args         []string
		wantErr      string
		wantViewType ViewType
	}{
		"with unsupported options": {
			args:         []string{"-raw"},
			wantErr:      "flag provided but not defined",
			wantViewType: ViewHuman,
		},
		"with both -backend and -cloud options set": {
			args:         []string{"-backend=false", "-cloud=false"},
			wantErr:      "The -backend and -cloud options are aliases of one another and mutually-exclusive in their use",
			wantViewType: ViewHuman,
		},
		"with both -migrate-state and -json options set": {
			args:         []string{"-migrate-state", "-json"},
			wantErr:      "Terraform cannot ask for interactive approval when -json is set. To use the -migrate-state option, disable the -json option.",
			wantViewType: ViewJSON,
		},
		"with both -migrate-state and -reconfigure options set": {
			args:         []string{"-migrate-state", "-reconfigure"},
			wantErr:      "The -migrate-state and -reconfigure options are mutually-exclusive.",
			wantViewType: ViewHuman,
		},
		"with both -upgrade and -lockfile=readonly options set": {
			args:         []string{"-upgrade", "-lockfile=readonly"},
			wantErr:      "The -upgrade flag conflicts with -lockfile=readonly.",
			wantViewType: ViewHuman,
		},
	}

	for name, tc := range testCases {
		t.Run(name, func(t *testing.T) {
			experimentsEnabled := false
			got, diags := ParseInit(tc.args, experimentsEnabled)
			if len(diags) == 0 {
				t.Fatal("expected diags but got none")
			}
			if got, want := diags.Err().Error(), tc.wantErr; !strings.Contains(got, want) {
				t.Fatalf("wrong diags\n got: %s\nwant: %s", got, want)
			}
			if got.ViewType != tc.wantViewType {
				t.Fatalf("wrong view type, got %#v, want %#v", got.ViewType, tc.wantViewType)
			}
		})
	}
}

func TestParseInit_experimentalFlags(t *testing.T) {
	testCases := map[string]struct {
		args               []string
		envs               map[string]string
		wantErr            string
		experimentsEnabled bool
	}{
		"error: -enable-pluggable-state-storage-experiment and experiments are disabled": {
			args:               []string{"-enable-pluggable-state-storage-experiment"},
			experimentsEnabled: false,
			wantErr:            "Cannot use -enable-pluggable-state-storage-experiment flag without experiments enabled",
		},
		"error: TF_ENABLE_PLUGGABLE_STATE_STORAGE is set and experiments are disabled": {
			envs: map[string]string{
				"TF_ENABLE_PLUGGABLE_STATE_STORAGE": "1",
			},
			experimentsEnabled: false,
			wantErr:            "Cannot use -enable-pluggable-state-storage-experiment flag without experiments enabled",
		},
		"error: -state-provider-lock-file and experiments are disabled": {
			args:               []string{"-state-provider-lock-file=.terraform.lock.hcl"},
			experimentsEnabled: false,
			wantErr:            "Cannot use -state-provider-lock-file flag without experiments enabled",
		},
		"error: -state-provider-lock-file and -enable-pluggable-state-storage-experiment isn't set": {
			args:               []string{"-state-provider-lock-file=.terraform.lock.hcl"},
			experimentsEnabled: true,
			wantErr:            "Cannot use -state-provider-lock-file flag unless the pluggable state storage experiment is enabled",
		},
	}

	for name, tc := range testCases {
		t.Run(name, func(t *testing.T) {
			for k, v := range tc.envs {
				t.Setenv(k, v)
			}

			_, diags := ParseInit(tc.args, tc.experimentsEnabled)
			if len(diags) == 0 {
				t.Fatal("expected diags but got none")
			}
			if got, want := diags.Err().Error(), tc.wantErr; !strings.Contains(got, want) {
				t.Fatalf("wrong diags\n got: %s\nwant: %s", got, want)
			}
		})
	}
}

func TestParseInit_vars(t *testing.T) {
	testCases := map[string]struct {
		args []string
		want []FlagNameValue
	}{
		"no var flags by default": {
			args: nil,
			want: nil,
		},
		"one var": {
			args: []string{"-var", "foo=bar"},
			want: []FlagNameValue{
				{Name: "-var", Value: "foo=bar"},
			},
		},
		"one var-file": {
			args: []string{"-var-file", "cool.tfvars"},
			want: []FlagNameValue{
				{Name: "-var-file", Value: "cool.tfvars"},
			},
		},
		"ordering preserved": {
			args: []string{
				"-var", "foo=bar",
				"-var-file", "cool.tfvars",
				"-var", "boop=beep",
			},
			want: []FlagNameValue{
				{Name: "-var", Value: "foo=bar"},
				{Name: "-var-file", Value: "cool.tfvars"},
				{Name: "-var", Value: "boop=beep"},
			},
		},
	}

	for name, tc := range testCases {
		t.Run(name, func(t *testing.T) {
			experimentsEnabled := false
			got, diags := ParseInit(tc.args, experimentsEnabled)
			if len(diags) > 0 {
				t.Fatalf("unexpected diags: %v", diags)
			}
			if vars := got.Vars.All(); !cmp.Equal(vars, tc.want) {
				t.Fatalf("unexpected result\n%s", cmp.Diff(vars, tc.want))
			}
			if got, want := got.Vars.Empty(), len(tc.want) == 0; got != want {
				t.Fatalf("expected Empty() to return %t, but was %t", want, got)
			}
		})
	}
}