Блог

У меня есть следующий пример сценария для эксперимента с обработкой исключений в Cypress. Но исключение не улавливается. Что я здесь упускаю?

 Cypress.on('uncaught:exception', (err, runnable) => {
    Cypress.log("this is top-level exception hadling")
    return false
})

context('Actions', () => {
    
    it('sample_testing', () => {
    
        cy.on('uncaught:exception', (err, runnable) => {
            cy.log("this is test-level exception hadling")
            return false
        })
        
        cy.get("#notfound", {timeout:1000})
    })
    
})
 

Пожалуйста, обратите внимание, что на моей веб-странице нет элемента с идентификатором, который не найден.

Неперехваченные исключения относятся только к ошибкам приложения. Сбои в тестовом коде перехватываются Cypress, но затем сообщаются как сбой теста.

Тест Не Прошел

Чтобы предотвратить это, вы можете использовать событие fail

 Cypress.on('fail', (error, runnable) => {
  debugger

  // we now have access to the err instance
  // and the mocha runnable this failed on

  throw error // throw error to have test still fail
})

it('calls the "fail" callback when this test fails', () => {
  // when this cy.get() fails the callback
  // is invoked with the error
  cy.get('element-that-does-not-exist')
})
 

Неперехваченные исключения

Взгляните на рецепт Обработки ошибок приложения

app.js — выдает ошибку

 document.getElementById('error').addEventListener('click', () => {
  console.log('application will throw an error in 1 second')
  setTimeout(() => {
    console.log('application is about to throw an error')
    throw new Error('Things went bad')
  }, 1000)
})
 

тест — поймайте ошибку и выборочно проигнорируйте, если в ней есть определенное сообщение

   it('can be ignored', () => {
    /**
     * By using "cy.on()" we can ignore an exception in the current test only.
     * If you want to register exception handler for all tests using "Cypress.on()"
     * @see https://on.cypress.io/catalog-of-events
     * @param {Error} e The exception we caught
     * @param {Mocha.Runnable} runnable is the current test or hook during which the error is caught
     */
    cy.on('uncaught:exception', (e, runnable) => {
      console.log('error', e)
      console.log('runnable', runnable)

      // we can simply return false to avoid failing the test on uncaught error
      // return false
      // but a better strategy is to make sure the error is expected
      if (e.message.includes('Things went bad')) {
        // we expected this error, so let's ignore it
        // and let the test continue
        return false
      }
      // on any other error message the test fails
    })

    cy.visit('index.html')
    cy.get('button#error').click()
    // the error happens after 1000ms
    // we can use hard-coded wait, see the other test
    // to learn how to avoid an unnecessary wait
    cy.wait(1500)
  })
 

Я перепробовал множество вариантов такого решения, и это дало мне лучший способ отладки неучтенных исключений. Это одно регистрирует исключение в консоли браузера:

 Cypress.on('uncaught:exception', (err, runnable) => {
    // returning false here prevents Cypress from
    // failing the test
    cy.log('Uncaught exception... continuing...')
    return false
})


Cypress.on('fail', (error, runnable) => {
    console.log(error)

    // we now have access to the err instance
    // and the mocha runnable this failed on

    throw error // throw error to have test still fail
})

Cypress.on('window:before:load', (win) => {
    Cypress.log({
        name: 'console.log',
        message: 'wrap on console.log',
    });

    // pass through cypress log so we can see log inside command execution order
    win.console.log = (...args) => {
        Cypress.log({
            name: 'console.log',
            message: args,
        });
    };
});

Cypress.on('log:added', (options) => {
    if (options.instrument === 'command') {
        // eslint-disable-next-line no-console
        console.log(
            `${(options.displayName || options.name || '').toUpperCase()} ${
                options.message
            }`,
        );
    }
});