Add disk sync step before saving a new image (#46)

* Add sync disk step

* Update readme

* Update hc2 generate spec

Author: svetlimladenov

README.md

@@ -19,14 +19,13 @@ Then, run [`packer init`](https://www.packer.io/docs/commands/init).
 packer {
   required_plugins {
     macstadium-orka = {
-      version = ">= 2.3.0"
+      version = ">= 2.3.0, < 3.0.0"
       source  = "github.com/macstadium/macstadium-orka"
     }
   }
 }
 ```
 
-
 #### Manual installation
 
 You can find pre-built binary releases of the plugin [here](https://github.com/macstadium/packer-plugin-macstadium-orka/releases).

builder/orka/builder.go

@@ -6,17 +6,17 @@ import (
 	"net/http"
 
 	"github.com/hashicorp/hcl/v2/hcldec"
-	"github.com/hashicorp/packer-plugin-sdk/multistep/commonsteps"
 	"github.com/hashicorp/packer-plugin-sdk/communicator"
 	"github.com/hashicorp/packer-plugin-sdk/multistep"
+	"github.com/hashicorp/packer-plugin-sdk/multistep/commonsteps"
 	"github.com/hashicorp/packer-plugin-sdk/packer"
 	"github.com/macstadium/packer-plugin-macstadium-orka/mocks"
 )
 
 const BuilderId = "orka"
 
 type HttpClient interface {
-    Do(req *http.Request) (*http.Response, error)
+	Do(req *http.Request) (*http.Response, error)
 }
 
 // Builder ...
@@ -39,7 +39,6 @@ func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
 	return nil, warnings, nil
 }
 
-
 func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error) {
 	// Setup the state bag and initial state for the steps.
 	state := new(multistep.BasicStateBag)
@@ -62,19 +61,19 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 
 	// Iniitialize communicatior
 	var comm = &communicator.StepConnect{
-			Config:    &b.config.CommConfig,
-			Host:      CommHost(b.config.CommConfig.Host()),
-			SSHPort:   CommPort(b.config.CommConfig.Port()),
-			SSHConfig: b.config.CommConfig.SSHConfigFunc(),
+		Config:    &b.config.CommConfig,
+		Host:      CommHost(b.config.CommConfig.Host()),
+		SSHPort:   CommPort(b.config.CommConfig.Port()),
+		SSHConfig: b.config.CommConfig.SSHConfigFunc(),
 	}
 
-
 	// Add our SSH Communicator after our steps.
 	if b.config.Mock == (MockOptions{}) {
 		steps = append(
 			steps,
 			comm,
 			new(commonsteps.StepProvision),
+			new(stepSyncDisk),
 			new(stepCreateImage),
 		)
 	} else {

builder/orka/config.hcl2spec.go

@@ -0,0 +1,51 @@
+package orka
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/packer-plugin-sdk/multistep"
+	"github.com/hashicorp/packer-plugin-sdk/packer"
+)
+
+type stepSyncDisk struct {
+}
+
+func (s *stepSyncDisk) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction {
+	ui := state.Get("ui").(packer.Ui)
+
+	var comm packer.Communicator
+	if raw, ok := state.Get("communicator").(packer.Communicator); ok {
+		comm = raw
+	}
+
+	var stderr bytes.Buffer
+
+	ui.Say("Syncing disk changes...")
+
+	// Start the command
+	cmd := packer.RemoteCmd{Command: "sync", Stderr: &stderr}
+	if err := comm.Start(ctx, &cmd); err != nil {
+		err := fmt.Errorf("failed to sync disk changes: %w; stdErr=%q", err, stderr.String())
+		state.Put("error", err)
+		ui.Error(err.Error())
+		return multistep.ActionHalt
+	}
+
+	// Wait for it to complete
+	status := cmd.Wait()
+
+	if status != 0 {
+		err := fmt.Errorf("failed to sync disk changes: status code %d; stdErr=%q", status, stderr.String())
+		state.Put("error", err)
+		ui.Error(err.Error())
+		return multistep.ActionHalt
+	}
+
+	// Continue processing
+	return multistep.ActionContinue
+}
+
+func (s *stepSyncDisk) Cleanup(multistep.StateBag) {
+}