allure-framework · May 24, 2023 · May 26, 2023 · May 26, 2023 · May 26, 2023 · May 26, 2023
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -27,6 +27,7 @@ module.exports = {
     "@typescript-eslint",
   ],
   rules: {
+    "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/adjacent-overload-signatures": "error",
     "@typescript-eslint/array-type": [
       "error",
@@ -216,7 +217,7 @@ module.exports = {
     "no-throw-literal": "error",
     "no-trailing-spaces": "error",
     "no-undef-init": "error",
-    "no-underscore-dangle": "error",
+    "no-underscore-dangle": ["error", { "allow": ["_currentRetry", "_retriedTest", "_retries"] }],
     "no-unsafe-finally": "error",
     "no-unused-labels": "error",
     "no-var": "error",

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "allure-js",
   "private": true,
-  "version": "2.3.0",
+  "version": "2.4.0",
   "workspaces": [
     "packages/*"
   ],

diff --git a/packages/allure-codeceptjs/package.json b/packages/allure-codeceptjs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-codeceptjs",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure codeceptjs integration",
   "license": "Apache-2.0",
   "repository": {

diff --git a/packages/allure-codeceptjs/src/index.ts b/packages/allure-codeceptjs/src/index.ts
@@ -208,11 +208,19 @@ class AllureReporter {
   }
 
   testAfter(test: CodeceptTest) {
+    // @ts-ignore
+    const currentRetry = test._currentRetry;
+    if (currentRetry !== 0) {
+      // @ts-ignore
+      test = test._retriedTest;
+    }
     const allureTest = this.allureTestByCodeceptTest(test);
-
     allureTest?.endTest();
-
     this.currentTest = null;
+    // @ts-ignore
+    if (test.state === "failed" && test._retries !== 0 && currentRetry !== test._retries) {
+      this.createTest(test);
+    }
   }
 
   getStepParents(step: CodeceptStep) {

diff --git a/packages/allure-codeceptjs/test/retries.test.ts b/packages/allure-codeceptjs/test/retries.test.ts
@@ -0,0 +1,47 @@
+const allurePlugin = require("../src/index.ts");
+describe("handleRetries", () => {
+  it("should handle retries if the test has retried", () => {
+    // Mock the necessary dependencies and setup test data
+    const test = {
+      _currentRetry: 1,
+      _retriedTest: {
+        state: "failed",
+        _retries: 2,
+      },
+    };
+
+    const allureTestByCodeceptTest = jest.fn().mockReturnValue({
+      endTest: jest.fn(),
+    });
+    const createTest = jest.fn();
+
+    const instance = allurePlugin({ outputDir: "./output" });
+    instance.allureTestByCodeceptTest = allureTestByCodeceptTest;
+    instance.createTest = createTest;
+
+    instance.testAfter(test);
+
+    expect(allureTestByCodeceptTest).toHaveBeenCalledWith(test._retriedTest);
+    expect(allureTestByCodeceptTest().endTest).toHaveBeenCalled();
+    expect(createTest).toHaveBeenCalledWith(test._retriedTest);
+  });
+
+  it("should not handle retries if the test has not retried", () => {
+    // Mock the necessary dependencies and setup test data
+    const test = {
+      _currentRetry: 0,
+      _retriedTest: {},
+    };
+
+    const allureTestByCodeceptTest = jest.fn();
+    const createTest = jest.fn();
+
+    const instance = allurePlugin({ outputDir: "./output" });
+    instance.allureTestByCodeceptTest = allureTestByCodeceptTest;
+    instance.createTest = createTest;
+
+    instance.testAfter(test);
+
+    expect(createTest).not.toHaveBeenCalled();
+  });
+});
diff --git a/packages/allure-cucumberjs/package.json b/packages/allure-cucumberjs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-cucumberjs",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure Cucumber.JS integration",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-cucumberjs/src/CucumberJSAllureReporter.ts b/packages/allure-cucumberjs/src/CucumberJSAllureReporter.ts
@@ -385,7 +385,7 @@ export class CucumberJSAllureFormatter extends Formatter {
     const encoding = Buffer.isEncoding(contentEncoding) ? contentEncoding : undefined; // only pass through valid encodings
     const attachmentFilename = this.allureRuntime.writeAttachment(body, mediaType, encoding);
 
-    currentTest.addAttachment(
+    (currentStep ?? currentTest).addAttachment(
       fileName,
       {
         contentType: mediaType,

diff --git a/packages/allure-cucumberjs/test/specs/attachments_test.ts b/packages/allure-cucumberjs/test/specs/attachments_test.ts
@@ -46,7 +46,7 @@ describe("CucumberJSAllureReporter > examples", () => {
     expect(attachmentsKeys).length(2);
     expect(results.attachments[attachmentsKeys[0]]).eq("some text");
 
-    const [attachment] = results.tests[0].attachments;
+    const [attachment] = results.tests[0].steps[0].attachments;
     expect(attachment.type).eq("text/plain");
     expect(attachment.source).eq(attachmentsKeys[0]);
   });
@@ -58,7 +58,7 @@ describe("CucumberJSAllureReporter > examples", () => {
     const attachmentsKeys = Object.keys(results.attachments);
     expect(attachmentsKeys).length(2);
 
-    const [imageAttachment] = results.tests[1].attachments;
+    const [imageAttachment] = results.tests[1].steps[0].attachments;
     expect(imageAttachment.type).eq("image/png");
   });
 });
diff --git a/packages/allure-decorators/package.json b/packages/allure-decorators/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-decorators",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Write your tests in a Java-like annotation-driven manner via JS decorators.",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-hermione/docs/development.md b/packages/allure-hermione/docs/development.md
@@ -0,0 +1,43 @@
+# Development
+
+## Running hermione tests locally
+
+The easiest way to run Hermione tests locally is [Selenium standalone grid](https://www.npmjs.com/package/selenium-standalone).
+
+```shell
+npm i -g selenium-standalone   # install the package globally
+selenium-standalone install    # install selenium server
+selenium-standalone start      # start selenium server
+```
+
+Then you are able to run Hermione tests with the following settings:
+
+```js
+// .hermione.conf.js
+module.exports = {
+  gridUrl: "http://localhost:4444/wd/hub",
+  // ...
+};
+```
+
+Tests in the package already runs the grid before themselves, so you don't need to start it manually.
+
+## Using repeater
+
+To test the reporter with `hermione-test-repeater`, install `hermione-test-repeater` package and
+add the following configuration to your `.hermione.conf.js`:
+
+```js
+module.exports = {
+  // ...
+  plugins: {
+    "hermione-test-repeater": {
+      enabled: true,
+      repeat: 10,
+      minRepeat: 10,
+      maxRepeat: 100,
+      uniqSession: true,
+    },
+  },
+};
+```
diff --git a/packages/allure-hermione/package.json b/packages/allure-hermione/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-hermione",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "packageManager": "yarn@3.4.1",
   "license": "Apache-2.0",
   "author": {
@@ -33,17 +33,18 @@
     "@types/glob": "^7.1.4",
     "@types/mocha": "^10.0.0",
     "@types/node": "^16.7.8",
+    "@types/selenium-standalone": "^7.0.1",
     "chai": "^4.2.0",
     "codecov": "^3.6.5",
     "dotenv": "^10.0.0",
     "fs-jetpack": "^4.1.0",
     "glob": "^7.1.7",
     "hermione": "^6.0.2",
-    "hermione-headless-chrome": "^1.1.0",
     "mocha": "^9.1.3",
     "mocha-multi-reporters": "^1.5.1",
     "nyc": "^15.0.1",
     "rimraf": "^3.0.2",
+    "selenium-standalone": "^8.3.0",
     "source-map-support": "^0.5.19",
     "ts-node": "^10.2.1",
     "typescript": "^4.4.2"

diff --git a/packages/allure-hermione/src/index.ts b/packages/allure-hermione/src/index.ts
@@ -37,6 +37,8 @@ export type AllureReportOptions = {
   resultsDir?: string;
 };
 
+export type TestIDFactory = (testId?: string) => string;
+
 const hostname = os.hostname();
 
 const hermioneAllureReporter = (hermione: Hermione, opts: AllureReportOptions) => {
@@ -45,12 +47,18 @@ const hermioneAllureReporter = (hermione: Hermione, opts: AllureReportOptions) =
     resultsDir: "allure-results",
     ...opts,
   });
-  const getTestId = (context: string | Hermione.Test) => {
+  /**
+   * Creates browser-specific test ID to identify test in the reporter
+   *
+   * @param context Hermione test object, or browser ID string
+   * @returns Browser-specific test ID factory function
+   */
+  const getTestId = (context: string | Hermione.Test): TestIDFactory => {
     if (typeof context === "string") {
       return (testId?: string) => `${context}:${testId || ""}`;
     }
 
-    return () => `${context.sessionId}:${context.id()}`;
+    return () => `${context.browserId}:${context.id()}`;
   };
   const handleTestError = (test: Hermione.Test, error: Hermione.TestError) => {
     const testId = getTestId(test);
@@ -146,8 +154,8 @@ const hermioneAllureReporter = (hermione: Hermione, opts: AllureReportOptions) =
     currentTest.addStep(step);
   };
 
-  hermione.on(hermione.events.NEW_BROWSER, (browser) => {
-    const testId = getTestId(browser.sessionId);
+  hermione.on(hermione.events.NEW_BROWSER, (browser, { browserId }) => {
+    const testId = getTestId(browserId);
 
     browser.addCommand("label", async (id: string, name: string, value: string) => {
       await addLabel(testId(id), name, value);
@@ -220,6 +228,10 @@ const hermioneAllureReporter = (hermione: Hermione, opts: AllureReportOptions) =
     });
   });
   hermione.on(hermione.events.TEST_BEGIN, (test) => {
+    if (!test.sessionId) {
+      throw new Error("Test session hasn't been started correctly! Check the driver availability.");
+    }
+
     const testId = getTestId(test);
     const { ALLURE_HOST_NAME, ALLURE_THREAD_NAME } = process.env;
     const thread = ALLURE_THREAD_NAME || test.sessionId;
@@ -236,6 +248,7 @@ const hermioneAllureReporter = (hermione: Hermione, opts: AllureReportOptions) =
     currentTest.addLabel(LabelName.LANGUAGE, "javascript");
     currentTest.addLabel(LabelName.FRAMEWORK, "hermione");
     currentTest.addLabel(LabelName.THREAD, thread);
+    currentTest.addParameter("browser", test.browserId);
 
     if (parentSuite) {
       currentTest.addLabel(LabelName.PARENT_SUITE, parentSuite);

diff --git a/packages/allure-hermione/test/.hermione.conf.js b/packages/allure-hermione/test/.hermione.conf.js
@@ -1,4 +1,5 @@
 module.exports = {
+  gridUrl: "http://localhost:4444/wd/hub",
   sets: {
     desktop: {
       browsers: ["headless"],
@@ -7,7 +8,6 @@ module.exports = {
   },
   browsers: {
     headless: {
-      automationProtocol: "devtools",
       desiredCapabilities: {
         browserName: "chrome",
         "goog:chromeOptions": {
@@ -17,11 +17,6 @@ module.exports = {
     },
   },
   plugins: {
-    "hermione-headless-chrome": {
-      enabled: true,
-      browserId: "headless",
-      version: "112",
-    },
     "allure-hermione": {
       writer: {
         results: [],

diff --git a/packages/allure-hermione/test/runner.ts b/packages/allure-hermione/test/runner.ts
@@ -3,19 +3,28 @@
 import path from "path";
 import glob from "glob";
 import Mocha from "mocha";
+import selenium from "selenium-standalone";
 import "source-map-support/register";
 
-const mocha = new Mocha({
-  timeout: 30000,
-  reporter: "mocha-multi-reporters",
-  reporterOptions: {
-    reporterEnabled: "list, ../allure-mocha",
-    allureMochaReporterOptions: {
-      resultsDir: path.resolve(__dirname, "../out/allure-results"),
+(async () => {
+  await selenium.install();
+
+  const seleniumProcess = await selenium.start();
+  const mocha = new Mocha({
+    timeout: 30000,
+    reporter: "mocha-multi-reporters",
+    reporterOptions: {
+      reporterEnabled: "list, ../allure-mocha",
+      allureMochaReporterOptions: {
+        resultsDir: path.resolve(__dirname, "../out/allure-results"),
+      },
     },
-  },
-});
+  });
 
-glob.sync("./test/spec/**/*.test.ts").forEach((file) => mocha.addFile(file));
+  glob.sync("./test/spec/**/*.test.ts").forEach((file) => mocha.addFile(file));
 
-mocha.run((failures) => process.exit(failures === 0 ? 0 : 1));
+  mocha.run((failures) => {
+    seleniumProcess.kill();
+    process.exit(failures === 0 ? 0 : 1);
+  });
+})();
diff --git a/packages/allure-jasmine/package.json b/packages/allure-jasmine/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-jasmine",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure Jasmine integration",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-jest/package.json b/packages/allure-jest/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "allure-jest",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure Jest integration",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-js-commons/package.json b/packages/allure-js-commons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-js-commons",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure JS Commons",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-mocha/package.json b/packages/allure-mocha/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-mocha",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure Mocha integration",
   "license": "Apache-2.0",
   "author": {

diff --git a/packages/allure-playwright/package.json b/packages/allure-playwright/package.json
@@ -1,6 +1,6 @@
 {
   "name": "allure-playwright",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Allure Playwright integration",
   "license": "Apache-2.0",
   "author": {
@@ -30,7 +30,7 @@
     "lint:fix": "eslint ./src --ext .ts --fix"
   },
   "devDependencies": {
-    "@playwright/test": "^1.30.0",
+    "@playwright/test": "^1.34.1",
     "properties": "^1.2.1",
     "rimraf": "^3.0.2",
     "typescript": "^4.4.2"