Chapter7: 利用Python的Testlink模块上传测试结果，取代Jenkins中的Testlink插件

本系列文章见总链接：

需要在Python环境中安装Testlink-API-Python-client。TestLink-API-Python-client is a Python XML-RPC client for Testlink

下载链接：https://pypi.org/project/TestLink-API-Python-client/

源代码：https://github.com/lczub/TestLink-API-Python-client

示例代码：https://github.com/lczub/TestLink-API-Python-client/blob/master/doc/usage.rst

安装Testlink模块： pip install TestLink-API-Python-client

在Jenkins Job中的配置

Execute Windows Batch Command in Jenkins Job

 代码：

@echo on
cd "%WORKSPACE%\%BUILD_NUMBER%"
for /F "delims=" %%i in ('findstr /r /c:"do set UUTResult="%%i"
echo %UUTResult% | findstr /c:"Passed" 1>nul
set "testresultlevel=%errorlevel%"
if %errorlevel% == 0 (set exec_status=p) else (set exec_status=f)
set "test_case_name=%ScriptName:~0,-4%"
set "custom_fields_name=%test_case_name%.1Main"
set "custom_fields=AutoTest"
for /f tokens^=8^ delims^=^" %%i in ('findstr /i "time=.*>" Report_JUnit.xml') do set "exec_duration=%%i"

set "exec_notes=%BUILD_URL%;;Project: %Project%;UnitType: %UnitType%;RunningMode: %RunningMode%;SystemInUse: %SystemInUse%;PublicORBritishSystem: %PublicORBritishSystem%;ScriptPath: %ScriptPath%;ScriptName: %ScriptName%;test_plan_name: %test_plan_name%;test_suite_name: %test_suite_name%;build_name: %build_name%;"
set "exec_junit_xml_path=%WORKSPACE%\Report_JUnit.xml"

@echo off
echo url = %TestlinkURL%
echo key = %TestlinkKEY%
echo test_project_name = %Project%
echo test_plan_name = %test_plan_name%
echo test_suite_name = %test_suite_name%
echo test_case_name = %test_case_name%
echo build_name = %build_name%
echo custom_fields_name = %custom_fields_name%
echo exec_status = %exec_status%
echo exec_duration(seconds) = %exec_duration%
echo exec_notes = %exec_notes%
echo exec_junit_xml_path = %exec_junit_xml_path%

@echo on
C:\Python27\python.exe c:\jenkins\UpdateTestExecutionINTestlink.py %TestlinkURL% %TestlinkKEY% "%Project%" "%test_plan_name%" "%test_suite_name%" "%test_case_name%" "%build_name%" "%custom_fields%" "%custom_fields_name%" %exec_status% %exec_duration% "%exec_notes%" "%exec_junit_xml_path%"

exit %testresultlevel%

UpdateTestExecutionINTestlink.py 代码：

# -*- coding:UTF-8 -*-
import testlink
import time
import sys

print("url: %s" %sys.argv[1])     #Testlink api address
print("key: %s" %sys.argv[2])     #Testlink developer key for specified user
print("test_project_name: %s" %sys.argv[3])   #test project name in Testlink
print("test_plan_name: %s" %sys.argv[4])      #test plan name for current test execution 
print("test_suite_name: %s" %sys.argv[5])     #test suite name of the test case
print("test_case_name: %s" %sys.argv[6])      #test case name
print("build_name: %s" %sys.argv[7])          #the build name, would be the SW version
print("custom_fields: %s" %sys.argv[8])       #the custom fields defined in Testlink
print("custom_fields_name: %s" %sys.argv[9])  #the custom fields value in test case
print("exec_status: %s" %sys.argv[10])        #the test status for current test execution
print("exec_duration(seconds): %s" %sys.argv[11])    #the duration for current test execution
print("exec_notes: %s" %sys.argv[12].replace(";","\n"))     #the useful information of jenkins job would be uploaded to Testlink
print("exec_junit_xml_path: %s" %sys.argv[13])     #the path of the Junit type XML file for current test execution results
url = sys.argv[1]
key = sys.argv[2]
test_project_name = sys.argv[3]
test_plan_name = sys.argv[4]
test_suite_name = sys.argv[5]
test_case_name = sys.argv[6]
build_name = sys.argv[7]
dict_key = sys.argv[8]
custom_fields = {}
custom_fields[dict_key] = sys.argv[9]
exec_status = sys.argv[10]
exec_duration = sys.argv[11]
exec_duration=round(float(exec_duration)//float(60.0) + float(exec_duration)%float(60.0)/float(60.0),2)     #convert the time from seconds to minutes
print("exec_duration(minutes): %s" %exec_duration)
exec_notes = sys.argv[12].replace(";","\n")+"\nTime: "+str(exec_duration)+" minutes\n"     #replace ; with \n . Then the note in Testlink would be readable
print("exec_notes: %s" %exec_notes)
exec_junit_xml_path = sys.argv[13]

tlc = testlink.TestlinkAPIClient(url,key)
for project in projects:
    print("testProject",project["id"],project["name"])    #print all project with id and name
for project in projects:
    if project["name"]==test_project_name:                
        project_id=project["id"]                          #get the project id by the known name
        print("project_id: %s" %project_id)
test_plans=tlc.getProjectTestPlans(project_id)            
for test_plan in test_plans:
    if test_plan["name"]==test_plan_name:
        test_plan_id=test_plan["id"]                      #get the test plan id by the known name
        print("test_plan_id: %s" %test_plan_id)
test_suites=tlc.getTestSuitesForTestPlan(test_plan_id)    #get the test suites by test plan id
for test_suite in test_suites:
    if test_suite["name"]==test_suite_name:
        test_suite_id=test_suite["id"]                    #get the test suite id by test suite name
        print("test_suite_id: %s" %test_suite_id)
test_cases=tlc.getTestCasesForTestSuite(test_suite_id,True,None)
for test_case in test_cases:
    if test_case["name"] == test_case_name:
        test_case_id=test_case["id"]                      #get the test case id by test case name
        print("test_case_id: %s" %test_case_id)
localtime=time.strftime("%Y-%m-%d %H:%M:%S",time.localtime())            #define the current time stamp

newBuild = tlc.createBuild(test_plan_id,build_name,'Build created automatically with Python')    #Create the build in Testlink

newResult = tlc.reportTCResult(testcaseid=test_case_id,testplanid=test_plan_id,status=exec_status,guess=True,testcaseexternalid=None,platformname=None,buildname=build_name,customfields=custom_fields,execduration=exec_duration,timestamp=localtime,notes=exec_notes)
print(newResult)
newAttachment = tlc.uploadExecutionAttachment(exec_junit_xml_path,newResult[0]['id'],test_case_name,'Description')

在Python中查看方法使用：

Python 2.7.17 (v2.7.17:c2f86d86e6, Oct 19 2019, 20:49:36) [MSC v.1500 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import testlink
>>> tlc = testlink.TestlinkAPIClient("http://10.90.69.239:8181/testlink-1.9.20/lib/api/xmlrpc/v1/xmlrpc.php","740c93c48fa88452c4e172c15b161ffc")
>>> print tlc.whatArgs('reportTCResult')
reportTCResult(, , , , , [testcaseexternalid=], [buildid=], [platformid=], [platformname=], [guess=], [bugid=], [customfields=], [overwrite=], [user=], [execduration=], [timestamp=], [steps=], [devKey=])
 Reports a result for a single test case

        args variations: testcaseid - testcaseexternalid
                         buildid - buildname
                         platformid - platformname

        customfields : dictionary with customfields names + values
            VERY IMPORTANT: value must be formatted in the way it's written to db
        overwrite    : if present and true, then last execution for
                       (testcase,testplan,build,platform) will be overwritten.
        user : if present and user is a valid login (no other check will be done)
               it will be used when writing execution.
        execduration : Exec (min) as float (2.5 = 2min 30sec)
        timestamp    : 'YYYY-MM-DD hh:mm[:ss]'#
        steps        : [{'step_number' : 6, 'result' : 'p', 'notes" : 'a_note'},
                        {'step_number' : 7, 'result' : 'f', 'notes" : 'blabla'}]

>>> print tlc.whatArgs('uploadExecutionAttachment')
uploadExecutionAttachment(, ,