AppCode 2021.3 Help

Run tests

Run a single test

If your tests don't require any specific actions before start and you don't want to configure additional options, such as code coverage, 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 ⌃ ⇧ F10. Alternatively, click the gutter icon next to the test class or test method.

    Gutter icons for running tests
  • To run all tests in a file, select this file in the Project tool window and then select Run 'All in <filename>' from its context menu.

Run tests via a run/debug configuration

When you run a test, AppCode 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. From the list on the main toolbar, select the configuration you want to run.

    Select test configuration

  3. Click the Run button or press ⇧ F10.

Create a test configuration

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

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

    • From the main menu, select Run | Edit Configurations.

    • Press ⌥ ⇧ F10 and select Edit Configuration from the context menu.

  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 AppCode finishes running your tests, it shows the results in the Run tool window on the Test Runner tab. For more information on how to analyze test results, refer to Explore test results.

Run tests before commit

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

Set up test configuration

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

  2. Click Show Commit Options the Settings button. In the menu, click Choose configuration near Run Tests 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 Test Runner tab:

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

  • Click the Exit button to terminate the process gracefully, allowing shutdown hooks to run.

Rerun tests

Rerun a single test

  • Right-click a test on the Test Runner tab of the Run tool window and select Run 'test name'.

Rerun all tests in a session

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

Rerun failed tests

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

    Hold Shift and click the Rerun Failed Tests button to choose whether you want to Run the tests again or Debug them.

    You can configure the IDE to trigger tests that were ignored or not started during the previous test run together with failed tests. Click the Settings button on the Test Runner toolbar and enable the Include Non-Started Tests into Rerun Failed option.

Rerun tests automatically

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

  • Click Toggle auto-test Toggle auto-test on the Run toolbar to enable the autotest-like runner.

Debug failed tests

If you don't know why a test fails, you can debug it.

  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 the Rerun the Run button gutter icon next to the failed test and select Debug 'test name'.

    The test that has failed will be rerun in the 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: 22 November 2021