EPMRPP-74329 || TestCaseId reporting (#22)

Co-authored-by: Aleksandr Zyabrev <aleksandr_zyabrev@epam.com>
reportportal · Feb 15, 2022 · 899debc · 899debc
1 parent fc10c19
commit 899debc
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -153,7 +153,32 @@ Given('I do something awesome', () => {
   //...
 });
 ```
-> **Note:** Agent is not supported adding description to the `scenario`. 
+> **Note:** Agent is not supported adding description to the `scenario`.
+
+### setTestCaseId
+`ReportingApi.setTestCaseId(testCaseId: string, suite?: string);`  
+**required**: `testCaseId`
+
+Examples:
+```js
+// Jasmine
+describe('suite name', () => {
+  ReportingApi.setTestCaseId('suiteTestCaseId', 'suite name'); // the second parameter must match the name of the suite
+  it('some test', () => {
+    ReportingApi.setTestCaseId('testCaseId');
+    // ...
+  })
+});
+```
+> **Note:** Pay attention if you want to provide testCaseId to the `suite` you should pass describe name as a parameter.
+
+```js
+// Cucumber
+Given('I do something awesome', () => {
+  ReportingApi.setTestCaseId('testCaseId');
+  //...
+});
+```
 
 ### setStatus
 Assign corresponding status to the current test item or suite.  

diff --git a/src/__tests__/reportingApi.spec.ts b/src/__tests__/reportingApi.spec.ts
@@ -23,6 +23,7 @@ import { LOG_LEVELS, RP_STATUSES } from '../constants';
 
 const attributes = [{ key: 'key', value: 'value' }];
 const description = 'some text';
+const testCaseId = 'testCaseId';
 
 describe('ReportingApi', () => {
   describe('ReportingApi.addAttributes', () => {
@@ -57,6 +58,22 @@ describe('ReportingApi', () => {
     });
   });
 
+  describe('ReportingApi.setTestCaseId', () => {
+    const spyOnSetTestCaseId = jest.spyOn(ClientPublicReportingAPI, 'setTestCaseId');
+
+    it('should call clientPublicReportingApi.setTestCaseId method with testCaseId and undefined as parameter', () => {
+      ReportingApi.setTestCaseId(testCaseId);
+
+      expect(spyOnSetTestCaseId).toBeCalledWith(testCaseId, undefined);
+    });
+
+    it('should call clientPublicReportingApi.setTestCaseId method with testCaseId and suite as parameter', () => {
+      ReportingApi.setTestCaseId(testCaseId, suiteName);
+
+      expect(spyOnSetTestCaseId).toBeCalledWith(testCaseId, suiteName);
+    });
+  });
+
   describe('ReportingApi.setLaunchStatus', () => {
     const reportingApiLaunchStatusMethods = [
       { method: 'setLaunchStatusPassed', status: 'passed' },

diff --git a/src/__tests__/reportingApiHandlers.spec.ts b/src/__tests__/reportingApiHandlers.spec.ts
@@ -78,6 +78,23 @@ describe('reporterApiHandlers', () => {
     });
   });
 
+  describe('setTestCaseId', () => {
+    const testCaseId = 'testCaseId';
+
+    it('reporter.setTestCaseId pass testCaseId', () => {
+      const expectedRes = { id: testId, name: testName, testCaseId };
+      reporter.setTestCaseId({ testCaseId });
+
+      expect(reporter['storage'].getCurrentTest()).toEqual(expectedRes);
+    });
+
+    it('reporter.setTestCaseId pass testCaseId and suite', () => {
+      reporter.setTestCaseId({ testCaseId, suite: suiteName });
+
+      expect(reporter['storage'].getAdditionalSuiteData(suiteName)).toEqual({ testCaseId });
+    });
+  });
+
   describe('setLaunchStatus', () => {
     it('reporter.setLaunchStatus assign status to the launch', () => {
       reporter.setLaunchStatus(RP_STATUSES.FAILED);

diff --git a/src/models/interfaces.ts b/src/models/interfaces.ts
@@ -107,6 +107,7 @@ export interface TestItem {
   attributes?: Attribute[];
   description?: string;
   status?: string;
+  testCaseId?: string;
 }
 
 export interface FinishTestItem {
@@ -122,6 +123,7 @@ export interface AdditionalData {
   description?: string;
   status?: string;
   logs?: LogRQ[];
+  testCaseId?: string;
 }
 
 export interface AdditionalSuitesData {

diff --git a/src/reporter.ts b/src/reporter.ts
@@ -58,6 +58,7 @@ export class Reporter extends WDIOReporter {
     process.on(EVENTS.SET_STATUS, this.setStatus.bind(this));
     process.on(EVENTS.ADD_LOG, this.sendTestItemLog.bind(this));
     process.on(EVENTS.ADD_LAUNCH_LOG, this.sendLaunchLog.bind(this));
+    process.on(EVENTS.SET_TEST_CASE_ID, this.setTestCaseId.bind(this));
   }
 
   unregisterRPListeners(): void {
@@ -67,6 +68,7 @@ export class Reporter extends WDIOReporter {
     process.off(EVENTS.SET_STATUS, this.setStatus.bind(this));
     process.off(EVENTS.ADD_LOG, this.sendTestItemLog.bind(this));
     process.off(EVENTS.ADD_LAUNCH_LOG, this.sendLaunchLog.bind(this));
+    process.off(EVENTS.SET_TEST_CASE_ID, this.setTestCaseId.bind(this));
   }
 
   get isSynchronised(): boolean {
@@ -158,12 +160,13 @@ export class Reporter extends WDIOReporter {
   }
 
   finishTest(testStats: TestStats): void {
-    const { id, attributes, description, status } = this.storage.getCurrentTest();
+    const { id, attributes, description, status, testCaseId } = this.storage.getCurrentTest();
     const finishTestItemRQ: FinishTestItem = {
       status: testStats.state,
       ...(attributes && { attributes }),
       ...(description && { description }),
       ...(status && { status }),
+      ...(testCaseId && { testCaseId }),
     };
     const { promise } = this.client.finishTestItem(id, finishTestItemRQ);
     promiseErrorHandler(promise);
@@ -172,11 +175,13 @@ export class Reporter extends WDIOReporter {
 
   onSuiteEnd(): void {
     const { id, name } = this.storage.getCurrentSuite();
-    const { status, attributes, description } = this.storage.getAdditionalSuiteData(name);
+    const { status, attributes, description, testCaseId } =
+      this.storage.getAdditionalSuiteData(name);
     const finishTestItemData = {
       ...(status && { status }),
       ...(attributes && { attributes }),
       ...(description && { description }),
+      ...(testCaseId && { testCaseId }),
     };
     const { promise } = this.client.finishTestItem(id, finishTestItemData);
     promiseErrorHandler(promise);
@@ -250,6 +255,14 @@ export class Reporter extends WDIOReporter {
     }
   }
 
+  setTestCaseId({ testCaseId, suite }: { testCaseId: string; suite?: string }): void {
+    if (testCaseId && suite) {
+      this.storage.addAdditionalSuiteData(suite, { testCaseId });
+    } else {
+      this.storage.updateCurrentTest({ testCaseId });
+    }
+  }
+
   sendTestItemLog({ log, suite }: { log: LogRQ; suite?: string }): void {
     if (log && suite) {
       const data = this.storage.getAdditionalSuiteData(suite);

diff --git a/src/reportingApi.ts b/src/reportingApi.ts
@@ -25,6 +25,8 @@ export const ReportingApi = {
     ClientPublicReportingAPI.addAttributes(attributes, suite),
   setDescription: (text: string, suite?: string): void =>
     ClientPublicReportingAPI.setDescription(text, suite),
+  setTestCaseId: (testCaseId: string, suite?: string): void =>
+    ClientPublicReportingAPI.setTestCaseId(testCaseId, suite),
   setLaunchStatus: (status: RP_STATUSES): void => ClientPublicReportingAPI.setLaunchStatus(status),
   setLaunchStatusPassed: (): void => ClientPublicReportingAPI.setLaunchStatus(RP_STATUSES.PASSED),
   setLaunchStatusFailed: (): void => ClientPublicReportingAPI.setLaunchStatus(RP_STATUSES.FAILED),

diff --git a/src/types/reportingApi.d.ts b/src/types/reportingApi.d.ts
@@ -21,6 +21,7 @@ declare module '@reportportal/client-javascript/lib/publicReportingAPI' {
   export default class {
     static addAttributes(attributes: Interfaces.Attribute[], suite?: string): void;
     static setDescription(text: string, suite?: string): void;
+    static setTestCaseId(testCaseId: string, suite?: string): void;
     static setLaunchStatus(status: RP_STATUSES): void;
     static setStatus(status: RP_STATUSES, suite?: string): void;
     static addLog(log: Interfaces.LogRQ, suite?: string): void;