reportportal-client - npm Package Compare versions

Comparing version 5.2.3 to 5.5.0

examples/README.md

@@ -0,0 +0,0 @@ # Report Portal client-javascript example

examples/testConnect.js

@@ -13,3 +13,3 @@ /* eslint-disable no-console */
     console.log('You have successfully connected to the server.');
-    console.log(`You are using an account: ${response.full_name}`);
+    console.log(`You are using an account: ${response.fullName}`);
 }, (error) => {
@@ -16,0 +16,0 @@ console.log('Error connection to server');

lib/helpers.js

@@ -0,0 +0,0 @@ const fs = require('fs');

lib/report-portal-client.js

@@ -108,5 +108,11 @@ /* eslint-disable quotes,no-console,class-methods-use-this */
             "name": "string",
-            "start_time": this.helper.now(),
-            "tags": [
-              "string"
+            "startTime": this.helper.now(),
+            "attributes": [
+                {
+                    "key": "string",
+                    "value": "string"
+                },
+                {
+                    "value": "string"
+                }
             ]
@@ -134,3 +140,3 @@ * }
             const launchData = Object.assign(
-                { name: this.config.launch || 'Test launch name', start_time: this.helpers.now() },
+                { name: this.config.launch || 'Test launch name', startTime: this.helpers.now() },
                 launchDataRQ,
@@ -169,4 +175,4 @@ );
      * {
-     *      "end_time": this.helper.now(),
-     *      "status": "PASSED" or one of ‘PASSED’, ‘FAILED’, ‘STOPPED’, ‘SKIPPED’, ‘RESTED’, ‘CANCELLED’
+     *      "endTime": this.helper.now(),
+     *      "status": "passed" or one of ‘passed’, ‘failed’, ‘stopped’, ‘skipped’, ‘interrupted’, ‘cancelled’
      * }
@@ -181,3 +187,3 @@ * @Returns {Object} - an object which contains a tempID and a promise
 
-        const finishExecutionData = Object.assign({ end_time: this.helpers.now(), status: '' }, finishExecutionRQ);
+        const finishExecutionData = Object.assign({ endTime: this.helpers.now() }, finishExecutionRQ);
 
@@ -221,9 +227,9 @@ launchObj.finishSend = true;
             description: "Merged launch",
-            end_time: this.helpers.now(),
+            endTime: this.helpers.now(),
             extendSuitesDescription: true,
             launches: launchIds,
-            merge_type: "BASIC",
+            mergeType: "BASIC",
             mode: "DEFAULT",
             name: this.config.launch || 'Test launch name',
-            tags: this.config.tags,
+            attributes: this.config.attributes,
         };
@@ -274,4 +280,10 @@ }
             "mode": "DEFAULT" or "DEBUG",
-            "tags": [
-                "string"
+            "attributes": [
+                {
+                    "key": "string",
+                    "value": "string"
+                },
+                {
+                    "value": "string"
+                }
             ]
@@ -318,5 +330,11 @@ }
             "name": "string",
-            "start_time": this.helper.now(),
-             "tags": [
-               "string"
+            "startTime": this.helper.now(),
+             "attributes": [
+                {
+                    "key": "string",
+                    "value": "string"
+                },
+                {
+                    "value": "string"
+                }
              ],
@@ -344,3 +362,3 @@ "type": 'SUITE' or one of 'SUITE', 'STORY', 'TEST',
 
-        const testItemData = Object.assign({ start_time: this.helpers.now() }, testItemDataRQ);
+        const testItemData = Object.assign({ startTime: this.helpers.now() }, testItemDataRQ);
 
@@ -366,3 +384,3 @@ let parentPromise = launchObj.promiseStart;
                 }
-                testItemData.launch_id = realLaunchId;
+                testItemData.launchUuid = realLaunchId;
                 this.logDebug(`Start test item ${tempId}`);
