PhpStorm 2024.1 Help

Run tests

Run tests directly in a file or folder

If your tests don't require any specific actions before start, and you don't want to configure additional options, you can run them by using the following options:

  • Place the caret at the test class to run all tests in that class, or at the test method, and press Ctrl+Shift+F10. Alternatively, click the gutter icon next to the test class or test method and select Run '<test name>' from the list.

    The gutter icon changes depending on the state of your test:

    • The gutter icon marks a set of tests.

    • The gutter icon marks new tests.

    • The gutter icon marks successful tests.

    • The gutter icon marks failed tests.

    Running a test using the gutter icon
  • To run all tests in a folder, select this folder in the Project tool window and press Ctrl+Shift+F10 or select Run Tests in 'folder' from the context menu.

Run tests via a run/debug configuration

When you run a test, PhpStorm creates a temporary run configuration. You can save temporary run configurations, change their settings, share them with other members of your team. For more information, refer to Run/debug configurations.

  1. Create a new run configuration or save a temporary one.

  2. Use the Run widget on the main toolbar to select the configuration you want to run.

    Running tests with a run configuration: select the run configuration
  3. Click or press Shift+F10.

Run tests from the Structure tool window

In the Structure tool window, you can run a single test method in a class or a set of selected test methods. In this case, the IDE also creates a temporary run configuration with these methods that you can save and edit.

  • To run a single test method in a test class, right-click it in the Structure tool window and select Run 'method name' (Ctrl+Shift+F10) in the context menu that opens.

  • To run a selection of tests, hold Ctrl and select the test methods, then right-click one of the methods and select Run 'method names' (Ctrl+Shift+F10).

    Run tests from the Structure tool window

Create a run configuration for tests

  1. Open the Run/Debug Configuration dialog by doing one of the following:

    • From the configuration switcher on the main toolbar, select Run | Edit Configurations.

    • Go to Run | Edit Configurations.

    • Press Alt+Shift+F10 and select Edit Configuration from the context menu.

    Running tests with a run configuration: select the run configuration
  2. Click Add New Configuration on the toolbar and select the desired configuration type:

  3. In the dialog that opens, specify the test scope, configuration parameters, and activities to perform before test execution. Apply the changes and close the dialog.

After PhpStorm finishes running your tests, it shows the results in the Run tool window on the tab for that run configuration. For more information about analyzing test results, refer to Explore test results.

Test runner in the Run tool window

The console on the right shows the output of the current test session. The test results toolbar located above the list of test results provides you with several helpful options.

Run tests after commit

When you want to check that your changes wouldn't break the code before pushing them, you can do that by running tests as commit checks.

Set up test configuration

  1. Open the Commit tool window as described in the following topics:

  2. Click Show Commit Options the Settings button.

  3. Under the Commit Checks menu, next to the Run Tests option, click Choose configuration and select which configuration you want to run.

    Pre-commit checks menu

After you have set up the test configuration, the specified tests will run every time you make a commit.

Non-modal commit dialog running a test

Stop tests

Use the following options on the Run toolbar of the tab for the run configuration:

  • Click the Stop button or press Ctrl+F2 to terminate the process immediately.

Rerun tests

Rerun a single test

  • Right-click a test on the tab for the run configuration in the Run tool window and select Run 'test name'.

Rerun all tests in a session

  • Click the Rerun button on the Run toolbar or press Ctrl+F5 to rerun all tests in a session.

Rerun failed tests

  • Click the Rerun Failed Tests icon on the Run toolbar to rerun only failed tests.

Rerun and debug failed tests

  • Hold Shift, click on the Run toolbar, and choose Debug from the context menu to rerun the failed tests in the debug mode.

    Restart/Debug failed tests

Rerun tests automatically

In PhpStorm, you can enable the autotest-like runner: any test in the current run configuration restarts automatically after you change the related source code.

  • Click Rerun Automatically on the test results toolbar to enable the autotest-like runner.

    Rerun Automatically option

Debug tests from the editor

  1. In the editor, click the gutter on the line where you want to set a breakpoint.

    There are different types of breakpoints that you can use depending on where you want to suspend the program. For more information, refer to Breakpoints.

  2. Right-click the gutter icon next to the failed test and select Debug 'test name'.

    The test will rerun in debug mode. After that, the test will be suspended, allowing you to examine its current state.

    You can step through the test to analyze its execution in detail.

Last modified: 28 June 2024