html-reporter
Version:
Html-reporter and GUI for viewing and managing results of a tests run. Currently supports Testplane and Hermione.
35 lines (34 loc) • 1.64 kB
TypeScript
import type { CommanderStatic } from '@gemini-testing/commander';
import { TestCollectionAdapter } from '../test-collection';
import { ConfigAdapter } from '../config';
import { GuiApi } from '../../gui/api';
import { EventSource } from '../../gui/event-source';
import { GuiReportBuilder } from '../../report-builder/gui';
import { BrowserFeature, ToolName } from '../../constants';
import type { ImageFile, ReporterConfig } from '../../types';
import type { TestSpec } from './types';
import type { HtmlReporter } from '../../plugin-api';
export interface ToolAdapterOptionsFromCli {
toolName: ToolName;
configPath?: string;
}
export interface UpdateReferenceOpts {
refImg: ImageFile;
state: string;
}
export interface ToolAdapter {
readonly toolName: ToolName;
readonly config: ConfigAdapter;
readonly reporterConfig: ReporterConfig;
readonly htmlReporter: HtmlReporter;
readonly guiApi?: GuiApi;
readonly browserFeatures: Record<string, BrowserFeature[]>;
initGuiApi(): void;
readTests(paths: string[], cliTool: CommanderStatic): Promise<TestCollectionAdapter>;
run(testCollection: TestCollectionAdapter, tests: TestSpec[], cliTool: CommanderStatic): Promise<boolean>;
runWithoutRetries(testCollection: TestCollectionAdapter, tests: TestSpec[], cliTool: CommanderStatic): Promise<boolean>;
updateReference(opts: UpdateReferenceOpts): void;
handleTestResults(reportBuilder: GuiReportBuilder, eventSource: EventSource): void;
halt(err: Error, timeout: number): void;
}
export declare const makeToolAdapter: (opts: ToolAdapterOptionsFromCli) => Promise<ToolAdapter>;