UnitTestBot Go automatically generates ready-to-use unit tests for Go programs.

With UnitTestBot Go, you can find bugs in your code and fixate the desired program behavior with less effort.

The project is under development, so feel free to contribute.

UnitTestBot Go now implements the basic fuzzing technique. It generates input values considering the parameter types, inserts these values into the user functions, and executes the resulting test cases.

Now UnitTestBot Go can generate values for primitive types, arrays, slices, maps, structs, channels, interfaces, and pointers.

For floating point types, UnitTestBot Go supports working with infinity and NaN.

For the returned function results, UnitTestBot Go supports the error type as well as all the types supported for the function parameters except interfaces and channels.

It also captures panic cases correctly.

Check the examples of supported functions.

Testing code typically lives in the same package as the code it tests. By default, UnitTestBot Go generates tests into the [name of source file]_go_ut_test.go file located in the same directory and Go package as the corresponding source file.

If you need to change the location for the generated tests, use the generateGo CLI command and set the generated test output mode to StdOut (-p, --print-test flag). Then, with bash primitives, redirect the output to an arbitrary file.

To simplify handling dependencies and generating tests, UnitTestBot Go requires the code under test to be a part of a Go project consisting of a module and packages.

To create a simple project, refer to the starter tutorial if necessary.

For larger projects, try the Create a Go module and Call your code from another module tutorials.

To create a new module rooted in the current directory, use the go mod init command.

To add missing module requirements necessary to build the current module’s packages and dependencies, use the go mod tidy command. For editing and formatting go.mod files, use the go mod edit command.

In the future, we plan to make UnitTestBot Go working with arbitrary code as input and generate the simplest Go projects automatically.

• IntelliJ IDEA Ultimate — for compatibility, see UnitTestBot on JetBrains Marketplace.
• Go SDK 1.18 or later
• Compatible Go plugin for IntelliJ IDEA
• Properly configured go.mod file for the code under test
• github.com/stretchr/testify/assert Go module installed (IntelliJ IDEA automatically offers to install it as soon as the tests are generated)

Please refer to UnitTestBot user guide.

1. In your IntelliJ IDEA, go to File > Settings > Tools, choose UnitTestBot and enable Experimental languages support.

   (!) NOTE: be sure to enable this option for each project.

2. Open a .go file and press Alt+Shift+U.

3. In the Generate Tests with UnitTestBot window, you can configure the settings.

• Java SDK 17 or later
• Go SDK 1.18 or later
• Properly configured go.mod file for the code under test
• GCC and github.com/stretchr/testify/assert installed

To install the UnitTestBot Go CLI application, go to GitHub, scroll through the release notes and click Assets. Download the zip-archive named like utbot-cli-VERSION. Extract the JAR file from the archive.

Run the extracted JAR file using a command line: generateGo and runGo actions are supported for now. To find info about the options for these actions, insert the necessary JAR file name instead of utbot-cli-2022.8-beta.jar in the example and run the following commands:

java -jar utbot-cli-2022.8-beta.jar generateGo --help

or

java -jar utbot-cli-2022.8-beta.jar runGo --help

generateGo options:

• -s, --source TEXT, required: specifies a Go source file to generate tests for.
• -f, --function TEXT: specifies a function name to generate tests for. Can be used multiple times to select multiple functions.
• -m, --method TEXT: specifies a method name to generate tests for. Can be used multiple times to select multiple methods.
• -go TEXT, required: specifies a path to a Go executable. For example, /usr/local/go/bin/go.
• -gopath TEXT, required: specifies a path to your workspace location. It defaults to a directory named go in your home directory: $HOME/go for Unix, $home/go for Plan 9, and %USERPROFILE%\go (usually C:\Users\YourName\go) for Windows.
• -parallel INT: specifies the number of fuzzing processes running at once (eight by default).
• -et, --each-execution-timeout INT: specifies a timeout in milliseconds for each target function execution. The default timeout is 1,000 ms.
• -at, --all-execution-timeout INT: specifies a timeout in milliseconds for all target function executions. The default timeout is 60,000 ms.
• -p, --print-test: specifies whether a test should be printed out to StdOut. Disabled by default.
• -w, --overwrite: specifies whether to overwrite the output test file if it already exists. Disabled by default.
• -fm, --fuzzing-mode: stops test generation when a panic situation, an error, or timeout occurs (only one test will be generated for one of these cases).
• -h, --help: shows a help message and exits.

runGo options:

• -p, --package TEXT, required: specifies a Go package to run tests for.
• -go, --go-path TEXT, required: specifies a path to a Go executable. For example, /usr/local/go/bin/go.
• -v, --verbose: specifies whether an output should be verbose. Disabled by default.
• -j, --json: specifies whether an output should be in JSON format. Disabled by default.
• -o, --output TEXT: specifies an output file for a test run report. Prints to StdOut by default.
• -cov-mode, --coverage-mode [html|func|json]: specifies whether a test coverage report should be generated and defines the report format. Coverage report generation is disabled by default.
• -cov-out, --coverage-output TEXT: specifies the output file for a test coverage report. Required if [--coverage-mode] is set.

To take part in project development or learn more about UnitTestBot Go, check out the Developer guide and our plans.