How to use failCurrentTest method in Cypress

1module.exports = function (Mocha, casper, utils) {2  var currentDone,3      currentTest,4      f = utils.format,5  reportError = function() {6    casper.checker = null7    if (currentDone && (!currentTest || !currentTest.state)) {8      // the first error takes priority9      currentDone(currentTest.errors && currentTest.errors[0])10    }11  },12  failTest = function(error) {13    casper.unwait()14    clearInterval(casper.checker)15    if (currentTest.errors) {16      currentTest.errors.push(error)17    } else {18      currentTest.errors = [error]19    }20    if ( casper.step < casper.steps.length ) {21      casper.run(function() {22        reportError();23      });24    } else {25      reportError();26    }27  },28  resetSteps = function() {29    casper.bypass(casper.steps.length)30  }31  Mocha.prototype.failCurrentTest = failTest;32  // hookup to all the various casper error events and save that error to report to mocha later33  [34    'error',35    'wait.error',36    'waitFor.timeout.error',37    'event.error',38    'complete.error',39    'step.error'40  ].forEach(function(event) {41    casper.on(event, function(error) {42      failTest(error)43    })44  })45  casper.on('waitFor.timeout', function(timeout, details) {46    resetSteps()47    var message = f('waitFor timeout of %dms occured', timeout)48    details = details || {}49    if (details.selector) {50      message = f(details.waitWhile ? '"%s" never went away in %dms' : '"%s" still did not exist %dms', details.selector, timeout)51    }52    else if (details.visible) {53      message = f(details.waitWhile ? '"%s" never disappeared in %dms' : '"%s" never appeared in %dms', details.visible, timeout)54    }55    else if (details.url) {56      message = f('%s did not load in %dms', details.url, timeout)57    }58    else if (details.popup) {59      message = f('%s did not pop up in %dms', details.popup, timeout)60    }61    else if (details.text) {62      message = f('"%s" did not appear in the page in %dms', details.text, timeout)63    }64    else if (details.selectorTextChange) {65      message = f('"%s" did not have a text change in %dms', details.selectorTextChange, timeout)66    }67    else if (typeof details.testFx === 'Function') {68      message = f('"%s" did not appear in the page in %dms', details.testFx.toString(), timeout)69    }70    failTest(new Error(message))71  })72  casper.on('step.timeout', function(step) {73    resetSteps()74    failTest(new Error(f('step %d timed out (%dms)', step, casper.options.stepTimeout)))75  })76  casper.on('timeout', function() {77    resetSteps()78    failTest(new Error(f('Load timeout of (%dms)', casper.options.timeout)))79  })80  // clear Casper's default handlers for these as we handle everything through events81  casper.options.onTimeout = casper.options.onWaitTimeout = casper.options.onStepTimeout = function() {}82  // casper will exit on step failure by default83  casper.options.silentErrors = true84  // Method for patching mocha to run casper steps is inspired by https://github.com/domenic/mocha-as-promised85  //86  Object.defineProperties(Mocha.Runnable.prototype, {87    fn: {88      configurable: true,89      enumerable: true,90      get: function () {91        return this.casperWraperFn;92      },93      set: function (fn) {94        Object.defineProperty(this, 'casperWraperFn', {95          value: function (done) {96            currentTest = this.test97            currentDone = done98            // Run the original `fn`, passing along `done` for the case in which it's callback-asynchronous.99            // Make sure to forward the `this` context, since you can set variables and stuff on it to share100            // within a suite.101            fn.call(this, done)102            // only flush the casper steps on test Runnables,103            // and if there are steps not ran,104            // and no set of steps are running (casper.checker is the setInterval for the checkSteps call)105            if (currentTest && casper.steps && casper.steps.length &&106                casper.step < casper.steps.length && !casper.checker) {107              casper.run(function () {108                casper.checker = null109                if (!currentTest || !currentTest.state) {110                  done()111                }112              })113            } else if (fn.length === 0 && currentTest && !currentTest.state) {114              // If `fn` is synchronous (i.e. didn't have a `done` parameter and didn't return a promise),115              // call `done` now. (If it's callback-asynchronous, `fn` will call `done` eventually since116              // we passed it in above.)117              done()118            }119          },120          writable: true,121          configurable: true122        })123        this.casperWraperFn.toString = function () {124          return fn.toString();125        }126      }127    },128    async: {129      configurable: true,130      enumerable: true,131      get: function () {132        return typeof this.casperWraperFn === 'function'133      },134      set: function () {135        // Ignore Mocha trying to set this - tests are always asyncronous with our wrapper136      }137    }138  })139  // Mocha needs the formating feature of console.log so copy node's format function and140  // monkey-patch it into place. This code is copied from node's, links copyright applies.141  // https://github.com/joyent/node/blob/master/lib/util.js142  console.format = function (f) {143    var i;144    if (typeof f !== 'string') {145      var objects = [];146      for (i = 0; i < arguments.length; i++) {147        objects.push(JSON.stringify(arguments[i]));148      }149      return objects.join(' ');150    }151    i = 1;152    var args = arguments;153    var len = args.length;154    var str = String(f).replace(/%[sdj%]/g, function(x) {155      if (x === '%%') return '%';156      if (i >= len) return x;157      switch (x) {158        case '%s': return String(args[i++]);159        case '%d': return Number(args[i++]);160        case '%j': return JSON.stringify(args[i++]);161        default:162          return x;163      }164    });165    for (var x = args[i]; i < len; x = args[++i]) {166      if (x === null || typeof x !== 'object') {167        str += ' ' + x;168      } else {169        str += ' ' + JSON.stringify(x);170      }171    }172    return str;173  };174  var origError = console.error,175      origLog = console.log176  console.error = function() { origError.call(console, console.format.apply(console, arguments)) }177  console.log = function() { origLog.call(console, console.format.apply(console, arguments)) }178  // Since we're using the precompiled version of mocha usually meant for the browser, 179  // patch the expossed process object (thanks mocha-phantomjs users for ensuring it's exposed)180  // https://github.com/visionmedia/mocha/issues/770181  Mocha.process = Mocha.process || {}182  Mocha.process.stdout = require('system').stdout...

1casper.on('page.error', function(err, trace) {2  mocha.failCurrentTest(new Error('Error from page: ' + err + '\nStack trace: ' + JSON.stringify(trace)))3})4describe('catching javascript errors in the page', function() {5  it('should fail when errors happen', function() {6    casper7      .start('http://bing.com')8      .then(function() {9        this.evaluate(function() {10          return window.foobar.somethingelse.kaboom11        })12      }).then(function() {13        throw new Error('you will not get to here')14      })15  })16})

1var searchData=2[3  ['failcurrenttest_132',['failCurrentTest',['../class_test_runner.html#ac7b64e84fbc3be012003ef5458f8a2bb',1,'TestRunner']]],4  ['filename_133',['fileName',['../class_test.html#af55b687c1498a727553a74bb6ac39df1',1,'Test']]],5  ['flushtofile_134',['flushToFile',['../class_disassembly_buffer.html#ab66fd90ea92c5af74594effaa5fea9bf',1,'DisassemblyBuffer']]]...

1var searchData=2[3  ['failcurrenttest_27',['failCurrentTest',['../class_test_runner.html#ac7b64e84fbc3be012003ef5458f8a2bb',1,'TestRunner']]],4  ['filename_28',['fileName',['../class_test.html#af55b687c1498a727553a74bb6ac39df1',1,'Test']]],5  ['flushtofile_29',['flushToFile',['../class_disassembly_buffer.html#ab66fd90ea92c5af74594effaa5fea9bf',1,'DisassemblyBuffer']]]...

1var searchData=2[3  ['failcurrenttest_52',['failCurrentTest',['../class_test_runner.html#ac7b64e84fbc3be012003ef5458f8a2bb',1,'TestRunner']]],4  ['filename_53',['fileName',['../class_test.html#af55b687c1498a727553a74bb6ac39df1',1,'Test']]]...

1var searchData=2[3  ['failcurrenttest_11',['failCurrentTest',['../class_test_runner.html#ac7b64e84fbc3be012003ef5458f8a2bb',1,'TestRunner']]],4  ['filename_12',['fileName',['../class_test.html#af55b687c1498a727553a74bb6ac39df1',1,'Test']]]...

1var searchData=2[3  ['failcurrenttest_11',['failCurrentTest',['../class_test_runner.html#ac7b64e84fbc3be012003ef5458f8a2bb',1,'TestRunner']]],4  ['filename_12',['fileName',['../class_test.html#af55b687c1498a727553a74bb6ac39df1',1,'Test']]]...