Skip to content

Commit 4ad8cdf

Browse files
julienduchesnejulienduchesne
authored
Test Suite: Specify all expected server responses (grafana#123)
* Test Suite: Specify all expected server responses Will be used for grafana#119. Currently, the test suite never ends because it's not possible to define a list of calls. It can only keep returning the first page forever * Linting * Cleanup the server in a `t.Cleanup` func
1 parent ecc1da7 commit 4ad8cdf

35 files changed

+221
-366
lines changed

‎admin_test.go

+6-12
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ const (
2121
)
2222

2323
func TestCreateUser(t *testing.T) {
24-
server, client := gapiTestTools(t, 200, createUserJSON)
25-
defer server.Close()
24+
client := gapiTestTools(t, 200, createUserJSON)
2625
user := User{
2726
Email: "admin@localhost",
2827
Login: "admin",
@@ -40,8 +39,7 @@ func TestCreateUser(t *testing.T) {
4039
}
4140

4241
func TestDeleteUser(t *testing.T) {
43-
server, client := gapiTestTools(t, 200, deleteUserJSON)
44-
defer server.Close()
42+
client := gapiTestTools(t, 200, deleteUserJSON)
4543

4644
err := client.DeleteUser(int64(1))
4745
if err != nil {
@@ -50,8 +48,7 @@ func TestDeleteUser(t *testing.T) {
5048
}
5149

5250
func TestUpdateUserPassword(t *testing.T) {
53-
server, client := gapiTestTools(t, 200, updateUserPasswordJSON)
54-
defer server.Close()
51+
client := gapiTestTools(t, 200, updateUserPasswordJSON)
5552

5653
err := client.UpdateUserPassword(int64(1), "new-password")
5754
if err != nil {
@@ -60,8 +57,7 @@ func TestUpdateUserPassword(t *testing.T) {
6057
}
6158

6259
func TestUpdateUserPermissions(t *testing.T) {
63-
server, client := gapiTestTools(t, 200, updateUserPermissionsJSON)
64-
defer server.Close()
60+
client := gapiTestTools(t, 200, updateUserPermissionsJSON)
6561

6662
err := client.UpdateUserPermissions(int64(1), false)
6763
if err != nil {
@@ -70,8 +66,7 @@ func TestUpdateUserPermissions(t *testing.T) {
7066
}
7167

7268
func TestPauseAllAlerts(t *testing.T) {
73-
server, client := gapiTestTools(t, 200, pauseAllAlertsJSON)
74-
defer server.Close()
69+
client := gapiTestTools(t, 200, pauseAllAlertsJSON)
7570

7671
res, err := client.PauseAllAlerts()
7772
if err != nil {
@@ -86,8 +81,7 @@ func TestPauseAllAlerts(t *testing.T) {
8681
}
8782

8883
func TestPauseAllAlerts_500(t *testing.T) {
89-
server, client := gapiTestTools(t, 500, pauseAllAlertsJSON)
90-
defer server.Close()
84+
client := gapiTestTools(t, 500, pauseAllAlertsJSON)
9185

9286
_, err := client.PauseAllAlerts()
9387
if !strings.Contains(err.Error(), "status: 500") {

‎alert_test.go

+6-12
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ const (
4747
)
4848

4949
func TestAlerts(t *testing.T) {
50-
server, client := gapiTestTools(t, 200, alertsJSON)
51-
defer server.Close()
50+
client := gapiTestTools(t, 200, alertsJSON)
5251

5352
params := url.Values{}
5453
params.Add("dashboardId", "123")
@@ -66,8 +65,7 @@ func TestAlerts(t *testing.T) {
6665
}
6766

6867
func TestAlerts_500(t *testing.T) {
69-
server, client := gapiTestTools(t, 500, alertsJSON)
70-
defer server.Close()
68+
client := gapiTestTools(t, 500, alertsJSON)
7169

7270
params := url.Values{}
7371
params.Add("dashboardId", "123")
@@ -79,8 +77,7 @@ func TestAlerts_500(t *testing.T) {
7977
}
8078

8179
func TestAlert(t *testing.T) {
82-
server, client := gapiTestTools(t, 200, alertJSON)
83-
defer server.Close()
80+
client := gapiTestTools(t, 200, alertJSON)
8481

8582
res, err := client.Alert(1)
8683
if err != nil {
@@ -95,8 +92,7 @@ func TestAlert(t *testing.T) {
9592
}
9693

9794
func TestAlert_500(t *testing.T) {
98-
server, client := gapiTestTools(t, 500, alertJSON)
99-
defer server.Close()
95+
client := gapiTestTools(t, 500, alertJSON)
10096

10197
_, err := client.Alert(1)
10298
if !strings.Contains(err.Error(), "status: 500") {
@@ -105,8 +101,7 @@ func TestAlert_500(t *testing.T) {
105101
}
106102

107103
func TestPauseAlert(t *testing.T) {
108-
server, client := gapiTestTools(t, 200, pauseAlertJSON)
109-
defer server.Close()
104+
client := gapiTestTools(t, 200, pauseAlertJSON)
110105

111106
res, err := client.PauseAlert(1)
112107
if err != nil {
@@ -121,8 +116,7 @@ func TestPauseAlert(t *testing.T) {
121116
}
122117

123118
func TestPauseAlert_500(t *testing.T) {
124-
server, client := gapiTestTools(t, 500, pauseAlertJSON)
125-
defer server.Close()
119+
client := gapiTestTools(t, 500, pauseAlertJSON)
126120

127121
_, err := client.PauseAlert(1)
128122
if !strings.Contains(err.Error(), "status: 500") {

‎alerting_alert_rule_test.go

+8-16
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ import (
1010

1111
func TestAlertRules(t *testing.T) {
1212
t.Run("get alert rule succeeds", func(t *testing.T) {
13-
server, client := gapiTestTools(t, 200, getAlertRuleJSON)
14-
defer server.Close()
13+
client := gapiTestTools(t, 200, getAlertRuleJSON)
1514

1615
alertRule, err := client.AlertRule("123abcd")
1716

@@ -24,8 +23,7 @@ func TestAlertRules(t *testing.T) {
2423
})
2524

2625
t.Run("get alert rule group succeeds", func(t *testing.T) {
27-
server, client := gapiTestTools(t, 200, getAlertRuleGroupJSON)
28-
defer server.Close()
26+
client := gapiTestTools(t, 200, getAlertRuleGroupJSON)
2927

3028
group, err := client.AlertRuleGroup("project_test", "eval_group_1")
3129

@@ -45,8 +43,7 @@ func TestAlertRules(t *testing.T) {
4543
})
4644

4745
t.Run("get non-existent alert rule fails", func(t *testing.T) {
48-
server, client := gapiTestTools(t, 404, "")
49-
defer server.Close()
46+
client := gapiTestTools(t, 404, "")
5047

5148
alertRule, err := client.AlertRule("does not exist")
5249

@@ -57,8 +54,7 @@ func TestAlertRules(t *testing.T) {
5754
})
5855

5956
t.Run("get non-existent rule group fails", func(t *testing.T) {
60-
server, client := gapiTestTools(t, 404, "")
61-
defer server.Close()
57+
client := gapiTestTools(t, 404, "")
6258

6359
group, err := client.AlertRuleGroup("d8-gk06nz", "does not exist")
6460

@@ -69,8 +65,7 @@ func TestAlertRules(t *testing.T) {
6965
})
7066

7167
t.Run("create alert rule succeeds", func(t *testing.T) {
72-
server, client := gapiTestTools(t, 201, writeAlertRuleJSON)
73-
defer server.Close()
68+
client := gapiTestTools(t, 201, writeAlertRuleJSON)
7469
alertRule := createAlertRule()
7570

7671
uid, err := client.NewAlertRule(&alertRule)
@@ -84,8 +79,7 @@ func TestAlertRules(t *testing.T) {
8479
})
8580

8681
t.Run("set alert rule group succeeds", func(t *testing.T) {
87-
server, client := gapiTestTools(t, 200, getAlertRuleGroupJSON)
88-
defer server.Close()
82+
client := gapiTestTools(t, 200, getAlertRuleGroupJSON)
8983
group := createAlertRuleGroup()
9084

9185
err := client.SetAlertRuleGroup(group)
@@ -96,8 +90,7 @@ func TestAlertRules(t *testing.T) {
9690
})
9791

9892
t.Run("update alert rule succeeds", func(t *testing.T) {
99-
server, client := gapiTestTools(t, 200, writeAlertRuleJSON)
100-
defer server.Close()
93+
client := gapiTestTools(t, 200, writeAlertRuleJSON)
10194
alertRule := createAlertRule()
10295
alertRule.UID = "foobar"
10396

@@ -109,8 +102,7 @@ func TestAlertRules(t *testing.T) {
109102
})
110103

111104
t.Run("delete alert rule succeeds", func(t *testing.T) {
112-
server, client := gapiTestTools(t, 204, "")
113-
defer server.Close()
105+
client := gapiTestTools(t, 204, "")
114106

115107
err := client.DeleteAlertRule("123abcd")
116108

‎alerting_contact_point_test.go

+7-14
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ import (
88

99
func TestContactPoints(t *testing.T) {
1010
t.Run("get contact points succeeds", func(t *testing.T) {
11-
server, client := gapiTestTools(t, 200, getContactPointsJSON)
12-
defer server.Close()
11+
client := gapiTestTools(t, 200, getContactPointsJSON)
1312

1413
ps, err := client.ContactPoints()
1514

@@ -29,8 +28,7 @@ func TestContactPoints(t *testing.T) {
2928
})
3029

3130
t.Run("get contact points by name succeeds", func(t *testing.T) {
32-
server, client := gapiTestTools(t, 200, getContactPointsQueryJSON)
33-
defer server.Close()
31+
client := gapiTestTools(t, 200, getContactPointsQueryJSON)
3432

3533
ps, err := client.ContactPointsByName("slack-receiver-1")
3634

@@ -47,8 +45,7 @@ func TestContactPoints(t *testing.T) {
4745
})
4846

4947
t.Run("get contact point succeeds", func(t *testing.T) {
50-
server, client := gapiTestTools(t, 200, getContactPointsJSON)
51-
defer server.Close()
48+
client := gapiTestTools(t, 200, getContactPointsJSON)
5249

5350
p, err := client.ContactPoint("rc5r0bjnz")
5451

@@ -62,8 +59,7 @@ func TestContactPoints(t *testing.T) {
6259
})
6360

6461
t.Run("get non-existent contact point fails", func(t *testing.T) {
65-
server, client := gapiTestTools(t, 200, getContactPointsJSON)
66-
defer server.Close()
62+
client := gapiTestTools(t, 200, getContactPointsJSON)
6763

6864
p, err := client.ContactPoint("does not exist")
6965

@@ -74,8 +70,7 @@ func TestContactPoints(t *testing.T) {
7470
})
7571

7672
t.Run("create contact point succeeds", func(t *testing.T) {
77-
server, client := gapiTestTools(t, 201, writeContactPointJSON)
78-
defer server.Close()
73+
client := gapiTestTools(t, 201, writeContactPointJSON)
7974
p := createContactPoint()
8075

8176
uid, err := client.NewContactPoint(&p)
@@ -89,8 +84,7 @@ func TestContactPoints(t *testing.T) {
8984
})
9085

9186
t.Run("update contact point succeeds", func(t *testing.T) {
92-
server, client := gapiTestTools(t, 200, writeContactPointJSON)
93-
defer server.Close()
87+
client := gapiTestTools(t, 200, writeContactPointJSON)
9488
p := createContactPoint()
9589
p.UID = "on7otbj7k"
9690

@@ -102,8 +96,7 @@ func TestContactPoints(t *testing.T) {
10296
})
10397

10498
t.Run("delete contact point succeeds", func(t *testing.T) {
105-
server, client := gapiTestTools(t, 204, "")
106-
defer server.Close()
99+
client := gapiTestTools(t, 204, "")
107100

108101
err := client.DeleteContactPoint("rc5r0bjnz")
109102

‎alerting_message_template_test.go

+5-10
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ import (
88

99
func TestMessageTemplates(t *testing.T) {
1010
t.Run("get message templates succeeds", func(t *testing.T) {
11-
server, client := gapiTestTools(t, 200, getMessageTemplatesJSON)
12-
defer server.Close()
11+
client := gapiTestTools(t, 200, getMessageTemplatesJSON)
1312

1413
ts, err := client.MessageTemplates()
1514

@@ -29,8 +28,7 @@ func TestMessageTemplates(t *testing.T) {
2928
})
3029

3130
t.Run("get message template succeeds", func(t *testing.T) {
32-
server, client := gapiTestTools(t, 200, messageTemplateJSON)
33-
defer server.Close()
31+
client := gapiTestTools(t, 200, messageTemplateJSON)
3432

3533
tmpl, err := client.MessageTemplate("template-one")
3634

@@ -44,8 +42,7 @@ func TestMessageTemplates(t *testing.T) {
4442
})
4543

4644
t.Run("get non-existent message template fails", func(t *testing.T) {
47-
server, client := gapiTestTools(t, 404, ``)
48-
defer server.Close()
45+
client := gapiTestTools(t, 404, ``)
4946

5047
tmpl, err := client.MessageTemplate("does not exist")
5148

@@ -56,8 +53,7 @@ func TestMessageTemplates(t *testing.T) {
5653
})
5754

5855
t.Run("put message template succeeds", func(t *testing.T) {
59-
server, client := gapiTestTools(t, 202, messageTemplateJSON)
60-
defer server.Close()
56+
client := gapiTestTools(t, 202, messageTemplateJSON)
6157

6258
err := client.SetMessageTemplate("template-three", "{{define \"template-one\" }}\n content three\n{{ end }}")
6359

@@ -67,8 +63,7 @@ func TestMessageTemplates(t *testing.T) {
6763
})
6864

6965
t.Run("delete message template succeeds", func(t *testing.T) {
70-
server, client := gapiTestTools(t, 204, ``)
71-
defer server.Close()
66+
client := gapiTestTools(t, 204, ``)
7267

7368
err := client.DeleteMessageTemplate("template-three")
7469

‎alerting_mute_timing_test.go

+6-12
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ import (
88

99
func TestMuteTimings(t *testing.T) {
1010
t.Run("get mute timings succeeds", func(t *testing.T) {
11-
server, client := gapiTestTools(t, 200, getMuteTimingsJSON)
12-
defer server.Close()
11+
client := gapiTestTools(t, 200, getMuteTimingsJSON)
1312

1413
mts, err := client.MuteTimings()
1514

@@ -29,8 +28,7 @@ func TestMuteTimings(t *testing.T) {
2928
})
3029

3130
t.Run("get mute timing succeeds", func(t *testing.T) {
32-
server, client := gapiTestTools(t, 200, muteTimingJSON)
33-
defer server.Close()
31+
client := gapiTestTools(t, 200, muteTimingJSON)
3432

3533
mt, err := client.MuteTiming("timing one")
3634

@@ -44,8 +42,7 @@ func TestMuteTimings(t *testing.T) {
4442
})
4543

4644
t.Run("get non-existent mute timing fails", func(t *testing.T) {
47-
server, client := gapiTestTools(t, 404, muteTimingJSON)
48-
defer server.Close()
45+
client := gapiTestTools(t, 404, muteTimingJSON)
4946

5047
mt, err := client.MuteTiming("does not exist")
5148

@@ -56,8 +53,7 @@ func TestMuteTimings(t *testing.T) {
5653
})
5754

5855
t.Run("create mute timing succeeds", func(t *testing.T) {
59-
server, client := gapiTestTools(t, 201, muteTimingJSON)
60-
defer server.Close()
56+
client := gapiTestTools(t, 201, muteTimingJSON)
6157
mt := createMuteTiming()
6258

6359
err := client.NewMuteTiming(&mt)
@@ -68,8 +64,7 @@ func TestMuteTimings(t *testing.T) {
6864
})
6965

7066
t.Run("update mute timing succeeds", func(t *testing.T) {
71-
server, client := gapiTestTools(t, 200, muteTimingJSON)
72-
defer server.Close()
67+
client := gapiTestTools(t, 200, muteTimingJSON)
7368
mt := createMuteTiming()
7469
mt.TimeIntervals[0].Weekdays = []WeekdayRange{"tuesday", "thursday"}
7570

@@ -81,8 +76,7 @@ func TestMuteTimings(t *testing.T) {
8176
})
8277

8378
t.Run("delete mute timing succeeds", func(t *testing.T) {
84-
server, client := gapiTestTools(t, 204, muteTimingJSON)
85-
defer server.Close()
79+
client := gapiTestTools(t, 204, muteTimingJSON)
8680

8781
err := client.DeleteMuteTiming("timing two")
8882

0 commit comments

Comments
 (0)