Test Case Assistant for Jira Documentation

Video Tutorial

Test Case Assistant

Initial App Setup

This app does not require any initial setup unless you wish to customize the generated test cases by providing a Format.

What is the Test Case Assistant for Jira App?

The Test Case Assistant for Jira is an App designed to help you easily create test cases from user stories using your templates, thereby saving you time.

How to Use the Test Case Assistant for Jira App

To use this app, open a user story that includes a description and summary. These details will be used to generate the test case. You can further customize the generated test cases using the prompt feature.

Generate Test Cases:

1. Navigate to the Jira project.

2. Open the user story for which you need to generate a test case.

3. In the user story, click on "Test Case Assistant."

4. The Test Case Assistant screen will open on the Right side of the issue screen. Click on "Click to generate."

5. The Test Case Assistant will generate the test case description. Here, you can edit your test case description or scenarios.

6. We can use “Regenerate” button to generate the test cases any number of times, which will help to generate new scenarios.

Clicking "Regenerate" provides a text area where you can suggest improvements for the test case generator.

Once you are satisfied with the test case, click on "Attach Test Case."

It will create the test case and automatically link it to the user story.

How the Application Creates Test Cases

The application uses the summary and description from user stories, employing the latest OpenAI models to generate test cases.

What is the “Test Case Format” Section?

The prompt section allows you to customize the generated test cases by specifying additional prompts.

Adding Format:

1. Click on “Test Case Assistant”, left side of project App section.

In the Test Case Assistant project page, we can select the issue type for the test case and add custom formats.

3. Click on “Add New Format”.

4. Enter the format Name as required.

5. Add the format/template style as required .(This will be used to display the format in which output/testcase will be generated.)

6. Set the temperature.(Higher values increase randomness, while lower values increase determinism.)

7. Click on Submit.

8. On the “Test Case Format” screen, you can edit or delete existing formats and choose which format to use for test case generation.

Note: Once this format is saved it will be the default format applicable for all the test cases generated, we can change this at any point of time and regenerate the test cases.

The system-level format is a global format that allows a company to use the same format template across all their projects. If edited, changes to the system-level format will be reflected everywhere else.

The App-Recommended- prompt is the recommended format provided by the application for generating quality test cases. It cannot be deleted or edited.

Why Do We Need an OpenAI API Token?

Providing an OpenAI API token is optional; however, there is a usage limit on generating test cases based on the number of users. If users exceed this limit and wish to continue using the app, they must supply their own OpenAI API token to access OpenAI models.

How to use your own token for API calls

To configure an Admin API token in the App, please follow these steps:

Click on “Manage Apps”.

Select the Test Case Assistance for Jira plugin in the Manage apps section.

Click on “Configure”.

Click on “Add new API Keys”.

Enter your name and OpenAI API token, then proceed with the submission. Upon successful authentication of the token's validity, it will be securely stored within your instance.

Note: Before setting an API token as the default, ensure it has access to GPT models. Otherwise, it cannot be set as the default.