Installation Guide
- Bake Technologies Pty Ltd
- Ash
BakeQA - AI Test Case Generator for Jira
Table of Contents
1. Introduction
BakeQA is an innovative AI Test Case Generator designed for Jira. This powerful tool leverages artificial intelligence (AI) and an advanced large language model (LLM) to automate the creation of test cases, streamlining the software testing process. By analysing user stories and requirements, BakeQA efficiently generates relevant and comprehensive test cases.
The app seamlessly integrates into the Jira environment, making it an asset for both team-managed and company-managed projects. This not only saves time but also enhances the quality and coverage of your software tests.
For effective test case generation, each Jira issue must include a title and details of the user story in the description field of the issue. This ensures that BakeQA accurately interprets the requirements and produces high-quality test cases.
2. Getting Started
Initial app configuration steps
Before utilising the full capabilities of BakeQA – AI Test Case Generator, there are two initial steps which are required after installing the app.
App Configuration: After installing the app, an administrator must configure the app once to make the service available per Atlassian site.
Project Settings: Once the app is configured, users within the Atlassian account can activate the app per Project under Project's Settings.
3. App Installation
Installing the AI Test Case Generator
Navigate to the Atlassian Marketplace https://marketplace.atlassian.com/ enter Bake into the search field, and press enter.
Select AI Test Case Generator which should be the first result top left.
Click Try It Free.
Select your site to install the app from the dropdown and press Start Free Trial. Repeat this step if you have multiple sites.
This screen may look slightly different depending on how your account is configured and your access privelages.
4. App Configuration
Configure the app under the sites global settings
Select Settings at the top right of the screen in the header menu to expand the drop-down menu and choose Apps under Jira Settings.
On the Discover Apps and Integrations for Jira screen select Manage Apps from the left side-bar menu under Atlassian Marketplace.
Under the User-Installed Apps section of the screen click AI Test Case Generator to expand the menu and choose Get Started.
In the AI Test Case Generator – Global Settings screen, select Configure.
All options should highlight in green, indicating successful setup.
If an error occurs, or options are highlighted red, click the blue Repair Configuration button which can be used multiple times for app repairs or updates.
5. Project Settings
Configure the different project types under project settings
When setting up the app for use in a Project, the process is simple, however, slightly different for Team-Managed and Company-Managed Projects. Setting up the app requires the project administrator to create an Issue Type to use for Test Cases. The Issue Type must be set up in the Project that will contain the Test Case Issues.
The Project can be the same as where your user story Issues are stored, or a separate Project. We recommend creating a separate Project as it can make testing easier to manage in the future becoming a central repository for Test Cases which can be cloned into separate testing projects for reporting and tracking of test execution.
If you decided to user a separate Project to store your Test Case Issues, create a new Project before taking next steps if you don't already have one.
Team-Managed Projects
Navigate to Projects dropdown in the header and select a Project.
Select Project Settings under Apps from the left side-bar menu.
Expand the Issues menu from left side-bar menu and choose Types.
Select the grey Actions drop-down button to the right of the screen and select Edit Issue Types.
Select the grey Add Issue Type button to the right of the screen
Enter name Test Case with description Test Case Issue Type for AI Test Case Generator and select Standard Issue Type radio button.
Drag and drop Test Case from under Available Issue Types into Issue Types for Current Scheme and Save.
Company-Managed Projects
Ensure an Issue Type for test cases exists, which should be available post successful configuration of the app.
6. Create a Project for Storing Your Test Cases
Navigate to Projects dropdown in the header and select Create Project.
Select a Project Template and follow the steps. We recommend Kanban and naming this project Test Cases or Regression Suite.
7. Enabling the App for All Projects
Navigate to Projects dropdown in the header and select a Project.
Select Project Settings from the left side-bar menu.
Scroll down the left side-bar menu and select AI Test Case Generator – Project Settings.
Select the Project you created to store your Test Cases.
Choose Test Case from the Issue Type drop-down menu.
Enable the project for AI Test Case Generator.
8. Using the App
The app can be used in a single Issue and generate Test Cases per User Story Issue, or users can select multiple User Story Issues by sprint or JQL and generate Test Cases across all of them in one click.
For Managing Single Issues – User Stories
In the Issue Screen, click the AI Test Case Generator button in the header.
Press Generate Test Cases to start auto-generating Test Cases from the User Story. If you don’t have a User Story title and description in the Issue, you will need to create one.
Progress updates will be provided.
In case of errors, retry or contact support for persistent issues or refresh your browser.
For Managing Bulk Issues – User Stories
In the left side-bar menu, select Bulk AI Test Case Generator.
Choose issues by:
Selecting a sprint, or
Using a JQL query (Note: Only Issues from the current project are eligible).
Use tick boxes to select desired Issues.
Click Generate Test Cases to start Bulk Test Case Generation.
9. Support and Troubleshooting
For any assistance or to report issues, please create a support ticket through the Atlassian Marketplace or contact our support team directly.