Run/debug configurations

Run kind

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: build an application in the specified directory as a package, without processing any subdirectories.

  For test configurations, GoLand runs all the tests in the specified directory and all its subdirectories.

• File: build an application from files specified in the Files field. To pass multiple file paths, use the vertical bar (|) as a delimiter. This configuration is automatically selected when you run your program from scratch files.

• Package: build a single package with all its dependencies. Specify a full import path to the package that you want to build in the Package path field (for example, github.com/gorilla/mux). This configuration is automatically selected when you run the main function or a separate test by using the Run Application icon () in the gutter.

Package path

Full import path of the package that you want to compile (for example, myServerApp). This field is available only when you select the Package run kind.

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

Output directory

Path to a directory where you want to output the executable file.

Run after build

Execute the application after the build.

Redirect input from

File to read the input from.

Working directory

Directory that is used for the built application. If you have any code that creates relative files or directories, they will be relative to this directory.

Environment

Environment variables for your application.

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

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

Use all custom build tags

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

Program arguments

Arguments for the built application. Also, you can use macros in this field.

Run with sudo

Run the application with elevated privileges.

Module

Name of the current module.

Before launch

Add tasks that you want to launch before the launch of the selected run/debug configuration. To add a task click the Add button Alt+Insert and select the tool that you want to add.

Store as project file

Enable this option to save your configuration as a project file and share it with team members through VCS.

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, refer to Package testing.

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

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

• go test -fuzz: use an automated testing technique that involves generating and feeding a large volume of random or semi-random data as input to a Go program. The goal of fuzzing is to explore the program's code and surface potential bugs, vulnerabilities, or unexpected behaviors that may not be apparent with traditional testing methods. For more information about gobench, refer to Go Fuzzing.

Test kind

Select the scope from which you want to run tests:

• Directory: to run all the tests in the specified directory. In the Directory field, specify a path to a directory that includes an application file and a test file (for example, applicationFolder/ with main.go and main_test.go).

• Package: to run all the tests that belong to a package. In the Package path field, select a path to the package with tests that you want to run (for example, github.com/rcrowley/go-metrics).

  To enable package tests, open setting by pressing Ctrl+Alt+S, navigate to Go | Go modules, and select the Enable Go modules integration checkbox.

• File: to run all tests from a testing file. In the Files field, type a path to a testing file.

  Ensure that the Files field does not include other paths.

Pattern

Type a regular expression that defines what tests to run. GoLand will execute only the tests, examples, and fuzz tests that conform to the regular expression provided. For tests, the expression is divided by slashes (/) not enclosed in brackets into a series of regular expressions. Each segment of a test's identifier must align with the corresponding part of the sequence.

For instance, to execute a specific test named add_positive_and_negative within the TestAdd table test, the regular expression would be: ^\QTestAdd\E$/^\Qadd_positive_and_negative\E$.

Working directory

Directory that is used for the built application. If you have any code that creates relative files or directories, they will be relative to this directory.

Output directory

Directory that stores your test results if any.

Run after build

Execute a test after the build.

Redirect input from

Path to the file that will to take program input instead of the console.

Working directory

Directory that is used for the built application. If you have any code that creates relative files or directories, they will be relative to this directory.

Environment

: environment variables that you need to run the test.

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

Arguments for the go tool (for example, -tags).

Use all custom build tags

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

Program arguments

Arguments for the test.

Run with sudo

Grant sudo privileges to the test.

Before launch: Activate tool window

Add tasks that you want to launch before the launch of the selected run/debug configuration. To add a task, click the Add button Alt+Insert and select the tool that you want to add.