Add ability to set dashboard sharing options (#146)

* Add ability to set dashboard sharing options

Closes: #139

* Add acceptance test and basic docs for dashboard sharing

* fix: Solve failing acceptance test

* fix: Solve incomplete state being saved

Co-authored-by: Ryan Moe <[email protected]>
Co-authored-by: Fede Barcelona <[email protected]>

Author: 3 people

sysdig/internal/client/monitor/model/dashboard.go

@@ -317,6 +317,16 @@ type TeamSharingOptions struct {
 	SelectedTeams []interface{} `json:"selectedTeams"`
 }
 
+type SharingOptions struct {
+	Member SharingMember `json:"member"`
+	Role   string        `json:"role"`
+}
+
+type SharingMember struct {
+	Type string `json:"type"`
+	ID   int    `json:"id"`
+}
+
 type ScopeExpressionList struct {
 	Operand     string      `json:"operand"`
 	Operator    string      `json:"operator"`
@@ -342,7 +352,7 @@ type Dashboard struct {
 	Description             string                 `json:"description"`
 	Username                string                 `json:"username"`
 	Shared                  bool                   `json:"shared"`
-	SharingSettings         []interface{}          `json:"sharingSettings"`
+	SharingSettings         []*SharingOptions      `json:"sharingSettings"`
 	Public                  bool                   `json:"public"`
 	Favorite                bool                   `json:"favorite"`
 	CreatedOn               int64                  `json:"createdOn"`

sysdig/resource_sysdig_monitor_dashboard.go

@@ -53,6 +53,35 @@ func resourceSysdigMonitorDashboard() *schema.Resource {
 				ComputedWhen: []string{"public"},
 				Computed:     true,
 			},
+			"share": {
+				Type:     schema.TypeSet,
+				Optional: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"member": {
+							Type:     schema.TypeSet,
+							MaxItems: 1,
+							Required: true,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"type": {
+										Type:     schema.TypeString,
+										Required: true,
+									},
+									"id": {
+										Type:     schema.TypeInt,
+										Required: true,
+									},
+								},
+							},
+						},
+						"role": {
+							Type:     schema.TypeString,
+							Required: true,
+						},
+					},
+				},
+			},
 			"scope": {
 				Type:     schema.TypeSet,
 				Optional: true,
@@ -273,9 +302,32 @@ func dashboardFromResourceData(data *schema.ResourceData) (dashboard *model.Dash
 	dashboard.ScopeExpressionList = scopes
 
 	dashboard.AddPanels(panels...)
+
+	shares, err := sharingFromResourceData(data)
+	if err != nil {
+		return nil, err
+	}
+	dashboard.SharingSettings = shares
+
 	return dashboard, nil
 }
 
+func sharingFromResourceData(data *schema.ResourceData) (sharingSettings []*model.SharingOptions, err error) {
+	for _, share := range data.Get("share").(*schema.Set).List() {
+		shareInfo := share.(map[string]interface{})
+		memberInfo := shareInfo["member"].(*schema.Set).List()[0].(map[string]interface{})
+		sharingSettings = append(sharingSettings,
+			&model.SharingOptions{
+				Member: model.SharingMember{
+					Type: memberInfo["type"].(string),
+					ID:   memberInfo["id"].(int),
+				},
+				Role: shareInfo["role"].(string),
+			})
+	}
+	return
+}
+
 func panelsFromResourceData(data *schema.ResourceData) (panels []*model.Panels, err error) {
 	for _, panelItr := range data.Get("panel").(*schema.Set).List() {
 		panelInfo := panelItr.(map[string]interface{})
@@ -521,9 +573,30 @@ func dashboardToResourceData(dashboard *model.Dashboard, data *schema.ResourceDa
 	_ = data.Set("scope", scopes)
 	_ = data.Set("version", dashboard.Version)
 
+	var shares []map[string]interface{}
+	for _, share := range dashboard.SharingSettings {
+		dShare, err := shareToResourceData(share)
+		if err != nil {
+			return err
+		}
+		shares = append(shares, dShare)
+	}
+	_ = data.Set("share", shares)
+
 	return nil
 }
 
+func shareToResourceData(share *model.SharingOptions) (map[string]interface{}, error) {
+	res := map[string]interface{}{
+		"role": share.Role,
+		"member": []map[string]interface{}{{
+			"type": share.Member.Type,
+			"id":   share.Member.ID,
+		}},
+	}
+	return res, nil
+}
+
 func scopeToResourceData(scope *model.ScopeExpressionList) (map[string]interface{}, error) {
 	res := map[string]interface{}{
 		"metric": scope.Operand,

sysdig/resource_sysdig_monitor_dashboard_test.go

@@ -44,6 +44,17 @@ func TestAccDashboard(t *testing.T) {
 			{
 				Config: multipleUpdatedPanelsDashboard(rText()),
 			},
+			{
+				Config: sharedDashboard(rText()),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("sysdig_monitor_dashboard.dashboard", "share.#", "1"),
+					resource.TestCheckTypeSetElemNestedAttrs("sysdig_monitor_dashboard.dashboard", "share.*", map[string]string{
+						"member.#":      "1",
+						"role":          "ROLE_RESOURCE_EDIT",
+						"member.0.type": "TEAM",
+					}),
+				),
+			},
 		},
 	})
 }
@@ -225,3 +236,42 @@ resource "sysdig_monitor_dashboard" "dashboard" {
 }
 `, name, name)
 }
+
+func sharedDashboard(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_monitor_team" "a_team" {
+  name      = "sample-%s"
+
+  entrypoint {
+	type = "Explore"
+  }
+}
+
+resource "sysdig_monitor_dashboard" "dashboard" {
+	name = "TERRAFORM TEST - METRIC %s"
+	description = "TERRAFORM TEST - METRIC %s"
+
+	panel {
+		pos_x = 0
+		pos_y = 0
+		width = 12 # Maximum size: 24
+		height = 6
+		type = "number"
+		name = "example panel"
+		description = "description"
+
+		query {
+			promql = "avg(avg_over_time(sysdig_host_cpu_used_percent[$__interval]))"
+			unit = "percent"
+		}
+	}
+	share {
+		role = "ROLE_RESOURCE_EDIT"
+		member {
+			type = "TEAM"
+			id = sysdig_monitor_team.a_team.id
+		}
+   }
+}
+`, name, name, name)
+}

