2018-04-26 12:34:15 +00:00
|
|
|
import json
|
|
|
|
import requests
|
2019-07-03 15:28:16 +00:00
|
|
|
import logging
|
2019-10-10 17:38:50 +00:00
|
|
|
import itertools
|
2018-05-20 16:34:22 +00:00
|
|
|
import emoji
|
2018-04-26 12:34:15 +00:00
|
|
|
import base64
|
|
|
|
from os import environ
|
|
|
|
from support.base_test_report import BaseTestReport
|
2020-12-29 15:44:08 +00:00
|
|
|
from sys import argv
|
2021-11-26 14:15:26 +00:00
|
|
|
from json import JSONDecodeError
|
2018-04-26 12:34:15 +00:00
|
|
|
|
2021-11-18 15:16:48 +00:00
|
|
|
|
2018-04-26 12:34:15 +00:00
|
|
|
class TestrailReport(BaseTestReport):
|
|
|
|
|
2018-10-26 13:32:05 +00:00
|
|
|
def __init__(self):
|
|
|
|
super(TestrailReport, self).__init__()
|
2018-04-26 12:34:15 +00:00
|
|
|
|
|
|
|
self.password = environ.get('TESTRAIL_PASS')
|
|
|
|
self.user = environ.get('TESTRAIL_USER')
|
|
|
|
|
|
|
|
self.run_id = None
|
2018-09-28 15:30:06 +00:00
|
|
|
self.suite_id = 48
|
|
|
|
self.project_id = 14
|
2018-04-26 12:34:15 +00:00
|
|
|
|
|
|
|
self.outcomes = {
|
|
|
|
'passed': 1,
|
|
|
|
'undefined_fail': 10}
|
|
|
|
|
|
|
|
self.headers = dict()
|
|
|
|
self.headers['Authorization'] = 'Basic %s' % str(
|
|
|
|
base64.b64encode(bytes('%s:%s' % (self.user, self.password), 'utf-8')), 'ascii').strip()
|
|
|
|
self.headers['Content-Type'] = 'application/json'
|
2021-09-20 10:08:04 +00:00
|
|
|
self.headers['x-api-ident'] = 'beta'
|
2018-04-26 12:34:15 +00:00
|
|
|
|
2018-10-26 13:32:05 +00:00
|
|
|
self.url = 'https://ethstatus.testrail.net/index.php?/'
|
|
|
|
self.api_url = self.url + 'api/v2/'
|
2018-04-26 12:34:15 +00:00
|
|
|
|
|
|
|
def get(self, method):
|
2019-06-17 16:36:28 +00:00
|
|
|
rval = requests.get(self.api_url + method, headers=self.headers).json()
|
|
|
|
if 'error' in rval:
|
2019-07-03 15:28:16 +00:00
|
|
|
logging.error("Failed TestRail request: %s" % rval['error'])
|
2019-06-17 16:36:28 +00:00
|
|
|
return rval
|
2018-04-26 12:34:15 +00:00
|
|
|
|
|
|
|
def post(self, method, data):
|
|
|
|
data = bytes(json.dumps(data), 'utf-8')
|
2018-10-26 13:32:05 +00:00
|
|
|
return requests.post(self.api_url + method, data=data, headers=self.headers).json()
|
2018-04-26 12:34:15 +00:00
|
|
|
|
2021-11-11 11:40:31 +00:00
|
|
|
def add_attachment(self, method, path):
|
|
|
|
files = {'attachment': (open(path, 'rb'))}
|
2021-11-18 15:16:48 +00:00
|
|
|
result = requests.post(self.api_url + method, headers={'Authorization': self.headers['Authorization']},
|
|
|
|
files=files)
|
2021-11-11 11:40:31 +00:00
|
|
|
files['attachment'].close()
|
2021-11-26 14:15:26 +00:00
|
|
|
try:
|
|
|
|
return result.json()
|
|
|
|
except JSONDecodeError:
|
|
|
|
pass
|
2021-11-11 11:40:31 +00:00
|
|
|
|
2018-04-26 12:34:15 +00:00
|
|
|
def get_suites(self):
|
|
|
|
return self.get('get_suites/%s' % self.project_id)
|
|
|
|
|
|
|
|
def get_tests(self):
|
2021-09-20 10:08:04 +00:00
|
|
|
return self.get('get_tests/%s' % self.run_id)['tests']
|
2018-04-26 12:34:15 +00:00
|
|
|
|
|
|
|
def get_milestones(self):
|
2021-09-20 10:08:04 +00:00
|
|
|
return self.get('get_milestones/%s' % self.project_id)['milestones']
|
2018-04-26 12:34:15 +00:00
|
|
|
|
2018-08-07 16:38:12 +00:00
|
|
|
def get_runs(self, pr_number):
|
2021-09-20 10:08:04 +00:00
|
|
|
return [i for i in self.get('get_runs/%s' % self.project_id)['runs'] if 'PR-%s ' % pr_number in i['name']]
|
2018-08-07 16:38:12 +00:00
|
|
|
|
|
|
|
def get_run(self, run_id: int):
|
|
|
|
return self.get('get_run/%s' % run_id)
|
|
|
|
|
|
|
|
def get_last_pr_run(self, pr_number):
|
|
|
|
run_id = max([run['id'] for run in self.get_runs(pr_number)])
|
|
|
|
return self.get_run(run_id=run_id)
|
|
|
|
|
2018-04-26 12:34:15 +00:00
|
|
|
@property
|
|
|
|
def actual_milestone_id(self):
|
|
|
|
return self.get_milestones()[-1]['id']
|
|
|
|
|
|
|
|
def add_run(self, run_name):
|
|
|
|
request_body = {'suite_id': self.suite_id,
|
|
|
|
'name': run_name,
|
2018-06-30 12:17:38 +00:00
|
|
|
'milestone_id': self.actual_milestone_id,
|
2020-09-04 15:34:58 +00:00
|
|
|
'case_ids': self.get_regression_cases(),
|
2018-06-30 12:17:38 +00:00
|
|
|
'include_all': False}
|
2018-04-26 12:34:15 +00:00
|
|
|
run = self.post('add_run/%s' % self.project_id, request_body)
|
|
|
|
self.run_id = run['id']
|
|
|
|
|
2019-10-10 17:38:50 +00:00
|
|
|
def get_cases(self, section_ids):
|
|
|
|
test_cases = list()
|
|
|
|
for section_id in section_ids:
|
2021-11-18 15:16:48 +00:00
|
|
|
test_cases.append(
|
|
|
|
self.get('get_cases/%s&suite_id=%s§ion_id=%s' % (self.project_id, self.suite_id, section_id))[
|
|
|
|
'cases'])
|
2019-10-10 17:38:50 +00:00
|
|
|
return itertools.chain.from_iterable(test_cases)
|
2018-06-30 12:17:38 +00:00
|
|
|
|
2020-09-04 15:34:58 +00:00
|
|
|
def get_regression_cases(self):
|
2018-06-30 12:17:38 +00:00
|
|
|
test_cases = dict()
|
2021-12-29 16:10:22 +00:00
|
|
|
test_cases['critical'] = 730
|
2018-09-28 15:30:06 +00:00
|
|
|
test_cases['medium'] = 736
|
2021-04-30 14:11:52 +00:00
|
|
|
test_cases['upgrade'] = 881
|
2021-12-29 16:10:22 +00:00
|
|
|
test_cases['public_chat'] = 50654
|
|
|
|
test_cases['one_to_one_chat'] = 50655
|
2018-06-30 12:17:38 +00:00
|
|
|
case_ids = list()
|
2020-12-29 15:44:08 +00:00
|
|
|
for arg in argv:
|
|
|
|
if "run_testrail_ids" in arg:
|
|
|
|
key, value = arg.split('=')
|
|
|
|
case_ids = value.split(',')
|
|
|
|
if len(case_ids) == 0:
|
|
|
|
if 'critical or high' in argv:
|
2021-12-29 16:10:22 +00:00
|
|
|
for case in self.get_cases([test_cases['critical'], test_cases['public_chat'], test_cases['one_to_one_chat']]):
|
2020-12-29 15:44:08 +00:00
|
|
|
case_ids.append(case['id'])
|
2021-04-30 14:11:52 +00:00
|
|
|
elif 'upgrade' in argv and 'not upgrade' not in argv:
|
|
|
|
for case in self.get_cases([test_cases['upgrade']]):
|
|
|
|
case_ids.append(case['id'])
|
2020-12-29 15:44:08 +00:00
|
|
|
else:
|
|
|
|
for phase in test_cases:
|
2021-04-30 14:11:52 +00:00
|
|
|
if phase != 'upgrade':
|
|
|
|
for case in self.get_cases([test_cases[phase]]):
|
|
|
|
case_ids.append(case['id'])
|
2018-06-30 12:17:38 +00:00
|
|
|
return case_ids
|
|
|
|
|
2018-04-26 12:34:15 +00:00
|
|
|
def add_results(self):
|
|
|
|
for test in self.get_all_tests():
|
|
|
|
test_steps = "# Steps: \n"
|
|
|
|
devices = str()
|
|
|
|
method = 'add_result_for_case/%s/%s' % (self.run_id, test.testrail_case_id)
|
2018-04-28 09:02:39 +00:00
|
|
|
last_testrun = test.testruns[-1]
|
|
|
|
for step in last_testrun.steps:
|
2018-04-26 12:34:15 +00:00
|
|
|
test_steps += step + "\n"
|
2018-04-28 09:02:39 +00:00
|
|
|
for i, device in enumerate(last_testrun.jobs):
|
2018-04-26 12:34:15 +00:00
|
|
|
devices += "# [Device %d](%s) \n" % (i + 1, self.get_sauce_job_url(device))
|
2018-04-28 09:02:39 +00:00
|
|
|
data = {'status_id': self.outcomes['undefined_fail'] if last_testrun.error else self.outcomes['passed'],
|
2021-11-18 15:16:48 +00:00
|
|
|
'comment': '%s' % ('# Error: \n %s \n' % emoji.demojize(
|
|
|
|
last_testrun.error)) + devices + test_steps if last_testrun.error
|
2018-04-26 12:34:15 +00:00
|
|
|
else devices + test_steps}
|
2021-11-19 17:27:21 +00:00
|
|
|
try:
|
|
|
|
result_id = self.post(method, data=data)['id']
|
|
|
|
except KeyError:
|
|
|
|
result_id = ''
|
2021-11-11 11:40:31 +00:00
|
|
|
if last_testrun.error:
|
|
|
|
for geth in test.geth_paths.keys():
|
2021-11-18 15:16:48 +00:00
|
|
|
self.add_attachment(method='add_attachment_to_result/%s' % str(result_id),
|
|
|
|
path=test.geth_paths[geth])
|
2020-12-04 17:32:05 +00:00
|
|
|
self.change_test_run_description()
|
|
|
|
|
|
|
|
def change_test_run_description(self):
|
|
|
|
tests = self.get_all_tests()
|
|
|
|
passed_tests = self.get_passed_tests()
|
|
|
|
failed_tests = self.get_failed_tests()
|
2021-01-13 10:14:32 +00:00
|
|
|
final_description = "Nothing to report this time..."
|
2020-12-04 17:32:05 +00:00
|
|
|
if len(tests) > 0:
|
|
|
|
description_title = "# %.0f%% of end-end tests have passed\n" % (len(passed_tests) / len(tests) * 100)
|
|
|
|
description_title += "\n"
|
|
|
|
description_title += "Total executed tests: %d\n" % len(tests)
|
|
|
|
description_title += "Failed tests: %d\n" % len(failed_tests)
|
|
|
|
description_title += "Passed tests: %d\n" % len(passed_tests)
|
|
|
|
description_title += "\n"
|
|
|
|
ids_failed_test = []
|
2021-01-13 10:14:32 +00:00
|
|
|
description, case_info = '', ''
|
2020-12-04 17:32:05 +00:00
|
|
|
if failed_tests:
|
|
|
|
for i, test in enumerate(failed_tests):
|
|
|
|
last_testrun = test.testruns[-1]
|
|
|
|
test_rail_link = self.get_test_result_link(self.run_id, test.testrail_case_id)
|
|
|
|
ids_failed_test.append(test.testrail_case_id)
|
|
|
|
case_title = '\n'
|
|
|
|
case_title += '-------\n'
|
2021-09-20 15:23:06 +00:00
|
|
|
case_title += "## %s) ID %s: [%s](%s) \n" % (i + 1, test.testrail_case_id, test.name, test_rail_link)
|
2021-11-18 15:16:48 +00:00
|
|
|
error = "```%s```\n" % last_testrun.error[:255]
|
2020-12-04 17:32:05 +00:00
|
|
|
for job_id, f in last_testrun.jobs.items():
|
2021-11-18 15:16:48 +00:00
|
|
|
case_info = "Logs for device %d: [steps](%s), [failure screenshot](%s)" \
|
|
|
|
% (f,
|
|
|
|
self.get_sauce_job_url(job_id),
|
|
|
|
self.get_sauce_final_screenshot_url(job_id))
|
2020-12-04 17:32:05 +00:00
|
|
|
|
|
|
|
description += case_title + error + case_info
|
2020-12-29 15:44:08 +00:00
|
|
|
description_title += '## Failed tests: %s \n' % ','.join(map(str, ids_failed_test))
|
2020-12-04 17:32:05 +00:00
|
|
|
final_description = description_title + description
|
|
|
|
|
|
|
|
request_body = {'description': final_description}
|
|
|
|
return self.post('update_run/%s' % self.run_id, request_body)
|
|
|
|
|
2018-11-24 16:18:31 +00:00
|
|
|
def get_run_results(self):
|
2021-09-20 15:23:06 +00:00
|
|
|
return self.get('get_results_for_run/%s' % self.run_id)['results']
|
2018-11-24 16:18:31 +00:00
|
|
|
|
|
|
|
def is_run_successful(self):
|
|
|
|
for test in self.get_run_results():
|
|
|
|
if test['status_id'] != 1:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return True
|
|
|
|
|
2018-10-26 13:32:05 +00:00
|
|
|
def get_test_result_link(self, test_run_id, test_case_id):
|
|
|
|
try:
|
2021-09-20 15:23:06 +00:00
|
|
|
test_id = self.get('get_results_for_case/%s/%s' % (test_run_id, test_case_id))['results'][0]['test_id']
|
2018-10-26 13:32:05 +00:00
|
|
|
return '%stests/view/%s' % (self.url, test_id)
|
|
|
|
except KeyError:
|
2021-09-20 15:23:06 +00:00
|
|
|
return None
|