@abhijoseph/reportportal-client 中文文档教程

Question

ReportPortal js client

此客户端用于与节点 js 上的报告门户通信。

库仅用于 ReportPortal 的自定义侦听器的实现者。

Already implemented listeners:

• EMPTY

Installation

最新版本在 npm 上可用：

npm install reportportal-client

Example

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

let rpClient = new RPClient({
    token: "00000000-0000-0000-0000-000000000000",
    endpoint: "http://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.full_name}`);
}, (error) => {
    console.log('Error connection to server');
    console.dir(error);
});

Settings

创建客户端实例时，需要指定以下参数：

Parameter	Description
token	user's token Report Portal from which you want to send requests. It can be found on the profile page of this user.
endpoint	URL of your server. For example, if you visit the page at 'https://server:8080/ui', then endpoint will be equal to 'https://server:8080/api/v1'.
launch	Name of launch at creation.
project	The name of the project in which the launches will be created.

Api

每个方法（checkConnect 除外）返回一个特定格式的对象：

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

客户端同步工作，因此无需等待发送后续请求的先前请求结束。

checkConnect

checkConnect - 用于验证客户端连接正确性的异步方法

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

startLaunch

startLaunch - 开始新的启动，返回要用于此启动中所有项目的临时 ID。

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

该方法采用一个参数：

• launch data object:

Parameter	Description
start_time	(optional) start time launch(unix time). Default: rpClient.helpers.now()
name	(optional) launch name. Default: parameter 'launch' specified when creating the client instance
mode	(optional) "DEFAULT" or "DEBUG". Default: "DEFAULT"
description	(optional) description of the launch (supports markdown syntax)
tags	(optional) array of launch tags
id	id of the existing launch in which tests data would be sent, without this param new launch instance would be created

要知道真正的启动 ID 等待方法完成（客户端不使用真实 ID）

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 - 启动完成。 调用该方法后，不能再向launch中添加items。 只有在其中的所有项目都完成后，才会发送完成启动的请求。

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

该方法有两个参数：

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

Parameter	Description
end_time	(optional) end time of launch. Default: rpClient.helpers.now()
status	(optional) status of launch, one of "", "PASSED", "FAILED", "STOPPED", "SKIPPED", "RESTED", "CANCELLED". Default: "".

getPromiseFinishAllItems

getPromiseFinishAllItems - 返回包含所有数据状态的承诺，这些数据已发送到 Report Protal。 当测试框架不等待异步方法并停止处理时需要此方法。

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

Parameter	Description
tempLaunchId	id of the client's process

updateLaunch

updateLaunch - 更新启动数据。 启动完成后才会向服务器发送请求。

// launchObj - object returned by method 'startLaunch'
rpClient.updateLaunch(
    launchObj.tempId, {
        description: 'new launch description',
        tags: ['new_tag1', 'new_tag2'],
        mode: 'DEBUG'
    }
);

该方法有两个参数：

• 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 - 启动一个新的测试项目。

// launchObj - object returned by method 'startLaunch'
let suiteObj = rpClient.startTestItem({
        description: makeid(),
        name: makeid(),
        start_time: rpClient.helpers.now(),
        type: "SUITE"
    }, launchObj.tempId);
let stepObj = rpClient.startTestItem({
        description: makeid(),
        name: makeid(),
        start_time: rpClient.helpers.now(),
        tags: ['step_tag', 'step_tag2', 'step_tag3'],
        type: "STEP"
    }, launchObj.tempId, suiteObj.tempId);

该方法采用三个参数：

• test item data object:

Parameter	Description
name	item name
type	Item type, one of 'SUITE', 'STORY', 'TEST', 'SCENARIO', 'STEP', 'BEFORECLASS', 'BEFOREGROUPS','BEFOREMETHOD', 'BEFORESUITE', 'BEFORETEST', 'AFTERCLASS', 'AFTERGROUPS', 'AFTERMETHOD', 'AFTERSUITE', 'AFTERTEST'
description	(optional) description of the launch (supports markdown syntax)
start_time	(optional) start time item(unix time). Default: rpClient.helpers.now()
tags	(optional) array of item tags

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

finishTestItem

finishTestItem - 项目的完成。 调用该方法后，不能向项目中添加项目。 完成该项目的请求将仅在其中的所有项目都完成后发送。

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

该方法采用两个参数：

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

Parameter	Description
end_time	(optional) end time of launch. Default: rpClient.helpers.now()
status	(optional) item status, one of "", "PASSED", "FAILED", "STOPPED", "SKIPPED", "RESTED", "CANCELLED". Default: "PASSED".
issue	(optional) object issue

示例问题对象：

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

sendLog

sendLog - 向项目添加日志

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

该方法采用三个参数：

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

Parameter	Description
time	(optional) time of log. Default: rpClient.helpers.now()
message	(optional) log message. Default: ''.
status	(optional) log status, one of 'trace', 'debug', 'info', 'warn', 'error', ''. Default "".

• file object (optional):

Parameter	Description
name	file name
type	file mimeType, example "image/png" (support types: 'image/*', application/ ['xml', 'javascript', 'json', 'css', 'php'] , another format will be opened in a new browser tab ),
content	file

Copyright Notice

在 GPLv3 许可证（请参阅 LICENSE.txt 文件）。