feat: add override option

Adds an `override` (bool) option to the `vsphere-template` post-processor, allowing the overwrite of an existing template if set to `true`.

Signed-off-by: Ryan Johnson <[email protected]>

Author: tenthirtyam

.web-docs/components/post-processor/vsphere-template/README.md

@@ -52,7 +52,9 @@ The following configuration options are available for the post-processor.
 
 - `snapshot_description` (string) - A description for the snapshot. Required when `snapshot_enable` is `true`.
 
-- `reregister_vm` (boolean) - Keepe the virtual machine registered after marking as a template.
+- `reregister_vm` (boolean) - Keep the virtual machine registered after marking as a template.
+
+- `override` (bool) - Overwrite existing template. Defaults to `false`.
 
 <!-- End of code generated from the comments of the Config struct in post-processor/vsphere-template/post-processor.go; -->
 

.web-docs/components/post-processor/vsphere/README.md

@@ -55,8 +55,7 @@ The following configuration options are available for the post-processor.
 - `options` ([]string) - Options to send to `ovftool` when uploading the virtual machine.
   Use `ovftool --help` to list all the options available.
 
-- `overwrite` (bool) - Overwrite existing files.
-  If `true`, forces overwrites of existing files. Defaults to `false`.
+- `overwrite` (bool) - Overwrite existing files. Defaults to `false`.
 
 - `resource_pool` (string) - The name of the resource pool to place the virtual machine.
 

docs-partials/post-processor/vsphere-template/Config-not-required.mdx

@@ -16,6 +16,8 @@
 
 - `snapshot_description` (string) - A description for the snapshot. Required when `snapshot_enable` is `true`.
 
-- `reregister_vm` (boolean) - Keepe the virtual machine registered after marking as a template.
+- `reregister_vm` (boolean) - Keep the virtual machine registered after marking as a template.
+
+- `override` (bool) - Overwrite existing template. Defaults to `false`.
 
 <!-- End of code generated from the comments of the Config struct in post-processor/vsphere-template/post-processor.go; -->

docs-partials/post-processor/vsphere/Config-not-required.mdx

@@ -10,8 +10,7 @@
 - `options` ([]string) - Options to send to `ovftool` when uploading the virtual machine.
   Use `ovftool --help` to list all the options available.
 
-- `overwrite` (bool) - Overwrite existing files.
-  If `true`, forces overwrites of existing files. Defaults to `false`.
+- `overwrite` (bool) - Overwrite existing files. Defaults to `false`.
 
 - `resource_pool` (string) - The name of the resource pool to place the virtual machine.
 

post-processor/vsphere-template/post-processor.go

@@ -62,8 +62,10 @@ type Config struct {
 	SnapshotName string `mapstructure:"snapshot_name"`
 	// A description for the snapshot. Required when `snapshot_enable` is `true`.
 	SnapshotDescription string `mapstructure:"snapshot_description"`
-	// Keepe the virtual machine registered after marking as a template.
+	// Keep the virtual machine registered after marking as a template.
 	ReregisterVM config.Trilean `mapstructure:"reregister_vm"`
+	// Overwrite existing template. Defaults to `false`.
+	Override bool `mapstructure:"override"`
 
 	ctx interpolate.Context
 }

post-processor/vsphere-template/post-processor.hcl2spec.go

@@ -15,7 +15,7 @@ func getTestConfig() Config {
 	}
 }
 