@@ -397,3 +415,3 @@ this.restClient.create(url, testItemData, { headers: this.headers })
      {
-        "end_time": this.helper.now(),
+        "endTime": this.helper.now(),
         "issue": {
@@ -410,5 +428,5 @@ "comment": "string",
           ],
-          "issue_type": "string"
+          "issueType": "string"
         },
-        "status": "PASSED" or one of 'PASSED', 'FAILED', 'STOPPED', 'SKIPPED', 'RESETED', 'CANCELLED'
+        "status": "passed" or one of 'passed', 'failed', 'stopped', 'skipped', 'interrupted', 'cancelled'
      }
@@ -424,4 +442,4 @@ * @Returns {Object} - an object which contains a tempId and a promise
         const finishTestItemData = Object.assign({
-            end_time: this.helpers.now(),
-            status: 'PASSED',
+            endTime: this.helpers.now(),
+            status: 'passed',
         }, finishTestItemRQ);
@@ -509,3 +527,3 @@
             // eslint-disable-next-line no-param-reassign
-            saveLogRQ.item_id = id;
+            saveLogRQ.itemUuid = id;
             return this.restClient.create(url, saveLogRQ, { headers: this.headers });
@@ -545,3 +563,3 @@ };
             // eslint-disable-next-line no-param-reassign
-            saveLogRQ.item_id = id;
+            saveLogRQ.itemUuid = id;
             return this.getRequestLogWithFile(saveLogRQ, fileObj);
@@ -548,0 +566,0 @@ };

lib/rest.js

@@ -0,0 +0,0 @@ const axios = require('axios');

LICENSE.txt

@@ -0,0 +0,0 @@ Apache License

package.json

 {
   "name": "reportportal-client",
-  "version": "5.2.3",
+  "version": "5.5.0",
   "description": "ReportPortal client for node.js",
@@ -33,3 +33,3 @@ "contributors": [
   },
-  "license": "GPL-3.0",
+  "license": "Apache-2.0",
   "scripts": {
@@ -36,0 +36,0 @@ "lint": "eslint . --quiet",

README.md

 [![Build Status](https://travis-ci.org/reportportal/client-javascript.svg?branch=master)](https://travis-ci.org/reportportal/client-javascript)[![Code Coverage](https://codecov.io/gh/reportportal/client-javascript/branch/master/graph/badge.svg)](https://codecov.io/gh/reportportal/client-javascript)[![npm version](https://badge.fury.io/js/reportportal-client.svg)](https://badge.fury.io/js/reportportal-client)
 
-# ReportPortal js client 
+# ReportPortal js client
 This Client is to communicate with the Report Portal on node js.
@@ -17,3 +17,3 @@
 ```
-    
+
 ## Example
@@ -33,3 +33,3 @@
     console.log('You have successfully connected to the server.');
-    console.log(`You are using an account: ${response.full_name}`);
+    console.log(`You are using an account: ${response.fullName}`);
 }, (error) => {
@@ -66,3 +66,3 @@ console.log('Error connection to server');
     console.log('You have successfully connected to the server.');
-    console.log(`You are using an account: ${response.full_name}`);
+    console.log(`You are using an account: ${response.fullName}`);
 }, (error) => {
@@ -79,5 +79,13 @@ console.log('Error connection to server');
     name: "Client test",
-    start_time: rpClient.helpers.now(),
+    startTime: rpClient.helpers.now(),
     description: "description of the launch",
-    tags: ["tag1", "tag2"],
+    attributes: [
+        {
+            "key": "yourKey",
+            "value": "yourValue"
+        },
+        {
+            "value": "yourValue"
+        }
+    ],
     //this param used only when you need client to send data into the existing launch
@@ -93,7 +101,7 @@ id: 'id'
 --------- | -----------
-start_time | (optional) start time launch(unix time). Default: rpClient.helpers.now()
+startTime | (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
+attributes  | (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
@@ -117,3 +125,3 @@
 let launchFinishObj = rpClient.finishLaunch(launchObj.tempId, {
-    end_time: rpClient.helpers.now()
+    endTime: rpClient.helpers.now()
 });
@@ -127,4 +135,4 @@ ```
 --------- | -----------
-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: "".
+endTime  | (optional) end time of launch. Default: rpClient.helpers.now()
+status    | (optional) status of launch, one of "", "PASSED", "FAILED", "STOPPED", "SKIPPED", "INTERRUPTED", "CANCELLED".
 
@@ -150,3 +158,11 @@ ### getPromiseFinishAllItems
         description: 'new launch description',
-        tags: ['new_tag1', 'new_tag2'],
+        attributes: [
+            {
+                "key": "yourKey",
+                "value": "yourValue"
+            },
+            {
+                "value": "yourValue"
+            }
+        ],
         mode: 'DEBUG'
@@ -167,3 +183,3 @@ }
         name: makeid(),
-        start_time: rpClient.helpers.now(),
+        startTime: rpClient.helpers.now(),
         type: "SUITE"
@@ -174,4 +190,13 @@ }, launchObj.tempId);
         name: makeid(),
-        start_time: rpClient.helpers.now(),
-        tags: ['step_tag', 'step_tag2', 'step_tag3'],
+        startTime: rpClient.helpers.now(),
+        attributes: [
+
+            {
+                "key": "yourKey",
+                "value": "yourValue"
+            },
+            {
+                "value": "yourValue"
+            }
+        ],
         type: "STEP"
@@ -189,4 +214,4 @@ }, launchObj.tempId, suiteObj.tempId);
 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
