api: convert vSAN directory name to uuid in ResolveLibraryItemStorage

Author: dougm

vapi/library/finder/path.go

@@ -23,6 +23,7 @@ import (
 	"path"
 	"strings"
 
+	"github.com/vmware/govmomi/internal"
 	"github.com/vmware/govmomi/object"
 	"github.com/vmware/govmomi/property"
 	"github.com/vmware/govmomi/vapi/library"
@@ -134,6 +135,29 @@ func (f *PathFinder) datastoreName(ctx context.Context, id string) (string, erro
 	return name, nil
 }
 
+func (f *PathFinder) convertPath(ctx context.Context, b *mo.Datastore, path string) (string, error) {
+	if !internal.IsDatastoreVSAN(*b) {
+		return path, nil
+	}
+
+	var dc *object.Datacenter
+
+	entities, err := mo.Ancestors(ctx, f.c, f.c.ServiceContent.PropertyCollector, b.Self)
+	if err != nil {
+		return "", err
+	}
+
+	for _, entity := range entities {
+		if entity.Self.Type == "Datacenter" {
+			dc = object.NewDatacenter(f.c, entity.Self)
+			break
+		}
+	}
+
+	m := object.NewDatastoreNamespaceManager(f.c)
+	return m.ConvertNamespacePathToUuidPath(ctx, dc, path)
+}
+
 // ResolveLibraryItemStorage transforms StorageURIs Datastore url (uuid) to Datastore name.
 func (f *PathFinder) ResolveLibraryItemStorage(ctx context.Context, storage []library.Storage) error {
 	// TODO:
@@ -154,7 +178,8 @@ func (f *PathFinder) ResolveLibraryItemStorage(ctx context.Context, storage []li
 
 	var ds []mo.Datastore
 	pc := property.DefaultCollector(f.c)
-	if err := pc.Retrieve(ctx, ids, []string{"name", "info.url"}, &ds); err != nil {
+	props := []string{"name", "summary.url", "summary.type"}
+	if err := pc.Retrieve(ctx, ids, props, &ds); err != nil {
 		return err
 	}
 
@@ -164,12 +189,21 @@ func (f *PathFinder) ResolveLibraryItemStorage(ctx context.Context, storage []li
 
 	for _, item := range storage {
 		b := backing[item.StorageBacking.DatastoreID]
-		dsurl := b.Info.GetDatastoreInfo().Url
+		dsurl := b.Summary.Url
 
 		for i := range item.StorageURIs {
-			u := strings.TrimPrefix(item.StorageURIs[i], dsurl)
+			uri, err := url.Parse(item.StorageURIs[i])
+			if err != nil {
+				return err
+			}
+			uri.Path = path.Clean(uri.Path) // required for ConvertNamespacePathToUuidPath()
+			uri.RawQuery = ""
+			u, err := f.convertPath(ctx, b, uri.String())
+			if err != nil {
+				return err
+			}
+			u = strings.TrimPrefix(u, dsurl)
 			u = strings.TrimPrefix(u, "/")
-			u = strings.SplitN(u, "?", 2)[0] // strip query, if any
 
 			item.StorageURIs[i] = (&object.DatastorePath{
 				Datastore: b.Name,

vapi/library/finder/path_test.go

@@ -0,0 +1,94 @@
+/*
+Copyright (c) 2024-2024 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 finder_test
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/vmware/govmomi/find"
+	"github.com/vmware/govmomi/object"
+	"github.com/vmware/govmomi/simulator"
+	"github.com/vmware/govmomi/vapi/library"
+	"github.com/vmware/govmomi/vapi/library/finder"
+	"github.com/vmware/govmomi/vapi/rest"
+	_ "github.com/vmware/govmomi/vapi/simulator"
+	"github.com/vmware/govmomi/vim25"
+	"github.com/vmware/govmomi/vim25/mo"
+	"github.com/vmware/govmomi/vim25/types"
+)
+
+func TestResolveLibraryItemStorage(t *testing.T) {
+	simulator.Test(func(ctx context.Context, vc *vim25.Client) {
+		rc := rest.NewClient(vc)
+
+		ds, err := find.NewFinder(vc).Datastore(ctx, "*")
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		var props mo.Datastore
+		err = ds.Properties(ctx, ds.Reference(), []string{"name", "summary"}, &props)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		fsTypes := []string{
+			string(types.HostFileSystemVolumeFileSystemTypeOTHER),
+			string(types.HostFileSystemVolumeFileSystemTypeVsan),
+		}
+
+		for _, fs := range fsTypes {
+			// client uses DatastoreNamespaceManager only when datastore fs is vsan/vvol
+			simulator.Map.Get(ds.Reference()).(*simulator.Datastore).Summary.Type = fs
+
+			u := props.Summary.Url
+
+			storage := []library.Storage{
+				{
+					StorageBacking: library.StorageBacking{DatastoreID: ds.Reference().Value, Type: "DATASTORE"},
+					StorageURIs: []string{
+						fmt.Sprintf("%s/contentlib-${lib_id}/${item_id}/${file_name}_${file_id}.iso", u),
+						fmt.Sprintf("%s/contentlib-${lib_id}/${item_id}/${file_name}_${file_id}.iso?serverId=${server_id}", u),
+					},
+				},
+			}
+
+			f := finder.NewPathFinder(library.NewManager(rc), vc)
+
+			err = f.ResolveLibraryItemStorage(ctx, storage)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			var path object.DatastorePath
+			for _, s := range storage {
+				for _, u := range s.StorageURIs {
+					path.FromString(u)
+					if path.Datastore != props.Name {
+						t.Errorf("failed to parse %s", u)
+					}
+					if strings.Contains(u, "?") {
+						t.Errorf("includes query: %s", u)
+					}
+				}
+			}
+		}
+	})
+}