feat: add possibility to pass additional data to the reporter plugin (closes #3584)

[Artem-Babich]

Purpose

#3584
A lot of users need to pass additional information from the test to the custom or existing reporter.

Aproach

This is the first part of reporter improvements that allow users to pass additional data to the reporter by running t.report action.
This action triggers reportData reporter event as well as adds passed data to the testRun. Finally this data is passed to the reportTestDone event handler.

API:

TestController:

t.report (...args: any[]): TestControllerPromise

ReporterPlugin

interface TestRunInfo {
   //...
   reportData: { [testRunId: string]: any[] };
}

interface ReportDataTestRunInfo {
    test: {name, id, meta},
    fixture: {name, id, meta, path},
    testRunId: string,
    browser: BrowserInfo,
}

class ReporterPlugin {
   reportData (testRun: ReportDataTestInfo, ...data: any[]) { }

   reportTestDone ( testName: string, { reportData, browsers }: TestRunInfo, meta: Metadata ) {
       browsers.forEach(({ testRunId, alias }) => {
          const browserReportData = reportData[testRunId];
       });
   }
}

References

#3584
DevExpress/testcafe-reporter-spec#8

Pre-Merge TODO

• Write tests for your proposed changes
• Make sure that existing tests do not fail

[github-actions]

Release v2.5.0-rc.1 addresses this.