stembuild: use vcsim as library

instead of building from source, this should allow testing on windows

Author: aramprice

ci/pipelines/stemcells-windows.yml

@@ -165,10 +165,6 @@ resources:
   type: git
   source:
     uri: https://github.com/cloudfoundry/windows-utilities-release.git
-- name: govmomi
-  type: git
-  source:
-    uri: https://github.com/vmware/govmomi.git
 
 # type: docker-image
 - name: bosh-windows-stemcell-builder-ci-docker-image
@@ -931,7 +927,6 @@ jobs:
       - get: blobstore-gcs-cli
       - get: windows-bsdtar
       - get: windows-winsw
-      - get: govmomi
   - put: version
     inputs: detect
     resource: stembuild-linux-build-number

ci/tasks/test-integration-stembuild-linux/run.sh

@@ -15,9 +15,6 @@ echo '---> Install VMWare OVF Tools'
 chmod +x "${ROOT_DIR}/ovftool/VMware-ovftool-4.2.0-5965791-lin.x86_64.bundle"
 "${ROOT_DIR}/ovftool/VMware-ovftool-4.2.0-5965791-lin.x86_64.bundle" --eulas-agreed --required
 
-echo "---> Install github.com/vmware/govmomi/vcsim"
-go install -C "${ROOT_DIR}/govmomi/vcsim"
-
 export TARGET_VM_IP
 TARGET_VM_IP=$(cat nimbus-ips/name)
 export VM_NAME

stembuild/go.mod

