allure-hermione
Allure integration for
hermione@^5.x.xand above
- Learn more about Allure Report at https://allurereport.org
- 📚 Documentation – discover official documentation for Allure Report
- ❓ Questions and Support – get help from the team and community
- 📢 Official annoucements – be in touch with the latest updates
- 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
Installation
Use your favorite node package manager to install required packages:
npm add -D allure-hermione allure-js-commonsSetup
Add allure-hermione field to plugins in your .hermione.conf.js file:
module.exports = {
plugins: {
+ "allure-hermione": {
+ resultsDir: "./allure-results"
+ }
}
}Using allure commands
The plugin provides custom browser commands which allow to add additional info inside your tests:
import { expect } from "chai";
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser }) => {
await browser.url("https://www.example.org/");
await browser.$("#btn").click();
const screenshot = await browser.takeScreenshot();
await allure(browser).attach(screenshot, "image/png");
await allure(browser).epic("my_epic");
await allure(browser).parameter("parameter_name", "parameter_value", {
mode: "hidden",
excluded: false,
});
expect(browser.url).not.eq("https://www.startpage.com/");
});Don't forget to pass current test id as first argument to command!
Supported commands
Display name
Change your test case name on custom value on the fly using displayName method:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).displayName("my test custom name");
});Description
Provide description in markdown or html syntax:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser }) => {
await allure(browser).description("my **markdown description**");
await allure(browser).descriptionHtml("<p>my <b>html description</b></p>");
});Labels
Markup you tests with labels using low-level label method:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).label("label_name", "label_value");
});Or using aliases: id, epic, feature, story, suite, parentSuite, subSuite,
owner, severity, tag:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).epic("my_epic");
});Links
Add any link by low-level link method:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).link("http://example.org", "my_link_name", "my_link_type");
});Or using aliases: issue, tms:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).issue("my_link_name", "http://example.org");
});Parameters
Test parameters can be added by parameter method:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).parameter("param_name", "param_value", {
excluded: false,
});
});Attachments
Attach any file as string or buffer using attach method:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).attach(JSON.stringify({ foo: "bar" }), "application/json");
});If you want to attach a screenshot generated in tests, you can use the same method:
import { allure } from "allure-hermione/runtime";
it("adds screenshots", async ({ browser, currentTest }) => {
const screenshot = await allure(browser).takeScreenshot();
await allure(browser).attach(screenshot, "image/png");
});Steps
The reporter provides step method to add steps inside your tests for better structure:
import { allure } from "allure-hermione/runtime";
it("my test", async ({ browser, currentTest }) => {
await allure(browser).step("first step name", async (s1) => {
await s1.step("second step name", async (s2) => {
await s2.step("third step name", (s3) => {
// you can add infinite nested steps with any function inside
s3.label("foo", "bar");
});
});
});
});