-func TestConfigure_Good(t *testing.T) {
+func TestConfigure_Valid(t *testing.T) {
 	var p PostProcessor
 
 	config := getTestConfig()
@@ -26,7 +26,7 @@ func TestConfigure_Good(t *testing.T) {
 	}
 }
 
-func TestConfigure_ReRegisterVM(t *testing.T) {
+func TestConfigure_ReregisterVM_Default(t *testing.T) {
 	var p PostProcessor
 
 	config := getTestConfig()
@@ -40,3 +40,47 @@ func TestConfigure_ReRegisterVM(t *testing.T) {
 		t.Errorf("error: should be unset, not false")
 	}
 }
+
+func TestConfigure_Override(t *testing.T) {
+	tests := []struct {
+		name     string
+		override *bool
+		expected bool
+	}{
+		{
+			name:     "default",
+			override: nil,
+			expected: false,
+		},
+		{
+			name:     "true",
+			override: &[]bool{true}[0],
+			expected: true,
+		},
+		{
+			name:     "false",
+			override: &[]bool{false}[0],
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var p PostProcessor
+			config := getTestConfig()
+
+			if tt.override != nil {
+				config.Override = *tt.override
+			}
+
+			err := p.Configure(config)
+			if err != nil {
+				t.Errorf("error: %s", err)
+			}
+
+			if p.config.Override != tt.expected {
+				t.Errorf("expected override to be %v, got %v", tt.expected, p.config.Override)
+			}
+		})
+	}
+}

post-processor/vsphere-template/post-processor_test.go

@@ -52,7 +52,7 @@ func (s *StepCreateSnapshot) Run(ctx context.Context, state multistep.StateBag)
 
 	ui.Say("Creating virtual machine snapshot...")
 
-	vm, err := findRuntimeVM(cli, dcPath, s.VMName, s.RemoteFolder)
+	vm, err := findVirtualMachine(cli, dcPath, s.VMName, s.RemoteFolder)
 	if err != nil {
 		state.Put("error", err)
 		ui.Errorf("%s", err)

post-processor/vsphere-template/step_create_snapshot.go

@@ -24,6 +24,7 @@ type StepMarkAsTemplate struct {
 	TemplateName string
 	RemoteFolder string
 	ReregisterVM config.Trilean
+	Override     bool
 }
 
 func NewStepMarkAsTemplate(artifact packersdk.Artifact, p *PostProcessor) *StepMarkAsTemplate {
@@ -48,6 +49,7 @@ func NewStepMarkAsTemplate(artifact packersdk.Artifact, p *PostProcessor) *StepM
 		TemplateName: p.config.TemplateName,
 		RemoteFolder: remoteFolder,
 		ReregisterVM: p.config.ReregisterVM,
+		Override:     p.config.Override,
 	}
 }
 
@@ -57,13 +59,48 @@ func (s *StepMarkAsTemplate) Run(ctx context.Context, state multistep.StateBag)
 	folder := state.Get("folder").(*object.Folder)
 	dcPath := state.Get("dcPath").(string)
 
-	vm, err := findRuntimeVM(cli, dcPath, s.VMName, s.RemoteFolder)
+	vm, err := findVirtualMachine(cli, dcPath, s.VMName, s.RemoteFolder)
 	if err != nil {
 		state.Put("error", err)
 		ui.Errorf("%s", err)
 		return multistep.ActionHalt
 	}
 
+	templateName := s.VMName
+	if s.TemplateName != "" {
+		templateName = s.TemplateName
+	}
+
+	existingTemplate, err := findTemplate(cli, folder, templateName)
+	if err != nil {
+		state.Put("error", fmt.Errorf("error checking for existing template: %s", err))
+		ui.Errorf("error checking for existing template: %s", err)
+		return multistep.ActionHalt
+	}
+
+	if existingTemplate != nil {
+		if !s.Override {
+			err := fmt.Errorf("template '%s' already exists. Set 'override = true' to replace existing templates", templateName)
+			state.Put("error", err)
+			ui.Errorf("%s", err)
+			return multistep.ActionHalt
+		}
+
+		ui.Say(fmt.Sprintf("Removing existing template '%s'...", templateName))
+		task, err := existingTemplate.Destroy(context.Background())
+		if err != nil {
+			state.Put("error", fmt.Errorf("failed to remove existing template '%s': %s", templateName, err))
+			ui.Errorf("failed to remove existing template '%s': %s", templateName, err)
+			return multistep.ActionHalt
+		}
+		if err = task.Wait(context.Background()); err != nil {
+			state.Put("error", fmt.Errorf("failed to remove existing template '%s': %s", templateName, err))
+			ui.Errorf("failed to remove existing template '%s': %s", templateName, err)
+			return multistep.ActionHalt
+		}
+		ui.Say(fmt.Sprintf("Successfully removed existing template '%s'.", templateName))
+	}
+
 	// Use the MarkAsTemplate method unless the `reregister_vm` is set to `true`.
 	if s.ReregisterVM.False() {
 		ui.Say("Marking as a template...")
@@ -96,15 +133,46 @@ func (s *StepMarkAsTemplate) Run(ctx context.Context, state multistep.StateBag)
 		return multistep.ActionHalt
 	}
 
-	if err := unregisterPreviousVM(cli, folder, s.VMName); err != nil {
+	artifactName := s.VMName
+	if s.TemplateName != "" {
+		artifactName = s.TemplateName
+	}
+
+	if err := unregisterVirtualMachine(cli, folder, artifactName); err != nil {
 		state.Put("error", err)
-		ui.Errorf("unregisterPreviousVM: %s", err)
+		ui.Errorf("unregisterVirtualMachine: %s", err)
 		return multistep.ActionHalt
 	}
 
-	artifactName := s.VMName
-	if s.TemplateName != "" {
-		artifactName = s.TemplateName
+	// Check if a template with the target name already exists in the destination folder.
+	destinationTemplate, err := findTemplate(cli, folder, artifactName)
+	if err != nil {
+		state.Put("error", fmt.Errorf("error checking for existing template in destination: %s", err))
+		ui.Errorf("error checking for existing template in destination: %s", err)
+		return multistep.ActionHalt
+	}
+
+	if destinationTemplate != nil {
+		if !s.Override {
+			err := fmt.Errorf("template '%s' already exists. Set 'override = true' to replace existing templates", artifactName)
+			state.Put("error", err)
+			ui.Errorf("%s", err)
+			return multistep.ActionHalt
+		}
+
+		ui.Say(fmt.Sprintf("Removing existing template '%s'...", artifactName))
+		task, err := destinationTemplate.Destroy(context.Background())
+		if err != nil {
+			state.Put("error", fmt.Errorf("failed to remove existing template '%s': %s", artifactName, err))
+			ui.Errorf("failed to remove existing template '%s': %s", artifactName, err)
+			return multistep.ActionHalt
+		}
+		if err = task.Wait(context.Background()); err != nil {
+			state.Put("error", fmt.Errorf("failed to remove existing template '%s': %s", artifactName, err))
+			ui.Errorf("failed to remove existing template '%s': %s", artifactName, err)
+			return multistep.ActionHalt
+		}
+		ui.Say(fmt.Sprintf("Successfully removed existing template '%s'", artifactName))
 	}
 
 	ui.Say("Registering virtual machine as a template: " + artifactName)
@@ -155,7 +223,7 @@ func datastorePath(vm *object.VirtualMachine) (*object.DatastorePath, error) {
 	}, nil
 }
 
-func findRuntimeVM(cli *govmomi.Client, dcPath, name, remoteFolder string) (*object.VirtualMachine, error) {
+func findVirtualMachine(cli *govmomi.Client, dcPath, name, remoteFolder string) (*object.VirtualMachine, error) {
 	si := object.NewSearchIndex(cli.Client)
 	fullPath := path.Join(dcPath, "vm", remoteFolder, name)
 
@@ -175,7 +243,7 @@ func findRuntimeVM(cli *govmomi.Client, dcPath, name, remoteFolder string) (*obj
 	return vm, nil
 }
 
-func unregisterPreviousVM(cli *govmomi.Client, folder *object.Folder, name string) error {
+func unregisterVirtualMachine(cli *govmomi.Client, folder *object.Folder, name string) error {
 	si := object.NewSearchIndex(cli.Client)
 	fullPath := path.Join(folder.InventoryPath, name)
 
@@ -187,11 +255,27 @@ func unregisterPreviousVM(cli *govmomi.Client, folder *object.Folder, name strin
 	if ref != nil {
 		if vm, ok := ref.(*object.VirtualMachine); ok {
 			return vm.Unregister(context.Background())
-		} else {
-			return fmt.Errorf("object name '%v' already exists", name)
 		}
+		return fmt.Errorf("object name '%v' already exists", name)
 	}
 	return nil
 }
 
+func findTemplate(cli *govmomi.Client, folder *object.Folder, name string) (*object.VirtualMachine, error) {
+	si := object.NewSearchIndex(cli.Client)
+	fullPath := path.Join(folder.InventoryPath, name)
+
+	ref, err := si.FindByInventoryPath(context.Background(), fullPath)
+	if err != nil {
+		return nil, err
+	}
+
+	if ref != nil {
+		if vm, ok := ref.(*object.VirtualMachine); ok {
+			return vm, nil
+		}
+	}
+	return nil, nil
+}
+
 func (s *StepMarkAsTemplate) Cleanup(multistep.StateBag) {}