@mmisty/cypress-allure-adapter
Version:
cypress allure adapter to generate allure results during tests execution (Allure TestOps compatible)
113 lines (112 loc) • 4.76 kB
TypeScript
import { AllureGroup, AllureRuntime, AllureStep, AllureTest, ExecutableItem, ExecutableItemWrapper, FixtureResult, Status, StatusDetails, TestResult } from 'allure-js-commons';
import { ReporterOptions } from './allure';
import { GlobalHooks } from './allure-global-hook';
import { AfterSpecScreenshots, AllureTaskArgs, EnvironmentInfo, StatusType } from './allure-types';
export declare class AllureReporter {
private showDuplicateWarn;
private allureResults;
private allureResultsWatch;
private allureAddVideoOnPass;
private allureSkipSteps;
private videos;
private screenshots;
groups: AllureGroup[];
tests: AllureTest[];
steps: AllureStep[];
labels: {
name: string;
value: string;
}[];
globalHooks: GlobalHooks;
hooks: {
id?: string;
hook: ExecutableItemWrapper;
nested: number;
name: string;
}[];
allHooks: {
id?: string;
hook: ExecutableItemWrapper;
suite: string;
nested: number;
name: string;
}[];
currentSpec: Cypress.Spec | undefined;
allureRuntime: AllureRuntime;
descriptionHtml: string[];
private screenshotsTest;
testStatusStored: AllureTaskArgs<'testStatus'> | undefined;
testDetailsStored: AllureTaskArgs<'testDetails'> | undefined;
constructor(opts: ReporterOptions);
get currentTestAll(): {
specRelative: string | undefined;
fullTitle: string;
uuid: string;
mochaId: string;
retryIndex: number | undefined;
status?: Status;
} | undefined;
get currentGroup(): AllureGroup | undefined;
get currentTest(): AllureTest | undefined;
get currentHook(): ExecutableItemWrapper | undefined;
get currentStep(): AllureStep | undefined;
get currentExecutable(): ExecutableItemWrapper | undefined;
addGlobalHooks(_nestedLevel: number): void;
suiteStarted(arg: AllureTaskArgs<'suiteStarted'>): void;
addHooks(nested: number): void;
specStarted(args: AllureTaskArgs<'specStarted'>): void;
hookStarted(arg: AllureTaskArgs<'hookStarted'>): void;
setExecutableStatus(executable: ExecutableItemWrapper | undefined, res: Status, dtls?: StatusDetails): void;
setExecutableItemStatus(executableItem: ExecutableItem | undefined, res: Status, dtls?: StatusDetails): void;
hookEnded(arg: AllureTaskArgs<'hookEnded'>): void;
endHooks(status?: StatusType): void;
attachScreenshots(arg: AfterSpecScreenshots): void;
keyWhenNoTest(testId: string | undefined): string;
screenshotAttachment(arg: AllureTaskArgs<'screenshotAttachment'>): void;
screenshotOne(arg: AllureTaskArgs<'screenshotOne'>): void;
waitAllTasksToFinish(): Promise<void>;
/**
* Attach video to parent suite
* @param arg {path: string}
*/
attachVideoToContainers(arg: {
path: string;
}): void;
endGroup(): void;
endAllGroups(): void;
label(arg: AllureTaskArgs<'label'>): void;
link(arg: AllureTaskArgs<'link'>): void;
fullName(arg: AllureTaskArgs<'fullName'>): void;
historyId(arg: AllureTaskArgs<'fullName'>): void;
parameter(arg: AllureTaskArgs<'parameter'>): void;
private addGroupLabelByUser;
suite(arg: AllureTaskArgs<'suite'>): void;
parentSuite(arg: AllureTaskArgs<'parentSuite'>): void;
subSuite(arg: AllureTaskArgs<'subSuite'>): void;
testParameter(arg: AllureTaskArgs<'parameter'>): void;
testFileAttachment(arg: AllureTaskArgs<'testFileAttachment'>): void;
fileAttachment(arg: AllureTaskArgs<'fileAttachment'>): void;
testAttachment(arg: AllureTaskArgs<'testAttachment'>): void;
attachment(arg: AllureTaskArgs<'attachment'>): void;
addGroupLabels(): void;
startTest(arg: AllureTaskArgs<'testStarted'>): void;
endTests(): void;
endGroups(): void;
endAll(): void;
addDescriptionHtml(arg: AllureTaskArgs<'addDescriptionHtml'>): void;
applyDescriptionHtml(): void;
testStatus(arg: AllureTaskArgs<'testStatus'>): void;
testDetails(arg: AllureTaskArgs<'testDetails'>): void;
applyGroupLabels(): void;
filterSteps(result: FixtureResult | TestResult | undefined, skipSteps: RegExp[]): void;
endTest(arg: AllureTaskArgs<'testEnded'>): void;
startStep(arg: AllureTaskArgs<'stepStarted'>): void;
endAllSteps(arg: AllureTaskArgs<'stepEnded'>): void;
setLastStepStatus(steps: ExecutableItem[], status: Status, details?: StatusDetails): void;
hasChildrenWith(steps: ExecutableItem[], statuses: Status[]): boolean;
endStep(arg: AllureTaskArgs<'stepEnded'>): void;
private executableAttachment;
setAttached(file: string): void;
private executableFileAttachment;
getEnvInfo(resultsFolder: string): EnvironmentInfo;
}