WIP

Signed-off-by: Dainius Serplis <dserplis@vmware.com>

Author: Didainius

.changes/v2.23.0/652-improvements.md

@@ -0,0 +1,6 @@
+* New public method `VApp.GetParentVDC` to retrieve parent VDC of vApp (previously it was private)
+  [GH-642]
+* New methods `Catalog.CaptureVappTemplate`, `Catalog.CaptureVappTemplateAsync` and type
+  `types.CaptureVAppParams` that add support for creating catalog template from existing vApp
+  [GH-642]
+* New method `Org.GetVAppByHref` to retrieve a vApp by given HREF [GH-642]

govcd/catalog.go

@@ -360,6 +360,36 @@ func (cat *Catalog) UploadOvfByLink(ovfUrl, itemName, description string) (Task,
 	return task, nil
 }
 
+// CaptureVappTemplate captures a vApp template from an existing vApp
+func (cat *Catalog) CaptureVappTemplate(captureParams *types.CaptureVAppParams) (*VAppTemplate, error) {
+	task, err := cat.CaptureVappTemplateAsync(captureParams)
+	if err != nil {
+		return nil, err
+	}
+
+	err = task.WaitTaskCompletion()
+	if err != nil {
+		return nil, err
+	}
+
+	// After the task is finished, owner field contains the resulting vApp template
+	return cat.GetVappTemplateByHref(task.Task.Owner.HREF)
+}
+
+func (cat *Catalog) CaptureVappTemplateAsync(captureParams *types.CaptureVAppParams) (Task, error) {
+	util.Logger.Printf("[TRACE] Capturing vApp template to catalog %s", cat.Catalog.Name)
+	captureTemplateHref := cat.client.VCDHREF
+	captureTemplateHref.Path += fmt.Sprintf("/catalog/%s/action/captureVApp", extractUuid(cat.Catalog.ID))
+
+	captureParams.Xmlns = types.XMLNamespaceVCloud
+	captureParams.XmlnsNs0 = types.XMLNamespaceOVF
+
+	util.Logger.Printf("[TRACE] Url for capturing vApp template: %s", captureTemplateHref.String())
+
+	return cat.client.ExecuteTaskRequest(captureTemplateHref.String(), http.MethodPost,
+		types.MimeCaptureVappTemplateParams, "error capturing vApp Template: %s", captureParams)
+}
+
 // Upload files for vCD created upload links. Different approach then vmdk file are
 // chunked (e.g. test.vmdk.000000000, test.vmdk.000000001 or test.vmdk). vmdk files are chunked if
 // in description file attribute ChunkSize is not zero.

govcd/catalog_test.go

@@ -1490,3 +1490,34 @@ func (vcd *TestVCD) Test_CatalogCreateCompleteness(check *C) {
 	err = catalog.Delete(true, true)
 	check.Assert(err, IsNil)
 }
+
+func (vcd *TestVCD) Test_CaptureVapp(check *C) {
+	fmt.Printf("Running: %s\n", check.TestName())
+
+	vapp, vm := createNsxtVAppAndVm(vcd, check)
+	check.Assert(vapp, NotNil)
+	check.Assert(vm, NotNil)
+
+	// retrieve NSX-T Catalog
+	cat, err := vcd.org.GetCatalogByName(vcd.config.VCD.Catalog.NsxtBackedCatalogName, false)
+	check.Assert(err, IsNil)
+	check.Assert(cat, NotNil)
+
+	vAppCaptureParams := &types.CaptureVAppParams{
+		Name: check.TestName() + "vm-template",
+		Source: &types.Reference{
+			HREF: vapp.VApp.HREF,
+		},
+		CustomizationSection: types.CaptureVAppParamsCustomizationSection{
+			Info:                   "CustomizeOnInstantiate Settings",
+			CustomizeOnInstantiate: true,
+		},
+		CopyTpmOnInstantiate: addrOf(false),
+	}
+
+	templ, err := cat.CaptureVappTemplate(vAppCaptureParams)
+	check.Assert(err, IsNil)
+	check.Assert(templ, NotNil)
+
+	AddToCleanupList(templ.VAppTemplate.Name, "catalogItem", vcd.org.Org.Name+"|"+vcd.config.VCD.Catalog.NsxtBackedCatalogName, "Test_UploadOvf")
+}

