UTBotJava-action-example

To analyse the Java project with UTBotJava-action you need to follow these simple steps:

1. Apply the UTBot gradle plugin to your project:

plugins {
id "org.utbot.gradle.plugin" version "1.0.0-alpha"
}

2. Create a new file <your-repository>/.github/workflows/run-utbot-java-action.yml with a workflow that can be run and configured manually:

name: "Run UTBotJava action"on:
workflow_dispatch:
inputs:
pushTests:
description: "Push generated tests to the repository"type: booleandefault: truegeneratedTestsRelativeRoot:
description: "Relative path to the root of the tests"type: stringdefault: '.utbot/test'testFramework:
type: choiceoptions:
- junit4
- junit5
- testngdefault: 'junit5'generationTimeout:
description: "Time budget for one class (ms)"type: stringdefault: '60000'codegenLanguage:
type: choiceoptions:
- java
- kotlindefault: javamockStrategy:
type: choiceoptions:
- 'no-mocks'
- 'other-packages'
- 'other-classes'default: 'other-packages'staticsMocking:
type: choiceoptions: - 'do-not-mock-statics'
- 'mock-statics'default: 'mock-statics'jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2
- name: Setup Javauses: actions/setup-java@v2with:
distribution: adoptjava-version: 8
- name: Setup Gradleuses: gradle/gradle-build-action@v2with:
gradle-version: 6.8
- name: Run UTBotJava-actionuses: UnitTestBot/UTBotJava-action@v1with:
pushTests: ${{ inputs.pushTests }}generatedTestsRelativeRoot: ${{ inputs.generatedTestsRelativeRoot }}testFramework: ${{ inputs.testFramework }}generationTimeout: ${{ inputs.generationTimeout }}codegenLanguage: ${{ inputs.codegenLanguage }}mockStrategy: ${{ inputs.mockStrategy }}staticsMocking: ${{ inputs.staticsMocking }}

3. On the Actions tab find the section Run UTBotJava action:

4. Click Run workflow and select the needed options:

5. After the workflow is completed, look at the Security → Code Scanning Alerts to find the detected errors (by the way, you won`t find any if your code is fine 😉):

6. Explore any alert by clicking on it:

As you see in this case above, UTBot detected an unchecked ArrayIndexOutOfBoundsException by passing the array [-192, -192] to the isSorted method.

Click Show paths button, and you see the execution trace.

📍 Note: All these steps are performed more clearly in this project, watch it above. 🙂