+startTime  | (optional) start time item(unix time). Default: rpClient.helpers.now()
+attributes        | (optional) array of item attributes
 
@@ -212,5 +237,5 @@ * id launch (returned by method 'startLaunch')
 --------- | -----------
-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 
+endTime  | (optional) end time of launch. Default: rpClient.helpers.now()
+status    | (optional) item status, one of "", "PASSED", "FAILED", "STOPPED", "SKIPPED", "INTERRUPTED", "CANCELLED". Default: "PASSED".
+issue     | (optional) object issue. IssueType is required, allowable values: "pb***", "ab***", "si***", "ti***", "nd001". Where *** is locator id
 
@@ -220,2 +245,3 @@ Example issue object:
 {
+    issueType: "string",
     comment: "string",
@@ -263,3 +289,3 @@ externalSystemIssues: [
 # Copyright Notice
-Licensed under the [GPLv3](https://www.gnu.org/licenses/quick-guide-gplv3.html)
+Licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)
 license (see the LICENSE.txt file).

spec/helper.spec.js

@@ -0,0 +0,0 @@ const RPClient = require('../lib/report-portal-client.js');

spec/libSpec.js

@@ -27,7 +27,7 @@ /* eslint-disable global-require,no-underscore-dangle */
             client.startLaunch({
-                start_time: time,
+                startTime: time,
             });
             expect(client.restClient.create).toHaveBeenCalledWith('launch', {
                 name: 'Test launch name',
-                start_time: time,
+                startTime: time,
             }, { headers: client.headers });
@@ -42,6 +42,6 @@ });
             description: 'Merged launch',
-            end_time: fakeEndTime,
+            endTime: fakeEndTime,
             extendSuitesDescription: true,
             launches: fakeLaunchIds,
-            merge_type: 'BASIC',
+            mergeType: 'BASIC',
             mode: 'DEFAULT',
@@ -48,0 +48,0 @@ name: 'Test launch name',

spec/rest.spec.js

@@ -0,0 +0,0 @@ const nock = require('nock');

spec/support/jasmine.json

@@ -0,0 +0,0 @@ {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

138635

increased by2.59%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by42.86%

Lines of code

1425

increased by3.34%

Number of lines in readme file

278

increased by10.32%

No dependency changes