ReportPortal js client

This Client is to communicate with the Report Portal on node js.

Library is used only for implementors of custom listeners for ReportPortal.

Already implemented listeners:

• EMPTY

Installation

The latest version is available on npm:

npm install reportportal-client

Example

let RPClient = require('reportportal-client');

let rpClient = new RPClient({
    token: "00000000-0000-0000-0000-000000000000",
    endpoint: "https://your-instance.com:8080/api/v1",
    launch: "LAUNCH_NAME",
    project: "PROJECT_NAME"
});

rpClient.checkConnect().then((response) => {
    console.log('You have successfully connected to the server.');
    console.log(`You are using an account: ${response.fullName}`);
}, (error) => {
    console.log('Error connection to server');
    console.dir(error);
});

Settings

When creating a client instance, you need to specify the following parameters:

Api

Each method (except checkConnect) returns an object in a specific format:

{
    tempId: '4ds43fs', // generated by the client id for further work with the created item
    promise: Promise // An object indicating the completion of an operation
}

The client works synchronously, so it is not necessary to wait for the end of the previous requests to send following ones.

checkConnect

checkConnect - asynchronous method for verifying the correctness of the client connection

rpClient.checkConnect().then((response) => {
    console.log('You have successfully connected to the server.');
    console.log(`You are using an account: ${response.fullName}`);
}, (error) => {
    console.log('Error connection to server');
    console.dir(error);
});

startLaunch

startLaunch - starts a new launch, return temp id that you want to use for all of the items within this launch.

let launchObj = rpClient.startLaunch({
    name: "Client test",
    startTime: rpClient.helpers.now(),
    description: "description of the launch",
    attributes: [
        {
            "key": "yourKey",
            "value": "yourValue"
        },
        {
            "value": "yourValue"
        }
    ],
    //this param used only when you need client to send data into the existing launch
    id: 'id'
});
console.log(launchObj.tempId);

The method takes one argument:

• launch data object:

To know the real launch id wait for the method to finish (the real id is not used by the client)

let launchObj = rpClient.startLaunch();
launchObj.promise.then((response) => {
    console.log(`Launch real id: ${response.id}`);
}, (error) => {
    console.dir(`Error at the start of launch: ${error}`);
})

finishLaunch

finishLaunch - finish of the launch. After calling this method, you can not add items to the launch. The request to finish the launch will be sent only after all items within it have finished.

// launchObj - object returned by method 'startLaunch'
let launchFinishObj = rpClient.finishLaunch(launchObj.tempId, {
    endTime: rpClient.helpers.now()
});

The method takes two arguments:

• id launch (returned by method 'startLaunch')
• data object:

getPromiseFinishAllItems

getPromiseFinishAllItems - returns promise that contains status about all data has been sent to the Report Protal. This method needed when test frameworks don't wait for async methods and stop processed.

// jasmine example. tempLaunchId - id of the client's process
agent.getPromiseFinishAllItems(agent.tempLaunchId).then(()=> done());

updateLaunch

updateLaunch - updates launch data. Will send a request to the server only after finishing the launch.

// launchObj - object returned by method 'startLaunch'
rpClient.updateLaunch(
    launchObj.tempId, {
        description: 'new launch description',
        attributes: [
            {
                "key": "yourKey",
                "value": "yourValue"
            },
            {
                "value": "yourValue"
            }
        ],
        mode: 'DEBUG'
    }
);

The method takes two arguments:

• id launch (returned by method 'startLaunch')
• data object - may contain the following fields: description, tags, mode. These fields can be looked up in the method "startLaunch".

startTestItem

startTestItem - starts a new test item.

// launchObj - object returned by method 'startLaunch'
let suiteObj = rpClient.startTestItem({
        description: makeid(),
        name: makeid(),
        startTime: rpClient.helpers.now(),
        type: "SUITE"
    }, launchObj.tempId);
let stepObj = rpClient.startTestItem({
        description: makeid(),
        name: makeid(),
        startTime: rpClient.helpers.now(),
        attributes: [

            {
                "key": "yourKey",
                "value": "yourValue"
            },
            {
                "value": "yourValue"
            }
        ],
        type: "STEP"
    }, launchObj.tempId, suiteObj.tempId);

The method takes three arguments:

• test item data object:

• id launch (returned by method 'startLaunch')
• id parent item (optional) (returned by method 'startTestItem')

finishTestItem

finishTestItem - finish of the item. After calling this method, you can not add items to the item. The request to finish the item will be sent only after all items within it have finished.

// itemObj - object returned by method 'startTestItem'
rpClient.finishTestItem(itemObj.tempId, {
    status: "failed"
})

The method takes two arguments:

• id item (returned by method 'startTestItem')
• data object:

Example issue object:

{
    issueType: "string",
    comment: "string",
    externalSystemIssues: [
        {
            submitDate: 0,
            submitter: "string",
            systemId: "string",
            ticketId: "string",
            url: "string"
        }
    ]
}

sendLog

sendLog - adds a log to the item

// stepObj - object returned by method 'startTestItem'
rpClient.sendLog(stepObj.tempId, {
    level: "INFO",
    message: makeid(),
    time: rpClient.helpers.now()
})

The method takes three arguments:

• id item (returned by method 'startTestItem')
• data object:

• file object (optional):

Copyright Notice

Licensed under the Apache 2.0 license (see the LICENSE.txt file).