GoLand 2021.3 Help

Go Test

Run | Edit Configurations | Add New Configuration | Go Test

With the Go Test configuration, you can run and debug Go applications. For more information about running tests, see the following topics:

Run/Debug Configuration for Go Test

Item

Description

Test framework

Select the package that you want to use to run tests.

  • gotest: use for running standard unit tests. For more information about go test, see Package testing.

  • gocheck: use to have extended functionality of go check and running more complex tests. For more information about go check, see go check.

  • gobench: use for running performance tests. For more information about gobench, see Package testing: Benchmarks.

Packages for testing

Test kind

Select a building scope for your application. File and Package scopes work similarly in tests and compilation/running configurations (in terms of the scope they cover).

  • Directory: run or debug all the tests in the specified directory and all its subdirectories.

  • File: run or debug all the tests from the specified file.

  • Package: run or debug all the tests in the package. If you want to specific tests, provide a pattern matching names of these tests in the Pattern field.

Package path

Type or autocomplete a full import path of the package that contains tests that you want to run or debug. This field is available only when you select the Package test kind.

You can press Ctrl+Space to see a list of available packages.

Autocompletion for the Package path field in tests

Directory

Type a path to the directory that contains tests that you want to run or debug. This field is available only when you select the Directory test kind.

Files

Type a path to a file or files with tests that you want to run or debug. To pass multiple file paths, use the vertical bar (|) as a delimiter. This field is available only when you select the File test kind.

Pattern

Type a pattern for tests that you want to run by using regular expressions.

The -run flag in go test may also run other tests if they contain the string NameOfTest. So to ensure that only a test named exactly NameOfTest is run, use the regexp ^NameOfTest$. For more information about testing flags, see Testing flags at pkg.go.dev.

Go test pattern

Output directory

Type a path to a directory where you want to store test output.

Working directory

Type a directory that is used for tests. If you have any code that creates relative files or directories, they will be relative to this directory.

Environment

Specify environment variables for tests.

To edit environment variables, click the Browse button at the end of the field. In the Environment Variables dialog, click the Add button and add the environment variables that you need.

Go tool arguments

Type arguments for the go tool (for example, -o). Also, you can use macros in this field.

Use all custom build tags

Specify all tags that are applied during the build. Tags are listed in settings Ctrl+Alt+S under Go | | Build Tags & Vendoring.

Program arguments

Type arguments for tests. Also, you can use macros in this field.

Run with sudo

Run tests with elevated privileges.

Module

Name of the current module.

Common settings

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

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, GoLand suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and GoLand stores run configuration settings in .idea/workspace.xml.

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

Alt+Insert

Create a run/debug configuration.

the Remove button

Alt+Delete

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

Copy

Ctrl+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.

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 to 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

Alt+Insert

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 GoLand yet, add its definition.

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

  • Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

  • Run File Watchers: select this option to have GoLand apply all the currently active File Watchers.

  • 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.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Run Go Command: select to run a Go command before running your program. For example, you can run go generate to generate source code before compilation. In the Edit Go Command Task dialog, you can use auto-completion. Auto-completion supports the following commands generate, vet, test -i. You can use your own commands.

  • Run Remote External Tool: adds a remote SSH external tool.

  • Disconnect Data Source: select this option if you want to disrupt the connection to a data source before the run/debug configuration is run.

the Remove button

Alt+Delete

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

Edit

Enter

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

Method up/Method down

Alt+Up/Alt+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 is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

Last modified: 22 November 2021