stembuild: vmconstruct extract ScriptExecutor

Author: aramprice

stembuild/construct/script_executor.go

@@ -0,0 +1,47 @@
+package construct
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/remotemanager"
+)
+
+type ScriptExecutor struct {
+	remoteManager remotemanager.RemoteManager
+}
+
+func NewScriptExecutor(remoteManager remotemanager.RemoteManager) *ScriptExecutor {
+	return &ScriptExecutor{
+		remoteManager,
+	}
+}
+
+func (e *ScriptExecutor) ExecuteSetupScript(stembuildVersion string, setupFlags []string) error {
+	var automationSetupScriptArgs []string
+	automationSetupScriptArgs = append(automationSetupScriptArgs, fmt.Sprintf("-Version %s", stembuildVersion))
+
+	for _, arg := range setupFlags {
+		automationSetupScriptArgs = append(automationSetupScriptArgs, fmt.Sprintf("-%s", arg))
+	}
+
+	powershellCommand := fmt.Sprintf("powershell.exe %s %s", stemcellAutomationSetupScript, strings.Join(automationSetupScriptArgs, " "))
+	_, err := e.remoteManager.ExecuteCommand(powershellCommand)
+	return err
+}
+
+func (e *ScriptExecutor) ExecutePostRebootScript(timeout time.Duration) error {
+	_, err := e.remoteManager.ExecuteCommandWithTimeout("powershell.exe "+stemcellAutomationPostRebootScript, timeout)
+
+	if err != nil && strings.Contains(err.Error(), remotemanager.PowershellExecutionErrorMessage) {
+		return err
+	}
+
+	if err != nil {
+		return fmt.Errorf("winrm connection event: %s", err)
+	}
+
+	return nil
+
+}

stembuild/construct/script_executor_test.go

@@ -0,0 +1,114 @@
+package construct_test
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/construct"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/remotemanager"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/remotemanager/remotemanagerfakes"
+)
+
+var _ = Describe("NewScriptExecutor", func() {
+	var (
+		fakeRemoteManager *remotemanagerfakes.FakeRemoteManager
+
+		scriptExecutor *construct.ScriptExecutor
+	)
+
+	BeforeEach(func() {
+		fakeRemoteManager = &remotemanagerfakes.FakeRemoteManager{}
+
+		scriptExecutor = construct.NewScriptExecutor(fakeRemoteManager)
+	})
+
+	Describe("ScriptExecutor", func() {
+		Describe("ExecuteSetupScript", func() {
+			It("executes setup script with correct arguments", func() {
+				version := "11.11.11"
+				setupFlags := []string{"SomeFlag SomeValue", "OtherFlag OtherValue"}
+				expectedCommandInvocation :=
+					fmt.Sprintf(
+						"powershell.exe %s -Version %s %s",
+						`C:\provision\Setup.ps1`,
+						version,
+						"-SomeFlag SomeValue -OtherFlag OtherValue",
+					)
+
+				err := scriptExecutor.ExecuteSetupScript(version, setupFlags)
+				Expect(err).NotTo(HaveOccurred())
+
+				executeCommandCallArg := fakeRemoteManager.ExecuteCommandArgsForCall(0)
+
+				Expect(executeCommandCallArg).To(Equal(expectedCommandInvocation))
+			})
+		})
+
+		Describe("ExecutePostRebootScript", func() {
+			var expectedTimeout time.Duration
+
+			BeforeEach(func() {
+				expectedTimeout = 24 * time.Hour
+			})
+
+			It("executes post-reboot script with correct arguments", func() {
+				expectedCommandInvocation :=
+					fmt.Sprintf(
+						"powershell.exe %s",
+						`C:\provision\PostReboot.ps1`,
+					)
+
+				err := scriptExecutor.ExecutePostRebootScript(expectedTimeout)
+				Expect(err).NotTo(HaveOccurred())
+
+				executeCommandWithTimeoutCallArg, actualTimeout := fakeRemoteManager.ExecuteCommandWithTimeoutArgsForCall(0)
+
+				Expect(executeCommandWithTimeoutCallArg).To(Equal(expectedCommandInvocation))
+				Expect(expectedTimeout).To(Equal(actualTimeout))
+			})
+
+			Context("when there is an error", func() {
+				var commandExecutionErrorCode int
+				var commandExecutionErr error
+
+				BeforeEach(func() {
+					commandExecutionErrorCode = 999
+				})
+
+				Context("when the error is a powershell execution error", func() {
+					BeforeEach(func() {
+						powershellErrorPrefix := errors.New(remotemanager.PowershellExecutionErrorMessage)
+						commandExecutionErr = fmt.Errorf("%s: %s", powershellErrorPrefix, "a command failed to run")
+
+						fakeRemoteManager.ExecuteCommandWithTimeoutReturns(commandExecutionErrorCode, commandExecutionErr)
+					})
+
+					It("returns the error", func() {
+						err := scriptExecutor.ExecutePostRebootScript(expectedTimeout)
+
+						Expect(err).To(MatchError(commandExecutionErr))
+					})
+				})
+
+				Context("when the error is a NOT powershell execution error", func() {
+					BeforeEach(func() {
+						commandExecutionErr = errors.New("fake-non-powershell-execution-error")
+					})
+
+					It("wraps a non-powershell execution error", func() {
+						fakeRemoteManager.ExecuteCommandWithTimeoutReturns(1, commandExecutionErr)
+
+						err := scriptExecutor.ExecutePostRebootScript(expectedTimeout)
+
+						Expect(err).To(HaveOccurred())
+						Expect(err.Error()).To(Equal(fmt.Sprintf("winrm connection event: %s", commandExecutionErr.Error())))
+					})
+				})
+			})
+		})
+	})
+})

