RoostGPT

Login at https://app.roost.ai to access GPT feature.

CLI

Installation Command

RoostGPT binary is available at https://github.com/roost-io/roost-support/releases

The RoostGPT binary allows for unmatched flexibility during test generation, by allowing you to trigger test generation both locally and through git through the use of one simple .env file.

Add the "roostgpt-<linux|macos|win.exe>" binary to your PATH environment variable

For Linux/MacOS,  you can execute the below command to install roostgpt

curl https://raw.githubusercontent.com/roost-io/roost-support/master/roostgpt.sh | bash -

CLI Commands

roostgpt   (for mac) &  ./roostGPT-win.exe (for windows)

This command is used to run the RoostGPT CLI on your operating system.

Instructions for creating .env file

An easy way to download the .env file is to use https://app.roost.ai/gptCLIForm

The .env file should be in the same folder path as RoostGPT binary.
Here is what the content of your .env file will look like:

# GIT env vars
GIT_TYPE=                                        # Default is github; Supports [github, gitlab, azure, bitbucket, local]
HOSTED_TYPE=                                     # Default is cloud; Supports [cloud, hosted]
GIT_HOSTED_URL=                                  # Required if HOSTED_TYPE=hosted
USE_SSH=                                         # Optional; Default is false; Supports [true, false]; SSH based auth for Git
LOCAL_PROJECT_PATH=                              # Required if GIT_TYPE is local, Path to your workspace
SOURCE_GIT_CLONE_URL=                            # Optional; the source repo clone URL
SOURCE_GIT_TOKEN=                                # Required
SOURCE_OWNER_NAME=                               # Required
SOURCE_REPO_NAME=                                # Required
SOURCE_REPO_ID=                                  # Required for GIT_TYPE=gitlab
SOURCE_PROJECT_NAME=                             # Required for GIT_TYPE=azure
SOURCE_PROJECT_ID=                               # Required for GIT_TYPE=bitbucket
SOURCE_BASE_BRANCH=                              # Required
SOURCE_RELATIVE_DIRECTORY=                       # Optional; the relative path of the repository
SAME_TARGET_DETAIL=                              # Optional; Default true, Supports [true, false]
DESTINATION_GIT_CLONE_URL=                       # Optional; the destination repo clone URL
DESTINATION_GIT_TOKEN=                           # Required if SAME_TARGET_DETAIL=false
DESTINATION_OWNER_NAME=                          # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_NAME=                           # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_ID=                             # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=gitlab
DESTINATION_PROJECT_NAME=                        # Required for GIT_TYPE=azure
DESTINATION_PROJECT_ID=                          # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=bitbucket
DESTINATION_BASE_BRANCH=                         # Required if SAME_TARGET_DETAIL=false

# Open AI env vars
OPENAI_API_MODEL=                                # Optional; Default is gpt-4
OPENAI_API_KEY=                                  # Required if AI_TYPE=openai

# Vertex AI env vars
VERTEX_FINE_TUNE=                                # Optional; Default is false, Supports [true, false]
VERTEX_PROJECT_ID=                               # Required if AI_TYPE=vertexai
VERTEX_REGION=                                   # Required if AI_TYPE=vertexai and VERTEX_FINE_TUNE=true
VERTEX_BEARER_TOKEN=                             # Required if AI_TYPE=vertexai
VERTEX_MODEL=                                    # Required if AI_TYPE=vertexai; Supports [text-bison, code-bison, codechat-bison, text-bison-32k, code-bison-32k, codechat-bison-32k, gemini-pro]

# Azure Open AI env vars
AZURE_OPENAI_ENDPOINT=                           # Required if AI_TYPE=azure_open_ai
AZURE_DEPLOYMENT_NAME=                           # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_KEY=                                # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_VERSION=                            # Optional Default is 2023-12-01-preview

# Open source env vars
OPEN_SOURCE_MODEL_ENDPOINT=                      # Required if AI_TYPE=open_source_ai
OPEN_SOURCE_MODEL=                               # Optional; Supports [meta-llama/Llama-2-13b-chat, HuggingFaceH4/starchat-beta]

# Sagemaker model env vars
SAGEMAKER_MODEL_ENDPOINT=                        # Required if AI_TYPE=sagemake_model

# Claude AI env vars 
CLAUDE_AI_MODEL=                                 # Required if AI_TYPE=claude_ai
CLAUDE_AI_API_KEY=                               # Required if AI_TYPE=claude_ai