website/docs/r/monitor_dashboard.md

@@ -94,6 +94,7 @@ resource "sysdig_monitor_dashboard" "dashboard" {
 
 * `panel` - (Required) At least 1 panel is required to define a Dashboard.
 
+* `share` - (Optional) Define sharing options for this dashboard.
 
 ### scope
 
@@ -152,7 +153,7 @@ The following arguments are supported:
 * `transparent_background` - (Optional) If true, the panel will have a transparent background.
                              This field is ignored for all panel types except `text`.
 
-### query 
+### query
 
 To scope a panel built from a PromQL query, you must use a scope variable within the query. The variable will take the value of the referenced scope parameter, and the PromQL panel will change accordingly.
 There are two predefined variables available:
@@ -169,6 +170,24 @@ The following arguments are supported:
 * `unit` - (Required) The type of metric for this query. Can be one of: `percent`, `data`, `data rate`, 
             `number`, `number rate`, `time`.
 
+
+### share
+
+A dashboard can be shared by creating one or more `share` blocks.
+
+The following arguments are supported:
+
+* `role` - (Required) The role to grant to the team.
+
+* `member` - (Required) The team with which to share the dashboard.
+
+   Nested scheme for `member`:
+
+   * `type`- (Required) Type of member.
+
+   * `id` - (Required) ID of member.
+
+
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
@@ -196,4 +215,4 @@ Only dashboards that contain supported query types can be imported. Currently su
 - Data rate
 - Number
 - Number rate
-- Time
+- Time