(Spike) Explore service hooks available in ADO for onboarding

[samiyaakhtar]

As a developer, I would like to know the method(s) for how I can onboard to start using the Spektate tool and send data to the tool from all the pipelines.

I want: a complete guide on how to onboard to use the Spektate tool, both CLI and dashboard.

Additional context:
Methods for updating the pipeline from a task:

• send POST request to an azure function
• download and run a python script
• (Spike) explore the service hooks available in Azure DevOps (and see if these can be extended to tools outside ADO or if they would remain Azure specific, in which an alternative needs to be setup)
  • Push a message to azure storage queue when a build starts
  • Run a script that dequeues this message and gets the build id
    • Query the azure API to get variables for this specific build, to get image tag, hld commit id, etc.

Does this require updates to documentation?: Yes

Acceptance Criteria:

A document/artifact explaining why we can/cannot use the service hooks in AzDO for sending data to the pipelines. If we can use this method, ideally, a working example of sending data to the pipelines would be useful

[samiyaakhtar]

It looks like there's no way to trigger an event when a build starts, only when the build completes. This will make the deployment visible on the introspection tool very late, possible after it has failed or completed.

[andrebriggs]

@samiyaakhtar I wonder if this combination fulfills the same need

Update

Seems to work. Here is example json payload

{
    "id": "94e2d948-8916-4828-8e8a-4526bd047a89",
    "eventType": "ms.vss-pipelines.run-state-changed-event",
    "publisherId": "pipelines",
    "message": {
        "text": "Run 20190927.1 in progress.",
        "html": "Run <a href=\"https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/results?buildId=457\">20190927.1</a> in progress.",
        "markdown": "Run [20190927.1](https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/results?buildId=457) in progress."
    },
    "detailedMessage": {
        "text": "Run 20190927.1 in progress.",
        "html": "Run <a href=\"https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/results?buildId=457\">20190927.1</a> in progress.",
        "markdown": "Run [20190927.1](https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/results?buildId=457) in progress."
    },
    "resource": {
        "run": {
            "_links": {
                "self": {
                    "href": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_apis/pipelines/7/runs/457"
                },
                "web": {
                    "href": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/results?buildId=457"
                },
                "pipeline.web": {
                    "href": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_build/definition?definitionId=7"
                },
                "pipeline": {
                    "href": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_apis/pipelines/7?revision=2"
                }
            },
            "pipeline": {
                "url": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_apis/pipelines/7?revision=2",
                "id": 7,
                "revision": 2,
                "name": "andrebriggs.spartan-app",
                "folder": "\\"
            },
            "state": "inProgress",
            "createdDate": "2019-09-27T02:11:44.4795508Z",
            "url": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_apis/pipelines/7/runs/457",
            "resources": {
                "repositories": {
                    "self": {
                        "repository": {
                            "fullName": "andrebriggs/spartan-app",
                            "connection": {
                                "id": "e1b9d03d-0bcf-4e8f-aa8c-efc5935b821b"
                            },
                            "type": "gitHub"
                        },
                        "refName": "refs/heads/master",
                        "version": "c3c013e852c627f6239da0eb752a9f35416aa4c6"
                    }
                }
            },
            "id": 457,
            "name": "20190927.1"
        },
        "pipeline": {
            "url": "https://dev.azure.com/abrig/efd47cfd-d35f-40ba-b424-e1ab432fdc68/_apis/pipelines/7?revision=2",
            "id": 7,
            "revision": 2,
            "name": "andrebriggs.spartan-app",
            "folder": "\\"
        }
    },
    "resourceVersion": "5.1-preview.1",
    "createdDate": "2019-09-27T02:11:53.5723651Z"
}```

[samiyaakhtar]

Error from "Run state changed" hook

I keep getting this error when I try to create a service hook for "Run state changed", but I was able to get a hook working for "Build completed"

Response from "Build completed" hook

{ 
   "id":"592e4c17-753b-4aac-8b61-0c4700c11d78",
   "eventType":"build.complete",
   "publisherId":"tfs",
   "message":{ 
      "text":"Build 20190927.12 succeeded"
   },
   "detailedMessage":{ 
      "text":"Build 20190927.12 succeeded"
   },
   "resource":{ 
      "uri":"vstfs:///Build/Build/6208",
      "id":6208,
      "buildNumber":"20190927.12",
      "url":"https://dev.azure.com/epicstuff/f8a98d9c-8f11-46ef-89e4-07b4a56d1ad5/_apis/build/Builds/6208",
      "startTime":"2019-09-27T19:18:21.4257117Z",
      "finishTime":"2019-09-27T19:20:12.6375544Z",
      "reason":"manual",
      "status":"succeeded",
      "drop":{ 

      },
      "log":{ 

      },
      "sourceGetVersion":"LG:refs/heads/master:d629794aac44d1445c56a8ab8e7fbe25cc9310c1",
      "lastChangedBy":{ 
         "displayName":"Microsoft.VisualStudio.Services.TFS",
         "id":"00000000-0000-0000-0000-000000000000",
         "uniqueName":"00000002-0000-8888-8000-000000000000@2c895908-04e0-4952-89fd-54b0046d6288"
      },
      "retainIndefinitely":false,
      "definition":{ 
         "definitionType":"xaml",
         "id":126,
         "name":"samiyaakhtar.hello-service-hooks",
         "url":"https://dev.azure.com/epicstuff/f8a98d9c-8f11-46ef-89e4-07b4a56d1ad5/_apis/build/Definitions/126"
      },
      "requests":[ 
         { 
            "id":6208,
            "url":"https://dev.azure.com/epicstuff/f8a98d9c-8f11-46ef-89e4-07b4a56d1ad5/_apis/build/Requests/6208",
            "requestedFor":{ 
               "displayName":"Samiya Akhtar",
               "id":"e8900b94-217f-4a51-9d86-6bbf5d82b6fb",
               "uniqueName":"saakhta@microsoft.com"
            }
         }
      ]
   },
   "resourceVersion":"1.0",
   "resourceContainers":{ 
      "collection":{ 
         "id":"b4ad2b30-c669-4749-9c24-e42a8da5d35d",
         "baseUrl":"https://dev.azure.com/epicstuff/"
      },
      "account":{ 
         "id":"5ba215af-08b5-44cc-8587-9f8b80f7799a",
         "baseUrl":"https://dev.azure.com/epicstuff/"
      },
      "project":{ 
         "id":"f8a98d9c-8f11-46ef-89e4-07b4a56d1ad5",
         "baseUrl":"https://dev.azure.com/epicstuff/"
      }
   },
   "createdDate":"2019-09-27T19:20:25.5808981Z"
}

[andrebriggs]

Added a write up of the spike here: https://github.com/andrebriggs/service-introspection

[samiyaakhtar]

Closing this task but created a few follow ups: #690, #686