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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
from __future__ import annotations
from unittest import mock
import pytest
from jira.exceptions import JIRAError
from jira.resources import (
Dashboard,
DashboardGadget,
DashboardItemProperty,
DashboardItemPropertyKey,
)
from tests.conftest import (
JiraTestCase,
allow_on_cloud,
broken_test,
only_run_on_cloud,
rndstr,
)
class DashboardTests(JiraTestCase):
def setUp(self):
super().setUp()
self.dashboards_to_delete = []
self.gadget_title = "Filter Results"
self.dashboard_item_expected_key = "config"
self.dashboard_item_column_names = "issuetype|issuekey|summary|priority|status"
self.dashboard_item_num = 5
self.dashboard_item_refresh = 15
self.filter = self.jira.create_filter(
rndstr(), "description", f"project={self.project_b}", True
)
def tearDown(self):
for dashboard in self.dashboards_to_delete:
dashboard.delete()
super().tearDown()
def test_dashboards(self):
dashboards = self.jira.dashboards()
self.assertGreaterEqual(len(dashboards), 1)
@broken_test(
reason="standalone jira docker image has only 1 system dashboard by default"
)
def test_dashboards_filter(self):
dashboards = self.jira.dashboards(filter="my")
self.assertEqual(len(dashboards), 2)
self.assertEqual(dashboards[0].id, "10101")
def test_dashboards_startat(self):
dashboards = self.jira.dashboards(startAt=0, maxResults=1)
self.assertEqual(len(dashboards), 1)
def test_dashboards_maxresults(self):
dashboards = self.jira.dashboards(maxResults=1)
self.assertEqual(len(dashboards), 1)
def test_dashboard(self):
expected_ds = self.jira.dashboards()[0]
dashboard = self.jira.dashboard(expected_ds.id)
self.assertEqual(dashboard.id, expected_ds.id)
self.assertEqual(dashboard.name, expected_ds.name)
@only_run_on_cloud
@allow_on_cloud
def test_create_dashboard(self):
name = rndstr()
description = rndstr()
share_permissions = [{"type": "authenticated"}]
dashboard = self.jira.create_dashboard(
name=name, description=description, share_permissions=share_permissions
)
self.assertIsInstance(dashboard, Dashboard)
self.dashboards_to_delete.append(dashboard)
self.assertEqual(dashboard.name, name)
self.assertEqual(dashboard.description, description)
# This is a bit obtuse, but Jira mutates the type on this
# object after the fact. `authenticated` corresponds to `loggedin`.
self.assertEqual(dashboard.sharePermissions[0].type, "loggedin")
# The system dashboard always has the ID `10000`, just
# ensuring we actually have a
self.assertGreater(int(dashboard.id), 10000)
@only_run_on_cloud
@allow_on_cloud
def test_update_dashboard(self):
updated_name = "changed"
name = rndstr()
description = rndstr()
share_permissions = [{"type": "authenticated"}]
dashboard = self.jira.create_dashboard(
name=name, description=description, share_permissions=share_permissions
)
self.assertIsInstance(dashboard, Dashboard)
self.dashboards_to_delete.append(dashboard)
dashboard.update(name=updated_name)
self.assertEqual(dashboard.name, updated_name)
@only_run_on_cloud
@allow_on_cloud
def test_delete_dashboard(self):
dashboard = self.jira.create_dashboard(name="to_delete")
dashboard_id = dashboard.id
delete_response = dashboard.delete()
self.assertEqual(delete_response.status_code, 204)
with pytest.raises(JIRAError) as ex:
self.jira.dashboard(dashboard_id)
self.assertEqual(ex.value.status_code, 404)
self.assertEqual(
ex.value.text, f"The dashboard with id '{dashboard_id}' does not exist."
)
@only_run_on_cloud
@allow_on_cloud
def test_copy_dashboard(self):
original_dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(original_dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
original_gadget = self.jira.add_gadget_to_dashboard(
original_dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
original_dashboard = self.jira.dashboard(original_dashboard.id)
copied_dashboard = self.jira.copy_dashboard(
original_dashboard.id, name=rndstr()
)
copied_dashboard = self.jira.dashboard(copied_dashboard.id)
self.assertIsInstance(copied_dashboard, Dashboard)
self.dashboards_to_delete.append(copied_dashboard)
self.assertEqual(len(original_dashboard.gadgets), len(copied_dashboard.gadgets))
self.assertEqual(original_gadget.color, copied_dashboard.gadgets[0].color)
self.assertEqual(original_gadget.uri, copied_dashboard.gadgets[0].uri)
@only_run_on_cloud
@allow_on_cloud
def test_all_dashboard_gadgets(self):
# This is a super basic test. We can't really rely on the fact
# that the gadgets available at any given moment will be specifically represented
# here and it would be silly to have to update the tests to adjust for that if
# the starting list ever changed.
gadgets = self.jira.all_dashboard_gadgets()
self.assertGreater(len(gadgets), 0)
self.assertIsInstance(gadgets[0], DashboardGadget)
@only_run_on_cloud
@allow_on_cloud
def test_dashboard_gadgets(self):
gadget_count = 3
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
for _ in range(0, gadget_count):
self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
dashboard_gadgets = self.jira.dashboard_gadgets(dashboard.id)
self.assertEqual(len(dashboard_gadgets), gadget_count)
for dashboard_gadget in dashboard_gadgets:
self.assertIsInstance(dashboard_gadget, DashboardGadget)
@only_run_on_cloud
@allow_on_cloud
def test_update_dashboard_automatic_refresh_minutes(self):
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
response = self.jira.update_dashboard_automatic_refresh_minutes(
dashboard.id, 10
)
self.assertEqual(response.status_code, 204)
response = self.jira.update_dashboard_automatic_refresh_minutes(dashboard.id, 0)
self.assertEqual(response.status_code, 204)
@only_run_on_cloud
@allow_on_cloud
def test_add_gadget_to_dashboard(self):
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
gadget = self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
dashboard = self.jira.dashboard(dashboard.id)
self.assertEqual(dashboard.gadgets[0], gadget)
self.assertIsInstance(dashboard.gadgets[0], DashboardGadget)
@only_run_on_cloud
@allow_on_cloud
def test_remove_gadget_from_dashboard(self):
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
gadget = self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
dashboard = self.jira.dashboard(dashboard.id)
self.assertEqual(len(dashboard.gadgets), 1)
self.assertEqual(dashboard.gadgets[0], gadget)
gadget.delete(dashboard.id)
dashboard = self.jira.dashboard(dashboard.id)
self.assertEqual(len(dashboard.gadgets), 0)
@only_run_on_cloud
@allow_on_cloud
def test_update_gadget(self):
new_color = "green"
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
gadget = self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
gadget = gadget.update(dashboard.id, color=new_color)
self.assertEqual(gadget.color, new_color)
self.assertEqual(gadget.raw["color"], new_color)
self.assertIsInstance(gadget, DashboardGadget)
@only_run_on_cloud
@allow_on_cloud
def test_dashboard_item_property_keys(self):
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
gadget = self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
dashboard_item_property_keys = self.jira.dashboard_item_property_keys(
dashboard.id, gadget.id
)
self.assertEqual(len(dashboard_item_property_keys), 0)
item_property_payload = {
"filterId": self.filter.id,
"columnNames": self.dashboard_item_column_names,
"num": self.dashboard_item_num,
"refresh": self.dashboard_item_refresh,
}
self.jira.set_dashboard_item_property(
dashboard.id,
gadget.id,
self.dashboard_item_expected_key,
value=item_property_payload,
)
dashboard_item_property_keys = self.jira.dashboard_item_property_keys(
dashboard.id, gadget.id
)
self.assertEqual(len(dashboard_item_property_keys), 1)
self.assertEqual(
dashboard_item_property_keys[0].key, self.dashboard_item_expected_key
)
self.assertIsInstance(dashboard_item_property_keys[0], DashboardItemPropertyKey)
delete_response = dashboard_item_property_keys[0].delete()
self.assertEqual(delete_response.status_code, 204)
dashboard_item_property_keys = self.jira.dashboard_item_property_keys(
dashboard.id, gadget.id
)
self.assertEqual(len(dashboard_item_property_keys), 0)
@only_run_on_cloud
@allow_on_cloud
def test_dashboard_item_properties(self):
dashboard = self.jira.create_dashboard(
name=rndstr(), share_permissions=[{"type": "authenticated"}]
)
self.dashboards_to_delete.append(dashboard)
available_gadgets = self.jira.all_dashboard_gadgets()
filter_gadget = next(
gadget for gadget in available_gadgets if gadget.title == self.gadget_title
)
gadget = self.jira.add_gadget_to_dashboard(
dashboard.id,
color="blue",
ignore_uri_and_module_key_validation=True,
uri=filter_gadget.uri,
)
item_property_payload = {
"filterId": self.filter.id,
"columnNames": self.dashboard_item_column_names,
"num": self.dashboard_item_num,
"refresh": self.dashboard_item_refresh,
}
dashboard_item_property = self.jira.set_dashboard_item_property(
dashboard.id,
gadget.id,
self.dashboard_item_expected_key,
value=item_property_payload,
)
dashboard = self.jira.dashboard(dashboard.id)
self.assertEqual(
dashboard.gadgets[0].item_properties[0], dashboard_item_property
)
self.assertIsInstance(dashboard_item_property, DashboardItemProperty)
updated_item_property_payload = {"num": 10}
updated_dashboard_item_property = dashboard_item_property.update(
dashboard.id, gadget.id, value=updated_item_property_payload
)
self.assertEqual(
updated_dashboard_item_property.value.num,
updated_item_property_payload["num"],
)
delete_response = updated_dashboard_item_property.delete(
dashboard.id, gadget.id
)
self.assertEqual(delete_response.status_code, 204)
@only_run_on_cloud
@allow_on_cloud
@mock.patch("requests.Session.request")
def test_set_dashboard_item_property_not_201_response(self, mocked_request):
mocked_request.return_value = mock.MagicMock(ok=False, status_code=404)
with pytest.raises(JIRAError) as ex:
self.jira.set_dashboard_item_property(
"id", "item_id", "config", {"this": "that"}
)
assert ex.value.status_code == 404
|
