Skip to content

Latest commit

 

History

History
89 lines (73 loc) · 3.01 KB

README.md

File metadata and controls

89 lines (73 loc) · 3.01 KB
Raw

Work in progress, not yet usable.

Build status

Build Status Sauce Test Status Coverage Status

Installation

Install via Bower:

bower install qunit-desktop-notifications

Or download from GitHub.

Include QUnit Desktop Notifications after QUnit:

<link href="path/to/qunit.css" rel="stylesheet">
<script src="path/to/qunit.js"></script>
<link href="path/to/qunit-desktop-notifications.css" rel="stylesheet">
<script src="path/to/qunit-desktop-notifications.js"></script>

Configuration

QUnit Desktop Notifications has to be configured before QUnit.start() is called. If you call QUnit.start() explicitly, just call QUnitDesktopNotifications.options() before that. Otherwise, configuration would ideally be included right after plugin inclusion, and must be included before window load event, because QUnit uses it for auto start.

Available configuration:

QUnitDesktopNotifications.options({
	disabled: false, // whether the plugin should be disabled
	urlConfig: true  // whether to add URL config item to QUnit toolbar
})

Profiles

Profiles are a way to configure what kind of events will generate desktop notifications.

Development

If you would like to participate in development of this plugin, fork this repository, clone it, then install locally:

npm install --global bower grunt-cli selenium-standalone@latest
npm install
bower install
selenium-standalone install

Running tests

Unit tests are run using Node. Functional tests are run using local Selenium server or Sauce Labs VM's.

To run all tests using local Selenium server:

grunt test

To run unit tests using Node:

grunt test:client

To run functional tests using local Selenium server:

selenium-standalone start # start Selenium Server
grunt test:runner # run tests when Selenium Server started

To run all test using Sauce Labs:

grunt intern:runner-ci

For that, Sauce Labs username and accesskey needs to be available as environment variables (more on the subject, ignore the Karma part).

Known issues

  • Stop local Selenium server before running Sauce Labs tests from local machine. Also stop or finish SauceLabs tests before starting local server, because both use the same port.
  • Running grunt coveralls:all can cause BSOD on Windows 7.