nathanboktae

mocha-casperjs

module.exports = function (Mocha, casper, utils) {

    if (currentDone && (!currentTest || !currentTest.state)) {

      currentDone(currentTest.errors && currentTest.errors[0])

    if ( casper.step < casper.steps.length ) {

  Mocha.prototype.failCurrentTest = failTest;

  // hookup to all the various casper error events and save that error to report to mocha later

  casper.on('waitFor.timeout', function(timeout, details) {

    var message = f('waitFor timeout of %dms occured', timeout)

      message = f(details.waitWhile ? '"%s" never went away in %dms' : '"%s" still did not exist %dms', details.selector, timeout)

      message = f(details.waitWhile ? '"%s" never disappeared in %dms' : '"%s" never appeared in %dms', details.visible, timeout)

      message = f('%s did not load in %dms', details.url, timeout)

      message = f('%s did not pop up in %dms', details.popup, timeout)

      message = f('"%s" did not appear in the page in %dms', details.text, timeout)

    else if (details.selectorTextChange) {

      message = f('"%s" did not have a text change in %dms', details.selectorTextChange, timeout)

    else if (typeof details.testFx === 'Function') {

      message = f('"%s" did not appear in the page in %dms', details.testFx.toString(), timeout)

  casper.on('step.timeout', function(step) {

    failTest(new Error(f('step %d timed out (%dms)', step, casper.options.stepTimeout)))

    failTest(new Error(f('Load timeout of (%dms)', casper.options.timeout)))

  // clear Casper's default handlers for these as we handle everything through events

  casper.options.onTimeout = casper.options.onWaitTimeout = casper.options.onStepTimeout = function() {}

  // casper will exit on step failure by default

  // Method for patching mocha to run casper steps is inspired by https://github.com/domenic/mocha-as-promised

  Object.defineProperties(Mocha.Runnable.prototype, {

        Object.defineProperty(this, 'casperWraperFn', {

            // Run the original `fn`, passing along `done` for the case in which it's callback-asynchronous.

            // Make sure to forward the `this` context, since you can set variables and stuff on it to share

            // only flush the casper steps on test Runnables,

            // and if there are steps not ran,

            // and no set of steps are running (casper.checker is the setInterval for the checkSteps call)

            if (currentTest && casper.steps && casper.steps.length &&

                casper.step < casper.steps.length && !casper.checker) {

                if (!currentTest || !currentTest.state) {

            } else if (fn.length === 0 && currentTest && !currentTest.state) {

              // If `fn` is synchronous (i.e. didn't have a `done` parameter and didn't return a promise),

              // call `done` now. (If it's callback-asynchronous, `fn` will call `done` eventually since

        this.casperWraperFn.toString = function () {

        return typeof this.casperWraperFn === 'function'

        // Ignore Mocha trying to set this - tests are always asyncronous with our wrapper

  // Mocha needs the formating feature of console.log so copy node's format function and

  // monkey-patch it into place. This code is copied from node's, links copyright applies.

  // https://github.com/joyent/node/blob/master/lib/util.js

      for (i = 0; i < arguments.length; i++) {

        objects.push(JSON.stringify(arguments[i]));

    var str = String(f).replace(/%[sdj%]/g, function(x) {

        case '%s': return String(args[i++]);

        case '%d': return Number(args[i++]);

        case '%j': return JSON.stringify(args[i++]);

    for (var x = args[i]; i < len; x = args[++i]) {

      if (x === null || typeof x !== 'object') {

  "description": "Write CasperJS tests using Mocha",

  "author": "Nathan Black <nathan@nathanblack.org>",

    "url": "https://github.com/nathanboktae/mocha-casperjs"

    "url": "http://github.com/nathanboktae/mocha-casperjs/issues"

    "mocha-casperjs": "./bin/mocha-casperjs"

    "casperjs": "git://github.com/n1k0/casperjs.git#master",

    "test": "./node_modules/mocha/bin/mocha test/all.coffee"

# CasperJS automation via Mocha [![Build Status](https://secure.travis-ci.org/nathanboktae/mocha-casperjs.png?branch=master)](https://travis-ci.org/nathanboktae/mocha-casperjs)

[![Join the chat at https://gitter.im/nathanboktae/mocha-casperjs](https://badges.gitter.im/nathanboktae/mocha-casperjs.svg)](https://gitter.im/nathanboktae/mocha-casperjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Combine the power of [casperjs][]' automation with [Mocha][]'s robust testing framework features

- automatically load Casper, Mocha, and optionally [chai][] and [casper-chai][]

- automatically run your Casper steps after each test

- use any Mocha reporter that can run in the [phantomjs][] environment

For example, let's rewrite Casper's [google testing example](http://docs.casperjs.org/en/latest/testing.html#browser-tests)

describe('Google searching', function() {

    casper.start('http://www.google.fr/')

  it('should retrieve 10 or more results', function() {

      'form[action="/search"]'.should.be.inDOM.and.be.visible

      this.fill('form[action="/search"]', {

    casper.waitForUrl(/q=casperjs/, function() {

For the sample above you also need `chai` and `casper-chai`, a great assertion library and a plugin that works well with casperjs (more info below)

Like Mocha, if you place your tests in the `test` or `tests` directory, it will find them and run them. You can also specify tests to run individually instead.

Note that mocha-casperjs has peer dependencies on casper and mocha, and will be installed ajacent to where you are installing mocha-casperjs (e.g. if you install mocha-casperjs globally, you'll have mocha and casperjs also installed globally).

Note that [slimerjs][] isn't [supported at the moment](https://github.com/nathanboktae/mocha-casperjs/issues/5)

Remember that your tests *do not run in node.js*, but whatever engine you choose from casperjs, so your language and API features will depend on that.

You need to use `mocha-casperjs.bat` that will call into `casperjs.exe`. Please also refer to [CasperJS' Installation Instructions on Windows](http://docs.casperjs.org/en/latest/installation.html#casperjs-on-windows).

I no longer have access to a Windows box or VM to develop on, so you'll have to dig into any issues with the batch file yourselves and send a pull request. In the end it's a shell and `PATH` issue and you can always call `casperjs.exe` yourself.

If [chai][] is discovered (it must be installed adjacent to mocha-casperjs), it will automatically use the `should` style as well as expose `expect` globally.

If [casper-chai][] is discovered, it will be used with chai.

The [selectXPath](http://casperjs.readthedocs.org/en/latest/selectors.html#index-2) casper helper method is exposed globally as `xpath`.

In addition to specifying options on the command line, you can add them to a `mocha-casperjs.opts` [like mocha.opts](http://mochajs.org#mochaopts), except it looks for this file in the current directory.

These are all [Mocha command line options](http://mochajs.org/#usage) that mocha-casperjs supports. Currently the default timeout is 30 seconds, not two, as writing end to end tests takes more time.

Note the CasperJS cli parser does not support shorthands or spaces between parameters. So rather than `-g foo` and `--grep foo`, use `--grep=foo`

Set Casper's timeout. If not set, no timeout will happen. This is one overall timeout for the entire test run.

Set Casper's waitTimeout, the timeout used by the `waitFor*` family of functions. If not set, the casper default is used (as of this writting, it is 5 seconds)

Set Casper's stepTimeout, the timeout for individual steps. If not set, the casper default is used (as of this writing, no timeout is set).

Pipe reporter output to the specified file instead of standard out. Use this if you have to filter out console messages from reporter output, like for `json`, `xunit`, etc. type of reporters. However, this only works if you the reporter uses `process.stdout.write`. If it uses `console.log`, mocha-casperjs cannot distinquish reporter output from test output. In that case, simply pipe the output to a file.

Load [Mocha][] from the specified path, otherwise look for it adjacent to mocha-casperjs

Load [Chai][] from the specified path, otherwise look for it adjacent to mocha-casperjs

Load [casper-chai][] from the specified path, otherwise look for it adjacent to mocha-casperjs

Also, you can add [CasperJS options](http://docs.casperjs.org/en/latest/modules/casper.html#index-1) to `mocha-casperjs.opts`. Below are the supported options:

Sets the `User-Agent` string (like `Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)`) to send through headers when performing requests. 

`--viewport-width=<pixels> --viewport-height=<pixels>`

Sets the `PhantomJS` viewport to custom size. Useful for testing media queries and capturing screenshots:

casper.on('load.finished', function (resource) {

  this.captureSelector(screenshots_path + 'body.png', 'body');

A comma seperated list of files to inject into the remote client every page load.

Any phantomjs options (use `phantomjs --help` - online documentation is very old) will be passed through as-is to casperjs, which then passes them to phantomjs. Note you cannot pass them via `mocha-casperjs.opts` file, as these options are only for specific options that `mocha-casperjs` knows about.

You can provide your own reporter via the `--reporter` flag. mocha-phantomjs will try to `require` the module and load it. Some things to take note of:

- Both node modules and script files can be required, so for relative paths to scripts, make sure they start with '.'. E.g. use `--reporter=./foo` to load `foo.js` that is in the current directory. CoffeeScript files can be directly required too, as phantomjs has coffeescript built in.

- *PhantomJS is not node.js.* You won't have access to standard node modules like `url`, `http`, etc. Refer to [PhantomJS's built in modules](https://github.com/ariya/phantomjs/wiki/API-Reference#wiki-module-api). However, mocha-casperjs does provide a very minimalistic `process` shim to PhantomJS's `system` module.

		@@ -31,3 +31,6 @@ module.exports = function (Mocha, casper, utils) {
		}
		},

		resetSteps = function() {
		casper.bypass(casper.steps.length)
		}
		@@ -52,3 +55,3 @@
		casper.on('waitFor.timeout', function(timeout, details) {
		casper.step++
		resetSteps()
		var message = f('waitFor timeout of %dms occured', timeout)
		@@ -83,7 +86,7 @@ details = details \|\| {}
		casper.on('step.timeout', function(step) {
		casper.step++
		resetSteps()
		failTest(new Error(f('step %d timed out (%dms)', step, casper.options.stepTimeout)))
		})
		casper.on('timeout', function() {
		casper.step++
		resetSteps()
		failTest(new Error(f('Load timeout of (%dms)', casper.options.timeout)))
		@@ -90,0 +93,0 @@ })

		@@ -11,3 +11,3 @@ {
		],
		"version": "0.5.8" ,
		"version": "0.6.0" ,
		"author": "Nathan Black <nathan@nathanblack.org>",
		@@ -14,0 +14,0 @@ "license": "MIT",

		@@ -55,2 +55,4 @@ # CasperJS automation via Mocha [![Build Status](https://secure.travis-ci.org/nathanboktae/mocha-casperjs.png?branch=master)](https://travis-ci.org/nathanboktae/mocha-casperjs)

		Remember that your tests do not run in node.js, but whatever engine you choose from casperjs, so your language and API features will depend on that.

		#### Windows users
		@@ -57,0 +59,0 @@

Improved metrics