Protractor

Protractor is a test framework for Angular and AngularJS applications. Protractor executes tests against your application running in a real browser, which ensures correctness and trustworthiness of test results. PhpStorm integrates with Protractor so you can run and debug your tests from inside the IDE. You can see the test results in a treeview and easily navigate to the test source from there.

Before you start

Download and install Node.js.

Installing Protractor

You can install Protractor locally, in your project, or globally. Global installation is preferable.

To install Protractor globally

In the embedded Terminal (Alt+F12) , type:
npm install -g protractor
To download the necessary binaries, type webdriver-manager update. See also Getting Started on the Protractor official website.

You can also install the protractor package on the Node.js and NPM page as described in npm, pnpm, and Yarn.

Running tests

Protractor tests are launched only through a run/debug configuration.

To create a Protractor run configuration

Open the Run/Debug Configuration dialog (Run | Edit Configurations on the main menu), click in the left-hand pane, and select Protractor from the list. The Run/Debug Configuration: Protractor dialog opens.
Alternatively, select a test file in the Project tool window and select Create <filename> from the context menu.
Specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.
Specify the location of the protractor package and the path to the protractor.conf.js configuration file. If you followed the standard installation, PhpStorm detects all these paths and displays them in the corresponding fields.

To run tests via a run configuration

Start the Selenium Server manually or configure it to start automatically in protractor.conf.js. For details, see the Protractor official website.
Select the Protractor run/debug configuration from the list on the main toolbar and click to the right of the list.
View and analyze messages from the server in the <current_run_configuration_name> tab of the Run tool window.

Navigation

With PhpStorm, you can jump between a file and the related test file or from a test result in the Test Runner Tab to the test.

To jump between a test and its subject or vice versa, open the file in the editor and select Go to | Test or Go to | Test Subject from the context menu, or just press Ctrl+Shift+T.
To jump from a test result to the test definition, click the test name in the Test Runner tab twice or select Jump to Source from the context menu. The test file opens in the editor with the cursor placed at the test definition.

Debugging tests

A debugging session for Protractor tests is started only through a run/debug configuration.

To start debugging tests

Create a Protractor run/debug configuration as described above.
Select the Protractor run/debug configuration from the list on the main toolbar and click to the right of the list.
In the Debug tool window that opens, proceed as usual: step through the tests, pause and resume test execution, examine the test when suspended, run JavaScript code snippets in the Console, and so on.

Last modified: 13 October 2021