Re-work TenantManager addition to ServiceContent for older clients

Older (Java/Python/non-Go) clients do not have TenantManaager in vmodl API and
will break if they receive TenanatManager entry in ServiceContent.

This patch reworks the addition of TenantManager moref entry in ServiceContent,
by default the TenantManager morer entry in ServiceContent is kept nil to
avoid breaking clients older than 6.9.1 (that version of vmodl does not
define TenantManager). To return a valid TenantManager ref in ServiceConent
in the response to newer clients (either on RetrieveServiceContent() API call
or the property collector call on ServiceInstance object), we would need
to handle client vmodl version properly, expecting this as a separate change,
this patch keeps the TenantManager unwired and skips the new tests.

Author: nikhail

object/tenant_manager.go

@@ -0,0 +1,78 @@
+/*
+Copyright (c) 2021 VMware, Inc. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package object
+
+import (
+	"context"
+
+	"github.com/vmware/govmomi/vim25"
+	"github.com/vmware/govmomi/vim25/methods"
+	"github.com/vmware/govmomi/vim25/types"
+)
+
+type TenantManager struct {
+	Common
+}
+
+func NewTenantManager(c *vim25.Client) *TenantManager {
+	t := TenantManager{
+		Common: NewCommon(c, *c.ServiceContent.TenantManager),
+	}
+
+	return &t
+}
+
+func (t TenantManager) MarkServiceProviderEntities(ctx context.Context, entities []types.ManagedObjectReference) error {
+	req := types.MarkServiceProviderEntities{
+		This:   t.Reference(),
+		Entity: entities,
+	}
+
+	_, err := methods.MarkServiceProviderEntities(ctx, t.Client(), &req)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (t TenantManager) UnmarkServiceProviderEntities(ctx context.Context, entities []types.ManagedObjectReference) error {
+	req := types.UnmarkServiceProviderEntities{
+		This:   t.Reference(),
+		Entity: entities,
+	}
+
+	_, err := methods.UnmarkServiceProviderEntities(ctx, t.Client(), &req)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (t TenantManager) RetrieveServiceProviderEntities(ctx context.Context) ([]types.ManagedObjectReference, error) {
+	req := types.RetrieveServiceProviderEntities{
+		This: t.Reference(),
+	}
+
+	res, err := methods.RetrieveServiceProviderEntities(ctx, t.Client(), &req)
+	if err != nil {
+		return nil, err
+	}
+
+	return res.Returnval, nil
+}

simulator/tenant_manager_test.go

@@ -17,13 +17,16 @@ limitations under the License.
 package simulator
 
 import (
+	"context"
 	"reflect"
 	"sort"
 	"strings"
 	"testing"
 
-	"github.com/vmware/govmomi/simulator/vpx"
-	"github.com/vmware/govmomi/vim25/methods"
+	"github.com/vmware/govmomi"
+	"github.com/vmware/govmomi/object"
+	"github.com/vmware/govmomi/vim25"
+	"github.com/vmware/govmomi/vim25/soap"
 	"github.com/vmware/govmomi/vim25/types"
 )
 
@@ -40,7 +43,70 @@ func sortMoRefSlice(a []types.ManagedObjectReference) {
 	})
 }
 
+func TestTenantManagerForOldClients(t *testing.T) {
+	// ServiceContent TenantManager field is not present in older (<6.9.1) vmodl
+	// (e.g. response to RetrieveServiceConent() API or propery collector on
+	// ServiceInstance object), this field should be set only if the client is newer.
+	// Currently TenantManager is not set in vpx simulator's ServiceContent, and
+	// would be added once simulator supports client vmodl versioning properly.
+	t.Skip("needs vmodl versioning")
+
+	ctx := context.Background()
+	m := VPX()
+	defer m.Remove()
+
+	err := m.Create()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	s := m.Service.NewServer()
+	defer s.Close()
+
+	// Ensure non-nil moref being returned for ServiceContent.TenantManger for newer vim version clients.
+	newSoapClient := soap.NewClient(s.URL, true)
+	newSoapClient.Version = "6.9.1"
+	newVimClient, err := vim25.NewClient(ctx, newSoapClient)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if newVimClient.ServiceContent.TenantManager == nil {
+		t.Fatal("Expected retrieved ServiceContent.TenantManager to be non-nil")
+	}
+
+	// Ensure non-nil moref being returned for ServiceContent.TenantManger for default version used in vim25 client.
+	defaultSoapClient := soap.NewClient(s.URL, true)
+	// No version being set for soap client
+	defaultVimClient, err := vim25.NewClient(ctx, defaultSoapClient)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if defaultVimClient.ServiceContent.TenantManager == nil {
+		t.Fatal("Expected retrieved ServiceContent.TenantManager to be non-nil")
+	}
+
+	// Ensure nil being returned for ServiceContent.TenantManger for older vim version clients.
+	oldSoapClient := soap.NewClient(s.URL, true)
+	oldSoapClient.Version = "6.5"
+	oldVimClient, err := vim25.NewClient(ctx, oldSoapClient)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if oldVimClient.ServiceContent.TenantManager != nil {
+		t.Fatalf("Expected retrieved ServiceContent.TenantManager to be nil but found %v", oldVimClient.ServiceContent.TenantManager)
+	}
+
+}
+
 func TestTenantManagerVPX(t *testing.T) {
+	// ServiceContent TenantManager field is not present in older (<6.9.1) vmodl
+	// (e.g. response to RetrieveServiceConent() API or propery collector on
+	// ServiceInstance object), this field should be set only if the client is newer.
+	// Currently TenantManager is not set in vpx simulator's ServiceContent, and
+	// would be added once simulator supports client vmodl versioning properly.
+	t.Skip("needs vmodl versioning")
+
+	ctx := context.Background()
 	m := VPX()
 	defer m.Remove()
 
@@ -52,77 +118,70 @@ func TestTenantManagerVPX(t *testing.T) {
 	s := m.Service.NewServer()
 	defer s.Close()
 
-	tenantManager := Map.Get(*vpx.ServiceContent.TenantManager).(*TenantManager)
+	c, err := govmomi.NewClient(ctx, s.URL, true)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	tenantManager := object.NewTenantManager(c.Client)
 	serviceProviderEntities := []types.ManagedObjectReference{
 		{Type: "VirtualMachine", Value: "vm-123"},
 		{Type: "HostSystem", Value: "host-1"},
 	}
 	sortMoRefSlice(serviceProviderEntities)
 
 	// "Read your writes", mark entities and verify they are marked.
-	resBody := tenantManager.MarkServiceProviderEntities(&types.MarkServiceProviderEntities{
-		Entity: serviceProviderEntities,
-	})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	err = tenantManager.MarkServiceProviderEntities(ctx, serviceProviderEntities)
+	if err != nil {
+		t.Fatal(err)
 	}
-	resBody = tenantManager.RetrieveServiceProviderEntities(&types.RetrieveServiceProviderEntities{})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	markedEntities, err := tenantManager.RetrieveServiceProviderEntities(ctx)
+	if err != nil {
+		t.Fatal(err)
 	}
-	markedEntities := resBody.(*methods.RetrieveServiceProviderEntitiesBody).Res.Returnval
 	sortMoRefSlice(markedEntities)
 	if !reflect.DeepEqual(serviceProviderEntities, markedEntities) {
 		t.Errorf("Requested-to-be-marked entities mismatch with acutally marked: %+v, %+v", serviceProviderEntities, markedEntities)
 	}
 
-	// Repeatedely mark entities and verify they are deduped.
-	resBody = tenantManager.MarkServiceProviderEntities(&types.MarkServiceProviderEntities{
-		Entity: serviceProviderEntities,
-	})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	// Repeatedely mark same entities and verify they are deduped.
+	err = tenantManager.MarkServiceProviderEntities(ctx, serviceProviderEntities)
+	if err != nil {
+		t.Fatal(err)
 	}
-	resBody = tenantManager.RetrieveServiceProviderEntities(&types.RetrieveServiceProviderEntities{})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	markedEntities, err = tenantManager.RetrieveServiceProviderEntities(ctx)
+	if err != nil {
+		t.Fatal(err)
 	}
-	markedEntities = resBody.(*methods.RetrieveServiceProviderEntitiesBody).Res.Returnval
 	sortMoRefSlice(markedEntities)
 	if !reflect.DeepEqual(serviceProviderEntities, markedEntities) {
 		t.Errorf("Requested-to-be-marked entities mismatch with acutally marked: %+v, %+v", serviceProviderEntities, markedEntities)
 	}
 
 	// Unmark not-previously-marked entity and verify no-op.
 	unknownEntities := []types.ManagedObjectReference{{Type: "Folder", Value: "group-3"}}
-	resBody = tenantManager.UnmarkServiceProviderEntities(&types.UnmarkServiceProviderEntities{
-		Entity: unknownEntities,
-	})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	err = tenantManager.UnmarkServiceProviderEntities(ctx, unknownEntities)
+	if err != nil {
+		t.Fatal(err)
 	}
-	resBody = tenantManager.RetrieveServiceProviderEntities(&types.RetrieveServiceProviderEntities{})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	markedEntities, err = tenantManager.RetrieveServiceProviderEntities(ctx)
+	if err != nil {
+		t.Fatal(err)
 	}
-	markedEntities = resBody.(*methods.RetrieveServiceProviderEntitiesBody).Res.Returnval
 	sortMoRefSlice(markedEntities)
 	if !reflect.DeepEqual(serviceProviderEntities, markedEntities) {
 		t.Errorf("Requested-to-be-marked entities mismatch with acutally marked: %+v, %+v", serviceProviderEntities, markedEntities)
 	}
 
 	// Unmark marked entities and verify no longer marked.
-	resBody = tenantManager.UnmarkServiceProviderEntities(&types.UnmarkServiceProviderEntities{
-		Entity: serviceProviderEntities,
-	})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	err = tenantManager.UnmarkServiceProviderEntities(ctx, serviceProviderEntities)
+	if err != nil {
+		t.Fatal(err)
 	}
-	resBody = tenantManager.RetrieveServiceProviderEntities(&types.RetrieveServiceProviderEntities{})
-	if f := resBody.Fault(); f != nil {
-		t.Fatal(f)
+	markedEntities, err = tenantManager.RetrieveServiceProviderEntities(ctx)
+	if err != nil {
+		t.Fatal(err)
 	}
-	markedEntities = resBody.(*methods.RetrieveServiceProviderEntitiesBody).Res.Returnval
 	if len(markedEntities) > 0 {
 		t.Errorf("Expected all entities to be unmarked but still found marked: %+v", markedEntities)
 	}

simulator/vpx/service_content.go

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2017-2021 VMware, Inc. All Rights Reserved.
+Copyright (c) 2017 VMware, Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -83,5 +83,4 @@ var ServiceContent = types.ServiceContent{
 	HealthUpdateManager:         &types.ManagedObjectReference{Type: "HealthUpdateManager", Value: "HealthUpdateManager"},
 	FailoverClusterConfigurator: &types.ManagedObjectReference{Type: "FailoverClusterConfigurator", Value: "FailoverClusterConfigurator"},
 	FailoverClusterManager:      &types.ManagedObjectReference{Type: "FailoverClusterManager", Value: "FailoverClusterManager"},
-	TenantManager:               &types.ManagedObjectReference{Type: "TenantTenantManager", Value: "TenantManager"},
 }