Add v2 of the dashboard_list_item API (#262)

dashboard_list_items_v2.go

@@ -0,0 +1,76 @@
+/*
+ * Datadog API for Go
+ *
+ * Please see the included LICENSE file for licensing information.
+ *
+ * Copyright 2019 by authors and contributors.
+ */
+
+package datadog
+
+import (
+	"fmt"
+)
+
+// DashboardListItemV2 represents a single dashboard in a dashboard list.
+type DashboardListItemV2 struct {
+	ID   *string `json:"id,omitempty"`
+	Type *string `json:"type,omitempty"`
+}
+
+type reqDashboardListItemsV2 struct {
+	Dashboards []DashboardListItemV2 `json:"dashboards,omitempty"`
+}
+
+type reqAddedDashboardListItemsV2 struct {
+	Dashboards []DashboardListItemV2 `json:"added_dashboards_to_list,omitempty"`
+}
+
+type reqDeletedDashboardListItemsV2 struct {
+	Dashboards []DashboardListItemV2 `json:"deleted_dashboards_from_list,omitempty"`
+}
+
+// GetDashboardListItemsV2 fetches the dashboard list's dashboard definitions.
+func (client *Client) GetDashboardListItemsV2(id int) ([]DashboardListItemV2, error) {
+	var out reqDashboardListItemsV2
+	if err := client.doJsonRequest("GET", fmt.Sprintf("/v2/dashboard/lists/manual/%d/dashboards", id), nil, &out); err != nil {
+		return nil, err
+	}
+	return out.Dashboards, nil
+}
+
+// AddDashboardListItemsV2 adds dashboards to an existing dashboard list.
+//
+// Any items already in the list are ignored (not added twice).
+func (client *Client) AddDashboardListItemsV2(dashboardListID int, items []DashboardListItemV2) ([]DashboardListItemV2, error) {
+	req := reqDashboardListItemsV2{items}
+	var out reqAddedDashboardListItemsV2
+	if err := client.doJsonRequest("POST", fmt.Sprintf("/v2/dashboard/lists/manual/%d/dashboards", dashboardListID), req, &out); err != nil {
+		return nil, err
+	}
+	return out.Dashboards, nil
+}
+
+// UpdateDashboardListItemsV2 updates dashboards of an existing dashboard list.
+//
+// This will set the list of dashboards to contain only the items in items.
+func (client *Client) UpdateDashboardListItemsV2(dashboardListID int, items []DashboardListItemV2) ([]DashboardListItemV2, error) {
+	req := reqDashboardListItemsV2{items}
+	var out reqDashboardListItemsV2
+	if err := client.doJsonRequest("PUT", fmt.Sprintf("/v2/dashboard/lists/manual/%d/dashboards", dashboardListID), req, &out); err != nil {
+		return nil, err
+	}
+	return out.Dashboards, nil
+}
+
+// DeleteDashboardListItemsV2 deletes dashboards from an existing dashboard list.
+//
+// Deletes any dashboards in the list of items from the dashboard list.
+func (client *Client) DeleteDashboardListItemsV2(dashboardListID int, items []DashboardListItemV2) ([]DashboardListItemV2, error) {
+	req := reqDashboardListItemsV2{items}
+	var out reqDeletedDashboardListItemsV2
+	if err := client.doJsonRequest("DELETE", fmt.Sprintf("/v2/dashboard/lists/manual/%d/dashboards", dashboardListID), req, &out); err != nil {
+		return nil, err
+	}
+	return out.Dashboards, nil
+}

datadog-accessors.go

@@ -4168,6 +4168,68 @@ func (d *DashboardListItem) SetType(v string) {
 	d.Type = &v
 }
 
+// GetID returns the ID field if non-nil, zero value otherwise.
+func (d *DashboardListItemV2) GetID() string {
+	if d == nil || d.ID == nil {
+		return ""
+	}
+	return *d.ID
+}
+
+// GetIDOk returns a tuple with the ID field if it's non-nil, zero value otherwise
+// and a boolean to check if the value has been set.
+func (d *DashboardListItemV2) GetIDOk() (string, bool) {
+	if d == nil || d.ID == nil {
+		return "", false
+	}
+	return *d.ID, true
+}
+
+// HasID returns a boolean if a field has been set.
+func (d *DashboardListItemV2) HasID() bool {
+	if d != nil && d.ID != nil {
+		return true
+	}
+
+	return false
+}
+
+// SetID allocates a new d.ID and returns the pointer to it.
+func (d *DashboardListItemV2) SetID(v string) {
+	d.ID = &v
+}
+
+// GetType returns the Type field if non-nil, zero value otherwise.
+func (d *DashboardListItemV2) GetType() string {
+	if d == nil || d.Type == nil {
+		return ""
+	}
+	return *d.Type
+}
+
+// GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise
+// and a boolean to check if the value has been set.
+func (d *DashboardListItemV2) GetTypeOk() (string, bool) {
+	if d == nil || d.Type == nil {
+		return "", false
+	}
+	return *d.Type, true
+}
+
+// HasType returns a boolean if a field has been set.
+func (d *DashboardListItemV2) HasType() bool {
+	if d != nil && d.Type != nil {
+		return true
+	}
+
+	return false
+}
+
+// SetType allocates a new d.Type and returns the pointer to it.
+func (d *DashboardListItemV2) SetType(v string) {
+	d.Type = &v
+}
+
 // GetCreated returns the Created field if non-nil, zero value otherwise.
 func (d *DashboardLite) GetCreated() string {
 	if d == nil || d.Created == nil {

integration/dashboard_lists_v2_test.go

@@ -0,0 +1,180 @@
+package integration
+
+import (
+	"testing"
+
+	datadog "github.com/zorkian/go-datadog-api"
+)
+
+func TestDashboardListItemsV2GetAndUpdate(t *testing.T) {
+	list := getTestDashboardList()
+	list, err := client.CreateDashboardList(list)
+	if err != nil {
+		t.Fatalf("Creating a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	defer cleanUpDashboardList(t, *list.Id)
+
+	if *list.DashboardCount != 0 {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+
+	// Test update with timeboard in list
+	timeboard := createTestDashboard(t)
+	defer cleanUpDashboard(t, *timeboard.Id)
+
+	timeboardItems := []datadog.DashboardListItemV2{
+		getTestDashboardListItemV2Timeboard(*timeboard.NewId),
+	}
+
+	actualItems, err := client.UpdateDashboardListItemsV2(*list.Id, timeboardItems)
+	if err != nil {
+		t.Fatalf("Updating dashboard list items failed when it shouldn't: %s", err)
+	}
+	if len(actualItems) != len(timeboardItems) {
+		t.Fatalf("Number of updated dashboards does not match: %d != %d", len(actualItems), len(timeboardItems))
+	}
+	assertDashboardListItemV2Equals(t, &actualItems[0], &timeboardItems[0])
+
+	// Get dashboard list to make sure count is 1
+	list, err = client.GetDashboardList(*list.Id)
+	if err != nil {
+		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	if *list.DashboardCount != len(timeboardItems) {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+
+	// Test update with screenboard in list
+	screenboard := createTestScreenboard(t)
+	defer cleanUpScreenboard(t, *screenboard.Id)
+
+	screenboardItems := []datadog.DashboardListItemV2{
+		getTestDashboardListItemV2Screenboard(*screenboard.NewId),
+	}
+
+	actualItems, err = client.UpdateDashboardListItemsV2(*list.Id, screenboardItems)
+	if err != nil {
+		t.Fatalf("Updating dashboard list items failed when it shouldn't: %s", err)
+	}
+	if len(actualItems) != len(screenboardItems) {
+		t.Fatalf("Number of updated dashboards does not match: %d != %d", len(actualItems), len(screenboardItems))
+	}
+	assertDashboardListItemV2Equals(t, &actualItems[0], &screenboardItems[0])
+
+	// Get dashboard list to make sure count is 1
+	list, err = client.GetDashboardList(*list.Id)
+	if err != nil {
+		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	if *list.DashboardCount != len(screenboardItems) {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+}
+
+func TestDashboardListItemsV2AddAndDelete(t *testing.T) {
+	list := getTestDashboardList()
+	list, err := client.CreateDashboardList(list)
+	if err != nil {
+		t.Fatalf("Creating a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	defer cleanUpDashboardList(t, *list.Id)
+
+	// Add timeboard to list
+	timeboard := createTestDashboard(t)
+	defer cleanUpDashboard(t, *timeboard.Id)
+
+	items := []datadog.DashboardListItemV2{
+		getTestDashboardListItemV2Timeboard(*timeboard.NewId),
+	}
+
+	addedItems, err := client.AddDashboardListItemsV2(*list.Id, items)
+	if err != nil {
+		t.Fatalf("Adding dashboard list items failed when it shouldn't: %s", err)
+	}
+	if len(addedItems) != len(items) {
+		t.Fatalf("Number of updated dashboards does not match: %d != %d", len(addedItems), len(items))
+	}
+	assertDashboardListItemV2Equals(t, &addedItems[0], &items[0])
+
+	// Get dashboard list to make sure count is 1
+	list, err = client.GetDashboardList(*list.Id)
+	if err != nil {
+		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	if *list.DashboardCount != len(items) {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+
+	// Adding an existing item should be ignored, meaning we should only get
+	// one item back in the list of added items.
+	screenboard := createTestScreenboard(t)
+	defer cleanUpScreenboard(t, *screenboard.Id)
+
+	items = append(items, getTestDashboardListItemV2Screenboard(*screenboard.NewId))
+
+	addedItems, err = client.AddDashboardListItemsV2(*list.Id, items)
+	if err != nil {
+		t.Fatalf("Adding dashboard list items failed when it shouldn't: %s", err)
+	}
+	if len(addedItems) != 1 {
+		t.Fatalf("Number of updated dashboards does not match: %d != %d", len(addedItems), 1)
+	}
+	assertDashboardListItemV2Equals(t, &addedItems[0], &items[1])
+
+	// Get dashboard list to make sure count is now 2
+	list, err = client.GetDashboardList(*list.Id)
+	if err != nil {
+		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	if *list.DashboardCount != len(items) {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+
+	// Delete everything in the dashboard list and check length of deleted items is 2
+	deletedItems, err := client.DeleteDashboardListItemsV2(*list.Id, items)
+	if err != nil {
+		t.Fatalf("Deleting dashboard list items failed when it shouldn't: %s", err)
+	}
+	if len(deletedItems) != len(items) {
+		t.Fatalf("Number of deleted dashboards does not match: %d != %d", len(deletedItems), len(items))
+	}
+
+	// Check that the dashboard list is empty again
+	list, err = client.GetDashboardList(*list.Id)
+	if err != nil {
+		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
+	}
+
+	if *list.DashboardCount != 0 {
+		t.Fatalf("Number of dashboards in dashboard list does not match: %d != %d", *list.DashboardCount, 0)
+	}
+}
+
+func getTestDashboardListItemV2Timeboard(id string) datadog.DashboardListItemV2 {
+	return datadog.DashboardListItemV2{
+		ID:   datadog.String(id),
+		Type: datadog.String(datadog.DashboardListItemCustomTimeboard),
+	}
+}
+
+func assertDashboardListItemV2Equals(t *testing.T, actual, expected *datadog.DashboardListItemV2) {
+	if *actual.ID != *expected.ID {
+		t.Errorf("Dashboard list item id does not match: %s != %s", *actual.ID, *expected.ID)
+	}
+	if *actual.Type != *expected.Type {
+		t.Errorf("Dashboard list item type does not match: %s != %s", *actual.Type, *expected.Type)
+	}
+}
+
+func getTestDashboardListItemV2Screenboard(id string) datadog.DashboardListItemV2 {
+	return datadog.DashboardListItemV2{
+		ID:   datadog.String(id),
+		Type: datadog.String(datadog.DashboardListItemCustomScreenboard),
+	}
+}