Archives
/
iceraven-browser
mirror of https://github.com/fork-maintainers/iceraven-browser
2
0
Fork 0
Code Issues Releases Wiki Activity

Bug 1867539 - reformat testrail scripts with black

Browse Source 
Fixes lint warnings on oak
fenix/124.1.0
Julien Cristau 5 months ago committed by mergify[bot]
parent 528136c473
commit 28384dcde5
2 changed files with 84 additions and 56 deletions
Show Stats Download Patch File Download Diff File

54
automation/taskcluster/androidTest/lib/testrail_conn.py
Unescape Escape View File

@ -21,11 +21,11 @@ import requests
class APIClient:
def __init__(self, base_url):
self.user = ''
self.password = ''
if not base_url.endswith('/'):
base_url += '/'
self.__url = base_url + 'index.php?/api/v2/'
self.user = ""
self.password = ""
if not base_url.endswith("/"):
base_url += "/"
self.__url = base_url + "index.php?/api/v2/"
def send_get(self, uri, filepath=None):
"""Issue a GET request (read) against the API.
@ -38,7 +38,7 @@ class APIClient:
Returns:
A dict containing the result of the request.
"""
return self.__send_request('GET', uri, filepath)
return self.__send_request("GET", uri, filepath)
def send_post(self, uri, data):
"""Issue a POST request (write) against the API.
@ -52,49 +52,51 @@ class APIClient:
Returns:
A dict containing the result of the request.
"""
return self.__send_request('POST', uri, data)
return self.__send_request("POST", uri, data)
def __send_request(self, method, uri, data):
url = self.__url + uri
auth = str(
base64.b64encode(
bytes('%s:%s' % (self.user, self.password), 'utf-8')
),
'ascii'
base64.b64encode(bytes("%s:%s" % (self.user, self.password), "utf-8")),
"ascii",
).strip()
headers = {'Authorization': 'Basic ' + auth}
headers = {"Authorization": "Basic " + auth}
if method == 'POST':
if uri[:14] == 'add_attachment': # add_attachment API method
files = {'attachment': (open(data, 'rb'))}
if method == "POST":
if uri[:14] == "add_attachment": # add_attachment API method
files = {"attachment": (open(data, "rb"))}
response = requests.post(url, headers=headers, files=files)
files['attachment'].close()
files["attachment"].close()
else:
headers['Content-Type'] = 'application/json'
payload = bytes(json.dumps(data), 'utf-8')
headers["Content-Type"] = "application/json"
payload = bytes(json.dumps(data), "utf-8")
response = requests.post(url, headers=headers, data=payload)
else:
headers['Content-Type'] = 'application/json'
headers["Content-Type"] = "application/json"
response = requests.get(url, headers=headers)
if response.status_code > 201:
try:
error = response.json()
except requests.exceptions.HTTPError: # response.content not formatted as JSON
except (
requests.exceptions.HTTPError
): # response.content not formatted as JSON
error = str(response.content)
raise APIError('TestRail API returned HTTP %s (%s)' % (response.status_code, error))
raise APIError(
"TestRail API returned HTTP %s (%s)" % (response.status_code, error)
)
else:
if uri[:15] == 'get_attachment/': # Expecting file, not JSON
if uri[:15] == "get_attachment/": # Expecting file, not JSON
try:
open(data, 'wb').write(response.content)
return (data)
open(data, "wb").write(response.content)
return data
except FileNotFoundError:
return ("Error saving attachment.")
return "Error saving attachment."
else:
try:
return response.json()
except requests.exceptions.HTTPError:
except requests.exceptions.HTTPError:
return {}

86
automation/taskcluster/androidTest/testrail.py
Unescape Escape View File

