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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
|
from __future__ import annotations
import logging
from jira.exceptions import JIRAError
from tests.conftest import JiraTestCase, find_by_key, find_by_key_value
LOGGER = logging.getLogger(__name__)
class IssueTests(JiraTestCase):
def setUp(self):
JiraTestCase.setUp(self)
self.issue_1 = self.test_manager.project_b_issue1
self.issue_2 = self.test_manager.project_b_issue2
self.issue_3 = self.test_manager.project_b_issue3
def test_issue(self):
issue = self.jira.issue(self.issue_1)
self.assertEqual(issue.key, self.issue_1)
self.assertEqual(issue.fields.summary, f"issue 1 from {self.project_b}")
def test_issue_search_finds_issue(self):
issues = self.jira.search_issues(f"key={self.issue_1}")
self.assertEqual(self.issue_1, issues[0].key)
def test_issue_search_return_type(self):
issues = self.jira.search_issues(f"key={self.issue_1}")
self.assertIsInstance(issues, list)
issues = self.jira.search_issues(f"key={self.issue_1}", json_result=True)
self.assertIsInstance(issues, dict)
def test_issue_search_only_includes_provided_fields(self):
issues = self.jira.search_issues(
f"key={self.issue_1}", fields="comment,assignee"
)
self.assertTrue(hasattr(issues[0].fields, "comment"))
self.assertTrue(hasattr(issues[0].fields, "assignee"))
self.assertFalse(hasattr(issues[0].fields, "reporter"))
def test_issue_search_default_behaviour_included_fields(self):
search_str = f"key={self.issue_1}"
issues = self.jira.search_issues(search_str)
self.assertTrue(hasattr(issues[0].fields, "reporter"))
self.assertTrue(hasattr(issues[0].fields, "comment"))
# fields=None should be valid and return all fields (ie. default behavior)
self.assertEqual(
self.jira.search_issues(search_str),
self.jira.search_issues(search_str, fields=None),
)
def test_issue_get_field(self):
issue = self.jira.issue(self.issue_1)
self.assertEqual(
issue.fields.description, issue.get_field(field_name="description")
)
with self.assertRaisesRegex(AttributeError, ": _something"):
issue.get_field("_something")
with self.assertRaisesRegex(AttributeError, "customfield_1234"):
issue.get_field("customfield_1234")
def test_issue_field_limiting(self):
issue = self.jira.issue(self.issue_2, fields="summary,comment")
self.assertEqual(issue.fields.summary, f"issue 2 from {self.project_b}")
comment1 = self.jira.add_comment(issue, "First comment")
comment2 = self.jira.add_comment(issue, "Second comment")
comment3 = self.jira.add_comment(issue, "Third comment")
self.jira.issue(self.issue_2, fields="summary,comment")
LOGGER.warning(issue.raw["fields"])
self.assertFalse(hasattr(issue.fields, "reporter"))
self.assertFalse(hasattr(issue.fields, "progress"))
comment1.delete()
comment2.delete()
comment3.delete()
def test_issue_equal(self):
issue1 = self.jira.issue(self.issue_1)
issue2 = self.jira.issue(self.issue_2)
issues = self.jira.search_issues(f"key={self.issue_1}")
self.assertTrue(issue1 is not None)
self.assertTrue(issue1 == issues[0])
self.assertFalse(issue2 == issues[0])
def test_issue_expand(self):
issue = self.jira.issue(self.issue_1, expand="editmeta,schema")
self.assertTrue(hasattr(issue, "editmeta"))
self.assertTrue(hasattr(issue, "schema"))
# testing for changelog is not reliable because it may exist or not based on test order
# self.assertFalse(hasattr(issue, 'changelog'))
def test_create_issue_with_fieldargs(self):
issue = self.jira.create_issue(
summary="Test issue created",
project=self.project_b,
issuetype={"name": "Bug"},
description="foo description",
) # customfield_10022='XSS'
self.assertEqual(issue.fields.summary, "Test issue created")
self.assertEqual(issue.fields.description, "foo description")
self.assertEqual(issue.fields.issuetype.name, "Bug")
self.assertEqual(issue.fields.project.key, self.project_b)
# self.assertEqual(issue.fields.customfield_10022, 'XSS')
issue.delete()
def test_create_issue_with_fielddict(self):
fields = {
"summary": "Issue created from field dict",
"project": {"key": self.project_b},
"issuetype": {"name": "Bug"},
"description": "Some new issue for test",
# 'customfield_10022': 'XSS',
"priority": {"name": "High"},
}
issue = self.jira.create_issue(fields=fields)
self.assertEqual(issue.fields.summary, "Issue created from field dict")
self.assertEqual(issue.fields.description, "Some new issue for test")
self.assertEqual(issue.fields.issuetype.name, "Bug")
self.assertEqual(issue.fields.project.key, self.project_b)
# self.assertEqual(issue.fields.customfield_10022, 'XSS')
self.assertEqual(issue.fields.priority.name, "High")
issue.delete()
def test_create_issue_without_prefetch(self):
issue = self.jira.create_issue(
summary="Test issue created",
project=self.project_b,
issuetype={"name": "Bug"},
description="some details",
prefetch=False,
) # customfield_10022='XSS'
assert hasattr(issue, "self")
assert hasattr(issue, "raw")
assert "fields" not in issue.raw
issue.delete()
def test_create_issues(self):
field_list = [
{
"summary": "Issue created via bulk create #1",
"project": {"key": self.project_b},
"issuetype": {"name": "Bug"},
"description": "Some new issue for test",
# 'customfield_10022': 'XSS',
"priority": {"name": "High"},
},
{
"summary": "Issue created via bulk create #2",
"project": {"key": self.project_a},
"issuetype": {"name": "Bug"},
"description": "Another new issue for bulk test",
"priority": {"name": "High"},
},
]
issues = self.jira.create_issues(field_list=field_list)
self.assertEqual(len(issues), 2)
self.assertIsNotNone(issues[0]["issue"], "the first issue has not been created")
self.assertEqual(
issues[0]["issue"].fields.summary, "Issue created via bulk create #1"
)
self.assertEqual(
issues[0]["issue"].fields.description, "Some new issue for test"
)
self.assertEqual(issues[0]["issue"].fields.issuetype.name, "Bug")
self.assertEqual(issues[0]["issue"].fields.project.key, self.project_b)
self.assertEqual(issues[0]["issue"].fields.priority.name, "High")
self.assertIsNotNone(
issues[1]["issue"], "the second issue has not been created"
)
self.assertEqual(
issues[1]["issue"].fields.summary, "Issue created via bulk create #2"
)
self.assertEqual(
issues[1]["issue"].fields.description, "Another new issue for bulk test"
)
self.assertEqual(issues[1]["issue"].fields.issuetype.name, "Bug")
self.assertEqual(issues[1]["issue"].fields.project.key, self.project_a)
self.assertEqual(issues[1]["issue"].fields.priority.name, "High")
for issue in issues:
issue["issue"].delete()
def test_create_issues_one_failure(self):
field_list = [
{
"summary": "Issue created via bulk create #1",
"project": {"key": self.project_b},
"issuetype": {"name": "Bug"},
"description": "Some new issue for test",
# 'customfield_10022': 'XSS',
"priority": {"name": "High"},
},
{
"summary": "This issue will not succeed",
"project": {"key": self.project_a},
"issuetype": {"name": "InvalidIssueType"},
"description": "Should not be seen.",
"priority": {"name": "High"},
},
{
"summary": "However, this one will.",
"project": {"key": self.project_a},
"issuetype": {"name": "Bug"},
"description": "Should be seen.",
"priority": {"name": "High"},
},
]
issues = self.jira.create_issues(field_list=field_list)
self.assertEqual(
issues[0]["issue"].fields.summary, "Issue created via bulk create #1"
)
self.assertEqual(
issues[0]["issue"].fields.description, "Some new issue for test"
)
self.assertEqual(issues[0]["issue"].fields.issuetype.name, "Bug")
self.assertEqual(issues[0]["issue"].fields.project.key, self.project_b)
self.assertEqual(issues[0]["issue"].fields.priority.name, "High")
self.assertEqual(issues[0]["error"], None)
self.assertEqual(issues[1]["issue"], None)
self.assertEqual(issues[1]["error"], {"issuetype": "issue type is required"})
self.assertEqual(issues[1]["input_fields"], field_list[1])
self.assertEqual(issues[2]["issue"].fields.summary, "However, this one will.")
self.assertEqual(issues[2]["issue"].fields.description, "Should be seen.")
self.assertEqual(issues[2]["issue"].fields.issuetype.name, "Bug")
self.assertEqual(issues[2]["issue"].fields.project.key, self.project_a)
self.assertEqual(issues[2]["issue"].fields.priority.name, "High")
self.assertEqual(issues[2]["error"], None)
self.assertEqual(len(issues), 3)
for issue in issues:
if issue["issue"] is not None:
issue["issue"].delete()
def test_create_issues_without_prefetch(self):
field_list = [
dict(
summary="Test issue #1 created with dicts without prefetch",
project=self.project_b,
issuetype={"name": "Bug"},
description="some details",
),
dict(
summary="Test issue #2 created with dicts without prefetch",
project=self.project_a,
issuetype={"name": "Bug"},
description="foo description",
),
]
issues = self.jira.create_issues(field_list, prefetch=False)
assert hasattr(issues[0]["issue"], "self")
assert hasattr(issues[0]["issue"], "raw")
assert hasattr(issues[1]["issue"], "self")
assert hasattr(issues[1]["issue"], "raw")
assert "fields" not in issues[0]["issue"].raw
assert "fields" not in issues[1]["issue"].raw
for issue in issues:
issue["issue"].delete()
def test_create_issue_with_integer_issuetype(self):
# take first existing issuetype to avoid problems due to hardcoded name/id later
issue_types_resolved = self.jira.issue_types()
dyn_it = issue_types_resolved[0]
issue = self.jira.create_issue(
summary="Test issue created using an integer issuetype",
project=self.project_b,
issuetype=int(dyn_it.id),
)
self.assertEqual(issue.get_field("issuetype").name, dyn_it.name)
def test_create_issue_with_issue_type_name(self):
issue_types_resolved = self.jira.issue_types()
dyn_it = issue_types_resolved[0]
issue = self.jira.create_issue(
summary="Test issue created using a str issuetype",
project=self.project_b,
issuetype=dyn_it.name,
)
self.assertEqual(issue.get_field("issuetype").name, dyn_it.name)
def test_update_with_fieldargs(self):
issue = self.jira.create_issue(
summary="Test issue for updating with fieldargs",
project=self.project_b,
issuetype={"name": "Bug"},
description="Will be updated shortly",
)
# customfield_10022='XSS')
issue.update(
summary="Updated summary",
description="Now updated",
issuetype={"name": "Task"},
)
self.assertEqual(issue.fields.summary, "Updated summary")
self.assertEqual(issue.fields.description, "Now updated")
self.assertEqual(issue.fields.issuetype.name, "Task")
# self.assertEqual(issue.fields.customfield_10022, 'XSS')
self.assertEqual(issue.fields.project.key, self.project_b)
issue.delete()
def test_update_with_fielddict(self):
issue = self.jira.create_issue(
summary="Test issue for updating with fielddict",
project=self.project_b,
description="Will be updated shortly",
issuetype={"name": "Bug"},
)
fields = {
"summary": "Issue is updated",
"description": "it sure is",
"issuetype": {"name": "Task"},
# 'customfield_10022': 'DOC',
"priority": {"name": "High"},
}
issue.update(fields=fields)
self.assertEqual(issue.fields.summary, "Issue is updated")
self.assertEqual(issue.fields.description, "it sure is")
self.assertEqual(issue.fields.issuetype.name, "Task")
# self.assertEqual(issue.fields.customfield_10022, 'DOC')
self.assertEqual(issue.fields.priority.name, "High")
issue.delete()
def test_update_with_label(self):
issue = self.jira.create_issue(
summary="Test issue for updating labels",
project=self.project_b,
description="Label testing",
issuetype=self.test_manager.CI_JIRA_ISSUE,
)
labelarray = ["testLabel"]
fields = {"labels": labelarray}
issue.update(fields=fields)
self.assertEqual(issue.fields.labels, ["testLabel"])
def test_update_label_with_proxy(self):
issue = self.jira.create_issue(
summary="Test issue for updating labels",
project=self.project_b,
description="Label testing",
issuetype=self.test_manager.CI_JIRA_ISSUE,
)
labelarray = ["testLabel"]
fields = {"labels": labelarray}
# This simulates when your Jira server is behind a proxy
# The self address returned will be different from the configured server
issue.self = f"https://foo.bar/jira/rest/api/2/issue/{issue.id}"
issue.update(fields=fields)
self.assertEqual(issue.fields.labels, ["testLabel"])
def test_update_with_bad_label(self):
issue = self.jira.create_issue(
summary="Test issue for updating bad labels",
project=self.project_b,
description="Label testing",
issuetype=self.test_manager.CI_JIRA_ISSUE,
)
issue.fields.labels.append("this should not work")
fields = {"labels": issue.fields.labels}
self.assertRaises(JIRAError, issue.update, fields=fields)
def test_update_with_notify_false(self):
issue = self.jira.create_issue(
summary="Test issue for updating wiith notify false",
project=self.project_b,
description="Will be updated shortly",
issuetype={"name": "Bug"},
)
issue.update(notify=False, description="Now updated, but silently")
self.assertEqual(issue.fields.description, "Now updated, but silently")
issue.delete()
def test_delete(self):
issue = self.jira.create_issue(
summary="Test issue created",
project=self.project_b,
description="Not long for this world",
issuetype=self.test_manager.CI_JIRA_ISSUE,
)
key = issue.key
issue.delete()
self.assertRaises(JIRAError, self.jira.issue, key)
def test_delete_with_proxy(self):
issue = self.jira.create_issue(
summary="Test issue created",
project=self.project_b,
description="Not long for this world",
issuetype=self.test_manager.CI_JIRA_ISSUE,
)
key = issue.key
# This simulates when your Jira server is behind a proxy
# The self address returned will be different from the configured server
issue.self = f"https://foo.bar/jira/rest/api/2/issue/{issue.id}"
issue.delete()
self.assertRaises(JIRAError, self.jira.issue, key)
def test_createmeta(self):
meta = self.jira.createmeta()
proj = find_by_key(meta["projects"], self.project_b)
# we assume that this project should allow at least one issue type
self.assertGreaterEqual(len(proj["issuetypes"]), 1)
def test_createmeta_filter_by_projectkey_and_name(self):
meta = self.jira.createmeta(projectKeys=self.project_b, issuetypeNames="Bug")
self.assertEqual(len(meta["projects"]), 1)
self.assertEqual(len(meta["projects"][0]["issuetypes"]), 1)
def test_createmeta_filter_by_projectkeys_and_name(self):
meta = self.jira.createmeta(
projectKeys=(self.project_a, self.project_b), issuetypeNames="Task"
)
self.assertEqual(len(meta["projects"]), 2)
for project in meta["projects"]:
self.assertEqual(len(project["issuetypes"]), 1)
def test_createmeta_filter_by_id(self):
projects = self.jira.projects()
proja = find_by_key_value(projects, self.project_a)
projb = find_by_key_value(projects, self.project_b)
issue_type_ids = dict()
full_meta = self.jira.createmeta(projectIds=(proja.id, projb.id))
for project in full_meta["projects"]:
for issue_t in project["issuetypes"]:
issue_t_id = issue_t["id"]
val = issue_type_ids.get(issue_t_id)
if val is None:
issue_type_ids[issue_t_id] = []
issue_type_ids[issue_t_id].append([project["id"]])
common_issue_ids = []
for key, val in issue_type_ids.items():
if len(val) == 2:
common_issue_ids.append(key)
self.assertNotEqual(len(common_issue_ids), 0)
for_lookup_common_issue_ids = common_issue_ids
if len(common_issue_ids) > 2:
for_lookup_common_issue_ids = common_issue_ids[:-1]
meta = self.jira.createmeta(
projectIds=(proja.id, projb.id), issuetypeIds=for_lookup_common_issue_ids
)
self.assertEqual(len(meta["projects"]), 2)
for project in meta["projects"]:
self.assertEqual(
len(project["issuetypes"]), len(for_lookup_common_issue_ids)
)
def test_createmeta_expand(self):
# limit to SCR project so the call returns promptly
meta = self.jira.createmeta(
projectKeys=self.project_b, expand="projects.issuetypes.fields"
)
self.assertTrue("fields" in meta["projects"][0]["issuetypes"][0])
def test_assign_issue(self):
self.assertTrue(self.jira.assign_issue(self.issue_1, self.user_normal.name))
self.assertEqual(
self.jira.issue(self.issue_1).fields.assignee.name, self.user_normal.name
)
def test_assign_issue_with_issue_obj(self):
issue = self.jira.issue(self.issue_1)
x = self.jira.assign_issue(issue, self.user_normal.name)
self.assertTrue(x)
self.assertEqual(
self.jira.issue(self.issue_1).fields.assignee.name, self.user_normal.name
)
def test_assign_to_bad_issue_raises(self):
self.assertRaises(JIRAError, self.jira.assign_issue, "NOPE-1", "notauser")
def test_unassign_issue(self):
# Given: A user is assigned to an issue
self.assertTrue(self.jira.assign_issue(self.issue_1, self.user_normal.name))
self.assertEqual(
self.jira.issue(self.issue_1).fields.assignee.name, self.user_normal.name
)
# When: we unassign the issue
self.assertTrue(self.jira.assign_issue(self.issue_1, None))
# Then: the issue has an assignee of None
self.assertEqual(self.jira.issue(self.issue_1).fields.assignee, None)
def test_assign_issue_automatic(self):
# Given: A user is assigned to an issue
self.assertTrue(self.jira.assign_issue(self.issue_1, self.user_normal.name))
self.assertEqual(
self.jira.issue(self.issue_1).fields.assignee.name, self.user_normal.name
)
# When: we assign the issue to "-1"
self.assertTrue(self.jira.assign_issue(self.issue_1, "-1"))
# Then: the issue has the default assignee (the admin user)
self.assertEqual(self.jira.issue(self.issue_1).fields.assignee, self.user_admin)
def test_editmeta(self):
expected_fields = {
"assignee",
"attachment",
"comment",
"components",
"description",
"fixVersions",
"issuelinks",
"labels",
"summary",
}
for i in (self.issue_1, self.issue_2):
meta = self.jira.editmeta(i)
meta_field_set = set(meta["fields"].keys())
self.assertEqual(
meta_field_set.intersection(expected_fields), expected_fields
)
def test_transitioning(self):
# we check with both issue-as-string or issue-as-object
transitions = []
for issue in [self.issue_2, self.jira.issue(self.issue_2)]:
transitions = self.jira.transitions(issue)
self.assertTrue(transitions)
self.assertTrue("id" in transitions[0])
self.assertTrue("name" in transitions[0])
self.assertTrue(transitions, msg="Expecting at least one transition")
# we test getting a single transition
transition = self.jira.transitions(self.issue_2, transitions[0]["id"])[0]
self.assertDictEqual(transition, transitions[0])
# we test the expand of fields
transition = self.jira.transitions(
self.issue_2, transitions[0]["id"], expand="transitions.fields"
)[0]
self.assertTrue("fields" in transition)
# Testing of transition with field assignment is disabled now because default workflows do not have it.
# self.jira.transition_issue(issue, transitions[0]['id'], assignee={'name': self.test_manager.CI_JIRA_ADMIN})
# issue = self.jira.issue(issue.key)
# self.assertEqual(issue.fields.assignee.name, self.test_manager.CI_JIRA_ADMIN)
#
# fields = {
# 'assignee': {
# 'name': self.test_manager.CI_JIRA_USER
# }
# }
# transitions = self.jira.transitions(issue.key)
# self.assertTrue(transitions) # any issue should have at least one transition available to it
# transition_id = transitions[0]['id']
#
# self.jira.transition_issue(issue.key, transition_id, fields=fields)
# issue = self.jira.issue(issue.key)
# self.assertEqual(issue.fields.assignee.name, self.test_manager.CI_JIRA_USER)
# self.assertEqual(issue.fields.status.id, transition_id)
def test_rank(self):
def get_issues_ordered_by_rank():
"""Search for the issues, returned in the order determined by their rank."""
return self.jira.search_issues(
f"key in ({self.issue_1},{self.issue_2}) ORDER BY Rank ASC"
)
self.jira.rank(self.issue_1, next_issue=self.issue_2)
issues = get_issues_ordered_by_rank()
assert (issues[0].key, issues[1].key) == (self.issue_1, self.issue_2)
self.jira.rank(self.issue_2, next_issue=self.issue_1)
issues = get_issues_ordered_by_rank()
assert (issues[0].key, issues[1].key) == (self.issue_2, self.issue_1)
self.jira.rank(self.issue_2, prev_issue=self.issue_1)
issues = get_issues_ordered_by_rank()
assert (issues[0].key, issues[1].key) == (self.issue_1, self.issue_2)
|