Где хранятся вложения шагов в VSTS REST API? - PullRequest
Новая
       8

Где хранятся вложения шагов в VSTS REST API?

0 голосов
/ 03 января 2019

Я использую Python REST API VSTS для операций разработки TFS / Azure (https://github.com/Microsoft/azure-devops-python-api).

. Я хотел бы добавить вложения к некоторым шагам моих тестовых случаев, как я могу сделать в ИнтернетеИнтерфейс.

Вот как я хочу, чтобы мой шаг выглядел следующим образом:

Step with attachment

... и когда вы его запустите, этобудет выглядеть так: enter image description here

Однако я не смог найти, где хранится эта информация.

Это данные JSON для WorkItem ofмой тестовый пример 

{
id: 224,
rev: 2,
fields: {
    System.AreaPath: "GM_sandbox\GM-Toto",
    System.TeamProject: "GM_sandbox",
    System.IterationPath: "GM_sandbox",
    System.WorkItemType: "Test Case",
    System.State: "Design",
    System.Reason: "New",
    System.AssignedTo: "Jeff",
    System.CreatedDate: "2019-01-03T01:43:09.743Z",
    System.CreatedBy: "Jeff",
    System.ChangedDate: "2019-01-03T02:12:07.15Z",
    System.ChangedBy: "Jeff",
    System.Title: "Titi",
    Microsoft.VSTS.Common.StateChangeDate: "2019-01-03T01:43:09.743Z",
    Microsoft.VSTS.Common.ActivatedDate: "2019-01-03T01:43:09.743Z",
    Microsoft.VSTS.Common.ActivatedBy: "Jeff",
    Microsoft.VSTS.Common.Priority: 2,
    Microsoft.VSTS.TCM.AutomationStatus: "Not Automated",
    Microsoft.VSTS.TCM.Steps: "<steps id="0" last="2"><step id="2" type="ValidateStep"><parameterizedString isformatted="true">&lt;DIV&gt;&lt;P&gt;Click on the rainbow button&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><parameterizedString isformatted="true">&lt;P&gt;Screen becomes Blue (see picture)&lt;/P&gt;</parameterizedString><description/></step></steps>"
},
_links: {
    self: {
        href: "https://my_server.com:8443/tfs/PRODUCT/23d89bd4-8547-4be3-aa73-13a30866f176/_apis/wit/workItems/224"
    },
    workItemUpdates: {
        href: "https://my_server.com:8443/tfs/PRODUCT/_apis/wit/workItems/224/updates"
    },
    workItemRevisions: {
        href: "https://my_server.com:8443/tfs/PRODUCT/_apis/wit/workItems/224/revisions"
    },
    workItemHistory: {
        href: "https://my_server.com:8443/tfs/PRODUCT/_apis/wit/workItems/224/history"
    },
    html: {
        href: "https://my_server.com:8443/tfs/PRODUCTi.aspx?pcguid=4107d6a2-eaaa-40b9-9a8d-f8fdbb31d4b7&id=224"
    },
    workItemType: {
        href: "https://my_server.com:8443/tfs/PRODUCT/23d89bd4-8547-4be3-aa73-13a30866f176/_apis/wit/workItemTypes/Test%20Case"
    },
    fields: {
        href: "https://my_server.com:8443/tfs/PRODUCT/23d89bd4-8547-4be3-aa73-13a30866f176/_apis/wit/fields"
    }
},
url: "https://my_server.com:8443/tfs/PRODUCT/23d89bd4-8547-4be3-aa73-13a30866f176/_apis/wit/workItems/224"
}

Есть идеи, где хранится эта информация?

И, если вы знакомы с Python REST API, как добавить вложение из файла и связать егона шаг теста?

Большое спасибо

1 Ответ

0 голосов
/ 04 января 2019

Вот поток, использующий только azure-devops-rest-api

Создать вложение:

Запрос: 

POST https://dev.azure.com/{organization}/_apis/wit/attachments?fileName=info.txt&api-version=4.1

Body: 

{"User text content to upload"}

Ответ: 

{
    "id": "f5016cf4-4c36-4bd6-9762-b6ad60838cf7",
    "url": "https://dev.azure.com/{organization}/_apis/wit/attachments/f5016cf4-4c36-4bd6-9762-b6ad60838cf7?fileName=info.txt"
}

Создание рабочего элемента:

Запрос: 

PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/$Test Case?api-version=4.1

Body: 

[
  {
    "op": "add",
    "path": "/fields/System.Title",
    "from": null,
    "value": "Sample test case"
  },
  {
    "op": "add",
    "path": "/fields/Microsoft.VSTS.TCM.Steps",
    "value": "<steps id=\"0\" last=\"4\"><step id=\"2\" type=\"ActionStep\"><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;P&gt;test&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;P&gt;&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><description/></step><step id=\"3\" type=\"ActionStep\"><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;test&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</parameterizedString><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;P&gt;&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><description/></step><step id=\"4\" type=\"ActionStep\"><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;P&gt;test&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><parameterizedString isformatted=\"true\">&lt;DIV&gt;&lt;P&gt;&amp;nbsp;&lt;/P&gt;&lt;/DIV&gt;</parameterizedString><description/></step></steps>"
  },
  {
    "op": "add",
    "path": "/relations/-",
    "value": {
        "rel": "AttachedFile",
        "url": "https://dev.azure.com/{organization}/_apis/wit/attachments/f5016cf4-4c36-4bd6-9762-b6ad60838cf7?fileName=info.txt",
        "attributes": {
            "comment": "[TestStep=3]:",
            "name": "info.txt"
        }
    }
  }
]

Созданный тестовый пример будет выглядеть следующим образом. Что-то не так с нумерацией шагов для номера в комментарии. Похоже, для фактического шага, на который вы хотите сослаться, должно быть +1.

TFS TestCase

Ключ должен быть в атрибутах вложенного файла, комментарий с "[TestStep=3]:", а также name для вложения.

В Python это выглядело бы примерно так:

  1. Создание вложения с функцией create_attachment

  2. Обновление тестового примера с url, comment и filename

Так что-то в этом роде ... 

from vsts.work_item_tracking.v4_1.models.json_patch_operation import JsonPatchOperation

def add_attachment(wit_id: int, project: str, url:str, comment: str, step = 0, name = ""):
    """Add attachment already uploaded to a WorkItem
    """
    # For linking the attachment to a step, we need to modify the comment and add a name
    if step:
        attributes = {
            "comment":f"[TestStep={step}]:{comment}",
            "name": name if name else re.sub(r".*fileName=", "", url)
        }
    else:
        attributes = {"comment": comment}

    patch_document = [
        JsonPatchOperation(
            op="add",
            path="/relations/-",
            value={
                "rel": "AttachedFile",
                "url": url,
                "attributes": attributes,
            },
        )
    ]
    return client.wit.update_work_item(patch_document, wit_id, project)

attachment = client_wit.create_attachment(stream, project, 'smiley.png')
add_attachment(tcid, project, attachment.url, 'Attaching file to work item', step=3)
...