File: dashboard_lists_test.go

package info (click to toggle)
golang-github-zorkian-go-datadog-api 2.30.0-2
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 1,616 kB
  • sloc: makefile: 28; sh: 13
file content (283 lines) | stat: -rw-r--r-- 9,213 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
package integration

import (
	"log"
	"testing"

	"github.com/zorkian/go-datadog-api"
)

func TestDashboardListsGet(t *testing.T) {
	lists, err := client.GetDashboardLists()
	if err != nil {
		log.Fatalf("fatal: %s\n", err)
	}

	num := len(lists)
	list := createTestDashboardList(t)
	defer cleanUpDashboardList(t, *list.Id)

	lists, err = client.GetDashboardLists()
	if err != nil {
		t.Fatalf("Retrieving dashboard lists failed when it shouldn't: %s", err)
	}

	if num+1 != len(lists) {
		t.Fatalf("Number of dashboard lists didn't match expected: %d != %d", len(lists), num+1)
	}
}

func TestDashboardListCreateAndDelete(t *testing.T) {
	expected := getTestDashboardList()
	// create the dashboard list and compare it
	actual, err := client.CreateDashboardList(expected)
	if err != nil {
		t.Fatalf("Creating a dashboard list failed when it shouldn't: %s", err)
	}

	defer cleanUpDashboardList(t, *actual.Id)

	assertDashboardListEquals(t, actual, expected)

	// now try to fetch it freshly and compare it again
	actual, err = client.GetDashboardList(*actual.Id)
	if err != nil {
		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
	}
	assertDashboardListEquals(t, actual, expected)
}

func TestDashboardListUpdate(t *testing.T) {
	list := getTestDashboardList()
	expected, err := client.CreateDashboardList(list)
	if err != nil {
		t.Fatalf("Creating a dashboard list failed when it shouldn't: %s", err)
	}

	defer cleanUpDashboardList(t, *expected.Id)
	expected.Name = datadog.String("___New-Test-Dashboard-List___")

	if err := client.UpdateDashboardList(expected); err != nil {
		t.Fatalf("Updating a dashboard list failed when it shouldn't: %s", err)
	}

	actual, err := client.GetDashboardList(*expected.Id)
	if err != nil {
		t.Fatalf("Getting a dashboard list failed when it shouldn't: %s", err)
	}

	assertDashboardListEquals(t, actual, expected)
}

func TestDashboardListItemsGetAndUpdate(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.DashboardListItem{
		getTestDashboardListItemTimeboard(*timeboard.Id),
	}

	actualItems, err := client.UpdateDashboardListItems(*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))
	}
	assertDashboardListItemEquals(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.DashboardListItem{
		getTestDashboardListItemScreenboard(*screenboard.Id),
	}

	actualItems, err = client.UpdateDashboardListItems(*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))
	}
	assertDashboardListItemEquals(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 TestDashboardListItemsAddAndDelete(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.DashboardListItem{
		getTestDashboardListItemTimeboard(*timeboard.Id),
	}

	addedItems, err := client.AddDashboardListItems(*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))
	}
	assertDashboardListItemEquals(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, getTestDashboardListItemScreenboard(*screenboard.Id))

	addedItems, err = client.AddDashboardListItems(*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)
	}
	assertDashboardListItemEquals(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.DeleteDashboardListItems(*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 getTestDashboardList() *datadog.DashboardList {
	return &datadog.DashboardList{
		Name: datadog.String("___Test-Dashboard-List___"),
	}
}

func getTestDashboardListItemTimeboard(id int) datadog.DashboardListItem {
	return datadog.DashboardListItem{
		Id:   datadog.Int(id),
		Type: datadog.String(datadog.DashboardListItemCustomTimeboard),
	}
}

func getTestDashboardListItemScreenboard(id int) datadog.DashboardListItem {
	return datadog.DashboardListItem{
		Id:   datadog.Int(id),
		Type: datadog.String(datadog.DashboardListItemCustomScreenboard),
	}
}

func createTestDashboardList(t *testing.T) *datadog.DashboardList {
	list := getTestDashboardList()
	list, err := client.CreateDashboardList(list)
	if err != nil {
		t.Fatalf("Creating a dashboard list failed when it shouldn't: %s", err)
	}

	return list
}

func cleanUpDashboardList(t *testing.T, id int) {
	if err := client.DeleteDashboardList(id); err != nil {
		t.Fatalf("Deleting a dashboard list failed when it shouldn't. Manual cleanup needed. (%s)", err)
	}

	deletedBoard, err := client.GetDashboardList(id)
	if deletedBoard != nil {
		t.Fatalf("Dashboard list hasn't been deleted when it should have been. Manual cleanup needed.")
	}

	if err == nil {
		t.Fatal("Fetching deleted dashboard list didn't lead to an error. Manual cleanup needed.")
	}
}

func assertDashboardListEquals(t *testing.T, actual, expected *datadog.DashboardList) {
	if *actual.Name != *expected.Name {
		t.Errorf("Dashboard list name does not match: %s != %s", *actual.Name, *expected.Name)
	}
	if actual.GetDashboardCount() != expected.GetDashboardCount() {
		t.Errorf("Dashboard list dashboard count does not match: %d != %d", *actual.DashboardCount, *expected.DashboardCount)
	}
}

func assertDashboardListItemEquals(t *testing.T, actual, expected *datadog.DashboardListItem) {
	if *actual.Id != *expected.Id {
		t.Errorf("Dashboard list item id does not match: %d != %d", *actual.Id, *expected.Id)
	}
	if *actual.Type != *expected.Type {
		t.Errorf("Dashboard list item type does not match: %s != %s", *actual.Type, *expected.Type)
	}
}