packer-cn/builder/vsphere/common/cleanup_vm_test.go

package common

import (
	"bytes"
	"testing"

	"github.com/hashicorp/packer-plugin-sdk/multistep"
	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
	"github.com/hashicorp/packer/builder/vsphere/driver"
)

func cleanupTestState(mockVM driver.VirtualMachine) multistep.StateBag {
	state := new(multistep.BasicStateBag)
	state.Put("vm", mockVM)
	state.Put("ui", &packersdk.BasicUi{
		Reader: new(bytes.Buffer),
		Writer: new(bytes.Buffer),
	})
	return state
}

func Test_CleanupVM(t *testing.T) {
	type testCase struct {
		Reason        string
		ExtraState    map[string]interface{}
		ExpectDestroy bool
	}
	testCases := []testCase{
		{
			"if cancelled, we should destroy the VM",
			map[string]interface{}{multistep.StateCancelled: true},
			true,
		},
		{
			"if halted, we should destroy the VM",
			map[string]interface{}{multistep.StateHalted: true},
			true,
		},
		{
			"if destroy flag is set, we should destroy the VM",
			map[string]interface{}{"destroy_vm": true},
			true,
		},
		{
			"if none of the above flags are set, we should not destroy the VM",
			map[string]interface{}{},
			false,
		},
	}
	for _, tc := range testCases {
		mockVM := &driver.VirtualMachineMock{}
		state := cleanupTestState(mockVM)
		for k, v := range tc.ExtraState {
			state.Put(k, v)
		}
		CleanupVM(state)
		if mockVM.DestroyCalled != tc.ExpectDestroy {
			t.Fatalf("Problem with cleanup: %s", tc.Reason)
		}
	}

}