govcd/org.go

@@ -600,3 +600,17 @@ func queryCatalogList(client *Client, filterFields map[string]string) ([]*types.
 	util.Logger.Printf("[DEBUG] QueryCatalogList returned with : %#v and error: %s", catalogs, err)
 	return catalogs, nil
 }
+
+// GetVappByHref returns a vApp reference by running a vCD API call
+// If no valid vApp is found, it returns a nil VApp reference and an error
+func (org *Org) GetVAppByHref(vappHref string) (*VApp, error) {
+	newVapp := NewVApp(org.client)
+
+	_, err := org.client.ExecuteRequest(vappHref, http.MethodGet,
+		"", "error retrieving vApp: %s", nil, newVapp.VApp)
+
+	if err != nil {
+		return nil, err
+	}
+	return newVapp, nil
+}

govcd/vapp.go

@@ -60,7 +60,7 @@ type DhcpSettings struct {
 }
 
 // Returns the vdc where the vapp resides in.
-func (vapp *VApp) getParentVDC() (Vdc, error) {
+func (vapp *VApp) GetParentVDC() (Vdc, error) {
 	for _, link := range vapp.VApp.Link {
 		if (link.Type == types.MimeVDC || link.Type == types.MimeAdminVDC) && link.Rel == "up" {
 
@@ -620,7 +620,7 @@ func (vapp *VApp) ChangeStorageProfile(name string) (Task, error) {
 		return Task{}, fmt.Errorf("vApp doesn't contain any children, interrupting customization")
 	}
 
-	vdc, err := vapp.getParentVDC()
+	vdc, err := vapp.GetParentVDC()
 	if err != nil {
 		return Task{}, fmt.Errorf("error retrieving parent VDC for vApp %s", vapp.VApp.Name)
 	}
@@ -1442,7 +1442,7 @@ func (vapp *VApp) getOrgInfo() (*TenantContext, error) {
 		return previous, nil
 	}
 	var err error
-	vdc, err := vapp.getParentVDC()
+	vdc, err := vapp.GetParentVDC()
 	if err != nil {
 		return nil, err
 	}
@@ -1514,7 +1514,7 @@ func (vapp *VApp) Rename(newName string) error {
 }
 
 func (vapp *VApp) getTenantContext() (*TenantContext, error) {
-	parentVdc, err := vapp.getParentVDC()
+	parentVdc, err := vapp.GetParentVDC()
 	if err != nil {
 		return nil, err
 	}

govcd/vapp_test.go

@@ -29,7 +29,7 @@ func (vcd *TestVCD) TestGetParentVDC(check *C) {
 	vapp, err := vcd.vdc.GetVAppByName(vcd.vapp.VApp.Name, false)
 	check.Assert(err, IsNil)
 
-	vdc, err := vapp.getParentVDC()
+	vdc, err := vapp.GetParentVDC()
 
 	check.Assert(err, IsNil)
 	check.Assert(vdc.Vdc.Name, Equals, vcd.vdc.Vdc.Name)

govcd/vapptemplate.go

@@ -6,10 +6,11 @@ package govcd
 
 import (
 	"fmt"
-	"github.com/vmware/go-vcloud-director/v2/types/v56"
-	"github.com/vmware/go-vcloud-director/v2/util"
 	"net/http"
 	"net/url"
+
+	"github.com/vmware/go-vcloud-director/v2/types/v56"
+	"github.com/vmware/go-vcloud-director/v2/util"
 )
 
 type VAppTemplate struct {
@@ -363,3 +364,23 @@ func (vAppTemplate *VAppTemplate) GetLease() (*types.LeaseSettingsSection, error
 	}
 	return &leaseSettings, nil
 }
+
+// GetCatalogItemHref looks up Href for catalog item in vApp template
+func (vAppTemplate *VAppTemplate) GetCatalogItemHref() (string, error) {
+	for _, link := range vAppTemplate.VAppTemplate.Link {
+		if link.Rel == "catalogItem" && link.Type == types.MimeCatalogItem {
+			return link.HREF, nil
+		}
+	}
+	return "", fmt.Errorf("error finding Catalog Item link in vApp template %s", vAppTemplate.VAppTemplate.ID)
+}
+
+// GetCatalogItemHref looks up Href for catalog item in vApp template
+func (vAppTemplate *VAppTemplate) GetCatalogItemId() (string, error) {
+	href, err := vAppTemplate.GetCatalogItemHref()
+	if err != nil {
+		return "", err
+	}
+
+	return fmt.Sprintf("urn:vcloud:catalogitem:%s", extractUuid(href)), nil
+}

govcd/vm.go

@@ -925,7 +925,7 @@ func (vm *VM) GetParentVdc() (*Vdc, error) {
 		return nil, fmt.Errorf("could not find parent vApp for VM %s: %s", vm.VM.Name, err)
 	}
 
-	vdc, err := vapp.getParentVDC()
+	vdc, err := vapp.GetParentVDC()
 	if err != nil {
 		return nil, fmt.Errorf("could not find parent vApp for VM %s: %s", vm.VM.Name, err)
 	}

types/v56/constants.go

@@ -101,6 +101,8 @@ const (
 	MimeVM = "application/vnd.vmware.vcloud.vm+xml"
 	// Mime for instantiate vApp template params
 	MimeInstantiateVappTemplateParams = "application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml"
+	// Mime for capture vApp into template
+	MimeCaptureVappTemplateParams = "application/vnd.vmware.vcloud.captureVAppParams+xml"
 	// Mime for clone vApp template params
 	MimeCloneVapp = "application/vnd.vmware.vcloud.cloneVAppParams+xml"
 	// Mime for product section

types/v56/types.go

@@ -1604,6 +1604,45 @@ type VAppTemplateForUpdate struct {
 	Description string   `xml:"Description,omitempty"` // Optional description.
 }
 
+// CaptureVAppParams is a configuration that can be supplied for capturing a vApp template from
+// existing vApp
+type CaptureVAppParams struct {
+	XMLName xml.Name `xml:"CaptureVAppParams"`
+
+	Xmlns    string `xml:"xmlns,attr"`
+	XmlnsNs0 string `xml:"xmlns:ns0,attr,omitempty"`
+
+	// Name of vApp template
+	Name string `xml:"name,attr"`
+	// Description of vApp template
+	Description string `xml:"Description,omitempty"`
+
+	// Source vApp reference. At least HREF field must be set
+	Source *Reference `xml:"Source"`
+
+	// CustomizationSection section
+	CustomizationSection CaptureVAppParamsCustomizationSection `xml:"CustomizationSection"`
+
+	// TargetCatalogItem can be used to overwrite existing item. To overwrite an existing vApp
+	// template with the one created by this capture, place a reference to the existing template
+	// here. Otherwise, the operation creates a new vApp template.
+	TargetCatalogItem *Reference `xml:"TargetCatalogItem,omitempty"`
+	// CopyTpmOnInstantiate defines if TPM device is copied (`true`) to instantiated vApp from this
+	// template or `false` if a new TPM device is created for instantiated vApp.
+	// Note. Supported on VCD 10.4.2+
+	CopyTpmOnInstantiate *bool `xml:"CopyTpmOnInstantiate"`
+}
+
+// CaptureVAppParamsCustomizationSection settings for CaptureVAppParams type
+type CaptureVAppParamsCustomizationSection struct {
+	// This field must contain value "CustomizeOnInstantiate Settings" so that API does not reject
+	// the request
+	Info string `xml:"ns0:Info,omitempty"`
+	// CustomizeOnInstantiate marks if instantiating this template applies customization settings
+	// (`true`). `false` creates an identical copy.
+	CustomizeOnInstantiate bool `xml:"CustomizeOnInstantiate"`
+}
+
 // VMDiskChange represents a virtual machine only with Disk setting update part
 type VMDiskChange struct {
 	XMLName xml.Name `xml:"Vm"`