ReSharper Help

Unit Testing Assistance in JavaScript

ReSharper helps discover and run unit tests of QUnit and Jasmine frameworks right in Visual Studio.

With ReSharper, you can execute a single unit test, all tests in a file, project or solution. You can also execute any number of tests combined in a test session.

In this topic:

Configuring JavaScript unit testing preferences

If you use Jasmine framework, make sure to select the framework version on the Tools | Unit Testing | JavaScript Tests options page.

By default, when the tests are started, ReSharper launches default web browser to show output from the unit testing framework. It runs the tests and reports the information back to ReSharper. If necessary, you can change the browser in the Tools | Unit Testing | JavaScript Tests options page. You can also choose to run tests with PhantomJS library without launching a browser. To do so, select PhantomJS and specify the path to the PhantomJS executable file and change the default command line arguments, if necessary.

You can specify a custom HTML harness for your tests. The harness is compatible with the Chutzpah test runner and can use the special Chutzpah placeholders.

To use a custom HTML harness

  1. Tick the Enable custom HTML harness check box in the Tools | Unit Testing | JavaScript Tests options page.
  2. If you do not have a harness file, you can create an empty HTML file, click the Copy default implementation to clipboard and paste the default harness template into the file.
  3. Type a filename or path for the harness file.
  4. Using the Test harness location selector, specify how the filename or path should be treated by the test runner.
  5. Click Save to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To drop-down list. For more information, see Managing and Sharing ReSharper Settings.

Discovering tests in current document

ReSharper discovers unit test suites and single unit tests of all supported frameworks right in the editor and adds the corresponding action indicators next to each item in the editor:

The example below shows a unit test suite created using the Jasmine framework:

ReSharper shows different indicators for unit tests in the editor
  • ThemedIcon.UnitTestingOptionsPage.Screen.[Gray] - the function is a unit test that you can run
  • ThemedIcon.UnitSession.Screen.[Gray] - the function is a unit test suite and you can run containing tests
  • icon_unit_test_success - the unit test passed during the last execution.
  • icon_unit_test_class_success - tests in the unit test suite passed during the last execution.
  • icon_unit_test_failure - the unit test failed during the last execution.
  • icon_unit_test_class_failure - at least one test in the unit test suite failed during the last execution.

Executing tests in the current document

There are several ways to run unit tests in the current document. You can use action indicators, main menu or shortcuts:

  • To run a single test or all tests in a test class, click on the action indicator next to it or set the caret on the test /test suite and press Alt+Enter . In the action list , choose Run for a test or Run All for a test suite.
  • Alternatively, you can use the Run Unit Tests commands, which are available in the main menu (ReSharper | Unit Tests), in the context menu or with Ctrl+T,R shortcuts correspondingly. These commands work differently depending on the caret position or selection in the editor:
    • To run a single test or all tests in a test suite , set the caret at the test /test suite name or anywhere inside it in the editor .
    • To run several tests, select the desired tests in the editor .
    • To run all tests in the current file, either select all or set the caret outside test suites.

Whatever way you choose to run tests, you will see the execution progress, results and output in the Unit Test Sessions window. If there is an open unit test session, the executed tests are added in this session. If there are no test sessions or the existing ones are locked, then a new tests session is created.

If necessary, you can always re-run the tests that you executed last by choosing ReSharper | Unit Tests | Repeat Previous Run in the menu or pressing Ctrl+T,T.

Running a Jasmine unit test suite from the editor

Discovering unit tests in solution

ReSharper adds the Unit Test Explorer window to Visual Studio. Using this window, you can explore and run unit tests in the entire solution. The window displays all tests from the supported frameworks in the solution. Note that unit tests from a project only appear in the window after the project is built. Tests from currently opened files are updated automatically, new tests from these files appear in the Unit Test Explorer as soon as you create them.

To open Unit Test Explorer, choose ReSharper | Unit Tests | Unit Tests or ReSharper | Windows | Unit Tests in the main menu or press Ctrl+Alt+T.

