Merge pull request #106 from reportportal/develop

Release 5.0.4
reportportal · May 30, 2022 · 99dda22 · 99dda22
2 parents c6d82a8 + 43ce73f
commit 99dda22
Show file tree

Hide file tree

Showing 15 changed files with 2,259 additions and 4,957 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -62,6 +62,10 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+            node-version: '12'
       - name: Configure git
         run: |
           git config --global user.email "reportportal.io"

diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,6 @@ node_modules/
 # ide
 .idea/
 
+coverage/
+
 .npmrc
diff --git a/.npmignore b/.npmignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+### Added
+- Possibility to provide endpoint url via `RP_ENDPOINT` environment variable
+- New [option](./README.md#loglaunchlink-flag) `logLaunchLink` to print launch url in console
+
+### Fixed
+- The duration of tests and suites is now displayed correctly
+- The reporter will now wait for a report on all tests
+- Security vulnerabilities
+- Tests without describe block causes error [#82](https://github.com/reportportal/agent-js-jest/issues/82)
+
+### Changed
+- Package size reduced
 
 ## [5.0.3] - 2021-06-23
 ### Fixed

diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@ In your jest config section of `package.json`, add the following entry:
                 "project": "YourReportPortalProjectName",
                 "launch": "YourLauncherName",
                 "description": "YourDescription",
+                "logLaunchLink": true,
                 "attributes": [
                     {
                         "key": "YourKey",
@@ -60,6 +61,7 @@ module.exports = {
                 "project": "YourReportPortalProjectName",
                 "launch": "YourLauncherName",
                 "description": "YourDescription",
+                "logLaunchLink": true,
                 "attributes": [
                     {
                         "key": "YourKey",
@@ -80,8 +82,10 @@ It's possible by using environment variables, it's important to mention that env
 ```shell
 $ export RP_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 $ export RP_PROJECT_NAME=MY_AWESOME_PROJECT
+$ export RP_ENDPOINT=MY_RP_ENDPOINT
 $ export RP_LAUNCH=MY_COOL_LAUNCHER
 $ export RP_ATTRIBUTES=key:value,key:value,value
+$ export RP_LAUNCH_ID=EXIST_LAUNCH_ID
 ```
 
 This for your convenience in case you has a continuous job that run your tests and may post the results pointing to a different Report Portal definition of project, launcher name or tags.
@@ -139,6 +143,16 @@ Example:
 "debug": true
 ```
 
+## LogLaunchLink flag:
+
+This flag allows print the URL of the Launch of the tests in console.
+
+Example:
+
+```json
+"logLaunchLink": true
+```
+
 ## REST Client config:
 
 Optional property.<br/>

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-5.0.3
+5.0.4-SNAPSHOT
diff --git a/__tests__/getOptions.spec.js b/__tests__/getOptions.spec.js
@@ -22,8 +22,8 @@ const {
     options,
     getAppOptions,
     getEnvOptions,
-} = require('./../utils/getOptions');
-const constants = require('./../constants/index');
+} = require('../utils/getOptions');
+const constants = require('../constants/index');
 
 describe('Get Options script', () => {
     const OLD_ENV = process.env;

diff --git a/__tests__/index.spec.js b/__tests__/index.spec.js
@@ -18,7 +18,7 @@
 const path = require('path');
 const { getOptions, RPClient } = require('./mocks/reportportal-client.mock');
 const JestReportPortal = require('../index');
-const pjson = require('./../package.json');
+const pjson = require('../package.json');
 
 const testItemStatuses = { PASSED: 'passed', FAILED: 'failed', SKIPPED: 'pending' };
 const GLOBAL_CONFIG = {};
@@ -30,6 +30,7 @@ const systemAttr = {
     value: `${pjson.name}|${pjson.version}`,
     system: true,
 };
+const duration = 5;
 const testResult = {
     testResults: [
         {
@@ -38,6 +39,7 @@ const testResult = {
             ancestorTitles: ['Suite name', 'Test name'],
             failureMessages: 'error message',
             invocations: 1,
+            duration,
         },
     ],
 };
@@ -117,8 +119,10 @@ describe('index script', () => {
 
             reporter.onTestResult(testObj, testResult);
 
-            expect(spyStartSuite).toHaveBeenCalledWith(testResult.testResults[0].ancestorTitles[0], testObj.path);
-            expect(spyStartTest).toHaveBeenCalledWith(testResult.testResults[0], testObj.path);
+            expect(spyStartSuite).toHaveBeenCalledWith(
+                testResult.testResults[0].ancestorTitles[0], testObj.path, duration,
+            );
+            expect(spyStartTest).toHaveBeenCalledWith(testResult.testResults[0], testObj.path, duration);
             expect(spyStartStep).toHaveBeenCalledWith(testResult.testResults[0], false, testObj.path);
             expect(spyFinishStep).toHaveBeenCalledWith(testResult.testResults[0], false);
             expect(spyFinishTest).toHaveBeenCalledWith('1234', 'tempTestId');
@@ -203,10 +207,10 @@ describe('index script', () => {
     });
 
     describe('onRunComplete', () => {
-        test('finishLaunch should be called with tempLaunchId', () => {
+        test('finishLaunch should be called with tempLaunchId', async () => {
             reporter.tempLaunchId = 'tempLaunchId';
 
-            reporter.onRunComplete();
+            await reporter.onRunComplete();
 
             expect(reporter.client.finishLaunch).toHaveBeenCalledWith('tempLaunchId');
         });
@@ -220,12 +224,12 @@ describe('index script', () => {
                 type: 'SUITE',
                 name: 'suite name',
                 codeRef: 'example.js/suite name',
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
             const expectedTempSuiteIds = new Map([['suite name', 'startTestItem']]);
             reporter.tempLaunchId = 'tempLaunchId';
 
-            reporter._startSuite('suite name', testObj.path);
+            reporter._startSuite('suite name', testObj.path, duration);
 
             expect(reporter.client.startTestItem).toHaveBeenCalledWith(expectedStartTestItemParameter, 'tempLaunchId');
             expect(reporter.tempSuiteIds).toEqual(expectedTempSuiteIds);
@@ -248,13 +252,13 @@ describe('index script', () => {
                 type: 'TEST',
                 name: 'Test name',
                 codeRef: 'example.js/Suite name/Test name',
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
             const expectedTempTestIds = new Map([['Suite name/Test name', 'startTestItem']]);
             reporter.tempLaunchId = 'tempLaunchId';
             reporter.tempSuiteIds = new Map([['Suite name', 'suiteId']]);
 
-            reporter._startTest({ ancestorTitles: ['Suite name', 'Test name'] }, testObj.path);
+            reporter._startTest({ ancestorTitles: ['Suite name', 'Test name'] }, testObj.path, duration);
 
             expect(reporter.client.startTestItem)
                 .toHaveBeenCalledWith(expectedStartTestItemParameter, 'tempLaunchId', 'suiteId');
@@ -278,12 +282,12 @@ describe('index script', () => {
                 name: 'Step',
                 codeRef: 'example.js/Suite/Test/Step',
                 retry: true,
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
             reporter.tempLaunchId = 'tempLaunchId';
             reporter.tempTestIds = new Map([['Suite/Test', 'tempTestId']]);
 
-            reporter._startStep({ title: 'Step', ancestorTitles: ['Suite', 'Test'] }, true, testObj.path);
+            reporter._startStep({ title: 'Step', ancestorTitles: ['Suite', 'Test'], duration }, true, testObj.path);
 
             expect(reporter.client.startTestItem)
                 .toHaveBeenCalledWith(expectedStartStepItemParameter, 'tempLaunchId', 'tempTestId');
@@ -297,12 +301,12 @@ describe('index script', () => {
                 name: 'Step',
                 codeRef: 'example.js/Suite/Step',
                 retry: true,
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
             reporter.tempLaunchId = 'tempLaunchId';
             reporter.tempSuiteIds = new Map([['Suite', 'tempSuiteId']]);
 
-            reporter._startStep({ title: 'Step', ancestorTitles: ['Suite'] }, true, testObj.path);
+            reporter._startStep({ title: 'Step', ancestorTitles: ['Suite'], duration }, true, testObj.path);
 
             expect(reporter.client.startTestItem)
                 .toHaveBeenCalledWith(expectedStartStepItemParameter, 'tempLaunchId', 'tempSuiteId');

diff --git a/__tests__/mocks/reportportal-client.mock.js b/__tests__/mocks/reportportal-client.mock.js
@@ -20,6 +20,7 @@ const reporterOptions = {
     project: 'projectName',
     launch: 'launcherName',
     description: 'description',
+    logLaunchLink: true,
     attributes: [
         {
             key: 'YourKey',
@@ -77,6 +78,6 @@ class RPClient {
 }
 
 module.exports = {
-    getOptions: options => Object.assign(reporterOptions, options),
+    getOptions: (options) => Object.assign(reporterOptions, options),
     RPClient,
 };
diff --git a/__tests__/objectUtils.spec.js b/__tests__/objectUtils.spec.js
@@ -27,8 +27,8 @@ const {
     getFullTestName,
     getFullStepName,
     getSystemAttributes,
-} = require('./../utils/objectUtils');
-const pjson = require('./../package.json');
+} = require('../utils/objectUtils');
+const pjson = require('../package.json');
 
 const defaultOptions = {
     launch: 'launchName',
@@ -46,6 +46,7 @@ const defaultOptions = {
 };
 const currentDate = new Date();
 const RealDate = Date;
+const duration = 5;
 
 describe('Object Utils script', () => {
     const OLD_ENV = process.env;
@@ -124,10 +125,10 @@ describe('Object Utils script', () => {
                 type: 'STEP',
                 name: 'step title',
                 retry: true,
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
 
-            const stepStartObject = getStepStartObject('step title', true);
+            const stepStartObject = getStepStartObject('step title', true, undefined, duration);
 
             expect(stepStartObject).toBeDefined();
             expect(stepStartObject).toEqual(expectedStepStartObject);
@@ -139,10 +140,10 @@ describe('Object Utils script', () => {
             const expectedTestStartObject = {
                 type: 'TEST',
                 name: 'test title',
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
 
-            const testStartObject = getTestStartObject('test title');
+            const testStartObject = getTestStartObject('test title', undefined, duration);
 
             expect(testStartObject).toBeDefined();
             expect(testStartObject).toEqual(expectedTestStartObject);
@@ -154,10 +155,10 @@ describe('Object Utils script', () => {
             const expectedSuiteStartObject = {
                 type: 'SUITE',
                 name: 'suite name',
-                startTime: new Date().valueOf(),
+                startTime: new Date().valueOf() - duration,
             };
 
-            const suiteStartObject = getSuiteStartObject('suite name');
+            const suiteStartObject = getSuiteStartObject('suite name', undefined, duration);
 
             expect(suiteStartObject).toBeDefined();
             expect(suiteStartObject).toEqual(expectedSuiteStartObject);