def _fixture_setup(self):
super()._fixture_setup()
self.execution_1 = TestExecutionFactory()
self.execution_1.case.summary = "Tested at " + timezone.now(
).isoformat()
self.execution_1.case.text = "Given-When-Then"
self.execution_1.case.save() # will generate history object
self.execution_1.run.summary = (
"Automated TR for JIRA integration on " +
timezone.now().isoformat())
self.execution_1.run.save()
# this is the name of the JIRA Project
self.execution_1.run.plan.product.name = "Integration with JIRA"
self.execution_1.run.plan.product.save()
self.component = ComponentFactory(
name="JIRA integration", product=self.execution_1.run.plan.product)
self.execution_1.case.add_component(self.component)
bug_system = BugSystem.objects.create( # nosec:B106:hardcoded_password_funcarg
name="JIRA at kiwitcms.atlassian.net",
tracker_type="tcms.issuetracker.types.JIRA",
base_url="https://kiwitcms.atlassian.net",
api_username=os.getenv("JIRA_BUGTRACKER_INTEGRATION_API_USERNAME"),
api_password=os.getenv("JIRA_BUGTRACKER_INTEGRATION_API_TOKEN"),
)
self.integration = JIRA(bug_system, None)
class TestJIRAIntegration(APITestCase):
existing_bug_id = "JIRA-1"
existing_bug_url = "https://kiwitcms.atlassian.net/browse/JIRA-1"
def _fixture_setup(self):
super()._fixture_setup()
self.execution_1 = TestExecutionFactory()
self.execution_1.case.summary = "Tested at " + timezone.now(
).isoformat()
self.execution_1.case.text = "Given-When-Then"
self.execution_1.case.save() # will generate history object
self.execution_1.run.summary = (
"Automated TR for JIRA integration on " +
timezone.now().isoformat())
self.execution_1.run.save()
# this is the name of the JIRA Project
self.execution_1.run.plan.product.name = "Integration with JIRA"
self.execution_1.run.plan.product.save()
self.component = ComponentFactory(
name="JIRA integration", product=self.execution_1.run.plan.product)
self.execution_1.case.add_component(self.component)
bug_system = BugSystem.objects.create( # nosec:B106:hardcoded_password_funcarg
name="JIRA at kiwitcms.atlassian.net",
tracker_type="tcms.issuetracker.types.JIRA",
base_url="https://kiwitcms.atlassian.net",
api_username=os.getenv("JIRA_BUGTRACKER_INTEGRATION_API_USERNAME"),
api_password=os.getenv("JIRA_BUGTRACKER_INTEGRATION_API_TOKEN"),
)
self.integration = JIRA(bug_system, None)
def test_bug_id_from_url(self):
result = self.integration.bug_id_from_url(self.existing_bug_url)
self.assertEqual(self.existing_bug_id, result)
def test_details_for_url(self):
result = self.integration.details(self.existing_bug_url)
self.assertEqual("Hello Jira Cloud", result["title"])
self.assertEqual(
"This ticket is used in automated tests that verify Kiwi TCMS - JIRA "
"bug tracking integration.",
result["description"],
)
def test_auto_update_bugtracker(self):
issue = self.integration.rpc.issue(self.existing_bug_id)
# make sure there are no comments to confuse the test
initial_comments_count = 0
for comment in self.integration.rpc.comments(issue):
initial_comments_count += 1
self.assertNotIn(self.execution_1.run.summary, comment.body)
# simulate user adding a new bug URL to a TE and clicking
# 'Automatically update bug tracker'
result = self.rpc_client.TestExecution.add_link(
{
"execution_id": self.execution_1.pk,
"is_defect": True,
"url": self.existing_bug_url,
},
True,
)
# making sure RPC above returned the same URL
self.assertEqual(self.existing_bug_url, result["url"])
# wait until comments have been refreshed b/c this seem to happen async
retries = 0
current_comment_count = 0
while current_comment_count <= initial_comments_count:
current_comment_count = len(self.integration.rpc.comments(issue))
time.sleep(1)
retries += 1
self.assertLess(retries, 20)
# assert that a comment has been added as the last one
# and also verify its text
last_comment = self.integration.rpc.comments(issue)[-1]
for expected_string in [
"Confirmed via test execution",
"TR-%d: %s" %
(self.execution_1.run_id, self.execution_1.run.summary),
self.execution_1.run.get_full_url(),
"TE-%d: %s" %
(self.execution_1.pk, self.execution_1.case.summary),
]:
self.assertIn(expected_string, last_comment.body)
# clean up after ourselves in case everything above looks good
last_comment.delete()
def test_report_issue_from_test_execution_1click_works(self):
# simulate user clicking the 'Report bug' button in TE widget, TR page
result = self.rpc_client.Bug.report(self.execution_1.pk,
self.integration.bug_system.pk)
self.assertEqual(result["rc"], 0)
self.assertIn(self.integration.bug_system.base_url, result["response"])
self.assertIn("https://kiwitcms.atlassian.net/browse/JIRA-",
result["response"])
new_issue_id = self.integration.bug_id_from_url(result["response"])
issue = self.integration.rpc.issue(new_issue_id)
self.assertEqual("Failed test: %s" % self.execution_1.case.summary,
issue.fields.summary)
for expected_string in [
"Filed from execution %s" % self.execution_1.get_full_url(),
self.execution_1.run.plan.product.name,
self.component.name,
"Steps to reproduce",
self.execution_1.case.text,
]:
self.assertIn(expected_string, issue.fields.description)
# verify that LR has been added to TE
self.assertTrue(
LinkReference.objects.filter(
execution=self.execution_1,
url=result["response"],
is_defect=True,
).exists())
# close issue after we're done
self.integration.rpc.transition_issue(issue, "DONE")