@microfocus/alm-octane-test-result-convertion

1. Introduction 🚀

In the following documentation, the OpenText Core Software Delivery Platform and OpenText Software Delivery Management will collectively be referred to as 'the product'.

This is a Node.JS library for converting different kinds of test reports into the product's format.

---

2. Table of Contents

- 1. Introduction
- 2. Table of Contents
- 3. Supported Formats
- 4. Getting Started
- 4.1. Install Package
- 4.2. Usage Examples
- 4.2.1. Convert JUnit results
- 4.2.2. Convert Gherkin results
- 5. Change log

---

3. Supported Formats

The tool supports the following test result formats which can be converted to the format accepted by the product (documentation reference):

- JUnit
- Gherkin

---

4. Getting Started

$3

The library is released as a NPM package: @microfocus/alm-octane-test-result-convertion

Run the following command to install the package via NPM in your project:

``bash
$ npm i @microfocus/alm-octane-test-result-convertion
`

After installing the package, you can import the method needed for convestion as shown below.

---

$3

#### 4.2.1. Convert JUnit results

`typescript
import {convertJUnitXMLToOctaneXML} from '@microfocus/alm-octane-test-result-convertion';

const buildConfig = {
build_id: '123',
job_id: 'myJob',
server_id: 'serverId'
};

const xml = fs
.readFileSync(TestResources.XML_ONE_TEST_SUITE_PATH)
.toString();

const convertedXML = convertJUnitXMLToOctaneXML(xml, buildConfig, FrameworkType.JUnit);
`

#### 4.2.2. Convert Gherkin results

`typescript
import {convertGherkinXMLToOctaneXML} from '@microfocus/alm-octane-test-result-convertion';

const buildConfig = {
build_id: '123',
job_id: 'myJob',
server_id: 'serverId'
};

const xml = fs
.readFileSync(TestResources.GHERKIN_TWO_FEATURES_PATH)
.toString();

const convertedXML = convertGherkinXMLToOctaneXML(xml, buildConfig, FrameworkType.Cucumber);
`

5. Change log

$3


- Convert RobotFramework test results to the product's format XML via the convertJUnitXMLToOctaneXML method.

$3

- Add external_run_id to test run's properties for test results with multiple test suites.

$3

- Add external_run_id to test run's properties.

$3

- Add artifact_id as a build property into the OctaneBuildConfig interface.

$3

- Convert Gherkin test results to the product's format XML via the convertGherkinXMLToOctaneXML method.

$3

- Fix issue causing skipped test cases to be treated as passed.

$3

- Allows conversion from JUnit format XML to the product's format XML via the convertJUnitXMLToOctaneXML` method.