add unit tests

Author: Lando1n

Diff for: lib/helper/Mochawesome.js

@@ -1,4 +1,3 @@
-let addMochawesomeContext
 let currentTest
 let currentSuite
 
@@ -16,7 +15,8 @@ class Mochawesome extends Helper {
       disableScreenshots: false,
     }
 
-    addMochawesomeContext = require('mochawesome/addContext')
+    this._addContext = require('mochawesome/addContext')
+
     this._createConfig(config)
   }
 
@@ -44,7 +44,7 @@ class Mochawesome extends Helper {
     if (this.options.disableScreenshots) return
     let fileName
     // Get proper name if we are fail on hook
-    if (test.ctx.test.type === 'hook') {
+    if (test.ctx?.test?.type === 'hook') {
       currentTest = { test: test.ctx.test }
       // ignore retries if we are in hook
       test._retries = -1
@@ -58,13 +58,13 @@ class Mochawesome extends Helper {
     }
     if (test._retries < 1 || test._retries === test.retryNum) {
       fileName = `${fileName}.failed.png`
-      return addMochawesomeContext(currentTest, fileName)
+      return this._addContext(currentTest, fileName)
     }
   }
 
   addMochawesomeContext(context) {
     if (currentTest === '') currentTest = { test: currentSuite.ctx.test }
-    return addMochawesomeContext(currentTest, context)
+    return this._addContext(currentTest, context)
   }
 }
 

Diff for: lib/mocha/test.js

@@ -147,7 +147,7 @@ function cloneTest(test) {
 function testToFileName(test, { suffix = '', unique = false } = {}) {
   let fileName = test.title
 
-  if (unique) fileName += `_${test?.uid || Math.floor(new Date().getTime() / 1000)}`
+  if (unique) fileName = `${fileName}_${test?.uid || Math.floor(new Date().getTime() / 1000)}`
   if (suffix) fileName = `${fileName}_${suffix}`
   // remove tags with empty string (disable for now)
   // fileName = fileName.replace(/\@\w+/g, '')

Diff for: test/unit/plugin/screenshotOnFail_test.js

@@ -10,6 +10,8 @@ const event = require('../../../lib/event')
 const recorder = require('../../../lib/recorder')
 const { createTest } = require('../../../lib/mocha/test')
 const { deserializeSuite } = require('../../../lib/mocha/suite')
+const MochawesomeHelper = require('../../../lib/helper/Mochawesome')
+
 let screenshotSaved
 
 describe('screenshotOnFail', () => {
@@ -101,5 +103,36 @@ describe('screenshotOnFail', () => {
     await recorder.promise()
     expect(!screenshotSaved.called).is.ok
   })
+
+  it('should have the same unique file name as the mochawesome helper when the uuid is present', async () => {
+    screenshotOnFail({ uniqueScreenshotNames: true })
+    const test = createTest('test1')
+    test.uid = '1234'
+
+    const helper = new MochawesomeHelper({ uniqueScreenshotNames: true })
+    const spy = sinon.spy(helper, '_addContext')
+    helper._failed(test)
+
+    event.dispatcher.emit(event.test.failed, test)
+    await recorder.promise()
+
+    const screenshotFileName = screenshotSaved.getCall(0).args[0]
+    expect(spy.getCall(0).args[1]).to.equal(screenshotFileName)
+  })
+
+  it('should have the same unique file name as the mochawesome helper when the uuid is not present', async () => {
+    screenshotOnFail({ uniqueScreenshotNames: true })
+    const test = createTest('test1')
+
+    const helper = new MochawesomeHelper({ uniqueScreenshotNames: true })
+    const spy = sinon.spy(helper, '_addContext')
+    helper._failed(test)
+
+    event.dispatcher.emit(event.test.failed, test)
+    await recorder.promise()
+
+    const screenshotFileName = screenshotSaved.getCall(0).args[0]
+    expect(spy.getCall(0).args[1]).to.equal(screenshotFileName)
+  })
   // TODO: write more tests for different options
 })