如何使用Python REST API从VSTS(Azure DevOps)中的查询中提取工作项?

时间:2018-10-15 05:52:36

标签: python rest tfs azure-devops azure-devops-rest-api

我正在使用Azure DevOps的官方Python REST API: https://github.com/Microsoft/azure-devops-python-api

多亏了这些样本,我才能够从id中检索有关测试用例的信息。

如何通过查询(WIQL)做到这一点?

到目前为止,这是我的代码(带有经过修改的令牌和链接):

from vsts.vss_connection import VssConnection
from msrest.authentication import BasicAuthentication


token = "hcykwckuhe6vbnigsjs7r3ai2jefsdlkfjslkfj5mxizbtfu6k53j4ia"
team_instance = "https://tfstest.toto.com:8443/tfs/Development/"

credentials = BasicAuthentication("", token)
connection = VssConnection(base_url=team_instance, creds=credentials)


def print_work_items(work_items):
    for work_item in work_items:
        print(
            "{0} {1}: {2}".format(
                work_item.fields["System.WorkItemType"],
                work_item.id,
                work_item.fields["System.Title"],
            )
        )


WIT_CLIENT = (
    "vsts.work_item_tracking.v4_1.work_item_tracking_client.WorkItemTrackingClient"
)
wit_client = connection.get_client(WIT_CLIENT)


def get_TC_by_id(desired_ids):
    work_items = wit_client.get_work_items(ids=desired_ids, error_policy="omit")
    print_work_items(work_items)


def get_TC_from_query(query):
    # THIS FUNCTION IS NOT WORKING...
    work_items = wit_client.get_work_items(query=query, error_policy="omit")
    print_work_items(work_items)


get_TC_by_id([1035375])

get_TC_from_query(
    """\
SELECT
        [System.Id],
        [System.WorkItemType],
        [System.Title],
        [System.State],
        [System.AreaPath],
        [System.IterationPath]
FROM workitems
WHERE
        [System.TeamProject] = @project
        AND [System.WorkItemType] = 'Test Case'
ORDER BY [System.ChangedDate] DESC
"""
)

这是我得到的错误

  File "test_TFS.py", line 35, in get_TC_from_query
    work_items = wit_client.get_work_items(query=query, error_policy="omit")
TypeError: get_work_items() got an unexpected keyword argument 'query'

如何从查询中检索测试用例?

特别是,我不理解“ "vsts.work_item_tracking.v4_1.work_item_tracking_client.WorkItemTrackingClient"”等“客户端”的值

谢谢大家!

1 个答案:

答案 0 :(得分:1)

在Github存储库中发布VSTS示例消息(即导致pull request的消息)后,我得到了解决问题的提示。

解决方案是使用:

  • 具有Wiql类的wiql查询对象
  • query_by_wiql函数
  • 使用get_work_item函数(或get_work_items将查询结果(带有WorkItem ID的引用)转换为WorkItem(或通过一次from vsts.vss_connection import VssConnection from msrest.authentication import BasicAuthentication from vsts.work_item_tracking.v4_1.models.wiql import Wiql token = "hcykwckuhe6vbnigsjs7r3ai2jefsdlkfjslkfj5mxizbtfu6k53j4ia" team_instance = "https://tfstest.toto.com:8443/tfs/Development/" credentials = BasicAuthentication("", token) connection = VssConnection(base_url=team_instance, creds=credentials) def print_work_items(work_items): for work_item in work_items: print( "{0} {1}: {2}".format( work_item.fields["System.WorkItemType"], work_item.id, work_item.fields["System.Title"], ) ) WIT_CLIENT = ( "vsts.work_item_tracking.v4_1.work_item_tracking_client.WorkItemTrackingClient" ) wit_client = connection.get_client(WIT_CLIENT) def get_TC_from_query(query): query_wiql = Wiql(query=query) results = wit_client.query_by_wiql(query_wiql).work_items # WIQL query gives a WorkItemReference => we get the corresponding WorkItem from id work_items = (wit_client.get_work_item(int(result.id)) for result in results) print_work_items(work_items) 处理一次工作中的多个WorkItem)

这是我解决问题的方法:

oc create sa sample
oc policy add-role-to-user developer system:serviceaccount:sampleproject:sample
oc describe sa sample
oc describe sa secret sample-token-5s5kl