AppCode 2019.2 Help

Run/Debug Configuration: Boost.Test

Use this page to configure run/debug options for Boost.Test - a C++ testing framework.

Here you can find the description of the options that are common for all run/debug configurations.

Item

Description

Test kind

Choose Suite/Test to run a specific suite and its tests. Choose Pattern to run a combination of different suites and tests.

Suite

Test

These fieldes are displayed if Suite/Test is selected. Here you need to specify a suite and its tests to be run.

Pattern

This field is displayed if Pattern is selected. Here you need to specify a combination of suites and tests to be run.

Program arguments

In this field, type a list of arguments to be passed to the program in the format you would use in the command line. If necessary, click the the Expand button button and type the desired arguments.

Working directory

Specify the working directory to be used for running the application. This directory is the starting point for all relative input and output paths. By default, the field contains the directory where the project file resides. To specify another directory, click the Browse button and select the directory.

Expand the list to view available path variables that you can use as a path to your working directory. In this case you do not need to specify any additional environment variables in the Environment variables field.

Environment variables

Create environment variables and specify their values.

Shorten command line

Select a method that will be used to shorten the command line if the classpath gets too long, or you have many VM arguments that exceed your OS command line length limitation:

  • none: AppCode will not shorten a long classpath. If the command line exceeds the OS limitation, AppCode will be unable to run your application and will display a message suggesting you to specify the shortening method.

  • JAR manifest: AppCode will pass a long classpath via a temporary classpath.jar. The original classpath is defined in the manifest file as a class-path attribute in classpath.jar. You will be able to preview the full command line if it was shortened using this method, not just the classpath of the temporary classpath.jar.

  • classpath file: AppCode will write a long classpath into a text file.

  • user-local default: this legacy option is set automatically for projects created before AppCode version 2017.3. AppCode will configure this setting depending on the properties set in the ide/workspace.xml and idea.config.path/options/options.xml files.

Common

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

Name

In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup ⌃⌥R.

Share through VCS

Select this checkbox to put the run/debug configuration under version control and make it available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml .

Allow running in parallel

If this checkbox is selected, it is possible to launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run Tool Window or Debug Tool Window.

When disabled, every time a new instance of the run/debug configuration is launched, AppCode checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog. If you click OK in the confirmation dialog, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when launching two instances of run/debug configurations of the same type consumes too much of the CPU and memory resources..

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

Item

Shortcut

Description

the Add button⌘N

Create a run/debug configuration.

the Remove button⌘⌦

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Copy ⌘D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

Save configuration

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Edit Templates

View and edit the template (that is, the default settings) for the selected run/debug configuration. The templates are displayed under the Templates node and used for newly created configurations.

Method up/Method down

⌃↑/⌃↓

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

Move into new folder / Create new folder

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click Folder, and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations

Click this button to sort configurations in the alphabetical order.

Before Launch

In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item

Shortcut

Description

the Add button⌘N

Click this icon to add one of the following available tasks:

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in AppCode yet, add its definition. For more information, see Manage third-party tools and External Tools.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run Gulp task: select this option to run a Gulp task.

    In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm Script: select this option to execute an npm script.

    In the NPM Script dialog that opens, specify the npm run/debug configuration settings.
  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

the Remove button⌘⌦

Click this icon to remove the selected task from the list.

Edit

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

Method up/Method down

⌃↑/⌃↓

Click these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)

Show this page

Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.

Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing ⌘4 or ⌘5.

Last modified: 10 October 2019