Adding a log file to an Azure DevOps Test Execution

Question

Adding a log file to an Azure DevOps Test Execution

I have been encountering difficulties when trying to upload the log file generated from my automated tests in the Azure Release pipeline. My automated UI tests are conducted using selenium and MSTest. Initially, I believed that I could attach the file in the AssemblyCleanup Method of MSTest by utilizing the TestContext object. However, it turns out that the TestContext can only be utilized for attaching results to individual test cases. After some research online, I stumbled upon this API call:

POST {Organization}/{Project}/_apis/test/Runs/{runId}/attachments?api-version=5.1-preview.1

referenced in the Microsoft Documentation: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/attachments/create%20test%20result%20attachment?view=azure-devops-rest-5.1

Unfortunately, I am unsure about how to obtain the test runId within my test code or how to authenticate with OAuth2. Below is as far as I have progressed using RestSharp to make the call;

RestClient httpClient = new RestClient("");
//I am uncertain if this includes the correct OAuth details
httpClient.Authenticator = new RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator("");
RestRequest request = new RestRequest(Method.POST);
APIRequestBody body = new APIRequestBody
{
    //unsure if this is the accurate stream
    Stream = "",//not sure what to put in here
    FileName = "TestRun.log",
    Comment = "Test run log file.",
    AttachmentType = "GeneralAttachment"
};
request.AddJsonBody(body);
IRestResponse response = httpClient.Execute(request);

Any assistance would be greatly appreciated; I feel a bit overwhelmed by all of this.

c#selenium azure-devops mstest web-api-testing

Answer 1

Answer №1

If you're looking to call a restful api in C# using HttpClient with a Personal Access Token, check out the code example below. To obtain your Personal Access Token, follow the steps outlined here.

public static async void GetProjects()
{
    try
    {
        var personalaccesstoken = "PAT_FROM_WEBSITE";

        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Accept.Add(
                new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
                Convert.ToBase64String(
                    System.Text.ASCIIEncoding.ASCII.GetBytes(
                        string.Format("{0}:{1}", "", personalaccesstoken))));

            using (HttpResponseMessage response = await client.GetAsync(
                        "https://dev.azure.com/{organization}/_apis/projects"))
            {
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.ToString());
    }
}

The example provided above is sourced from Microsoft's documentation. Feel free to explore it further.

If you need a test runId, consider calling the test runs API to retrieve a list of test runs and extract the current runid from the Response.

GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=5.1

I hope the information above proves helpful.

Answer 2

If you're looking to call a restful api in C# using HttpClient with a Personal Access Token, check out the code example below. To obtain your Personal Access Token, follow the steps outlined here.

public static async void GetProjects()
{
    try
    {
        var personalaccesstoken = "PAT_FROM_WEBSITE";

        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Accept.Add(
                new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
                Convert.ToBase64String(
                    System.Text.ASCIIEncoding.ASCII.GetBytes(
                        string.Format("{0}:{1}", "", personalaccesstoken))));

            using (HttpResponseMessage response = await client.GetAsync(
                        "https://dev.azure.com/{organization}/_apis/projects"))
            {
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.ToString());
    }
}

The example provided above is sourced from Microsoft's documentation. Feel free to explore it further.

If you need a test runId, consider calling the test runs API to retrieve a list of test runs and extract the current runid from the Response.

GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=5.1

I hope the information above proves helpful.

Adding a log file to an Azure DevOps Test Execution

Answer №1

Similar questions

Handling session expiration in ASP.NET MVC when making an AJAX call by redirecting to the login page

The C# MVC Controller is having difficulty retrieving decimal or double values from an Ajax POST request

Implementing JSON methods in C# WebService to enable communication with external servers

Contrasting the uses of element(...) versus element(...).getWebElement() in Protractor

What is the best approach for finding the xPath of this specific element?

Showing C# File Content in JavaScript - A Step-by-Step Guide

Executing selenium tests on Internet Explorer 11 on a Windows 10 1809 machine without encountering any new pop-up windows

Is there a way to trigger a JavaScript function upon checking a checkbox?

Automating testing with JavaScript and Selenium WebDriver

Obtain the text that is shown for an input field

"Displaying a popup message prompting users to refresh the page after clicking

What is the best way to duplicate an entire webpage with all its content intact?

I am attempting to access data through an ajax function, but it is not functioning correctly

Encountering an issue with WebDriver in the realm of JavaScript

Working with JSON in AJAX with Javascript and C# to handle array data

Utilizing JavaScript to call functions from an ASP.NET code file

When items are removed client-side, the Listbox becomes null

Using Selenium to interact with a link's href attribute through JavaScript

Testing a cucumber scenario by comparing the redirect URL with a different URL

A combination of Tor Browser, Selenium, and Javascript for