Cypress: Latest Mochawesome version do not generate files

[davidsoderberg]

What versions are am I running?

• Operating System: Mac
• Cypress Version: 0.19.4
• Browser Version: 59.0.3071.115

Is this a Feature or Bug?

There is a bug with latest Mochawesome.

Current behavior:

The Mochawesome files are not generated.

Desired behavior:

The Mochawesome files are generated.

How to reproduce:

Install latest version of Mochawesome and run a cypress test suite.

[jennifer-shehane]

Our tests are checking against version 1.5.3 of mochawesome, which IS working properly. They seem to have updated how the reports are generated since then and the reports are not generating properly in their latest version (2.3.0).

Workaround: For now, you could set your mochawesome package version to 1.5.3 and get the generated reports.

[deshdeep-airwallex]

@jennifer-shehane Are there any plans to support the latest mochawesome version? As it allows lot more options then version 1.5.3. Thanks!!

[bahmutov]

yeah, we should upgrade and test against mocha v2

[deshdeep-airwallex]

Thank you Gleb for your response. I have found a workaround for now to timestamp my reports - I am reading the current time from bash and formatting it for reportName

cypress run --reporter mochawesome --reporter-options reportDir=reports,reportName=“${ENV_IMGTAG:-none}$(date “+%Y%m%d_%H%M%S”)“,overwrite=false

[bahmutov]

wow that is a hairy command 😄

[deshdeep-airwallex]

Yeah, i know it's not ideal but needed to get the tests working quickly.

[bahmutov]

Seems we do not properly call reporter.done to actually save the report too

function done (failures) {
    if (reporter.done) {
      reporter.done(failures, fn);
    } else {
      fn && fn(failures);
    }
  }

  return runner.run(done);

[adokania]

I am running into the same issue with v2, So for now is the solution to use 1.5.3?

[wichopy]

Got my mochawesome reports working once I rolled back to 1.5.3.

@bahmutov I ran into an issue with mochawesome not generating a report when there is a test failure. Do you think it has to do with the issue you brought up? I get the following stack trace:

TypeError: test.titlePath is not a function
    at /Users/my/repo/node_modules/mocha/lib/reporters/base.js:227:10
    at Array.forEach (native)
    at Function.exports.list (/Users/my/repo/node_modules/mocha/lib/reporters/base.js:167:12)
    at Spec.Base.epilogue (/Users/my/repo/node_modules/mocha/lib/reporters/base.js:344:10)
    at emitOne (events.js:101:20)
    at Runner.emit (events.js:188:7)
    at Reporter.emit (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/reporter.js:168:55)
    at Object.server.startWebsockets.onMocha (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/project.js:224:22)
    at Socket.<anonymous> (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/socket.js:237:36)
    at emitOne (events.js:96:13)
    at Socket.emit (events.js:188:7)
    at /Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/socket/node_modules/socket.io/lib/socket.js:503:12
    at _combinedTickCallback (internal/process/next_tick.js:67:7)
    at process._tickCallback (internal/process/next_tick.js:98:9)

TypeError: test.titlePath is not a function
    at /Users/my/repo/node_modules/mocha/lib/reporters/base.js:227:10
    at Array.forEach (native)
    at Function.exports.list (/Users/my/repo/node_modules/mocha/lib/reporters/base.js:167:12)
    at Spec.Base.epilogue (/Users/my/repo/node_modules/mocha/lib/reporters/base.js:344:10)
    at emitOne (events.js:101:20)
    at Runner.emit (events.js:188:7)
    at Reporter.emit (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/reporter.js:168:55)
    at Object.server.startWebsockets.onMocha (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/project.js:224:22)
    at Socket.<anonymous> (/Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/server/lib/socket.js:237:36)
    at emitOne (events.js:96:13)
    at Socket.emit (events.js:188:7)
    at /Users/my/repo/node_modules/cypress/dist/Cypress.app/Contents/Resources/app/packages/socket/node_modules/socket.io/lib/socket.js:503:12
    at _combinedTickCallback (internal/process/next_tick.js:67:7)
    at process._tickCallback (internal/process/next_tick.js:98:9)

[hululuxin]

Got the same issue with @wichopy

[wichopy]

@hululuxin Found out what caused it. Was not related to cypress. mocha is a dependency of mochawesome. You need to npm install mocha@3 as the latest version of mocha introduced breaking changes to mochawesome.

[hululuxin]

@wichopy I have tried mocha3 and it works. Thanks you so much.

[NicholasBoll]

Not sure if this is related, but using mochawesome 1.5.3 prevents a non-zero error codes from cypress run. Just letting @hululuxin and @wichopy know.

[NicholasBoll]

I got around this issue with mocha-multi-reporters even if mochawesome is the only reporter listed

[cameronc56]

just ran into this. would be nice if the reporter documentation was updated with a note of this until it is fixed

[jennifer-shehane]

@cameronc56 Our documentation is open source and contributions are welcome. 😄 Reporters guide is here: https://github.com/cypress-io/cypress-documentation/blob/develop/source/guides/guides/reporters.md

[avatsaev]

same problem here only generates css, js, fonts folders no html

[brian-mann]

I didn't realize mochaawesome was preventing this. We'll get it fixed.

[brian-mann]

There are a few different problems in play here and I'll be opening issues for each of them.

So far I have found three:

• mochawesome does not correctly output a stats object when failures occur in hooks. https://github.com/cypress-io/cypress/issues/1063 and https://github.com/cypress-io/cypress/issues/1141
• test.titlePath is not a function when using newer versions of mocha with mochawesome. This is easy to fix, we will simply polyfill this on Suite and Runnable classes. https://github.com/cypress-io/cypress/issues/1142
• reports are not generating correctly because we need to call reporter.done() when a run is finished

[NoNameProvided]

All the linked issues are closed now, does this mean it will get fixed in the next release?

[brian-mann]

Yes, next release has these all fixed.

[brian-mann]

Fixed by https://github.com/cypress-io/cypress/commit/dec388e76f548cf46b2e02d0c1afb82d12012da9

[brian-mann]

Released in 1.4.2.

[uday-nitjsr]

@brian-mann I am facing an interesting issue. I am not able to generate mochawesome reports if I am running full suite in CLI, but it works like a charm when using it with --spec

My Setup details:
OS: windows
cypress verison : 2.1.0
mochawesome version : 3.0.2

[mjhea0]

I have mochawesome working here -> https://github.com/testdrivenio/cypress-mochawesome-s3

Essentially-

1. cypress runs
2. each spec generates a new report
3. a custom script combines each mochawesome json file and calculates the stats
4. html report is then generated