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

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

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

4.1. Install Package

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:

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

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

4.2. Usage Examples

4.2.1. Convert JUnit results

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

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);