# DBRX AI env vars 
DBRX_MODEL_ENDPOINT=                             # Required if AI_TYPE=dbrx
DBRX_AUTH_TOKEN=                                 # Required if AI_TYPE=dbrx                                   
DBRX_MODEL_NAME=                                 # Required if AI_TYPE=dbrx

# Advanced AI env vars
AI_TEMPERATURE=                                  # Optional; Default value is 0.6
USE_ASSISTANT=                                   # Optional; Use Assistant feature in openai. Default:false

# Jira board env vars
JIRA_HOST_NAME=                                  # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_EMAIL=                                      # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_TOKEN=                                      # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_ID=                                         # Optional if TEST_TYPE=functional and BOARD_TYPE=jira

# Azure board env vars
AZURE_ORG=                                       # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_PROJECT=                                   # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_TOKEN=                                     # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_WORK_ITEM_ID=                              # Optional if TEST_TYPE=functional and BOARD_TYPE=azure

# Advanced Jira/Azure board env vars
CREATE_API_SPEC=                                 # Optional; Used for TEST_TYPE=functional

# Log env vars
LOG_SOURCE=                                      # Optional; Default is elks
LOG_SOURCE_PATH=                                 # Optional; the log file path
LOG_FILE_ENCODING=                               # Optional; Default is utf-8, supports [utf-8, utf-16le]
LOG_ELASTICSEARCH_URL=                           # Optional; the Elastic search URL
LOG_ELASTICSEARCH_USER=                          # Optional; the Elastic search user name
LOG_ELASTICSEARCH_TOKEN=                         # Optional; the Elastic search token
LOG_ELASTICSEARCH_API_KEY=                       # Optional; the Elastic search api key

# Behavioural test cases env vars
BEHAVIORAL_TEST_TYPE=                            # Optional; Supports [gherkin]
BEHAVIORAL_TEST_SOURCE=                          # Optional; Supports [file, gitpath, url]
BEHAVIORAL_TEST_FILE_PATH=                       # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath
BEHAVIORAL_TEST_URL=                             # Optional; URL of the source file if source is url

# API Spec env vars
API_SPEC_TYPE=                                   # Optional; Supports [swagger, postman, raml]
API_SPEC_SOURCE=                                 # Optional; Supports [file, gitpath, url]
API_SPEC_FILE_PATH=                              # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath
API_SPEC_URL=                                    # Optional; URL of the source file if source is url
API_SPEC_ALIAS=

# Cypress test env vars
SCREENSHOTS_SOURCE=                              # Optional; Used for cypress test. Supports [file, gitpath, url]
SCREENSHOTS_URL=                                 # Optional; URL of the source file if source is url
SCREENSHOTS_FILE_PATH=                           # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath

HTTP_VERBS_FOR_TESTING=                          # Optional; Default is "get,post,put,patch,delete", Supports all the combinations of http verbs. The specific http methods to be tested for all APIs. Enter "," seperated values here. 
REGEX_HTTP_ENDPOINTS_FOR_TESTING=                # Optional; Regex string that matches to specific endpoints that needs to be tested. If empty, all the endpoints will be tested.

# Application test env vars
APPLICATION_ENTRYPOINT=                          # Required; if you need to generate application tests along with unit tests. This feature is supported only for GPT Turbo models. Use a relative path from the project root.

# License env vars
ROOST_DOMAIN=                                    # Optional; Default is app.roost.ai
ROOST_TOKEN=                                     # Optional; the Roost token or license filepath, default $HOME/.roost/license.ral
TELEMETRY=                                       # Optional; Default is true, Supports [true, false], send telemetry data to roost, no private information is shared.

