
Product
A New Overview in our Dashboard
We redesigned Socket's first logged-in page to display rich and insightful visualizations about your repositories protected against supply chain threats.
jest-allure2-adapter
Advanced tools
Originally forked from jest-allure.
Add more power to your tests using Jest-Allure. Easily generate nice reports at the end of the execution.
Allure Framework is a flexible lightweight multi-language test report tool that not only shows a very concise representation of what have been tested in a neat web report form, but allows everyone participating in the development process to extract maximum of useful information from everyday execution of tests.
yarn add -D jest-allure2-adapter
or
npm install --save-dev jest-allure2-adapter
Then add jest-allure2-adapter/dist/setup-default
to setupFilesAfterEnv
section of your config.
setupFilesAfterEnv: ["jest-allure2-adapter/dist/setup-default"]
reporters: ["default", "jest-allure2-adapter"],
Run tests. Results will be generated and stored in allure-results
folder.
Object of the following type can be added into registerAllureReporter as first argument.
resultsDir?: string;
stepTimestamp?: boolean;
addStepStatusDetailsAttachment?: boolean; // add attachment with step status details
tmsLink?: (id: string) => string;
issueLink?: (id: string) => string;
You need to install the CLI in order to obtain a report.
For example see allure-commandline.
To see a report in browser, run in console
allure serve
If you want to generate html version, run in console
allure generate
You can add description, screenshots, steps, severity and lots of other fancy stuff to your reports.
Global variable reporter
available in your tests with such methods:
test: AllureCurrentApi; // actions for current test
startGroup(name: string): void;
startTest(spec: jasmine_.CustomReporterResult): void;
startStep(name: string, start?: number): AllureStep;
stepStatus(status: Status, details?: StatusDetails | any): void;
step<T>(
name: string,
body?: (step: StepInterface) => T,
start?: number,
...args: any[]
): any;
endStep(
status?: Status,
stage?: Stage,
details?: StatusDetails | any,
end?: number,
): void;
endTest(spec: jasmine_.CustomReporterResult): void;
endGroup(): void;
writeCategories(categories: Category[]): void;
addEnvironment(name: string, value: string): this;
logStep(name: string, status: Status, attachments?: [Attachment]): void;
attachment(name: string, content: Buffer | string, type?: ContentType): void;
addParameter(name: string, value: string): this;
addParameters(...params: [string, any][]): this;
description(description: string): this; // sets description to current executable (test / step)
descriptionHtml(description: string): this; // sets description to current executable (test / step)
addDescription(description: string): void; // adds html description to test
setFullName(fullName: string): void;
setHistoryId(uid: string): void;
addPackage(value: string): this;
addLink(options: { name?: string; url: string; type?: LinkType }): this;
addIssue(options: { id: string; name?: string; url?: string }): this;
addTms(options: { id: string; name?: string; url?: string }): this;
addLabel(name: string, value: string): this;
feature(feature: string): void;
story(story: string): void;
tag(tag: string): void;
owner(owner: string): void;
lead(lead: string): void;
framework(framework: string): void;
language(language: string): void;
as_id(id: string): void;
host(host: string): void;
testClass(testClass: string): void;
testMethod(testMethod: string): void;
severity(severity: Severity): void;
To use custom jasmine reporter - for example to add smth into allure when spec or suite started you can use custom jasmine reporter.
In this case you do NOT need to add jest-allure2-adapter/dist/setup-default
into SetupFilesAfterEnv section.
Just call registerAllureReporter with yur custom jasmine reporter.
see example:
// jest.setup.ts
...
setupFilesAfterEnv: [
'./config/jest-custom-reporter.ts',
],
...
// jest-custom-reporter.ts
import {
AllureReporterApi,
jasmine_,
registerAllureReporter,
} from 'jest-allure2-adapter';
class JasmineAllureReporter implements jasmine_.CustomReporter {
private allure: AllureReporterApi;
constructor(allure: AllureReporterApi) {
this.allure = allure;
}
suiteStarted(suite?: jasmine_.CustomReporterResult) {
this.allure.startGroup(suite.description);
// some actions here on suite started
}
suiteDone() {
// some actions here on suite end
this.allure.endGroup();
}
specStarted(spec: jasmine_.CustomReporterResult) {
this.allure.startTest(spec);
// some actions here on test started
}
specDone(spec: jasmine_.CustomReporterResult) {
// some actions here on spec end
this.allure.endTest(spec);
}
}
registerAllureReporter(
undefined,
(allure) => new JasmineAllureReporter(allure),
);
Example (todo)
import { Severity } from "jest-allure/dist/Reporter";
import { Feature } from "somwhere in your project";
describe("Fancy test", () => {
...
it("Test your amazing feature", async () => {
reporter
.description("Feature should work cool")
.severity(Severity.Critical)
.feature(Feature.Betting)
.story("BOND-007");
reporter.startStep("Check it's fancy");
// expect that it's fancy
reporter.endStep();
reporter.startStep("Check it's cool");
// expect that it's cool
reporter.endStep();
const screenshotBuffer = await page.screenshot();
reporter.addAttachment("Screenshot", screenshotBuffer, "image/png");
});
...
}
);
jest-allure2-adapter
reporter dynamically configure "setupTestFrameworkScriptFile" option in Jest configuration.
If you have your own setupTestFrameworkScriptFile file, you need to manually register allure reporter, for it you need to import jest-allure/dist/setup-default.
import 'jest-allure2-adapter/dist/setup-default';
In case if you have jest version > 24 just add jest-allure/dist/setup-default
to setupFilesAfterEnv
section of your config.
As far as describe is async setting feature/story under describe or in any other place in the file except test will add feature/story to all tests in this file (feature/story can be overridden in test)
Todo: add example
allure-results
tmsLink: (id) => http://someissue.com/${id}
)added addDescription (adds html description to test). Previously there was only ability to SET description.
allure.test.addDescription('<h1>Heading</h1><br>');
...
allure.test.addDescription('line<br>');
It will add description to test <h1>Heading</h1><br>line<br>
cleanup
Taisia Pitko |
---|
FAQs
Allure 2 Adapter for jest
We found that jest-allure2-adapter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
We redesigned Socket's first logged-in page to display rich and insightful visualizations about your repositories protected against supply chain threats.
Product
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.