# Azure DevOps Test Plans Service

> @gmangiapelo/wdio-azure-devops-service is a 3rd party package, for more information please see [GitHub](https://github.com/gianlucamangiapelo/wdio-azure-devops-service) | [npm](https://www.npmjs.com/package/@gmangiapelo/wdio-azure-devops-service)

[![version](https://img.shields.io/npm/v/@gmangiapelo/wdio-azure-devops-service.svg)](https://www.npmjs.com/package/@gmangiapelo/wdio-azure-devops-service) [![downloads](https://img.shields.io/npm/dt/@gmangiapelo/wdio-azure-devops-service.svg)](https://www.npmjs.com/package/@gmangiapelo/wdio-azure-devops-service)

Publishes [WebdriverIO](https://webdriver.io/) results on Azure DevOps Test Plans.

Core features:

* Support for Jasmine/Jest/Mocha and Cucumber runtime frameworks
* Test results are aggregated under the same test run if you are executing more spec(test) files and they are belongs to the same suite
* Results are reported immediately after single test execution (real-time reporting)
* Test run is closed after last spec(test) file has been finished
* Multi suite support

## Installation[​](#installation "Direct link to Installation")

Install this module locally with the following command to be used as a (dev-)dependency:

```
npm install --save @gmangiapelo/wdio-azure-devops-service
npm install --save-dev @gmangiapelo/wdio-azure-devops-service
```

Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted)

## Usage[​](#usage "Direct link to Usage")

> *wdio-azure-devops-service* supports **NodeJS 8 or higher**

> *wdio-azure-devops-service* supports **commonjs** and **esm**

### Configuration[​](#configuration "Direct link to Configuration")

Since `@gmangiapelo/wdio-azure-devops-service` is a service, you can set it up in your `wdio.conf.js` file as follows

```
import AzureDevopsService from "@gmangiapelo/wdio-azure-devops-service";
// wdio.conf.js
exports.config = {
    // ...
    // =====
    // Setup
    // =====
    services: [
        [
              AzureDevopsService,
              {
                  pat: '3qaPw0PnOyQ6mb8gwN7n9aIQtccn8FtsZ2s1tSIzo6yAt6eK9BInJQGJ99BDACAAAAAu9TDCAAASAZDO2Onn',
                  organizationUrl: 'https://dev.azure.com/gianlucamangiapelo',
                  projectId: '8b3c68ac-f69d-41c6-bbad-921d8bae9819',
                  planId: 263072,
                  suiteId: 263073,
                  caseIdRegex: '@?[ref](https://github.com/gianlucamangiapelo/wdio-azure-devops-service/blob/main/\\d+)',
                  runName: 'FE regression tests for TestPlan',
              },
          ],
    ],
    // ...
};
```

### Test case setup[​](#test-case-setup "Direct link to Test case setup")

Your WDIO tests should include the ID of your Azure test case. Make sure your test case IDs are distinct from your test titles:

**Mocha style:**

```
// Good:
it("C123 Can authenticate a valid user", ...

// Bad:
it("C123Can authenticate a valid user", ...
it("Can authenticate a valid user C123", ...
```

**Cucumber style:**

```
## Good:
@C123
Scenario Can authenticate a valid user
@c123
Scenario Can authenticate a valid user,

## Bad:
@c123stringTest
Scenario Can authenticate a valid user
```

### Azure DevOps Report Example[​](#azure-devops-report-example "Direct link to Azure DevOps Report Example")

This is an example of the results pushed on AZ Test Plans, during a test run ![AzureDevops Test Plans example](https://github.com/gianlucamangiapelo/wdio-azure-devops-service/blob/main/./img/AZ-DevOps-example.png)

<br />

## Service Options[​](#service-options "Direct link to Service Options")

### pat[​](#pat "Direct link to pat")

The Personal Access token generated in Azure DevOps with API permission set.

Example: `"3qaPw0PnOyQ6mb8gwN7n9aIQtccn8FtsZ2s1tSIzo6yAt6eK9BInJQGJ99BDACAAAAAu9TDCAAASAZDO2Onn"`

Type: `string`

Required: `true`

### organizationUrl[​](#organizationurl "Direct link to organizationUrl")

The base url of your Azure DevOps instance.

Example: `"https://dev.azure.com/gianlucamangiapelo"`

Type: `string`

Required: `true`

### projectId[​](#projectid "Direct link to projectId")

The id of the project in Azure DevOps.

To find the projectId use `GET {organizationUrl}/_apis/projects?api-version=6.0` and copy the appropriate `id`.

Example: `"3cf7dbc9-cb1e-4240-93f2-9a5960ab3945"`

Type: `string`

Required: `true`

### planId[​](#planid "Direct link to planId")

The test plainId that you can retrieve in Azure DevOps Test Plan section.

Example: `124`

Type: `integer`

Required: `true`

### suiteId[​](#suiteid "Direct link to suiteId")

The suiteId that you can retrieve in Azure DevOps Test Plan section, in case of nested suites, get the root suiteId, the service iterates over all the child suites.

Example: `21`

Type: `integer`

Required: `true`

### runName[​](#runname "Direct link to runName")

A descriptive name for the test run.

Example: `"FE regression tests run"`

Type: `string`

Required: `true`

### caseIdRegex[​](#caseidregex "Direct link to caseIdRegex")

Custom regular expression to match the testCaseId from tag or title test case.

Type: `string`

Default: `"@?[cC](https://github.com/gianlucamangiapelo/wdio-azure-devops-service/blob/main/\d+)"`

Required: `false`

## Author[​](#author "Direct link to Author")

Gianluca Mangiapelo - [github](https://github.com/gianlucamangiapelo)