# Additional env vars
TEST_NAME=                                       # Optional; Default is roost-test
ROOST_DIR=                                       # Optional; Default is /var/tmp/Roost/RoostGPT
LANGUAGE=                                        # Optional; Default is java; Supports [java, go, python, csharp, nodejs, reactjs, cpp]
AI_TYPE=                                         # Optional; Default is openai; Supports [openai, vertexai, azure_open_ai, open_source_ai, sagemaker_model, claude_ai, dbrx]
JAVA_BUILD_TOOL=                                 # Optional; Default is maven; Supports [maven, gradle]
PACKAGES_TO_SCAN=                                # Optional; Default is "*"; used for LANGUAGE=java, for generating tests for specific packages; Enter comma seperated values. E.g. "com.demo.sample,"com.example.products"
ITERATION=                                       # Optional; Set VERIFY_TEST=true to enable iteration; Default value of ITERATION is 1
TIMEOUT=                                         # Optional; Default is 1 hour
TEST_TYPE=                                       # Optional; Default is unit Supports [unit, functional, artillery, integration, api-spec-test]
TEST_FRAMEWORK=                                  # Optional; Default is "pytest" for Python, "gotest" for Golang, "JUnit4" for Java, "nunit" for CSharp, "jest" for Node.js, "postman" for Postman test-script. Supports [pytest, unittest] for Python, [gotest] for Golang, [JUnit4, JUnit5] for Java, [nunit] for Csharp, [jest] for Node.js, [postman, artillery, rest-assured] for [test_type: api-spec-test]
TRIGGER_ID=                                      # Unique id to identify multiple triggers; Default is epoch
BOARD_TYPE=                                      # Optional; Default is jira; Supports [jira, azure, none]
MAX_DEPTH=                                       # Optional; Default is -1; if MAX_DEPTH is -1, it will traverse all the sub directories else the maximum depth directories to look for
FUNCTIONS_TO_TEST=                               # Optional; List of function names to be tested, separated by comma. Name to be specified as module.[class.]method OR module.function
USE_CACHE=                                       # Optional; Used for only developer. Default:false
VERIFY_TEST=                                     # Optional; Default is true, Supports [true, false]
VULNERABILITY_GEN=                               # Optional; Default is false, Supports [true, false]
CONSIDER_EXISTING_TEST=                          # Optional; Default is true, Supports [true, false], used for Java, python, Golang unit test generation, It scans your repository to identify any existing tests for the specified function. If tests are found, it incorporates them into its consideration and generates additional test cases as needed
GRADING_NOTES=                                   # Optional; default is true
CUSTOM_TAGS=                                     # Optional; The tags to be attached to test code, so that the test's can run based on tags
ROOST_USER_INPUT=                                # Optional; The user input will be used to generate tests

# Improve test env vars
FILE_PATH=                                       # Required if IMPROVE_TEST=true
USER_CONTENT=                                    # Required if IMPROVE_TEST=true
TESTSCRIPT_ENDPOINT=                             # Required if IMPROVE_TEST=true and TEST_FRAMEWORK=postman

# Language version env vars, Used when RoostGPT is run in docker mode, visit https://docs.roost.ai/topics/roostgpt/page/cli to check the supported language versions
JAVA_VERSION=                                    # Optional; Default is 17, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
MAVEN_VERSION=                                   # Optional; Default is 3.8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GRADLE_VERSION=                                  # Optional; Default is 8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GO_VERSION=                                      # Optional; Default is 1.19.9, Used for TEST_FRAMEWORK "gotest"
PYTHON_VERSION=                                  # Optional; Default is 3, Used for TEST_FRAMEWORK "pytest", "unittest"
DOTNET_VERSION=                                  # Optional; Default is 8, Used for TEST_FRAMEWORK "nunit"
NODE_VERSION=                                    # Optional; Default is 18.18.0, Used for TEST_FRAMEWORK "artillery", "postman", "rest-assured", "karate", "jest","mocha"


Note: If a value in your .env file contains the '#' character, enclose the entire value in quotes. This prevents the '#' from being interpreted as the start of a comment.
Example: SECRET_KEY="my#secret#key"

Here's a description of each variable:

# Git env vars
# Open AI env vars
  • OPENAI_API_MODEL
    Description: Specifies the type of the OpenAI API model to be used.
    Default Value: "gpt-4"
    Supported Values: "gpt-4", "gpt-3.5-turbo", etc. (Availability of models depends on the OPENAI_API_KEY).
    Optional/Required: Optional
  • OPENAI_API_KEY
    Description: The API key required for accessing the OpenAI API.
    Optional/Required: Required if AI_TYPE is "openai"
# AZURE Open AI env vars
# Vertex AI env vars
  • VERTEX_FINE_TUNE
    Description: Indicates whether fine-tuning is enabled for the model.
    Default Value: "false"
    Supported Values: "true", "false"

  • VERTEX_PROJECT_ID
    Description: The ID of the Vertex project you are working with.
    Optional/Required: Required if AI_TYPE is "vertexai"
  • VERTEX_REGION
    Description: The region where the Vertex project is located. For example, "us-central1".
    Optional/Required: Required if AI_TYPE is "vertexai" and VERTEX_FINE_TUNE is "true"
  • VERTEX_BEARER_TOKEN
    Description: The bearer token used for authenticating requests to the Vertex API.
    Optional/Required: Required if AI_TYPE is "vertexai"
  • VERTEX_MODEL
    Description: The name of the Vertex model to be used.
    Supported Values: "text-bison", "code-bison"
    Optional/Required: Required if AI_TYPE is "vertexai"