stembuild/construct/vmconstruct.go

@@ -252,44 +252,6 @@ func (c *VMConstruct) logOutUsers() error {
 	return nil
 }
 
-type ScriptExecutor struct {
-	remoteManager remotemanager.RemoteManager
-}
-
-func NewScriptExecutor(remoteManager remotemanager.RemoteManager) *ScriptExecutor {
-	return &ScriptExecutor{
-		remoteManager,
-	}
-}
-
-func (e *ScriptExecutor) ExecuteSetupScript(stembuildVersion string, setupFlags []string) error {
-	var automationSetupScriptArgs []string
-	automationSetupScriptArgs = append(automationSetupScriptArgs, fmt.Sprintf("-Version %s", stembuildVersion))
-
-	for _, arg := range setupFlags {
-		automationSetupScriptArgs = append(automationSetupScriptArgs, fmt.Sprintf("-%s", arg))
-	}
-
-	powershellCommand := fmt.Sprintf("powershell.exe %s %s", stemcellAutomationSetupScript, strings.Join(automationSetupScriptArgs, " "))
-	_, err := e.remoteManager.ExecuteCommand(powershellCommand)
-	return err
-}
-
-func (e *ScriptExecutor) ExecutePostRebootScript(timeout time.Duration) error {
-	_, err := e.remoteManager.ExecuteCommandWithTimeout("powershell.exe "+stemcellAutomationPostRebootScript, timeout)
-
-	if err != nil && strings.Contains(err.Error(), remotemanager.PowershellExecutionErrorMessage) {
-		return err
-	}
-
-	if err != nil {
-		return fmt.Errorf("winrm connection event: %s", err)
-	}
-
-	return nil
-
-}
-
 func (c *VMConstruct) isPoweredOff(duration time.Duration) error {
 	const timeStampFormat = "2006-01-02T15:04:05.999999-07:00"
 	err := c.poller.Poll(duration, func() (bool, error) {

stembuild/construct/vmconstruct_test.go

@@ -15,7 +15,6 @@ import (
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/construct/constructfakes"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/messenger"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/poller/pollerfakes"
-	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/remotemanager"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/remotemanager/remotemanagerfakes"
 )
 
@@ -108,59 +107,6 @@ var _ = Describe("construct_helpers", func() {
 		vmConstruct.RebootWaitTime = 0
 	})
 
-	Describe("ScriptExecutor", func() {
-		It("executes setup script with correct arguments", func() {
-			e := construct.NewScriptExecutor(fakeRemoteManager)
-			version := "11.11.11"
-			err := e.ExecuteSetupScript(version, fakeSetupFlags)
-			executeCommandCallArg := fakeRemoteManager.ExecuteCommandArgsForCall(0)
-
-			Expect(err).NotTo(HaveOccurred())
-			Expect(executeCommandCallArg).To(ContainSubstring("powershell"))
-			Expect(executeCommandCallArg).To(ContainSubstring("Setup.ps1"))
-			Expect(executeCommandCallArg).To(ContainSubstring(" -Version " + version))
-			Expect(executeCommandCallArg).To(ContainSubstring(" -SomeFlag SomeValue"))
-			Expect(executeCommandCallArg).To(ContainSubstring(" -OtherFlag OtherValue"))
-		})
-
-		It("executes post-reboot script with correct arguments", func() {
-			e := construct.NewScriptExecutor(fakeRemoteManager)
-			superLongTimeout := 24 * time.Hour
-			err := e.ExecutePostRebootScript(superLongTimeout)
-			executeCommandCallArg, timeout := fakeRemoteManager.ExecuteCommandWithTimeoutArgsForCall(0)
-
-			Expect(err).NotTo(HaveOccurred())
-			Expect(executeCommandCallArg).To(ContainSubstring("powershell"))
-			Expect(executeCommandCallArg).To(ContainSubstring("PostReboot.ps1"))
-			Expect(timeout).To(Equal(superLongTimeout))
-		})
-
-		It("returns an error when there is a powershell script execution error", func() {
-			e := construct.NewScriptExecutor(fakeRemoteManager)
-			superLongTimeout := 24 * time.Hour
-			powershellErrorPrefix := errors.New(remotemanager.PowershellExecutionErrorMessage)
-			powershellErr := fmt.Errorf("%s: %s", powershellErrorPrefix, "a command failed to run")
-			fakeRemoteManager.ExecuteCommandWithTimeoutReturns(2, powershellErr)
-
-			err := e.ExecutePostRebootScript(superLongTimeout)
-
-			Expect(err).To(MatchError(powershellErr))
-		})
-
-		It("wraps a non-powershell execution error", func() {
-			e := construct.NewScriptExecutor(fakeRemoteManager)
-			superLongTimeout := 24 * time.Hour
-			winRMError := errors.New("some EOF thing")
-
-			fakeRemoteManager.ExecuteCommandWithTimeoutReturns(1, winRMError)
-
-			err := e.ExecutePostRebootScript(superLongTimeout)
-
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("winrm connection event"))
-		})
-	})
-
 	Describe("PrepareVM", func() {
 		Describe("creates provision directory", func() {
 			Context("when it fails", func() {