Merge pull request #93 from reportportal/develop

Release 5.2.0
reportportal · Oct 3, 2024 · a369129 · a369129
2 parents b5943a9 + 8aeaaf6
commit a369129
Show file tree

Hide file tree

Showing 13 changed files with 353 additions and 196 deletions.
diff --git a/.github/workflows/CI-pipeline.yml b/.github/workflows/CI-pipeline.yml
@@ -37,5 +37,5 @@ jobs:
         run: npm install
       - name: Run lint
         run: npm run lint
-      - name: Check coverage
+      - name: Run tests and check coverage
         run: npm run test:coverage
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -31,9 +31,7 @@ jobs:
         run: npm install
       - name: Run lint
         run: npm run lint
-      - name: Run tests
-        run: npm test
-      - name: Check coverage
+      - name: Run tests and check coverage
         run: npm run test:coverage
 
   publish-to-npm-and-gpr:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+### Changed
+- **Breaking change** Drop support of Node.js 12. The version [5.1.0](https://github.com/reportportal/agent-js-jasmine/releases/tag/v5.1.0) is the latest that supports it.
+- The agent now supports reporting the time for launches, test items and logs with microsecond precision in the ISO string format.
+For logs, microsecond precision is available on the UI from ReportPortal [version 24.2](https://reportportal.io/docs/releases/Version24.2/#:~:text=import%20plugin.-,Microseconds,-added%20to%20timestamps).
+- `@reportportal/client-javascript` bumped to version `5.3.0`.
+### Security
+- Updated versions of vulnerable packages (micromatch).
 
 ## [5.1.0] - 2024-07-16
 ### Added

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Agent to integrate Jasmine with ReportPortal.
 * More about [Jasmine](https://jasmine.github.io/)
-* More about [ReportPortal](http://reportportal.io/)
+* More about [ReportPortal](https://reportportal.io/)
 
 ## Installation
 
@@ -43,7 +43,7 @@ The full list of available options presented below.
 | project               | Required   |           | The name of the project in which the launches will be created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | attributes            | Optional   | []        | Launch attributes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | description           | Optional   | ''        | Launch description.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| rerun                 | Optional   | false     | Enable [rerun](https://reportportal.io/docs/dev-guides/RerunDevelopersGuide)                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| rerun                 | Optional   | false     | Enable [rerun](https://reportportal.io/docs/developers-guides/RerunDevelopersGuide/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | rerunOf               | Optional   | Not set   | UUID of launch you want to rerun. If not specified, ReportPortal will update the latest launch with the same name                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | mode                  | Optional   | 'DEFAULT' | Results will be submitted to Launches page <br/> *'DEBUG'* - Results will be submitted to Debug page.                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | skippedIssue          | Optional   | true      | ReportPortal provides feature to mark skipped tests as not 'To Investigate'. <br/> Option could be equal boolean values: <br/> *true* - skipped tests considered as issues and will be marked as 'To Investigate' on ReportPortal. <br/> *false* - skipped tests will not be marked as 'To Investigate' on application.                                                                                                                                                                                                                          |

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-5.1.0
+5.1.1-SNAPSHOT
diff --git a/__mocks__/@reportportal/client-javascript.js b/__mocks__/@reportportal/client-javascript.js
@@ -0,0 +1,54 @@
+/*
+ *  Copyright 2024 EPAM Systems
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+
+class RPClientMock {
+  constructor(config) {
+    this.config = config;
+
+    this.startLaunch = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+      tempId: 'tempLaunchId',
+    });
+
+    this.finishLaunch = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+    });
+
+    this.startTestItem = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+      tempId: 'testItemId',
+    });
+
+    this.finishTestItem = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+    });
+
+    this.sendLog = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+    });
+
+    this.getPromiseFinishAllItems = jest.fn().mockResolvedValue({
+      promise: Promise.resolve('ok'),
+    });
+
+    this.checkConnect = jest.fn().mockReturnValue({
+      promise: Promise.resolve('ok'),
+    });
+  }
+}
+
+module.exports = RPClientMock;
diff --git a/__tests__/jasmine-reportportal-reporter.spec.js b/__tests__/jasmine-reportportal-reporter.spec.js
@@ -13,26 +13,27 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
+const helpers = require('@reportportal/client-javascript/lib/helpers');
+const Reporter = require('../lib/jasmine-reportportal-reporter');
+const SpecificUtils = require('../lib/specificUtils');
 
-describe('jasmine Report Portal reporter', () => {
-  const Reporter = require('../lib/jasmine-reportportal-reporter');
-  const SpecificUtils = require('../lib/specificUtils');
+const mockedDate = '2024-09-23T12:20:59.392987Z';
 
+describe('jasmine Report Portal reporter', () => {
   let reporter;
   const tempLaunchId = 'ewrf35432r';
   let promise;
-  let baseTime;
 
   beforeEach(() => {
-    jest.useFakeTimers();
+    jest.spyOn(helpers, 'now').mockReturnValue(mockedDate);
+    // TODO: should be replaced with unregistering specific listeners only
+    process.removeAllListeners();
     const client = {
       startTestItem() {},
       finishTestItem() {},
       sendLog() {},
     };
     const onSetLaunchStatus = function () {};
-    baseTime = new Date(2020, 4, 8);
-    jest.setSystemTime(baseTime);
     reporter = new Reporter(
       {
         client,
@@ -363,7 +364,7 @@ describe('jasmine Report Portal reporter', () => {
             level: 'level',
             file: null,
             message: 'message',
-            time: baseTime.valueOf(),
+            time: mockedDate,
           },
         ],
       };
@@ -381,13 +382,13 @@ describe('jasmine Report Portal reporter', () => {
             level: 'level',
             file: null,
             message: 'message',
-            time: baseTime.valueOf(),
+            time: mockedDate,
           },
           {
             level: 'level1',
             file: null,
             message: 'message1',
-            time: baseTime.valueOf(),
+            time: mockedDate,
           },
         ],
       };
@@ -448,7 +449,7 @@ describe('jasmine Report Portal reporter', () => {
         {
           message: 'message',
           level: 'level',
-          time: baseTime.valueOf(),
+          time: mockedDate,
         },
         null
       );
@@ -465,7 +466,7 @@ describe('jasmine Report Portal reporter', () => {
         {
           message: '',
           level: 'level',
-          time: baseTime.valueOf(),
+          time: mockedDate,
         },
         undefined
       );
@@ -604,7 +605,7 @@ describe('jasmine Report Portal reporter', () => {
             description: 'text description',
             testCaseId: 'testCaseId',
             codeRef: 'codeRef',
-            startTime: baseTime.valueOf(),
+            startTime: mockedDate,
           },
           tempLaunchId,
           null
@@ -653,7 +654,7 @@ describe('jasmine Report Portal reporter', () => {
             description: 'test description',
             name: 'test description',
             codeRef: 'codeRef',
-            startTime: baseTime.valueOf(),
+            startTime: mockedDate,
           },
           tempLaunchId,
           null
@@ -674,7 +675,7 @@ describe('jasmine Report Portal reporter', () => {
       promise.then(() => {
         expect(reporter.setParentInfo).toHaveBeenCalledWith({
           tempId: '3452',
-          startTime: baseTime.valueOf(),
+          startTime: mockedDate,
         });
 
         done();
@@ -759,14 +760,14 @@ describe('jasmine Report Portal reporter', () => {
         tempId: '3452',
         promise: Promise.resolve(),
       });
-      jest.spyOn(reporter, 'getHookStartTime').mockReturnValue(baseTime.valueOf());
+      jest.spyOn(reporter, 'getHookStartTime').mockReturnValue(mockedDate);
 
       reporter.hookStarted('beforeAll');
 
       expect(reporter.client.startTestItem).toHaveBeenCalledWith(
         {
           type: 'BEFORE_SUITE',
-          startTime: baseTime.valueOf(),
+          startTime: mockedDate,
           name: 'beforeAll',
         },
         tempLaunchId,
@@ -787,7 +788,7 @@ describe('jasmine Report Portal reporter', () => {
 
       expect(reporter.client.finishTestItem).toHaveBeenCalledWith('3452', {
         status: 'passed',
-        endTime: baseTime.valueOf(),
+        endTime: mockedDate,
       });
       expect(reporter.itemStartTime).toEqual(null);
     });
@@ -802,7 +803,7 @@ describe('jasmine Report Portal reporter', () => {
 
       expect(reporter.client.finishTestItem).toHaveBeenCalledWith('3452', {
         status: 'failed',
-        endTime: baseTime.valueOf(),
+        endTime: mockedDate,
       });
     });
 
@@ -879,7 +880,7 @@ describe('jasmine Report Portal reporter', () => {
           {
             message: 'message: error\nstackTrace: stack',
             level: 'ERROR',
-            time: baseTime.valueOf(),
+            time: mockedDate,
           },
           null
         );
@@ -978,7 +979,7 @@ describe('jasmine Report Portal reporter', () => {
             {
               message: 'message: error\nstackTrace: stack',
               level: 'ERROR',
-              time: baseTime.valueOf(),
+              time: mockedDate,
             },
             null
           );

diff --git a/__tests__/reportportal-agent.spec.js b/__tests__/reportportal-agent.spec.js
@@ -20,7 +20,7 @@ const SpecificUtils = require('../lib/specificUtils');
 
 const reporterOptions = {
   apiKey: 'reportportalApiKey',
-  endpoint: 'endpoint',
+  endpoint: 'http://reportportal.example.com/api/v1',
   project: 'projectName',
   launch: 'launcherName',
   description: 'description',
@@ -44,10 +44,13 @@ describe('Report Portal agent', () => {
   let agent;
 
   beforeAll(() => {
-    jest.clearAllMocks(); // Clear mocks before initialization
     agent = new ReportportalAgent(options);
   });
 
+  beforeEach(() => {
+    jest.clearAllMocks(); // Clear mocks before initialization
+  });
+
   it('should be properly initialized', () => {
     expect(agent.tempLaunchId).toBeDefined();
     expect(agent.client).toBeDefined();

diff --git a/__tests__/specificUtils.spec.js b/__tests__/specificUtils.spec.js
@@ -348,5 +348,33 @@ describe('Specific Utils', () => {
         expect(escapeString).toBe('\\_test\\*');
       });
     });
+
+    describe('convertIsoStringToMicroseconds', () => {
+      it('converts ISO string with microseconds correctly', () => {
+        const isoString = '2024-09-20T14:32:35.304456Z';
+        const expectedMicroseconds = 1726842755304456;
+        expect(SpecificUtils.convertIsoStringToMicroseconds(isoString)).toBe(expectedMicroseconds);
+      });
+
+      it('handles microseconds accurately', () => {
+        const isoString = '2021-03-15T12:00:00.000001Z';
+        const expectedMicroseconds = 1615809600000001;
+        expect(SpecificUtils.convertIsoStringToMicroseconds(isoString)).toBe(expectedMicroseconds);
+      });
+
+      it('returns correct microseconds at epoch start', () => {
+        const isoString = '1970-01-01T00:00:00.000001Z';
+        const expectedMicroseconds = 1;
+        expect(SpecificUtils.convertIsoStringToMicroseconds(isoString)).toBe(expectedMicroseconds);
+      });
+    });
+
+    describe('getBeforeHookStartTime', () => {
+      it('should return the start time for the hook as reduced time from test item start by 1 millisecond', () => {
+        const itemStartTime = '2024-09-20T14:32:35.304456Z';
+        const expectedHookStartTime = '2024-09-20T14:32:35.303456Z';
+        expect(SpecificUtils.getBeforeHookStartTime(itemStartTime)).toBe(expectedHookStartTime);
+      });
+    });
   });
 });
diff --git a/lib/jasmine-reportportal-reporter.js b/lib/jasmine-reportportal-reporter.js
@@ -16,6 +16,7 @@
 
 const { EVENTS } = require('@reportportal/client-javascript/lib/constants/events');
 const { RP_STATUSES } = require('@reportportal/client-javascript/lib/constants/statuses');
+const clientHelpers = require('@reportportal/client-javascript/lib/helpers');
 const SpecificUtils = require('./specificUtils');
 const { entityType, hookTypes, hookTypesMap } = require('./constants/itemTypes');
 const LOG_LEVELS = require('./constants/logLevels');
@@ -84,7 +85,7 @@ class ReportportalReporter {
   }
 
   getTime() {
-    return new Date().valueOf();
+    return clientHelpers.now();
   }
 
   addAttributes(attr) {
@@ -282,6 +283,7 @@ class ReportportalReporter {
     });
   }
 
+  // TODO: update
   getHookStartTime(hookType, parent) {
     if (hookType === entityType.BEFORE_METHOD || hookType === entityType.BEFORE_SUITE) {
       return Math.max(parent && parent.startTime, this.itemStartTime - 1);