vcsim: Fix distribute VMs across resource pools

This fix aligns the behavior of vcsim with the documentation for the
`pool` and `machine` model flags for cluster configurations.

When no child pools are created, i.e. `pool` is not specified, VMs will
be deployed in the root resource pool of a cluster, i.e. `RP0`. The VMs
will also be prefixed with the corresponding resource pool. In order to
not break standalone host behavior, VMs deployed on a standalone host
will not carry a resource pool identifier in their name. See the linked
issue for deployment examples and naming.

The total number of VMs deployed in a VPX model is the result of the
number of datacenters, clusters and resource pools.

BREAKING:

The name of virtual machines deployed in `vcsim` in a cluster (and
optionally child resource pools) has changed to include the
corresponding resource pool name. VM names deployed to standalone hosts
in `vcsim` are not changed.

Closes: #2047
Signed-off-by: Michael Gasch <[email protected]>

Author: Michael Gasch

simulator/finder_test.go

@@ -74,9 +74,9 @@ func TestFinderVPX(t *testing.T) {
 		{"DatacenterList", "/F0/*", 1},
 		{"DatacenterList", "/DC0", 1},
 		{"VirtualMachineList", "/DC0/vm/*", (m.Host + m.Cluster) * m.Machine},
-		{"VirtualMachineList", "F0/DC1_C0_RP0_VM0", 1},
-		{"VirtualMachineList", "./DC1_C0_RP0_VM0", 0},
-		{"VirtualMachineList", "DC1_C0_RP0_VM0", 1}, // find . -type VirtualMachine -name DC1_C0_RP0_VM0
+		{"VirtualMachineList", "F0/DC1_C0_RP1_VM0", 1},
+		{"VirtualMachineList", "./DC1_C0_RP1_VM0", 0},
+		{"VirtualMachineList", "DC1_C0_RP1_VM0", 1}, // find . -type VirtualMachine -name DC1_C0_RP0_VM0
 		{"VirtualAppList", "/DC0/vm/*", 0},
 		{"DatastoreList", "/DC0/datastore/*", m.Datastore},
 		{"DatastoreList", "./*", 0},
@@ -123,7 +123,7 @@ func TestFinderVPX(t *testing.T) {
 		{"DatacenterList", "/*", m.Datacenter - m.Folder},
 		{"DatacenterList", "/*/*", m.Folder},
 		{"DatastoreList", "/F1/DC2/datastore/F1/LocalDS_0", 1},
-		{"VirtualMachineList", "DC1_C0_RP0_VM0", 0}, // TODO: recurse all Datacenters?
+		{"VirtualMachineList", "DC1_C0_RP1_VM0", 0}, // TODO: recurse all Datacenters?
 	}
 
 	f := reflect.ValueOf(finder)

simulator/model.go

@@ -107,6 +107,7 @@ type Model struct {
 	// For example: /DC0/host/DC0_C0/Resources
 	// The root ResourcePool is named "RP0" within other object names.
 	// When Model.Pool is set to 1 or higher, this creates child ResourcePools under the root pool.
+	// Note that this flag is not effective on standalone hosts.
 	// For example: /DC0/host/DC0_C0/Resources/DC0_C0_RP1
 	// Name prefix: RP, vcsim flag: -pool
 	Pool int
@@ -117,7 +118,12 @@ type Model struct {
 	// Name prefix: LocalDS, vcsim flag: -ds
 	Datastore int
 
-	// Machine specifies the number of VirtualMachine entities to create per ResourcePool
+	// Machine specifies the number of VirtualMachine entities to create per
+	// ResourcePool. If the pool flag is specified, the specified number of virtual
+	// machines will be deployed to each child pool and prefixed with the child
+	// resource pool name. Otherwise they are deployed into the root resource pool,
+	// prefixed with RP0. On standalone hosts, machines are always deployed into the
+	// root resource pool without any prefix.
 	// Name prefix: VM, vcsim flag: -vm
 	Machine int
 
@@ -731,19 +737,24 @@ func (m *Model) Create() error {
 				}
 			}
 
-			pool, err := cluster.ResourcePool(ctx)
+			rootRP, err := cluster.ResourcePool(ctx)
 			if err != nil {
 				return err
 			}
 
 			prefix := clusterName + "_RP"
 
-			addMachine(prefix+"0", nil, pool, folders)
+			// put VMs in cluster RP if no child RP(s) configured
+			if m.Pool == 0 {
+				addMachine(prefix+"0", nil, rootRP, folders)
+			}
 
-			for npool := 1; npool <= m.Pool; npool++ {
+			// create child RP(s) with VMs
+			for childRP := 1; childRP <= m.Pool; childRP++ {
 				spec := types.DefaultResourceConfigSpec()
 
-				_, err = pool.Create(ctx, m.fmtName(prefix, npool), spec)
+				p, err := rootRP.Create(ctx, m.fmtName(prefix, childRP), spec)
+				addMachine(m.fmtName(prefix, childRP), nil, p, folders)
 				if err != nil {
 					return err
 				}
@@ -756,7 +767,7 @@ func (m *Model) Create() error {
 				vspec := NewVAppConfigSpec()
 				name := m.fmtName(prefix, napp)
 
-				vapp, err := pool.CreateVApp(ctx, name, rspec, vspec, nil)
+				vapp, err := rootRP.CreateVApp(ctx, name, rspec, vspec, nil)
 				if err != nil {
 					return err
 				}

simulator/model_test.go

@@ -26,7 +26,7 @@ func compareModel(t *testing.T, m *Model) {
 	count := m.Count()
 
 	hosts := (m.Host + (m.ClusterHost * m.Cluster)) * m.Datacenter
-	vms := ((m.Host + m.Cluster) * m.Datacenter) * m.Machine
+	vms := ((m.Host + m.Cluster + m.Pool) * m.Datacenter) * m.Machine
 	// child pools + root pools
 	pools := (m.Pool * m.Cluster * m.Datacenter) + (m.Host+m.Cluster)*m.Datacenter
 	// root folder + Datacenter folders {host,vm,datastore,network} + top-level folders

simulator/search_index_test.go

@@ -160,9 +160,9 @@ func TestSearchIndexFindChild(t *testing.T) {
 		// Datacenter -> host Folder -> Cluster -> ResourcePool -> ResourcePool
 		{"DC0", "host", "DC0_C0", "Resources", "DC0_C0_RP1"},
 		// Datacenter -> host Folder -> Cluster -> ResourcePool -> VirtualMachine
-		{"DC0", "host", "DC0_C0", "Resources", "DC0_C0_RP0_VM0"},
+		{"DC0", "host", "DC0_C0", "Resources", "DC0_C0_RP1", "DC0_C0_RP1_VM0"},
 		// Datacenter -> vm Folder -> VirtualMachine
-		{"DC0", "vm", "DC0_C0_RP0_VM0"},
+		{"DC0", "vm", "DC0_C0_RP1_VM0"},
 	}
 
 	root := c.ServiceContent.RootFolder