Cypress - addContext() is keeping previous failure count and adding it to each 'it' scenario in mochawesome report

Question

In my mochawesome-report addContext() is keeping previous count and adding it to each 'it' scenario, in case of a test case failure, I'm adding 'someValue' as context to the test case. So if 2nd test case fails then value is getting printed twice.

Following is the snapshot:

Following is my afterEach() method :

afterEach(function () {
    if (this.currentTest.state === 'failed') {    
      var test = this.currentTest

      Cypress.on('test:after:run', (test) => {

        addContext({ test }, {
          title: 'Failing Screenshot: ' + '>> screenshots/' + Cypress.spec.name + '/' + test_name + ' -- ' + test.title + ' (failed)' + '.png <<',
          value: 'screenshots/' + Cypress.spec.name + '/' + test_name + ' -- ' + test.title + ' (failed)' + '.png'
          //value: 'data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA+gAAABkCAYAAAAVORraAAACH0lEQVR'
        })
      });
    } 
  })

Why are you mixing Cypress.on with an afterEach hook? You really want to add a new event listener on every test? — kuceb, Mar 18 '19 at 12:45

score 1 · Accepted Answer · answered Mar 18 '19 at 07:05

1

Got what I was looking from https://docs.cypress.io/api/events/catalog-of-events.html#Cypress-Events

Though I'll have to remove Cypress.on('test:after:run', afterEach()

So I'll have to specify Cypress.on('test:after:run', in each spec file

const spec_name = this.title

  Cypress.on('test:after:run', (test) => {

    if (test.state === 'failed') {
      addContext({ test }, {
        title: 'Failing Screenshot: ' + '>> screenshots/' + Cypress.spec.name + '/' + spec_name + ' -- ' + test.title + ' (failed)' + '.png <<',
        value: 'screenshots/' + Cypress.spec.name + '/' + spec_name + ' -- ' + test.title + ' (failed)' + '.png'
      })
    }
  });

which is kind of put off, it would be better to put this whole code in support/command.js

answered Mar 18 '19 at 07:05

Kushal Bhalaik

3,349
5
23
46

Why can't you put that in `support/index.js`? – kuceb Mar 18 '19 at 12:43
I need to have current spec title and current test title to be passed to cypress.on, feel free to share how to do that – Kushal Bhalaik Mar 19 '19 at 06:40
Do you know how to get the current spec title yet? – Jake He Jun 01 '19 at 04:22
1

I found it. `runnable.parent.title`. Just add `runnable` like this`Cypress.on('test:after:run', (test, runnable) => {` – Jake He Jun 01 '19 at 04:59
Thanks Jake, I'll try it out and let you know. – Kushal Bhalaik Jun 13 '19 at 09:43

score 1 · Answer 2 · answered Jun 18 '19 at 15:43

You can add this code :

const addContext = require('mochawesome/addContext');

Cypress.on('test:after:run', (test, runnable) => {
  if (test.state === 'failed') {
    addContext({test}, { title: "Screenshot", value:`../cypress/screenshots/${Cypress.spec.name}/${runnable.parent.title} -- ${test.title} (failed).png` })
  }
})

inside "support/index.js" and you will have the screenshot of the failed test within your reports

score 0 · Answer 3 · answered May 12 '20 at 13:25

Workaround if you need to use it within tests (using test id)

In your support/index.js

Cypress.on('test:before:run', (test, runnable) => {
  if (!window['extra']) {
    window['extra'] = []
  }

  if (!window['extra'][test.id]) {
    window['extra'][test.id] = []
  }
})

Cypress.on('test:after:run', (test, runnable) => {
    window['extra'][test.id].map((item) => {
      addContext({ test }, item)
    })
})

And now you can use it within your test (getting the test.id)

it('some test', function() {
  // Using window to bypass issue with context
        window['extra'][this.test.id].push( {
          title: 'Hello',
          value: 'World
        })  
})

Cypress - addContext() is keeping previous failure count and adding it to each 'it' scenario in mochawesome report

3 Answers3

Workaround if you need to use it within tests (using test id)