@ -55,11 +55,11 @@ except Exception as e:
raise Exception(f"An error occurred while loading the .env file: {e}")
try:
with open('.testrail_credentials.json', 'r') as file:
with open(".testrail_credentials.json", "r") as file:
secret = json.load(file)
TESTRAIL_HOST = secret['host']
TESTRAIL_USERNAME = secret['username']
TESTRAIL_PASSWORD = secret['password']
TESTRAIL_HOST = secret["host"]
TESTRAIL_USERNAME = secret["username"]
TESTRAIL_PASSWORD = secret["password"]
except json.JSONDecodeError as e:
raise ValueError("Failed to load testrail credentials : {e}")
@ -69,22 +69,26 @@ try:
VERSION_NUMBER = os.environ["MOBILE_HEAD_REF"]
TEST_STATUS = os.environ["TEST_STATUS"]
if TEST_STATUS not in ('PASS', 'FAIL'):
if TEST_STATUS not in ("PASS", "FAIL"):
raise ValueError(f"ERROR: Invalid TEST_STATUS value: {TEST_STATUS}")
except KeyError as e:
raise ValueError(f"ERROR: Missing Environment Variable: {e}")
def parse_release_number(VERSION_NUMBER):
parts = VERSION_NUMBER.split('_')
parts = VERSION_NUMBER.split("_")
return parts[1]
def build_milestone_name(product_type, release_type, version_number):
return f"Automated smoke testing sign-off - {product_type} {release_type} {version_number}"
def build_milestone_description(milestone_name):
current_date = datetime.now()
formatted_date = current_date = current_date.strftime("%B %d, %Y")
return textwrap.dedent(f"""
return textwrap.dedent(
f"""
RELEASE: {milestone_name}\n\n\
RELEASE_TAG_URL: https://github.com/mozilla-mobile/firefox-android/releases\n\n\
RELEASE_DATE: {formatted_date}\n\n\
@ -95,10 +99,11 @@ def build_milestone_description(milestone_name):
Known issues: n/a\n\
New issue: n/a\n\
Verified issue:
""")
"""
)
class TestRail():
class TestRail:
def __init__(self):
try:
self.client = APIClient(TESTRAIL_HOST)
@ -106,49 +111,70 @@ class TestRail():
self.client.password = TESTRAIL_PASSWORD
except KeyError as e:
raise ValueError(f"ERROR: Missing Testrail Env Var: {e}")
# Public Methods
def create_milestone(self, testrail_project_id, title, description):
data = {"name": title, "description": description}
return self.client.send_post(f'add_milestone/{testrail_project_id}', data)
def create_test_run(self, testrail_project_id, testrail_milestone_id, name_run, testrail_suite_id):
data = {"name": name_run, "milestone_id": testrail_milestone_id, "suite_id": testrail_suite_id}
return self.client.send_post(f'add_run/{testrail_project_id}', data)
def update_test_cases_to_passed(self, testrail_project_id, testrail_run_id, testrail_suite_id):
return self.client.send_post(f"add_milestone/{testrail_project_id}", data)
def create_test_run(
self, testrail_project_id, testrail_milestone_id, name_run, testrail_suite_id
):
data = {
"name": name_run,
"milestone_id": testrail_milestone_id,
"suite_id": testrail_suite_id,
}
return self.client.send_post(f"add_run/{testrail_project_id}", data)
def update_test_cases_to_passed(
self, testrail_project_id, testrail_run_id, testrail_suite_id
):
test_cases = self._get_test_cases(testrail_project_id, testrail_suite_id)
data = { "results": [{"case_id": test_case['id'], "status_id": 1} for test_case in test_cases]}
data = {
"results": [
{"case_id": test_case["id"], "status_id": 1} for test_case in test_cases
]
}
return testrail._update_test_run_results(testrail_run_id, data)
# Private Methods
def _get_test_cases(self, testrail_project_id, testrail_test_suite_id):
return self.client.send_get(f'get_cases/{testrail_project_id}&suite_id={testrail_test_suite_id}')
return self.client.send_get(
f"get_cases/{testrail_project_id}&suite_id={testrail_test_suite_id}"
)
def _update_test_run_results(self, testrail_run_id, data):
return self.client.send_post(f'add_results_for_cases/{testrail_run_id}', data)
return self.client.send_post(f"add_results_for_cases/{testrail_run_id}", data)
if __name__ == "__main__":
if TEST_STATUS != 'PASS':
if TEST_STATUS != "PASS":
raise ValueError("Tests failed. Sending Slack Notification....")
# There are for a dummy Testrail project used for Phase 1 testing of this script
# They will be parameterized during Phase 2 of script hardening
PROJECT_ID = 53 # Firefox for FireTV
TEST_SUITE_ID = 45442 # Demo Test Suite
PROJECT_ID = 53 # Firefox for FireTV
TEST_SUITE_ID = 45442 # Demo Test Suite
testrail = TestRail()
milestone_name = build_milestone_name(PRODUCT_TYPE, RELEASE_TYPE, parse_release_number(VERSION_NUMBER))
milestone_name = build_milestone_name(
PRODUCT_TYPE, RELEASE_TYPE, parse_release_number(VERSION_NUMBER)
)
milestone_description = build_milestone_description(milestone_name)
# Create milestone for 'Firefox for FireTV' and store the ID
milestone_id = testrail.create_milestone(PROJECT_ID, milestone_name, milestone_description)['id']
milestone_id = testrail.create_milestone(
PROJECT_ID, milestone_name, milestone_description
)["id"]
# Create test run for each Device/API and update test cases to 'passed'
# The Firebase Test devices are temporarily hard-coded during testing
# The Firebase Test devices are temporarily hard-coded during testing
# and will be parameterized in Phase 2 of hardening
for test_run_name in ['Google Pixel 32(Android11)', 'Google Pixel2(Android9)']:
test_run_id = testrail.create_test_run(PROJECT_ID, milestone_id, test_run_name, TEST_SUITE_ID)['id']
for test_run_name in ["Google Pixel 32(Android11)", "Google Pixel2(Android9)"]:
test_run_id = testrail.create_test_run(
PROJECT_ID, milestone_id, test_run_name, TEST_SUITE_ID
)["id"]
testrail.update_test_cases_to_passed(PROJECT_ID, test_run_id, TEST_SUITE_ID)

Write Preview
Loading…
Cancel
Save