RubyMine 7.0.1 Web Help

The Mocha test framework supports executing unit tests against the Node.js server. The tests themselves can use BDD, TDD, Exports, and QUnit interfaces.

On this page:

Preparing to Install the Mocha Test Framework
  1. Download and install Node.js. The framework is required for two reasons:
    • The Mocha test framework is started through Node.js.
    • NPM, which is a part of the framework, is also the easiest way to download the Mocha test framework.

  2. If you are going to use the command line mode, make sure the following paths are added to the PATH variable:
    1. The path to the parent folder of the Node.js executable file.
    2. The path to the npm folder.

    This enables you to launch the Mocha test framework and npm from any folder.

  3. Install and enable the NodeJS repository plugin.

    The plugin is not bundled with RubyMine, but it is available from the RubyMine plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your RubyMine projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

  4. Install and enable the Mocha repository plugin.

    The plugin is not bundled with RubyMine, but it is available from the RubyMine plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your RubyMine projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

Installing the Mocha Test Framework

The easiest way to install the Mocha test framework is to use the Node Package Manager (npm), which is a part of Node.js.

Depending on the desired location of the Mocha test framework executable file, choose one of the following methods:

  • Install the test framework globally at the RubyMine level so it can be used in any RubyMine project.
  • Install the test framework in a specific project and thus restrict its use to this project.
  • Install the test framework in a project as a development dependency.

In either installation mode, make sure that the parent folder of the Mocha test framework is added to the PATH variable. This enables you to launch the test framework from any folder.

RubyMine provides user interface both for global and project installation as well as supports installation through the command line.

Installing Mocha Globally

Global installation makes the test framework available at the RubyMine level so it can be used in any RubyMine project. Moreover, during installation the parent folder of the test framework is automatically added to the PATH variable, which enables you to launch the test framework from any folder. To install the test framework globally, do one of the following:

  1. Run the installation from the command line in the global mode:
    1. Launch the embedded Terminal by hovering your mouse pointer over show_tool_window_bars in the lower left corner of RubyMine and choosing Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Switch to the directory where NPM is stored or define a PATH variable for it so it is available from any folder, see Installing NodeJs.
    3. Type the following command at the command line prompt:
      npm install -g mocha 
                                  

      For more details on the NPM operation modes, see npm documentation. For more information about installing the Mocha test framework, see https://npmjs.org/package/mocha.

  2. Run NPM from RubyMine using the Node.js and NPM page of the Settings dialog box.
    1. Open the Settings dialog box by choosing File | Settings or pressing Ctrl+Alt+SCtrl+Alt+SCtrl+Alt+SCtrl+Alt+SCtrl+Alt+SAlt+F7Ctrl+Alt+SCtrl+Alt+S⌘+Comma⌘ Comma⌘ Comma⌘ Comma⌘ Comma and click Node.js and NPM under Languages&Frameworks.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the required package to install.
    4. Select the Options check box and type -g in the text box next to it.
    5. Optionally specify the product version and click Install Package to start installation.
Installing Mocha in a Project

Installing the test framework in a specific project restricts its use to this project. To run project installation, do one of the following:

  • Run the installation from the command line:
    1. Launch the embedded Terminal by hovering your mouse pointer over show_tool_window_bars in the lower left corner of RubyMine and choosing Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Switch to the project root folder and type the following command at the command line prompt:
      npm install mocha 
                              
  • Run NPM from RubyMine using the Node.js and NPM page of the Settings dialog box.
    1. Open the project settings by choosing File | Settings or pressing Ctrl+Alt+SCtrl+Alt+SCtrl+Alt+SCtrl+Alt+SCtrl+Alt+SAlt+F7Ctrl+Alt+SCtrl+Alt+S⌘+Comma⌘ Comma⌘ Comma⌘ Comma⌘ Comma, see Accessing Settings for details. Then click Node.js and NPM under the Languages & Frameworks node.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the required package.
    4. Optionally specify the product version and click Install Package to start installation.

Project level installation is helpful and reliable in template-based projects of the type Node Boilerplate or Node.js Express, which already have the node_modules folder. The latter is important because NPM installs the Mocha test framework in a node_modules folder. If your project already contains such folder, the Mocha test framework is installed there.

Projects of other types or empty projects may not have a node_modules folder. In this case npm goes upwards in the folder tree and installs the Mocha test framework in the first detected node_modules folder. Keep in mind that this detected node_modules folder may be outside your current project root.

Finally, if no node_modules folder is detected in the folder tree either, the folder is created right under the current project root and the Mocha test framework is installed there.

In either case, make sure that the parent folder of the Mocha test framework is added to the PATH variable. This enables you to launch the test framework from any folder.

See Also

Procedures:

Reference:

Web Resources: