Skip to content

Refactor simulated tag support #3916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tenthirtyam merged 1 commit into from
Nov 26, 2025
Merged

Refactor simulated tag support #3916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions simulator/registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,12 @@ type Registry struct {

// tagManager is an interface to simplify internal interaction with the vapi tag manager simulator.
type tagManager interface {
AttachedObjects(types.VslmTagEntry) ([]types.ManagedObjectReference, types.BaseMethodFault)
AttachedTags(id types.ManagedObjectReference) ([]types.VslmTagEntry, types.BaseMethodFault)
AttachTag(types.ManagedObjectReference, types.VslmTagEntry) types.BaseMethodFault
DetachTag(types.ManagedObjectReference, types.VslmTagEntry) types.BaseMethodFault
AttachedObjects(string) ([]types.ManagedObjectReference, types.BaseMethodFault)
AttachedTags(id types.ManagedObjectReference) ([]string, types.BaseMethodFault)
AttachTag(types.ManagedObjectReference, string) types.BaseMethodFault
DetachTag(types.ManagedObjectReference, string) types.BaseMethodFault
GetTagByCategoryAndName(string, string) (string, types.BaseMethodFault)
GetTagCategoryAndName(string) (string, string, types.BaseMethodFault)
}

// NewRegistry creates a new instances of Registry
Expand Down
27 changes: 9 additions & 18 deletions simulator/virtual_machine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3408,33 +3408,24 @@ func (vm *VirtualMachine) updateTagSpec(
vmRef := vm.Reference()

for _, spec := range specs {
tagEntry := types.VslmTagEntry{}

// TagId can be specified by UUID or by NameId (tag name + category name).
// The tagManager uses VslmTagEntry which requires tag and category names.
tagID := spec.Id.Uuid
if spec.Id.NameId != nil {
tagEntry.TagName = spec.Id.NameId.Tag
tagEntry.ParentCategoryName = spec.Id.NameId.Category
} else if spec.Id.Uuid != "" {
// UUID-based lookup is not supported by the tagManager interface.
// Return an error indicating this limitation.
return &types.InvalidArgument{
InvalidProperty: "tagSpecs.id.uuid",
}
} else {
// Neither NameId nor UUID specified
return &types.InvalidArgument{
InvalidProperty: "tagSpecs.id",
t, err := ctx.Map.tagManager.GetTagByCategoryAndName(
spec.Id.NameId.Category,
spec.Id.NameId.Tag)
if err != nil {
return err
}
tagID = t
}

switch spec.Operation {
case types.ArrayUpdateOperationAdd:
if err := ctx.Map.tagManager.AttachTag(vmRef, tagEntry); err != nil {
if err := ctx.Map.tagManager.AttachTag(vmRef, tagID); err != nil {
return err
}
case types.ArrayUpdateOperationRemove:
if err := ctx.Map.tagManager.DetachTag(vmRef, tagEntry); err != nil {
if err := ctx.Map.tagManager.DetachTag(vmRef, tagID); err != nil {
return err
}
default:
Expand Down
76 changes: 42 additions & 34 deletions simulator/vstorage_object_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,15 +395,15 @@ func (m *VcenterVStorageObjectManager) AttachTagToVStorageObject(ctx *Context, r
body := new(methods.AttachTagToVStorageObjectBody)
ref := m.tagID(req.Id)

err := ctx.Map.tagManager.AttachTag(ref, types.VslmTagEntry{
ParentCategoryName: req.Category,
TagName: req.Tag,
})

if err == nil {
body.Res = new(types.AttachTagToVStorageObjectResponse)
} else {
t, err := ctx.Map.tagManager.GetTagByCategoryAndName(req.Category, req.Tag)
if err != nil {
body.Fault_ = Fault("", err)
} else {
if err := ctx.Map.tagManager.AttachTag(ref, t); err != nil {
body.Fault_ = Fault("", err)
} else {
body.Res = new(types.AttachTagToVStorageObjectResponse)
}
}

return body
Expand All @@ -413,15 +413,15 @@ func (m *VcenterVStorageObjectManager) DetachTagFromVStorageObject(ctx *Context,
body := new(methods.DetachTagFromVStorageObjectBody)
ref := m.tagID(req.Id)

err := ctx.Map.tagManager.DetachTag(ref, types.VslmTagEntry{
ParentCategoryName: req.Category,
TagName: req.Tag,
})

if err == nil {
body.Res = new(types.DetachTagFromVStorageObjectResponse)
} else {
t, err := ctx.Map.tagManager.GetTagByCategoryAndName(req.Category, req.Tag)
if err != nil {
body.Fault_ = Fault("", err)
} else {
if err := ctx.Map.tagManager.DetachTag(ref, t); err != nil {
body.Fault_ = Fault("", err)
} else {
body.Res = new(types.DetachTagFromVStorageObjectResponse)
}
}

return body
Expand All @@ -430,18 +430,18 @@ func (m *VcenterVStorageObjectManager) DetachTagFromVStorageObject(ctx *Context,
func (m *VcenterVStorageObjectManager) ListVStorageObjectsAttachedToTag(ctx *Context, req *types.ListVStorageObjectsAttachedToTag) soap.HasFault {
body := new(methods.ListVStorageObjectsAttachedToTagBody)

refs, err := ctx.Map.tagManager.AttachedObjects(types.VslmTagEntry{
ParentCategoryName: req.Category,
TagName: req.Tag,
})

if err == nil {
body.Res = new(types.ListVStorageObjectsAttachedToTagResponse)
for _, ref := range refs {
body.Res.Returnval = append(body.Res.Returnval, types.ID{Id: ref.Value})
}
} else {
t, err := ctx.Map.tagManager.GetTagByCategoryAndName(req.Category, req.Tag)
if err != nil {
body.Fault_ = Fault("", err)
} else {
if refs, err := ctx.Map.tagManager.AttachedObjects(t); err != nil {
body.Fault_ = Fault("", err)
} else {
body.Res = new(types.ListVStorageObjectsAttachedToTagResponse)
for _, ref := range refs {
body.Res.Returnval = append(body.Res.Returnval, types.ID{Id: ref.Value})
}
}
}

return body
Expand All @@ -451,14 +451,22 @@ func (m *VcenterVStorageObjectManager) ListTagsAttachedToVStorageObject(ctx *Con
body := new(methods.ListTagsAttachedToVStorageObjectBody)
ref := m.tagID(req.Id)

tags, err := ctx.Map.tagManager.AttachedTags(ref)

if err == nil {
body.Res = &types.ListTagsAttachedToVStorageObjectResponse{
Returnval: tags,
}
} else {
if tags, err := ctx.Map.tagManager.AttachedTags(ref); err != nil {
body.Fault_ = Fault("", err)
} else {
body.Res = &types.ListTagsAttachedToVStorageObjectResponse{}
for _, t := range tags {
c, n, err := ctx.Map.tagManager.GetTagCategoryAndName(t)
if err != nil {
body.Res = nil
body.Fault_ = Fault("", err)
return body
}
body.Res.Returnval = append(body.Res.Returnval, types.VslmTagEntry{
ParentCategoryName: c,
TagName: n,
})
}
}

return body
Expand Down
53 changes: 39 additions & 14 deletions vapi/simulator/simulator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,9 +322,18 @@ func (s *handler) findTag(e vim.VslmTagEntry) *tags.Tag {
return nil
}

func (s *handler) findTagByID(tagID string) *tags.Tag {
for _, t := range s.Tag {
if t.ID == tagID {
return t
}
}
return nil
}

// AttachedObjects is meant for internal use via simulator.Registry.tagManager
func (s *handler) AttachedObjects(tag vim.VslmTagEntry) ([]vim.ManagedObjectReference, vim.BaseMethodFault) {
t := s.findTag(tag)
func (s *handler) AttachedObjects(tagID string) ([]vim.ManagedObjectReference, vim.BaseMethodFault) {
t := s.findTagByID(tagID)
if t == nil {
return nil, new(vim.NotFound)
}
Expand All @@ -341,28 +350,23 @@ func (s *handler) AttachedObjects(tag vim.VslmTagEntry) ([]vim.ManagedObjectRefe
}

// AttachedTags is meant for internal use via simulator.Registry.tagManager
func (s *handler) AttachedTags(ref vim.ManagedObjectReference) ([]vim.VslmTagEntry, vim.BaseMethodFault) {
func (s *handler) AttachedTags(ref vim.ManagedObjectReference) ([]string, vim.BaseMethodFault) {
oid := internal.AssociatedObject{
Type: ref.Type,
Value: ref.Value,
}
var tags []vim.VslmTagEntry
var tags []string
for id, objs := range s.Association {
if objs[oid] {
tag := s.Tag[id]
cat := s.Category[tag.CategoryID]
tags = append(tags, vim.VslmTagEntry{
TagName: tag.Name,
ParentCategoryName: cat.Name,
})
tags = append(tags, id)
}
}
return tags, nil
}

// AttachTag is meant for internal use via simulator.Registry.tagManager
func (s *handler) AttachTag(ref vim.ManagedObjectReference, tag vim.VslmTagEntry) vim.BaseMethodFault {
t := s.findTag(tag)
func (s *handler) AttachTag(ref vim.ManagedObjectReference, tagID string) vim.BaseMethodFault {
t := s.findTagByID(tagID)
if t == nil {
return new(vim.NotFound)
}
Expand All @@ -374,8 +378,8 @@ func (s *handler) AttachTag(ref vim.ManagedObjectReference, tag vim.VslmTagEntry
}

// DetachTag is meant for internal use via simulator.Registry.tagManager
func (s *handler) DetachTag(id vim.ManagedObjectReference, tag vim.VslmTagEntry) vim.BaseMethodFault {
t := s.findTag(tag)
func (s *handler) DetachTag(id vim.ManagedObjectReference, tagID string) vim.BaseMethodFault {
t := s.findTagByID(tagID)
if t == nil {
return new(vim.NotFound)
}
Expand All @@ -386,6 +390,27 @@ func (s *handler) DetachTag(id vim.ManagedObjectReference, tag vim.VslmTagEntry)
return nil
}

// GetTagByCategoryAndName is meant for internal use via simulator.Registry.tagManager
func (s *handler) GetTagByCategoryAndName(category, name string) (string, vim.BaseMethodFault) {
t := s.findTag(vim.VslmTagEntry{
ParentCategoryName: category,
TagName: name,
})
if t == nil {
return "", new(vim.NotFound)
}
return t.ID, nil
}

// GetTagCategoryAndName is meant for internal use via simulator.Registry.tagManager
func (s *handler) GetTagCategoryAndName(tagID string) (string, string, vim.BaseMethodFault) {
t := s.findTagByID(tagID)
if t == nil {
return "", "", new(vim.NotFound)
}
return t.CategoryID, t.Name, nil
}

// StatusOK responds with http.StatusOK and encodes val, if specified, to JSON
// For use with "/api" endpoints.
func StatusOK(w http.ResponseWriter, val ...any) {
Expand Down
Loading