Go Test

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 CtrlAlt0S, 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$.

tip

For a convenient way to generate a template for the Pattern field, use a quick way to run the test or set of tests from the gutter. Then, you can modify the automatically created regular expression as needed.

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 CtrlAlt0S 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 AltInsert and select the tool that you want to add.

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

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 stopping the running instance and starting another one. This is helpful when a run 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.

AltInsert

Create a run/debug configuration.

AltDelete

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

Ctrl0D

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

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. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click , 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 and buttons.

To remove grouping, select a folder and click .

Click this button to sort configurations in the alphabetical order.