feat(html-reporter): add testplane support #541

KuznetsovRoman · 2024-04-03T22:59:53Z

Merging straight to master

What is done

add native testplane@0 and testplane@1 support
customize help messages (e.g. it suggests to open gui like npx testplane gui if it was launched with npx testplane)
add testplane html-reporter plugins support
add testplane custom gui support (with doubling testplane property in addition to hermione)

TBD

import from "testplane" instead of "hermione"

KuznetsovRoman · 2024-04-03T23:00:26Z

index.ts

+import {ImagesInfoSaver} from './lib/images-info-saver';
+import {getStatus} from './lib/test-adapter/testplane';
+
+export default (testplane: Testplane, opts: Partial<ReporterOptions>): void => {


We can use export default for testplane

KuznetsovRoman · 2024-04-03T23:01:13Z

hermione.ts

-    const htmlReporter = HtmlReporter.create(config, {toolName: ToolName.Hermione});
-
-    (hermione as Hermione & HtmlReporterApi).htmlReporter = htmlReporter;
-
-    let isCliCommandLaunched = false;
-    let handlingTestResults: Promise<void>;
-    let staticReportBuilder: StaticReportBuilder;
-
-    const withMiddleware = <T extends (...args: unknown[]) => unknown>(fn: T):
-        (...args: Parameters<T>) => ReturnType<T> | undefined => {
-        return (...args: unknown[]) => {
-            // If any CLI command was launched, e.g. merge-reports, we need to interrupt regular flow
-            if (isCliCommandLaunched) {
-                return;
-            }
-
-            return fn.call(undefined, ...args) as ReturnType<T>;
-        };
-    };
-
-    hermione.on(hermione.events.CLI, (commander: CommanderStatic) => {
-        _.values(cliCommands).forEach((command: string) => {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            require(path.resolve(__dirname, 'lib/cli-commands', command))(commander, config, hermione);
-
-            commander.prependListener(`command:${command}`, () => {
-                isCliCommandLaunched = true;
-            });
-        });
-    });
-
-    hermione.on(hermione.events.INIT, withMiddleware(async () => {
-        const dbClient = await SqliteClient.create({htmlReporter, reportPath: config.path});
-        const imageStore = new SqliteImageStore(dbClient);
-        const expectedPathsCache = new Cache<[TestSpecByPath, string | undefined], string>(getExpectedCacheKey);
-
-        const imagesInfoSaver = new ImagesInfoSaver({
-            imageFileSaver: htmlReporter.imagesSaver,
-            expectedPathsCache,
-            imageStore,
-            reportPath: htmlReporter.config.path
-        });
-
-        staticReportBuilder = StaticReportBuilder.create(htmlReporter, config, {dbClient, imagesInfoSaver});
-
-        handlingTestResults = Promise.all([
-            staticReportBuilder.saveStaticFiles(),
-            handleTestResults(hermione, staticReportBuilder)
-        ]).then(async () => {
-            await staticReportBuilder.finalize();
-        }).then(async () => {
-            await htmlReporter.emitAsync(htmlReporter.events.REPORT_SAVED, {reportPath: config.path});
-        });
-
-        htmlReporter.emit(htmlReporter.events.DATABASE_CREATED, dbClient.getRawConnection());
-    }));
-
-    hermione.on(hermione.events.RUNNER_START, withMiddleware((runner) => {
-        staticReportBuilder.registerWorkers(createWorkers(runner as unknown as CreateWorkersRunner));
-    }));
-
-    hermione.on(hermione.events.RUNNER_END, withMiddleware(async () => {
-        try {
-            await handlingTestResults;
-
-            logPathToHtmlReport(config);
-        } catch (e: unknown) {
-            logError(e as Error);
-        }
-    }));
-};
-
-async function handleTestResults(hermione: Hermione, reportBuilder: StaticReportBuilder): Promise<void> {
-    return new Promise((resolve, reject) => {
-        const queue = new PQueue({concurrency: os.cpus().length});
-        const promises: Promise<unknown>[] = [];
-
-        [
-            {eventName: hermione.events.TEST_PASS},
-            {eventName: hermione.events.RETRY},
-            {eventName: hermione.events.TEST_FAIL},
-            {eventName: hermione.events.TEST_PENDING}
-        ].forEach(({eventName}) => {
-            type AnyHermioneTestEvent = typeof hermione.events.TEST_PASS;
-
-            hermione.on(eventName as AnyHermioneTestEvent, (testResult: HermioneTestResult) => {
-                promises.push(queue.add(async () => {
-                    const formattedResult = formatTestResult(testResult, getStatus(eventName, hermione.events, testResult));
-
-                    await reportBuilder.addTestResult(formattedResult);
-                }).catch(reject));
-            });
-        });
-
-        hermione.on(hermione.events.RUNNER_END, () => {
-            return Promise.all(promises).then(() => resolve(), reject);
-        });
-    });
-}
+export = pluginHandler;


Export default export of ./index.ts as module.exports, because old versions of hermione do not support export default

KuznetsovRoman · 2024-04-03T23:03:26Z