# Open Source AI env vars
# SageMaker Model env vars
# Claude AI env vars
# DBRX AI env vars
# Advanced AI env vars
# Jira board env vars
# Azure board env vars
# Advanced Jira/Azure board env vars
# Log env vars
# Behavioural Test cases env vars
# API Spec env vars
# Cypress test env vars
# Application test env variables
# API test env vars
# License env vars
# Additional vars
# Improve Test env vars
# Language version env vars

VS Code Extension

The Roost GPT VS code extension allows you to generate tests for your code using RoostGPT with just a click, straight from your VS Code workspace.

Download:

https://marketplace.visualstudio.com/items?itemName=RoostGPT.roostgpt

Installation:

To use the RoostGPT VS Code extension, you must have VS Code ready and installed in your system, as well as any dependencies that are required to run your code, as RoostGPT will often run its generated test code to improve it.

You can download and install VS Code for your Operating system here.

After VS Code is Successfully installed in your system, you can go ahead and download the Roost GPT VS Code extension from the VS Code marketplace, just simply search for Roost GPT in the extension store. Alternatively, you can download and install the VS code extension from here.

Once the extension is installed, you are ready to generate tests for your code.

Configuration:

Once the extension has been successfully installed in your system, you can then proceed with configuring the extension to start generating tests. This involves providing information that is required for test generation.
To configure the extension to use it, simply open the extension settings for Roost GPT, you can search for it in the extension store, or you can find it in the list of your installed extensions.

You can then set up the required values according to your workspace and needs. Following are the required fields which will be required for you to set no matter what:

Required Fields


Test Generation:

Once your extension configuration is complete, you can then start using the VS Code extension to generate tests for your workspace. To generate tests, simply right-click on a file in your Explorer menu and select the type of test you want to generate from the context menu that shows up. Note that each test type has some requirements to start test generation.
The test types currently supported are as follows:

Test Requirements

Following are the Required Fields, and other instructions for test generation according to each supported test type:

Improve and Analyze Generated Tests

After the test generation process is complete, a side panel will open, showing you all the generated test files, you can select the file you want to view by using the dropdown provided, if you want you can also edit the files in the panel itself and save your changes using the provided save button.
If you want to run the generated tests, you can do so from the provided run button in the side panel, doing so will run the selected test file. NOTE that you will need to have all the dependencies required for running the tests installed in your local system for test generation to take place. and for artillery tests, after you click the run button, you will be prompted to enter the target URL for the tests, if you want to provide a target URL, please provide so in the input box, and then you will be asked if you want to upload a .env file to provide environment variables, if yes then you can upload the env file for the same.
If you are not satisfied with the generated tests and want some improvements or changes in the test, then at the bottom of the side panel, you will find a feedback prompt, enter the feedback prompt that you want to give to the AI model and then click the improve button, this will trigger the test improvement.

Public SaaS

RoostGPT UI :
Access Public SaaS at https://app.roost.ai/login

 

Roost GPT allows the user to automate their test against their code repository.

Below is the UI structure of RoostGPT which has two header tabs Test and Events.

View of the Test Tab

Screenshot-d.png

Add Test