@@ -5,7 +5,6 @@ go 1.23.0
 require (
 	github.com/concourse/pool-resource v1.1.1
 	github.com/google/subcommands v1.2.0
-	github.com/google/uuid v1.6.0
 	github.com/masterzen/winrm v0.0.0-20240702205601-3fad6e106085
 	github.com/maxbrunsfeld/counterfeiter/v6 v6.11.3
 	github.com/onsi/ginkgo/v2 v2.23.4
@@ -29,6 +28,7 @@ require (
 	github.com/gofrs/uuid v4.4.0+incompatible // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/pprof v0.0.0-20250630185457-6e76a2b096b5 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
 	github.com/jcmturner/aescts/v2 v2.0.0 // indirect

…iaas_cli/iaas_clients/fixtures/dummycert …aas_cli/iaas_clients/fixtures/dummy-certstembuild/integration/iaas_cli/iaas_clients/fixtures/dummycert renamed to stembuild/integration/iaas_cli/iaas_clients/fixtures/dummy-cert stembuild/integration/iaas_cli/iaas_clients/fixtures/dummycert renamed to stembuild/integration/iaas_cli/iaas_clients/fixtures/dummy-cert

@@ -7,12 +7,11 @@ import (
 	"testing"
 	"time"
 
-	"github.com/google/uuid"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"github.com/vmware/govmomi/object"
 
-	vcenterclientfactory "github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients/vcenter_manager"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients/vcenter_manager"
 )
 
 func TestIaasClients(t *testing.T) {
@@ -31,9 +30,13 @@ const (
 	TestVmUsername  = "CONTRACT_TEST_VM_USERNAME"
 )
 
-var TestVmPath string
-var VM *object.VirtualMachine
-var CTX context.Context
+var (
+	ctx = context.TODO()
+
+	clonedVmPath string
+	clonedVm     *object.VirtualMachine
+)
+
 var _ = BeforeSuite(func() {
 	vcenterCaCert := envMustExist("VCENTER_CA_CERT")
 	vcenterCaCertFile, err := os.CreateTemp("", "vcenter-ca")
@@ -42,55 +45,51 @@ var _ = BeforeSuite(func() {
 	err = os.WriteFile(vcenterCaCertFile.Name(), []byte(vcenterCaCert), 0644)
 	Expect(err).NotTo(HaveOccurred())
 
-	managerFactory := &vcenterclientfactory.ManagerFactory{
-		Config: vcenterclientfactory.FactoryConfig{
+	managerFactory := &vcenter_manager.ManagerFactory{
+		Config: vcenter_manager.FactoryConfig{
 			VCenterServer:  envMustExist(VcenterUrl),
 			Username:       envMustExist(VcenterUsername),
 			Password:       envMustExist(VcenterPassword),
-			ClientCreator:  &vcenterclientfactory.ClientCreator{},
-			FinderCreator:  &vcenterclientfactory.GovmomiFinderCreator{},
+			ClientCreator:  &vcenter_manager.ClientCreator{},
+			FinderCreator:  &vcenter_manager.GovmomiFinderCreator{},
 			RootCACertPath: vcenterCaCertFile.Name(),
 		},
 	}
 
-	CTX = context.TODO()
-
-	vCenterManager, err := managerFactory.VCenterManager(CTX)
+	vCenterManager, err := managerFactory.VCenterManager(ctx)
 	Expect(err).ToNot(HaveOccurred())
 
-	err = vCenterManager.Login(CTX)
+	err = vCenterManager.Login(ctx)
 	Expect(err).ToNot(HaveOccurred())
 
 	vmFolder := envMustExist(VmFolder)
 	testVmName := envMustExist(TestVmName)
 	testVmPath := fmt.Sprintf("%s/%s", vmFolder, testVmName)
 
-	vmToClone, err := vCenterManager.FindVM(CTX, testVmPath)
+	vmToClone, err := vCenterManager.FindVM(ctx, testVmPath)
 	Expect(err).ToNot(HaveOccurred())
 
-	TestVmPath = testVmPath + fmt.Sprintf("%s", uuid.New())[0:8] //nolint:staticcheck
+	clonedVmPath = fmt.Sprintf("%s-%s", testVmPath, time.Now().Format("2006-01-02T15h04s05"))
 
-	err = vCenterManager.CloneVM(CTX, vmToClone, TestVmPath)
+	err = vCenterManager.CloneVM(ctx, vmToClone, clonedVmPath)
 	Expect(err).ToNot(HaveOccurred())
 
 	time.Sleep(30 * time.Second)
 
-	VM, err = vCenterManager.FindVM(CTX, TestVmPath)
+	clonedVm, err = vCenterManager.FindVM(ctx, clonedVmPath)
 	Expect(err).ToNot(HaveOccurred())
-
 })
 
 var _ = AfterSuite(func() {
-
-	if VM != nil {
-		task, err := VM.PowerOff(CTX)
+	if clonedVm != nil {
+		task, err := clonedVm.PowerOff(ctx)
 		Expect(err).ToNot(HaveOccurred())
-		err = task.WaitEx(CTX)
+		err = task.WaitEx(ctx)
 		Expect(err).ToNot(HaveOccurred())
 
-		task, err = VM.Destroy(CTX)
+		task, err = clonedVm.Destroy(ctx)
 		Expect(err).ToNot(HaveOccurred())
-		err = task.WaitEx(CTX)
+		err = task.WaitEx(ctx)
 		Expect(err).ToNot(HaveOccurred())
 	}
 })

…/iaas_cli/iaas_clients/fixtures/dummykey …cli/iaas_clients/fixtures/dummy-cert.keystembuild/integration/iaas_cli/iaas_clients/fixtures/dummykey renamed to stembuild/integration/iaas_cli/iaas_clients/fixtures/dummy-cert.key stembuild/integration/iaas_cli/iaas_clients/fixtures/dummykey renamed to stembuild/integration/iaas_cli/iaas_clients/fixtures/dummy-cert.key

@@ -2,30 +2,28 @@ package iaas_clients
 
 import (
 	"context"
+	"crypto/tls"
+	"fmt"
+	"net/url"
 	"os"
-	"os/exec"
 	"path/filepath"
-	"runtime"
 	"time"
 
-	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli"
-	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients"
-	vcenterclientfactory "github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients/vcenter_manager"
-
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/vmware/govmomi/simulator"
+
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients/vcenter_manager"
 )
 
 var _ = Describe("VcenterManager", func() {
-	BeforeEach(func() {
-		if runtime.GOOS == "windows" {
-			Skip("windows cannot run a vcsim server")
-		}
-	})
-
-	Context("vcsim server with special character credentials", func() {
+	Context("using a vcsim server when username and password have special characters", func() {
 		var (
-			cmd             *exec.Cmd
+			vcsimModel  *simulator.Model
+			vcsimServer *simulator.Server
+
 			vCenterUsername string
 			vCenterPassword string
 			vCenterUrl      string
@@ -36,59 +34,79 @@ var _ = Describe("VcenterManager", func() {
 		BeforeEach(func() {
 			workingDir, err := os.Getwd()
 			Expect(err).NotTo(HaveOccurred())
-			certPath = filepath.Join(workingDir, "fixtures", "dummycert")
-			keyPath = filepath.Join(workingDir, "fixtures", "dummykey")
-
-			vcsimBinary := filepath.Join(os.Getenv("GOPATH"), "bin", "vcsim")
+			certPath = filepath.Join(workingDir, "fixtures", "dummy-cert")
+			keyPath = filepath.Join(workingDir, "fixtures", "dummy-cert.key")
 
 			vCenterUsername = `user\name!#`
 			vCenterPassword = `password\!#!`
-			vCenterUrl = "127.0.0.1:8989/sdk"
-			cmd = exec.Command(vcsimBinary, "-username", vCenterUsername, "-password", vCenterPassword, "-tlscert", certPath, "-tlskey", keyPath)
 
-			err = cmd.Start()
+			vcsimModel = simulator.VPX()
+			err = vcsimModel.Create()
 			Expect(err).ToNot(HaveOccurred())
 
+			vcsimModel.Service.RegisterEndpoints = true
+			vcsimModel.Service.Listen = &url.URL{
+				User: url.UserPassword(vCenterUsername, vCenterPassword),
+			}
+
+			serverCert, err := tls.LoadX509KeyPair(certPath, keyPath)
+			Expect(err).ToNot(HaveOccurred())
+			vcsimModel.Service.TLS = &tls.Config{
+				Certificates: []tls.Certificate{serverCert},
+			}
+
+			vcsimServer = vcsimModel.Service.NewServer()
+
+			vCenterUrl = fmt.Sprintf("%s/sdk", vcsimServer.URL.Host)
+			By(fmt.Sprintf("Using VCsim server at '%s'", vCenterUrl))
+
 			time.Sleep(3 * time.Second) // the vcsim server needs a moment to come up
 		})
 
 		AfterEach(func() {
-			if runtime.GOOS != "windows" && cmd != nil {
-				err := cmd.Process.Kill()
-				Expect(err).ToNot(HaveOccurred())
+			if vcsimServer != nil {
+				vcsimServer.Close()
+			}
+			if vcsimModel != nil {
+				vcsimModel.Remove()
 			}
 		})
 
-		Context("VCenterManager.Login", func() {
-			It("succeeds", func() {
-				factoryConfig := &vcenterclientfactory.FactoryConfig{
-					VCenterServer:  vCenterUrl,
-					Username:       vCenterUsername,
-					Password:       vCenterPassword,
-					ClientCreator:  &vcenterclientfactory.ClientCreator{},
-					FinderCreator:  &vcenterclientfactory.GovmomiFinderCreator{},
-					RootCACertPath: certPath,
-				}
-
-				managerFactory := &vcenterclientfactory.ManagerFactory{
-					Config: *factoryConfig,
+		Describe("VCenterManager.Login()", func() {
+			var managerFactory *vcenter_manager.ManagerFactory
+			BeforeEach(func() {
+				managerFactory = &vcenter_manager.ManagerFactory{
+					Config: vcenter_manager.FactoryConfig{
+						VCenterServer:  vCenterUrl,
+						Username:       vCenterUsername,
+						Password:       vCenterPassword,
+						ClientCreator:  &vcenter_manager.ClientCreator{},
+						FinderCreator:  &vcenter_manager.GovmomiFinderCreator{},
+						RootCACertPath: certPath,
+					},
 				}
+			})
 
+			It("succeeds", func() {
 				ctx := context.TODO()
 
 				vCenterManager, err := managerFactory.VCenterManager(ctx)
 				Expect(err).ToNot(HaveOccurred())
 
 				err = vCenterManager.Login(ctx)
 				Expect(err).ToNot(HaveOccurred())
-
 			})
 		})
 
-		Context("govc_cli client login", func() {
+		Describe("VcenterClient.ValidateCredentials()", func() {
 			It("Succeeds", func() {
-				runner := &iaas_cli.GovcRunner{}
-				client := iaas_clients.NewVcenterClient(vCenterUsername, vCenterPassword, vCenterUrl, certPath, runner)
+				client := iaas_clients.NewVcenterClient(
+					vCenterUsername,
+					vCenterPassword,
+					vCenterUrl,
+					certPath,
+					&iaas_cli.GovcRunner{},
+				)
 
 				err := client.ValidateCredentials()
 				Expect(err).NotTo(HaveOccurred())