lib/server-utils.ts

    await Promise.all(
        _(customGui)
            .flatMap<CustomGuiItem>(_.identity)
-            .map((ctx) => ctx.initialize?.({hermione, ctx}))
+            .map((ctx) => ctx.initialize?.({testplane, hermione: testplane, ctx}))


testplane and hermione props are Object.is copies for backward compatibility

KuznetsovRoman · 2024-04-03T23:03:31Z

lib/server-utils.ts

    const {sectionName, groupIndex, controlIndex} = payload;
    const ctx = customGui[sectionName][groupIndex];
    const control = ctx.controls[controlIndex];

-    await ctx.action({hermione, control, ctx});
+    await ctx.action({testplane, hermione: testplane, control, ctx});


testplane and hermione props are Object.is copies for backward compatibility

KuznetsovRoman · 2024-04-03T23:04:39Z

lib/static/modules/load-plugin.js

+    const getRegisterFn = tool => `function __${tool}_html_reporter_register_plugin__(p) {return p;};`;
+
+    const exec = new Function(`${getRegisterFn('testplane')} ${getRegisterFn('hermione')} return ${code};`);
+


Add support for testplane html reporter plugins

This will work if both are present, right?

Yes, it will.

I tested it locally with "some plugins are built for testplane, while others stay for hermione" and remote with "all plugins are built for hermione": https://nda.ya.ru/t/1ELAEazw75GviJ

KuznetsovRoman · 2024-04-03T23:06:19Z

lib/types.ts


-export interface HermioneTestResult extends HermioneTestResultOriginal {
+export interface HermioneTestResult extends TestResult {


Not a part of public API, no JSDoc deprecated's is needed

KuznetsovRoman · 2024-04-03T23:07:15Z

lib/types.ts

+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface TestplaneTestResult extends HermioneTestResult {}


These two are separated, so we could add something to TestplaneTestResult while it still does not exist on HermioneTestResult

KuznetsovRoman · 2024-04-03T23:07:42Z

lib/types.ts

+        testplane: Testplane,
+        /**
+         * @deprecated Use `testplane` instead
+         */
+        hermione: Testplane,


Add some JSDoc deprecated comments

KuznetsovRoman · 2024-04-03T23:08:22Z

test/unit/index.js

+    const runHtmlReporter = proxyquire('../../', {
        './lib/sqlite-client': {SqliteClient},
        './lib/server-utils': utils,
        './lib/report-builder/static': {StaticReportBuilder},
        './lib/plugin-api': {HtmlReporter}
-    });
+    }).default;


use default-exported value here

KuznetsovRoman · 2024-04-03T23:10:18Z

test/unit/lib/gui/tool-runner/index.js


-        createTestRunner = sinon.stub();
+        createTestRunner = sandbox.stub();


replaced sinon with sandbox in the file, because some other tests (in another files) were failing without it

shadowusr

Looks good to me except making testplane a default export from the package, I am strongly against that.

index.ts

gemini.js

lib/constants/tool-names.ts

shadowusr · 2024-04-04T11:15:03Z

lib/static/modules/load-plugin.js

+    const getRegisterFn = tool => `function __${tool}_html_reporter_register_plugin__(p) {return p;};`;
+
+    const exec = new Function(`${getRegisterFn('testplane')} ${getRegisterFn('hermione')} return ${code};`);
+


This will work if both are present, right?

package.json

KuznetsovRoman commented Apr 3, 2024

View reviewed changes

KuznetsovRoman changed the title ~~feat: add testplane support~~ feat(html-reporter): add testplane support Apr 4, 2024

KuznetsovRoman self-assigned this Apr 4, 2024

shadowusr approved these changes Apr 4, 2024

View reviewed changes

feat: add testplane support

362a457

KuznetsovRoman force-pushed the HERMIONE-1492.testplane branch from 98a63e8 to 362a457 Compare April 4, 2024 13:04

KuznetsovRoman merged commit 2413861 into master Apr 4, 2024
5 checks passed

KuznetsovRoman deleted the HERMIONE-1492.testplane branch April 4, 2024 13:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(html-reporter): add testplane support #541

feat(html-reporter): add testplane support #541

KuznetsovRoman commented Apr 3, 2024 •

edited

Loading

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

shadowusr Apr 4, 2024

KuznetsovRoman Apr 4, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

KuznetsovRoman Apr 3, 2024

shadowusr left a comment

shadowusr Apr 4, 2024

		const getRegisterFn = tool => `function __${tool}_html_reporter_register_plugin__(p) {return p;};`;

		const exec = new Function(`${getRegisterFn('testplane')} ${getRegisterFn('hermione')} return ${code};`);


		export interface HermioneTestResult extends HermioneTestResultOriginal {
		export interface HermioneTestResult extends TestResult {

		// eslint-disable-next-line @typescript-eslint/no-empty-interface
		export interface TestplaneTestResult extends HermioneTestResult {}


		createTestRunner = sinon.stub();
		createTestRunner = sandbox.stub();

feat(html-reporter): add testplane support #541

feat(html-reporter): add testplane support #541

Conversation

KuznetsovRoman commented Apr 3, 2024 • edited Loading

What is done

TBD

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shadowusr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KuznetsovRoman commented Apr 3, 2024 •

edited

Loading