mirror of
https://github.com/Telecominfraproject/wlan-testing.git
synced 2025-10-31 19:08:01 +00:00
55d9e99978
This is going to take more work, but getting somewhat closer. Stop using pytest/helpers, they are replaced by libraries. Existing libraries are often taking a command-line-args option as easy way to pass something to various methods. This will have to be resolved to work with the way pytest wants to run. Much hard-coding needs to be removed, and specifically, the 'set profile' logic is completley not working. Need to use library logic that can query the eq-id based on name (and query eq-name based on serial port/ssh, perhaps). Need to resolve how cmd-line can take multiple APs, but each will have different eq-id. Signed-off-by: Ben Greear <greearb@candelatech.com>
210 lines
7.2 KiB
Python
210 lines
7.2 KiB
Python
"""TestRail API binding for Python 3.x.
|
|
|
|
"""
|
|
|
|
####################################################################
|
|
# Custom version of testrail_api module
|
|
#
|
|
# Used by Nightly_Sanity ###########################################
|
|
####################################################################
|
|
|
|
import base64
|
|
import json
|
|
|
|
import requests
|
|
from pprint import pprint
|
|
import os
|
|
|
|
class TestRail_Client:
|
|
def __init__(self, command_line_args):
|
|
self.user = command_line_args.testrail_user_id
|
|
self.password = command_line_args.testrail_user_password
|
|
self.command_line_args = command_line_args
|
|
base_url = command_line_args.testrail_base_url
|
|
if not base_url.endswith('/'):
|
|
base_url += '/'
|
|
self.__url = base_url + 'index.php?/api/v2/'
|
|
self.use_testrails = True
|
|
if command_line_args.testrail_user_id == "NONE":
|
|
self.use_testrails = False
|
|
|
|
def __init__(self, url, id, passwd):
|
|
self.user = id
|
|
self.password = passwd
|
|
base_url = url
|
|
if not base_url.endswith('/'):
|
|
base_url += '/'
|
|
self.__url = base_url + 'index.php?/api/v2/'
|
|
self.use_testrails = True
|
|
|
|
|
|
def send_get(self, uri, filepath=None):
|
|
"""Issue a GET request (read) against the API.
|
|
|
|
Args:
|
|
uri: The API method to call including parameters, e.g. get_case/1.
|
|
filepath: The path and file name for attachment download; used only
|
|
for 'get_attachment/:attachment_id'.
|
|
|
|
Returns:
|
|
A dict containing the result of the request.
|
|
"""
|
|
return self.__send_request('GET', uri, filepath)
|
|
|
|
def send_post(self, uri, data):
|
|
"""Issue a POST request (write) against the API.
|
|
|
|
Args:
|
|
uri: The API method to call, including parameters, e.g. add_case/1.
|
|
data: The data to submit as part of the request as a dict; strings
|
|
must be UTF-8 encoded. If adding an attachment, must be the
|
|
path to the file.
|
|
|
|
Returns:
|
|
A dict containing the result of the request.
|
|
"""
|
|
return self.__send_request('POST', uri, data)
|
|
|
|
def __send_request(self, method, uri, data):
|
|
if not self.use_testrails:
|
|
return {"TESTRAILS":"DISABLED"}
|
|
|
|
url = self.__url + uri
|
|
|
|
auth = str(
|
|
base64.b64encode(
|
|
bytes('%s:%s' % (self.user, self.password), 'utf-8')
|
|
),
|
|
'ascii'
|
|
).strip()
|
|
headers = {'Authorization': 'Basic ' + auth}
|
|
#print("Method =" , method)
|
|
|
|
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()
|
|
else:
|
|
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'
|
|
response = requests.get(url, headers=headers)
|
|
#print("headers = ", headers)
|
|
#print("resonse=", response)
|
|
#print("response code =", response.status_code)
|
|
|
|
if response.status_code > 201:
|
|
|
|
try:
|
|
error = response.json()
|
|
except: # response.content not formatted as JSON
|
|
error = str(response.content)
|
|
#raise APIError('TestRail API returned HTTP %s (%s)' % (response.status_code, error))
|
|
print('TestRail API returned HTTP %s (%s)' % (response.status_code, error))
|
|
return
|
|
else:
|
|
print(uri[:15])
|
|
if uri[:15] == 'get_attachments': # Expecting file, not JSON
|
|
try:
|
|
print('opening file')
|
|
print (str(response.content))
|
|
open(data, 'wb').write(response.content)
|
|
print('opened file')
|
|
return (data)
|
|
except:
|
|
return ("Error saving attachment.")
|
|
else:
|
|
|
|
try:
|
|
return response.json()
|
|
except: # Nothing to return
|
|
return {}
|
|
|
|
def get_project_id(self, project_name):
|
|
"Get the project ID using project name"
|
|
|
|
if not self.use_testrails:
|
|
return -1
|
|
|
|
project_id = None
|
|
projects = self.send_get('get_projects')
|
|
##pprint(projects)
|
|
for project in projects:
|
|
if project['name']== project_name:
|
|
project_id = project['id']
|
|
# project_found_flag=True
|
|
break
|
|
print("project Id =",project_id)
|
|
return project_id
|
|
|
|
def get_run_id(self, test_run_name):
|
|
"Get the run ID using test name and project name"
|
|
|
|
if not self.use_testrails:
|
|
return -1
|
|
|
|
run_id = None
|
|
project_id = self.get_project_id(project_name=project)
|
|
|
|
try:
|
|
test_runs = self.send_get('get_runs/%s' % (project_id))
|
|
#print("------------TEST RUNS----------")
|
|
#pprint(test_runs)
|
|
|
|
except Exception:
|
|
print
|
|
'Exception in update_testrail() updating TestRail.'
|
|
return None
|
|
else:
|
|
for test_run in test_runs:
|
|
if test_run['name'] == test_run_name:
|
|
run_id = test_run['id']
|
|
#print("run Id in Test Runs=",run_id)
|
|
break
|
|
return run_id
|
|
|
|
|
|
def update_testrail(self, case_id, run_id, status_id, msg):
|
|
"Update TestRail for a given run_id and case_id"
|
|
|
|
if not self.use_testrails:
|
|
return False
|
|
|
|
update_flag = False
|
|
# Get the TestRail client account details
|
|
# Update the result in TestRail using send_post function.
|
|
# Parameters for add_result_for_case is the combination of runid and case id.
|
|
# status_id is 1 for Passed, 2 For Blocked, 4 for Retest and 5 for Failed
|
|
#status_id = 1 if result_flag is True else 5
|
|
|
|
print("result status Pass/Fail = ", status_id)
|
|
print("case id=", case_id)
|
|
print("run id passed to update is ", run_id, case_id)
|
|
if run_id is not None:
|
|
try:
|
|
result = self.send_post(
|
|
'add_result_for_case/%s/%s' % (run_id, case_id),
|
|
{'status_id': status_id, 'comment': msg})
|
|
print("result in post",result)
|
|
except Exception:
|
|
print
|
|
'Exception in update_testrail() updating TestRail.'
|
|
|
|
else:
|
|
print
|
|
'Updated test result for case: %s in test run: %s with msg:%s' % (case_id, run_id, msg)
|
|
|
|
return update_flag
|
|
|
|
def create_testrun(self, name, case_ids, project_id, milestone_id, description):
|
|
result = self.send_post(
|
|
'add_run/%s' % (project_id),
|
|
{'name': name, 'case_ids': case_ids, 'milestone_id': milestone_id, 'description': description, 'include_all': False})
|
|
print("result in post", result)
|
|
|
|
class APIError(Exception):
|
|
pass
|