npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-mocha-selenium

v1.0.1

Published

Run functional Mocha tests with webdriver against a local selenium instance.

Downloads

15

Readme

grunt-mocha-selenium

Run functional Mocha tests with wd with Selenium, Phantomjs and Appium.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-mocha-selenium --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-mocha-selenium');

The "mochaSelenium" task

Selenium tests are run by a standalone selenium driver that will be downloaded the first time the task is run. Chrome support is provided by the Chrome Driver plugin for Selenium and is provided on demand.

The task fires up a selenium instance for the browser of your choice (Firefox, Chrome or Phantomjs) and initializes an instance of wd, passing it to the mocha test runner's context.

Take a look in the test directory for examples of what mocha tests with wd look like.

Overview

In your project's Gruntfile, add a section named mochaSelenium to the data object passed into grunt.initConfig().

grunt.initConfig({
  mochaSelenium: {
    options: {
      // Mocha options
      reporter: 'spec',
      timeout: 30e3,
      // Toggles wd's promises API, default:false
      usePromises: false
    },
    firefox: {
      src: ['test/*.js']
      // firefox is the default browser, so no browserName option required
    },
    chrome: {
      src: ['test/*.js'],
      options: {
        // Chrome browser must be installed from Chromedriver support
        browserName: 'chrome'
      }
    },
    phantomjs: {
      src: ['test/*.js'],
      options: {
        // phantomjs must be in the $PATH when invoked
        browserName: 'phantomjs'
      }
    }
  }
})

Options

The usual Mocha options are passed through this task to a new Mocha instance.

The following options can be supplied to the task:

options.usePromises

Type: Boolean Default value: false

If enabled, this will use the promise-enabled wd browser API instead of the normal synchronous API.

options.host and options.port

If these are specified then a server will not be started but these settings will be used to connect to an existing server.

"options.username" and "options.accesskey" can be specified if you want to use Sauce Labs' on demand service.

options.wdCustomizer

If you'd like to add custom wd methods, you can specify a wdCustomizer path to a module that patches the wd module before the wd remote is created.

Example:

grunt.initConfig({
  mochaSelenium: {
    options: {
      reporter: 'spec',
      timeout: 30e3,
      useChaining: true
    },
    phantomjs: {
      src: ['test/*.js'],
      options: {
        browserName: 'phantomjs',
        wdCustomizer: 'test/wd_customizer'
      }
    }
  }
})

test/wd_customizer.js:

function wdCustomizer(wd) {
  wd.addPromiseChainMethod(
    'waitForSomethingCustom',
    function(pageId) {
      return this.waitForElementByCssSelector('#somethingCustom');
    }
  );

  return wd;
}

module.exports = wdCustomizer;

Usage Examples

See this project's Gruntfile.js for examples.

In this example, we'll run functional mocha tests for all files in the test directory using the wd promises API and the nyan-cat reporter.

grunt.initConfig({
  mochaSelenium: {
    options: {
      reporter: 'nyan',
      usePromises: true,
      useChrome: true
    },
    all: ['test/*.js' ]
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • v0.7.0 - bumping selenium and chromedriver versions
  • v0.4.0 - add Appium support
  • v0.3.0 - add phantomjs support
  • v0.2.0 - add chromedriver support
  • v0.0.1 - initial release

Licensed under the MIT license.