Generate a stable historyId

Author: dtinth

examples/regression/tests/Issue27.js

@@ -1,34 +1,56 @@
 const { action } = require('../../..')
 const assert = require('assert')
+const expect = require('expect')
 const fs = require('fs')
 const glob = require('glob')
 const { execFileSync } = require('child_process')
 
-action('Run test (it should fail)', async () => {
-  let failed = false
+action('Clean the results directory', async () => {
   execFileSync('rm', ['-rf', 'tmp/issue27-allure-results'])
-  try {
-    execFileSync(
-      './bin/prescript',
-      [require.resolve('../fixtures/Issue27-AnsiColorTestFixture.js')],
-      {
-        env: {
-          ...process.env,
-          ALLURE_RESULTS_DIR: 'tmp/issue27-allure-results',
-          ALLURE_SUITE_NAME: 'prescript-regression-issue27',
-          FORCE_COLOR: '1'
-        }
-      }
-    )
-  } catch (error) {
-    failed = true
-  }
-  assert(failed, 'Expected prescript command to fail')
 })
 
+for (let i = 1; i <= 3; i++) {
+  action('Run test (it should fail)', async () => {
+    let failed = false
+    try {
+      execFileSync(
+        './bin/prescript',
+        [require.resolve('../fixtures/Issue27-AnsiColorTestFixture.js')],
+        {
+          env: {
+            ...process.env,
+            ALLURE_RESULTS_DIR: 'tmp/issue27-allure-results',
+            ALLURE_SUITE_NAME: 'prescript-regression-issue27',
+            FORCE_COLOR: '1'
+          }
+        }
+      )
+    } catch (error) {
+      failed = true
+    }
+    assert(failed, 'Expected prescript command to fail')
+  })
+}
+
 action('Verify that there are JSON allure results generated', async () => {
   const files = glob.sync('*.json', { cwd: 'tmp/issue27-allure-results' })
-  assert(files.length > 0, 'Expected to file JSON files')
+  assert(files.length > 0, 'Expected to find JSON files')
+})
+
+action('Verify the test results JSON have consistent historyId', async () => {
+  const files = glob.sync('*-result.json', {
+    cwd: 'tmp/issue27-allure-results'
+  })
+  const historyIds = Array.from(
+    new Set(
+      files.map(
+        f =>
+          JSON.parse(fs.readFileSync(`tmp/issue27-allure-results/${f}`, 'utf8'))
+            .historyId
+      )
+    )
+  )
+  expect(historyIds).toHaveLength(1)
 })
 
 action('Generate an allure-report', async () => {

src/createReporter.ts

@@ -8,8 +8,10 @@ import {
   AllureTest,
   AllureStep,
   Stage,
-  Status
+  Status,
+  LabelName
 } from 'allure-js-commons'
+import { hostname } from 'os'
 import { AllureWriter } from 'allure-js-commons/dist/src/writers'
 
 export default function createReporter(testModulePath, rootStepName) {
@@ -29,6 +31,9 @@ export default function createReporter(testModulePath, rootStepName) {
     return `${testPath}${testName ? ` - ${testName}` : ''}`
   }
   const caseName = process.env.ALLURE_CASE_NAME || getDefaultCaseName()
+  const historyId = createHash('md5')
+    .update([suiteName, caseName].join(' / '))
+    .digest('hex')
 
   const allureConfig: IAllureConfig = {
     resultsDir: process.env.ALLURE_RESULTS_DIR || 'allure-results'
@@ -37,6 +42,11 @@ export default function createReporter(testModulePath, rootStepName) {
   const runtime = new AllureRuntime({ ...allureConfig, writer })
   const group = runtime.startGroup(suiteName)
   const test = group.startTest(caseName)
+  const prescriptVersion = require('../package').version
+  test.historyId = historyId
+  test.addLabel(LabelName.THREAD, `${process.pid}`)
+  test.addLabel(LabelName.HOST, `${hostname()}`)
+  test.addLabel(LabelName.FRAMEWORK, `prescript@${prescriptVersion}`)
   let stack: IStepStack = new TestStepStack(test)
   singletonAllureInstance.currentReportingInterface = {
     addAttachment: (name, buf, mimeType) => {