Unit Test Explorer allows you to do the following:

  • Explore tests in the solution: browse all unit tests in a list or tree view, search tests and filter by a substring, regroup unit tests by project, namespace, etc.
  • Navigate to source code of any test or test suite by double-clicking it in the view.
  • run selected tests.
  • Create unit tests sessions from selected tests and test suites and/or add selected items to the current test session.
  • Export all tests from solution to a text, XML, or HTML file.
Unit Test Explorer displays test from the entire solution

Executing unit tests in project or solution

You can run tests from the Unit Test Explorer, Solution Explorer, or Class View. Unit Test Explorer gives you the advantage to see only tests and test suites , while using other windows you need to know, which projects, files, and classes contain tests.

  • To execute tests from Unit Test Explorer, select the desired tests and click Run Unit Tests toolbar__run_selected_tests on the toolbar or use the corresponding shortcuts (Ctrl+T,R ).
  • To run tests from Solution Explorer or Class View, select one or more items ( suites, files, folders, projects) that contain tests, and use the Run Unit Tests commands, which are available in the main menu (ReSharper | Unit Tests), in the context menu or with Ctrl+T,R shortcuts correspondingly.
  • To run all tests in solution, choose ReSharper | Unit Tests | Run All Tests from Solution in the main menu or press Ctrl+T,L .

Whatever way you choose to run tests, you will see the execution progress, results and output in the Unit Test Sessions window. If there is an open unit test session, the executed tests are added in this session. If there are no test sessions or the existing ones are locked, then a new tests session is created.

If necessary, you can always re-run the tests that you executed last by choosing ReSharper | Unit Tests | Repeat Previous Run in the menu or pressing Ctrl+T,T.

Using unit test sessions

ReSharper allows you to group test suites and single unit tests that target specific part of your application into unit test sessions. A unit test session can contain tests from different test suites and projects. You can have multiple test sessions and run them separately as needed. A single test /test suite can be included into several different test sessions.

For detailed instructions related to unit test sessions, see Using Unit Test Sessions.

Execution process

ReSharper provides several ways to execute unit tests. Whichever way you choose, execution progress, results, and output are displayed in the Unit Test Sessions window.

As the tests are running, the execution progress is shown in the status bar under the toolbar or the Unit Test Sessions window and the Stop Execution uts_toolbar_stop_execution button becomes active. You can click this button to abort execution of the tests.

If necessary, you can enable the Track Running Test uts_toolbar_track_running_test option on the toolbar. If it is on, the selection in the test tree switches automatically to the test that is currently running and the output panel always shows output of the current test during the execution.

You can also enable the Auto Scroll Output When Running Test icon_auto_scroll_output option to follow output of tests as they are running.

js_unit_test_sessions

Analysing execution results and output

When the execution is over, the results are visualized in the Unit Test Sessions window.

The output pane (which you can place on the right or on the bottom using the Show Output toolbar_show_preview button on the toolbar) displays output of the selected test. If the test is failed, ReSharper also adds short information on the failure. You can use clickable links in the failure information to navigate directly to types and methods involved with the failure.

By default, ReSharper wraps long lines in the output according to the current width of the output area. If necessary, you choose not to wrap long lines by clearing the Wrap long lines in Unit Test Session output check-box on the Tools | Unit Testing options page.

Status of each test in the Unit Test Sessions window is displayed with one of the following icons:

  • unit_test_status_progress - the unit test is currently executing.
  • unit_test_status_scheduled - the unit test is scheduled for execution in the current run.
  • unit_test_status_unknown - the unit test was not executed.
  • unit_test_status_passed - the unit test passed in the lats test run.
  • unit_test_status_failed - the unit test failed in the lats test run.
  • unit_test_status_aborted - the unit test was aborted in the last test run.

The same icons are used to display status of grouping items (suites, projects, etc.)

The icons are also used on each session's tab to display the overall execution result of the sessions.

The corresponding icons on the status bar show how many tests are in each of the status. The ThemedIcon.UnitSession.Screen.[Gray] icon shows the total number of tests in the session.

Last modified: 27 August 2015