Add catalog read-only sharing to all organizations

.changes/v2.22.0/559-features.md

@@ -0,0 +1 @@
+* Added methods `SetReadOnlyAccessControl` and `IsSharedReadOnly` for `Catalog` and `AdminCatalog`, to handle read-only catalog sharing [GH-559]

.changes/v2.22.0/559-improvements.md

@@ -0,0 +1 @@
+* Added catalog parent retrieval to `client.GetCatalogByHref` and `client.GetAdminCatalogByHref` to facilitate tenant context handling [GH-559]

govcd/access_control.go

@@ -456,3 +456,145 @@ func checkSanityVdcControlAccess(vdc *Vdc) error {
 	}
 	return nil
 }
+
+func publishCatalog(client *Client, catalogUrl string, tenantContext *TenantContext, publishCatalog types.PublishCatalogParams) error {
+	catalogUrl = catalogUrl + "/action/publish"
+
+	publishCatalog.Xmlns = types.XMLNamespaceVCloud
+
+	if tenantContext != nil {
+		client.SetCustomHeader(getTenantContextHeader(tenantContext))
+	}
+
+	err := client.ExecuteRequestWithoutResponse(catalogUrl, http.MethodPost,
+		types.PublishCatalog, "error setting catalog publishing state: %s", publishCatalog)
+
+	if tenantContext != nil {
+		client.RemoveProvidedCustomHeaders(getTenantContextHeader(tenantContext))
+	}
+
+	return err
+}
+
+// IsSharedReadOnly returns the state of the catalog read-only sharing to all organizations
+func (cat *Catalog) IsSharedReadOnly() (bool, error) {
+	accessControl, err := cat.GetAccessControl(true)
+	if err != nil {
+		return false, err
+	}
+	if accessControl.AccessSettings != nil || accessControl.IsSharedToEveryone {
+		return false, nil
+	}
+	err = cat.Refresh()
+	if err != nil {
+		return false, err
+	}
+	return cat.Catalog.IsPublished, nil
+}
+
+// IsSharedReadOnly returns the state of the catalog read-only sharing to all organizations
+func (cat *AdminCatalog) IsSharedReadOnly() (bool, error) {
+	accessControl, err := cat.GetAccessControl(true)
+	if err != nil {
+		return false, err
+	}
+	if accessControl.AccessSettings != nil || accessControl.IsSharedToEveryone {
+		return false, nil
+	}
+	err = cat.Refresh()
+	if err != nil {
+		return false, err
+	}
+	return cat.AdminCatalog.IsPublished, nil
+}
+
+// publish publishes a catalog read-only access control to all organizations
+// This operation is usually the second step for a read-only sharing to all Orgs
+func (cat *Catalog) publish(isPublished bool) error {
+	if cat.Catalog == nil {
+		return fmt.Errorf("cannot publish catalog, Object is empty")
+	}
+
+	catalogUrl := cat.Catalog.HREF
+	if catalogUrl == "nil" || catalogUrl == "" {
+		return fmt.Errorf("cannot publish catalog, HREF is empty")
+	}
+
+	tenantContext, err := cat.getTenantContext()
+	if err != nil {
+		return fmt.Errorf("cannot publish catalog, tenant context error: %s", err)
+	}
+
+	publishParameters := types.PublishCatalogParams{
+		IsPublished: &isPublished,
+	}
+	err = publishCatalog(cat.client, catalogUrl, tenantContext, publishParameters)
+	if err != nil {
+		return err
+	}
+
+	return cat.Refresh()
+}
+
+// publish publishes a catalog read-only access control to all organizations
+// This operation is usually the second step for a read-only sharing to all Orgs
+func (cat *AdminCatalog) publish(isPublished bool) error {
+	if cat.AdminCatalog == nil {
+		return fmt.Errorf("cannot publish catalog, Object is empty")
+	}
+
+	catalogUrl := cat.AdminCatalog.HREF
+	if catalogUrl == "nil" || catalogUrl == "" {
+		return fmt.Errorf("cannot publish catalog, HREF is empty")
+	}
+
+	tenantContext, err := cat.getTenantContext()
+	if err != nil {
+		return fmt.Errorf("cannot publish catalog, tenant context error: %s", err)
+	}
+
+	publishParameters := types.PublishCatalogParams{
+		IsPublished: &isPublished,
+	}
+	err = publishCatalog(cat.client, catalogUrl, tenantContext, publishParameters)
+	if err != nil {
+		return err
+	}
+
+	err = cat.Refresh()
+	if err != nil {
+		return err
+	}
+
+	return err
+}
+
+// SetReadOnlyAccessControl will create or rescind the read-only catalog sharing to all organizations
+func (cat *Catalog) SetReadOnlyAccessControl(isPublished bool) error {
+	if cat.Catalog == nil {
+		return fmt.Errorf("cannot set access control, Object is empty")
+	}
+	err := cat.SetAccessControl(&types.ControlAccessParams{
+		IsSharedToEveryone:  false,
+		EveryoneAccessLevel: addrOf(types.ControlAccessReadOnly),
+	}, true)
+	if err != nil {
+		return fmt.Errorf("error resetting access control record for catalog %s: %s", cat.Catalog.Name, err)
+	}
+	return cat.publish(isPublished)
+}
+
+// SetReadOnlyAccessControl will create or rescind the read-only AdminCatalog sharing to all organizations
+func (cat *AdminCatalog) SetReadOnlyAccessControl(isPublished bool) error {
+	if cat.AdminCatalog == nil {
+		return fmt.Errorf("cannot set access control, Object is empty")
+	}
+	err := cat.SetAccessControl(&types.ControlAccessParams{
+		IsSharedToEveryone:  false,
+		EveryoneAccessLevel: addrOf(types.ControlAccessReadOnly),
+	}, true)
+	if err != nil {
+		return err
+	}
+	return cat.publish(isPublished)
+}

govcd/admincatalog.go

@@ -624,6 +624,20 @@ func (client *Client) GetAdminCatalogByHref(catalogHref string) (*AdminCatalog,
 		return nil, err
 	}
 
+	// Setting the catalog parent, necessary to handle the tenant context
+	org := NewAdminOrg(client)
+	for _, link := range cat.AdminCatalog.Link {
+		if link.Rel == "up" && link.Type == types.MimeAdminOrg {
+			_, err = client.ExecuteRequest(link.HREF, http.MethodGet,
+				"", "error retrieving parent Org: %s", nil, org.AdminOrg)
+			if err != nil {
+				return nil, fmt.Errorf("error retrieving catalog parent: %s", err)
+			}
+			break
+		}
+	}
+
+	cat.parent = org
 	return cat, nil
 }
 

govcd/adminorg.go

@@ -55,6 +55,10 @@ func (adminOrg *AdminOrg) CreateCatalog(name, description string) (AdminCatalog,
 	if err != nil {
 		return AdminCatalog{}, err
 	}
+	err = adminCatalog.WaitForTasks()
+	if err != nil {
+		return AdminCatalog{}, err
+	}
 	return *adminCatalog, nil
 }
 

govcd/catalog.go

@@ -59,7 +59,7 @@ func (catalog *Catalog) Delete(force, recursive bool) error {
 		// A catalog cannot be removed if it has active tasks, or if any of its items have active tasks
 		err = catalog.consumeTasks()
 		if err != nil {
-			return err
+			return fmt.Errorf("error while consuming tasks from catalog %s: %s", catalog.Catalog.Name, err)
 		}
 	}
 
@@ -94,7 +94,7 @@ func (catalog *Catalog) consumeTasks() error {
 		"status": "running,preRunning,queued",
 	})
 	if err != nil {
-		return err
+		return fmt.Errorf("error getting task list from catalog %s: %s", catalog.Catalog.Name, err)
 	}
 	var taskList []string
 	addTask := func(status, href string) {
@@ -119,7 +119,7 @@ func (catalog *Catalog) consumeTasks() error {
 	}
 	catalogItemRefs, err := catalog.QueryCatalogItemList()
 	if err != nil {
-		return err
+		return fmt.Errorf("error getting catalog %s items list: %s", catalog.Catalog.Name, err)
 	}
 	for _, task := range allTasks {
 		for _, ref := range catalogItemRefs {
@@ -131,7 +131,10 @@ func (catalog *Catalog) consumeTasks() error {
 		}
 	}
 	_, err = catalog.client.WaitTaskListCompletion(taskList, true)
-	return err
+	if err != nil {
+		return fmt.Errorf("error while waiting for task list completion for catalog %s: %s", catalog.Catalog.Name, err)
+	}
+	return nil
 }
 
 // Envelope is a ovf description root element. File contains information for vmdk files.
@@ -1079,12 +1082,12 @@ func (cat *Catalog) PublishToExternalOrganizations(publishExternalCatalog types.
 		return fmt.Errorf("cannot publish to external organization, Object is empty")
 	}
 
-	url := cat.Catalog.HREF
-	if url == "nil" || url == "" {
+	catalogUrl := cat.Catalog.HREF
+	if catalogUrl == "nil" || catalogUrl == "" {
 		return fmt.Errorf("cannot publish to external organization, HREF is empty")
 	}
 
-	err := publishToExternalOrganizations(cat.client, url, nil, publishExternalCatalog)
+	err := publishToExternalOrganizations(cat.client, catalogUrl, nil, publishExternalCatalog)
 	if err != nil {
 		return err
 	}
@@ -1171,7 +1174,19 @@ func (client *Client) GetCatalogByHref(catalogHref string) (*Catalog, error) {
 	if err != nil {
 		return nil, err
 	}
-
+	// Setting the catalog parent, necessary to handle the tenant context
+	org := NewOrg(client)
+	for _, link := range cat.Catalog.Link {
+		if link.Rel == "up" && link.Type == types.MimeOrg {
+			_, err = client.ExecuteRequest(link.HREF, http.MethodGet,
+				"", "error retrieving parent Org: %s", nil, org.Org)
+			if err != nil {
+				return nil, fmt.Errorf("error retrieving catalog parent: %s", err)
+			}
+			break
+		}
+	}
+	cat.parent = org
 	return cat, nil
 }