Make VMware tool paths configurable in VsphereGuestInfoSettingsSource (#398)

Add RpcToolPath and VmToolsdPath fields to VsphereGuestInfoSourceOptions,
allowing agent.json to specify custom paths for rpctool and vmtoolsd
executables. Defaults to "vmware-rpctool" and "vmtoolsd" when not set.

This enables Windows deployments where the tools are located at
"C:\Program Files\VMware\VMware Tools\rpctool.exe".

Author: julian-hj

infrastructure/settings_source_factory.go

@@ -64,7 +64,10 @@ type CDROMSourceOptions struct {
 
 func (o CDROMSourceOptions) sourceOptionsInterface() {}
 
-type VsphereGuestInfoSourceOptions struct{}
+type VsphereGuestInfoSourceOptions struct {
+	RpcToolPath  string
+	VmToolsdPath string
+}
 
 func (o VsphereGuestInfoSourceOptions) sourceOptionsInterface() {}
 
@@ -143,6 +146,8 @@ func (f SettingsSourceFactory) buildWithoutRegistry() (boshsettings.Source, erro
 			settingsSource = NewVsphereGuestInfoSettingsSource(
 				f.platform,
 				f.logger,
+				typedOpts.RpcToolPath,
+				typedOpts.VmToolsdPath,
 			)
 
 		case InstanceMetadataSourceOptions:

infrastructure/settings_source_factory_test.go

@@ -135,7 +135,7 @@ var _ = Describe("SettingsSourceFactory", func() {
 				})
 
 				It("returns a settings source that uses the VsphereGuestInfo to fetch settings", func() {
-					vsphereGuestInfoSettingsSource := NewVsphereGuestInfoSettingsSource(platform, logger)
+					vsphereGuestInfoSettingsSource := NewVsphereGuestInfoSettingsSource(platform, logger, "", "")
 
 					multiSettingsSource, err := NewMultiSettingsSource(logger, vsphereGuestInfoSettingsSource)
 					Expect(err).ToNot(HaveOccurred())
@@ -204,6 +204,17 @@ var _ = Describe("SettingsSourceFactory", func() {
 			Expect(sourceOptionsSlice[0]).To(Equal(VsphereGuestInfoSourceOptions{}))
 		})
 
+		It("unmarshals VsphereGuestInfo source options with custom tool paths", func() {
+			jsonStr := `[{"Type": "VsphereGuestInfo", "RpcToolPath": "C:\\Program Files\\VMware\\VMware Tools\\rpctool.exe", "VmToolsdPath": "C:\\Program Files\\VMware\\VMware Tools\\vmtoolsd.exe"}]`
+			err := json.Unmarshal([]byte(jsonStr), &sourceOptionsSlice)
+			Expect(err).ToNot(HaveOccurred())
+			Expect(sourceOptionsSlice).To(HaveLen(1))
+			Expect(sourceOptionsSlice[0]).To(Equal(VsphereGuestInfoSourceOptions{
+				RpcToolPath:  `C:\Program Files\VMware\VMware Tools\rpctool.exe`,
+				VmToolsdPath: `C:\Program Files\VMware\VMware Tools\vmtoolsd.exe`,
+			}))
+		})
+
 		It("returns error when Type is missing", func() {
 			jsonStr := `[{"URI": "http://example.com"}]`
 			err := json.Unmarshal([]byte(jsonStr), &sourceOptionsSlice)

infrastructure/vsphere_guest_info_settings_source.go

@@ -15,23 +15,41 @@ import (
 	boshsettings "github.com/cloudfoundry/bosh-agent/v2/settings"
 )
 
+const (
+	defaultRpcToolPath  = "vmware-rpctool"
+	defaultVmToolsdPath = "vmtoolsd"
+)
+
 type VsphereGuestInfoSettingsSource struct {
 	platform  boshplatform.Platform
 	cmdRunner boshsys.CmdRunner
 
+	rpcToolPath  string
+	vmToolsdPath string
+
 	logTag string
 	logger boshlog.Logger
 }
 
 func NewVsphereGuestInfoSettingsSource(
 	platform boshplatform.Platform,
 	logger boshlog.Logger,
+	rpcToolPath string,
+	vmToolsdPath string,
 ) *VsphereGuestInfoSettingsSource {
+	if rpcToolPath == "" {
+		rpcToolPath = defaultRpcToolPath
+	}
+	if vmToolsdPath == "" {
+		vmToolsdPath = defaultVmToolsdPath
+	}
 	return &VsphereGuestInfoSettingsSource{
-		platform:  platform,
-		cmdRunner: platform.GetRunner(),
-		logTag:    "VsphereGuestInfoSettingsSource",
-		logger:    logger,
+		platform:     platform,
+		cmdRunner:    platform.GetRunner(),
+		rpcToolPath:  rpcToolPath,
+		vmToolsdPath: vmToolsdPath,
+		logTag:       "VsphereGuestInfoSettingsSource",
+		logger:       logger,
 	}
 }
 
@@ -87,12 +105,13 @@ func (s *VsphereGuestInfoSettingsSource) Settings() (boshsettings.Settings, erro
 	return settings, nil
 }
 
-// vmWareRPC runs the given command using vmware-rpctool, and if it fails, it runs the same command using vmtoolsd
-// for some versions, vmware-rpctool is significantly faster than vmtoolsd, so we use it if it is available.
+// vmWareRPC runs the given command using the configured rpctool path, and if it fails,
+// it runs the same command using the configured vmtoolsd path.
+// For some versions, vmware-rpctool is significantly faster than vmtoolsd, so we use it if it is available.
 func (s *VsphereGuestInfoSettingsSource) vmWareRPC(cmd string) (string, string, int, error) {
-	stdOut, stdErr, status, err := s.cmdRunner.RunCommand("vmware-rpctool", cmd)
+	stdOut, stdErr, status, err := s.cmdRunner.RunCommand(s.rpcToolPath, cmd)
 	if err != nil || status != 0 {
-		return s.cmdRunner.RunCommand("vmtoolsd", "--cmd", cmd)
+		return s.cmdRunner.RunCommand(s.vmToolsdPath, "--cmd", cmd)
 	}
 	return stdOut, stdErr, status, nil
 }

infrastructure/vsphere_guest_info_settings_source_test.go

@@ -32,7 +32,7 @@ var _ = Describe("VsphereGuestInfoSettingsSource", func() {
 		cmdRunner = fakes.NewFakeCmdRunner()
 		platform.GetRunnerReturns(cmdRunner)
 		logger := logger.NewLogger(logger.LevelNone)
-		source = NewVsphereGuestInfoSettingsSource(platform, logger)
+		source = NewVsphereGuestInfoSettingsSource(platform, logger, "", "")
 		settings = boshsettings.Settings{AgentID: "123"}
 		settingsBytes, err := json.Marshal(settings)
 		Expect(err).ToNot(HaveOccurred())
@@ -134,5 +134,40 @@ var _ = Describe("VsphereGuestInfoSettingsSource", func() {
 			Expect(cmdRunner.RunCommands[1]).To(Equal([]string{"vmware-rpctool", "info-set guestinfo.userdata ---"}))
 			Expect(cmdRunner.RunCommands[2]).To(Equal([]string{"vmware-rpctool", "info-set guestinfo.userdata.encoding ''"}))
 		})
+
+		Context("with custom tool paths", func() {
+			var customSource *VsphereGuestInfoSettingsSource
+
+			BeforeEach(func() {
+				l := logger.NewLogger(logger.LevelNone)
+				customSource = NewVsphereGuestInfoSettingsSource(
+					platform, l,
+					`C:\Program Files\VMware\VMware Tools\rpctool.exe`,
+					`C:\Program Files\VMware\VMware Tools\vmtoolsd.exe`,
+				)
+			})
+
+			It("uses the custom rpctool path", func() {
+				cmdRunner.AddCmdResult(`C:\Program Files\VMware\VMware Tools\rpctool.exe info-get guestinfo.userdata`, fakes.FakeCmdResult{Stdout: encodedSettings})
+
+				settings, err := customSource.Settings()
+				Expect(err).ToNot(HaveOccurred())
+				Expect(settings.AgentID).To(Equal("123"))
+				Expect(cmdRunner.RunCommands[0]).To(Equal([]string{`C:\Program Files\VMware\VMware Tools\rpctool.exe`, "info-get guestinfo.userdata"}))
+			})
+
+			It("falls back to the custom vmtoolsd path when rpctool fails", func() {
+				cmdRunner.AddCmdResult(`C:\Program Files\VMware\VMware Tools\rpctool.exe info-get guestinfo.userdata`, fakes.FakeCmdResult{Error: errors.New("fail"), ExitStatus: 1})
+				cmdRunner.AddCmdResult(`C:\Program Files\VMware\VMware Tools\vmtoolsd.exe --cmd info-get guestinfo.userdata`, fakes.FakeCmdResult{Stdout: encodedSettings})
+				cmdRunner.AddCmdResult(`C:\Program Files\VMware\VMware Tools\rpctool.exe info-set guestinfo.userdata ---`, fakes.FakeCmdResult{Error: errors.New("fail"), ExitStatus: 1})
+				cmdRunner.AddCmdResult(`C:\Program Files\VMware\VMware Tools\rpctool.exe info-set guestinfo.userdata.encoding `, fakes.FakeCmdResult{Error: errors.New("fail"), ExitStatus: 1})
+
+				settings, err := customSource.Settings()
+				Expect(err).ToNot(HaveOccurred())
+				Expect(settings.AgentID).To(Equal("123"))
+				Expect(cmdRunner.RunCommands[0]).To(Equal([]string{`C:\Program Files\VMware\VMware Tools\rpctool.exe`, "info-get guestinfo.userdata"}))
+				Expect(cmdRunner.RunCommands[1]).To(Equal([]string{`C:\Program Files\VMware\VMware Tools\vmtoolsd.exe`, "--cmd", "info-get guestinfo.userdata"}))
+			})
+		})
 	})
 })