UnitTestBot Java CLI allows you to automatically generate human-readable ready-to-use unit tests for Java code. With CLI, you can streamline manual unit testing or integrate UnitTestBot Java into your CI/CD process.

UnitTestBot Java CLI is distributed as a JAR file. You can find the implementation in the utbot-cli module.

Check the tutorial to get started with UnitTestBot Java CLI (examples are provided for Windows):

• System requirements
• How to download
• How to generate tests for a single class
• How to generate tests for multiple classes
• How to run tests
• Commands, options, arguments

• JDK 17: installed.
• JAVA_HOME: contains the path to JDK 17 installation directory, e.g., C:\Program Files\Java\jdk-17.
• PATH: contains the path to the bin folder of the JDK 17 installation directory, e.g., C:\Program Files\Java\jdk-17\bin.

1. Go to UnitTestBot Java builds.
2. Find the latest “green” build for main, e.g., try this valid one.
3. Scroll down to Artifacts and download the zip-archive named like utbot-cli-java-main-VERSION.
4. Create a directory (e.g., utbot) and unzip the archive into it.

You may keep your source and test files as well as the utbot-cli-java-main-VERSION.jar file anywhere you like, but you should specify the proper paths as options. To keep it simple, we locate everything in one place.

1. In your new directory with the utbot-cli-java-main-VERSION.jar inside, create an src folder for your source files under test, a build folder for the complied .class files, and a test folder for the resulting tests, e.g.:

└── utbot
    ├── build
    ├── src
        ├── BitOperators.java
    ├── test
    ├── utbot-cli-java-main-VERSION.jar

2. Compile the source .java file and put the resulting .class file into the build folder, e.g.:

javac src\BitOperators.java -d build

Now you have this:

└── utbot
    ├── build (path to compiled source or test classes)
        ├── org
            ├── utbot
                ├── examples
                    ├── math
                        ├── BitOperators.class
    ├── src
        ├── BitOperators.java (source file)
    ├── test (path for test file)
    ├── utbot-cli-java-main-VERSION.jar

3. Generate tests for the chosen source file using the generate command (refer to the upper tree to understand the relevant paths):

java -jar utbot-cli-main-VERSION.jar generate --source <path to source file> --classpath <path to compiled source class> --output <test file with path> <TARGETCLASSFQN: fully qualified name for source class>

Example:

java -jar utbot-cli-main-2023.6.4550.jar generate -s src\BitOperators.java -cp build -o test\BitOperatorsTest.java org.utbot.examples.math.BitOperators

Make sure you use the --source, -s and --classpath, -cp required options and pass the TARGETCLASSFQN argument, which is the target class fully qualified name. We recommend using the--output, -o option for consistency.

1. Keep the source files in the src folder.
2. Compile the source .java files and put the resulting .class files into the build folder.
3. Generate tests for the chosen source files using the bunchGenerate command:

java -jar utbot-cli-main-VERSION.jar bunchGenerate --classpath <path to compiled source classes> --output <path to test files> --filter <package to test> <CLASSROOTDIRECTORY: path to compiled source classes>

Example:

java -jar utbot-cli-main-2023.6.4550.jar bunchGenerate -cp build -o test -pf org.utbot.examples.math build

Make sure you use the --classpath, -cp required option and pass the CLASSROOTDIRECTORY argument, which is the folder containing the compiled source classes. We recommend using the--output, -o option for consistency.

With the --filter, -pf option, you can specify the source files to generate tests for. If the fully qualified name of the given source class contains the specified string, the tests are generated for this class.

1. Compile the generated test and put the resulting .class file into the build folder, e.g.:

javac -cp build;utbot-cli-main-2023.6.4550.jar -d build test\BitOperatorsTest.java

Make sure to include the following paths to the classpath:

• the path to the folder where you put the compiled .class files, e.g., build;
• the path to a test framework library (JUnit 4, JUnit 5, TestNG) or the utbot-cli-java-main-VERSION.jar file.

Now you have this:

└── utbot
    ├── build
        ├── org
            ├── utbot
                ├── examples
                    ├── math
                        ├── BitOperators.class
                        ├── BitOperatorsTest.class
    ├── src
        ├── BitOperators.java
    ├── test
        ├── BitOperatorsTest.java
    ├── utbot-cli-java-main-VERSION.jar

2. Run the compiled test class:

java -jar utbot-cli-main-VERSION.jar run --classpath <path to compiled test class> <fully qualified name for test class>

Example:

java -jar utbot-cli-main-2023.6.4550.jar run -cp build org.utbot.examples.math.BitOperatorsTest

Basic usage for UnitTestBot Java CLI requires you to specify commands, options, and arguments:

java -jar utbot-cli-main-VERSION.jar [GENERAL OPTIONS] COMMAND [COMMAND OPTIONS] ARGS

Generate tests for the specified class:

java -jar utbot-cli-main-VERSION.jar [GENERAL OPTIONS] generate [COMMAND OPTIONS] TARGETCLASSFQN

TARGETCLASSFQN — target class fully qualified name.

Generate tests for class files in the specified directory.

java -jar utbot-cli-main-VERSION.jar [GENERAL OPTIONS] bunchGenerate [COMMAND OPTIONS] CLASSROOTDIRECTORY

CLASSROOTDIRECTORY — directory with classes.

Runs tests for the specified class.

java -jar utbot-cli-main-VERSION.jar run [GENERAL OPTIONS] run [COMMAND OPTIONS] CLASSWITHTESTSNAME

CLASSWITHTESTSNAME — specifies a class with tests.