In case of Add Test it opens up the below page, which has 5 sections ->

  1. Provide a Test Name
  2. Select the Test Type (Unit Tests , Functional and Non Functional Tests, (API using swagger), API(using source code) and integration tests.
  3. Choose GenAI Models which has OpenAI Model and VertexAI Model and field to input their respective tokens. After the token verification, model specific details will be available for selection, such as
    • For openAI, you can choose GPT-3.5 or GPT-4,
    • For Vertex AI, you need to specify vertex project id, region and vertex model.S9TlXGh1FEC21Co1-screenshot-e.png    
  4. Select SCCS (Source Code Repositories) from available
    • Github (Cloud and self hosted) ,
    • Gitlab,(cloud and self managed),
    • Azure Devops and
    • Bitbucket(cloud and self hosted).

Screenshot-f.png

  1. After the SCCS token verification, you can provide the code repo, branch, language and their versions.
  2. Languages supported are Java, Python, C#, Go
  3. Optional Integration with ticketing tools like Jira and Azure DevOps is available. 
  4. Jira requires email address associated with jira account, jira hostname and the access token for your jira account.
  5. Azure Devops requires the Organization Name associated with Azure Devops account, access token for authenticating with Azure Devops and the Project Name for Azure Devops.

Screenshot 2023-07-19 at 1.37.44 PM.png

Screenshot 2023-07-19 at 1.38.00 PM.png

Screenshot 2023-07-19 at 2.07.37 PM.png

5. In Advance Timeout (in hrs) can be specified, for which the time the test will be on triggered mode

On click of save Button you can save your test and see the test you saved in the test header section. On click of download icon configuration for the test will be downloaded.

Workflow View

This will show you the workflow of your test, details you filled while adding your test.

Screenshot 2023-07-19 at 2.16.05 PM.png

Events View

Events view contains status of all the triggered test. Event Status filter shows the status of these events weather it is in Progress, timed out, aborted, completed or failed and the fields in the table show the test name with the status of the events and the status icons also the information of the repo, type of test, creation and completion time, user Information and action icons for re-triggering the test again, logs view and the insights 

 Screenshot-1.png

Logs View

Logs View contains the Event Information, AI Model Information and the Test Result Information having PR URL of your generated test on the left side and the Logs View container on the right side which has search Bar for searching in the logs and copy icon and download icons to copy and download logs respectively. 

Screenshot-3.png

Insights View

Insights view gives you the details about your test, here it will show your test files, their completion and creation time and corresponding action icons for Analyze and improve for further analysis and improvement of your tests and download , for downloading the test file.  screenshot-i.png

on the Click of eye icon in Actions, it will show you the test Files and Corresponding Actions. In the Actions, on click of Analyze and Improve it will open the modal which will show you the test and ask for the feedback for improvement of the test.

On click of download icon, it will download the test file generated.

screenshot-j.pngScreenshot 2023-07-19 at 1.11.52 PM.png

Self Hosted Solution

For a self-hosted cloud offering, please reach out to us at support@roost.ai. We'd be delighted to assist you with your specific requirements.

RoostGPT Permissions

This document outlines the permissions and licenses related to the use of third-party components within RoostGPT.

Introduction

RoostGPT integrates with various third-party components to enhance its functionality and provide a comprehensive user experience. We value transparency and wish to provide clarity on the permissions required to ensure seamless integration with these external components.

Third-Party Components and Permissions

1. Component Name: Git

  • Description: Git is a distributed version control system.
  • Supported Types: Github, Gitlab, Bitbucket, Azure DevOps (Both Cloud and Self Hosted)
  • Purpose in Our Software: RoostGPT uses Git for reading the source code and create automated test for it and create the PR in the same repo for the tests.
  • Required Permissions:
    • User Read.
    • Repo Read.
    • Repo Write.
    • Create Commit.
    • Create PR.

2. Component Name: Jira/Azure Board

  • Description: It's used by development teams to track bugs, enhancements, tasks, and other kinds of issues throughout the software development lifecycle.
  • Purpose in Our Software: RoostGPT fetch tickets based on commits message and use that as a acceptance criteria for the automated test generation.
  • Required Permissions:
    • API Access
    • Tickets Read.
    • Comments Write

3. Component Name: Log Server

  • Description:  A log server is a centralised system designed to collect, store, and manage logs from various sources, including applications, systems, devices, and network infrastructure. By consolidating log data in one place, log servers facilitate easier monitoring, analysis, and troubleshooting.
  • Supported Types: LogStash, Log File
  • Purpose in Our Software: RoostGPT fetch logs from the log server based on the input request to enhance the test generated by using the real life data.
  • Required Permissions:
    • API Access
    • Logs Read.

4. Component Name: AI Model

  • Description:  An AI Model is an advanced computational model trained on vast amounts of text data to understand and generate human-like language. Leveraging deep learning techniques, LLMs can comprehend context, answer questions, and assist in various language-related tasks, showcasing the pinnacle of natural language processing capabilities.
  • Supported Types: OpenAI, Vertex AI, Azure OpenAI, LLAMA2, Starchat and other open source models.
  • Purpose in Our Software: RoostGPT uses AI model to generate automated test case for the source code.
  • Required Permissions:
    • API Access.

Supported Features

Feature comparison across product offerings:

 

Yellow and Green Illustrated Features Comparison Chart Graph.png


RoostGPT UI, VSCode extension, and CLI(while using the --docker flag) allow you to choose the deployment version of your Language/Tools. Below is the list of currently supported versions for different Tools/Languages.

Supported Language Versions:

Java:

Go:

Python:

 Csharp:

NodeJS:

ReactJS:

Cpp:

Maven:

Gradle: