Jump to: navigation, search

Difference between revisions of "Orion/Node/Developing"

< Orion‎ | Node
m (Orion/Node/Tests moved to Orion/Node/Developing: don't need a separate tests page yet-- put it under 'developing')
Line 1: Line 1:
== Unit tests ==
+
This page explains how to develop the experimental Node.js-based Orion server. See [[Orion/Getting started with Orion node]] for an introduction.
 +
 
 +
== Running the tests ==
 
Our unit tests are written against the [http://visionmedia.github.com/mocha/ Mocha] test framework.
 
Our unit tests are written against the [http://visionmedia.github.com/mocha/ Mocha] test framework.
  
=== Running the tests ===
 
 
From the <code>org.eclipse.orion.client/modules/orionode</code> directory, just run the command:
 
From the <code>org.eclipse.orion.client/modules/orionode</code> directory, just run the command:
 
   npm test
 
   npm test

Revision as of 11:04, 27 March 2013

This page explains how to develop the experimental Node.js-based Orion server. See Orion/Getting started with Orion node for an introduction.

Running the tests

Our unit tests are written against the Mocha test framework.

From the org.eclipse.orion.client/modules/orionode directory, just run the command:

 npm test

This will invoke Mocha and produce console output showing which tests passed and failed.

If you didn't install the Mocha package globally (or if you want to pass custom arguments to Mocha), run this instead:

 ./node_modules/mocha/bin/mocha [debug] [options] [files]

To make this easier, you can install Mocha as a global npm package (npm install mocha -g), and then invoke it as simply mocha from a command shell.

Writing more tests

When you're prototyping a new feature, writing unit tests for it is always a good idea. Here's how to write a test:

  1. Create a new file my_tests.js in the org.eclipse.orion.client/modules/orionode/test/ directory.
  2. Write your tests in the file. Here are two resources to help you get started:
  3. Run the tests.
    • You don't have to register your new tests with the framework; it will discover anything in the test/ directory automatically.

Helper data or classes should go in test/support/.