Skip to content

Commit

Permalink
Merge pull request #1068 from Ishavyas9/main
Browse files Browse the repository at this point in the history
kane-ai-jira-integration
  • Loading branch information
Ishavyas9 authored Nov 5, 2024
2 parents fc98503 + 12ba64f commit e325049
Show file tree
Hide file tree
Showing 21 changed files with 472 additions and 8 deletions.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion docs/app-auto-network-throttling.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,14 @@ To utilize the **networkProfile** capability, ensure that you include `network:

#### iOS

- For **iOS** devices, offline mode cannot be set using the `networkProfile` capability. Instead, use the offline mode API by sending a cURL request within the running test session:

- **LambdaHook:** You can also switch to offline mode during the test execution with the following command:
```python
driver.execute_script("updateNetworkProfile=offline")
```

- For both iOS and android devices you can use the offline/online mode API as well within the running test session:

```bash
curl --location 'https://mobile-api.lambdatest.com/mobile-automation/api/v1/sessions/<session-id>/update_network' \
--header 'Authorization: Basic <username:access_key>' \
Expand Down
65 changes: 65 additions & 0 deletions docs/contacts-on-real-devices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
id: contacts-on-real-devices
title: Access your Contacts
sidebar_label: Contacts
description: Now you can test your contacts in your app on LambdaTest Real Device Cloud Platform with 3000+ real mobile devices.
keywords:
- image injection
- app test automation
- contacts
- access contacts
- delete contacts
- save contacts
- lambdatest capture code
- framework on lambdatest
- app testing appium
- app testing
- real devices
url: https://www.lambdatest.com/support/docs/contacts-on-real-devices/
site_name: LambdaTest
slug: contacts-on-real-devices/
---

import CodeBlock from '@theme/CodeBlock';
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Access Contacts on Real Devices",
"item": "https://www.lambdatest.com/support/docs/contacts-on-real-devices/"
}]
})
}}
></script>
With LambdaTest Real Devices, you can interact with the built-in Contacts app on our real devices to test your app's functionality. To support diverse testing, we've included sample contact data for you to use.

## Supported Devices
LambdaTest supports access to the dummy Contacts on the following devices:

- Devices running Android 10 and higher(Except Tabs).
- Devices running iOS 13 and higher.

## What you can test?
With access to the Contacts app on the remote devices, you can now test scenarios, such as:

- Access contacts from the Contacts app.
- Add/Save your custom contacts to the Contacts app.
- Edit/delete a contact.
4 changes: 2 additions & 2 deletions docs/hyperexecute-integration-with-virtual-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ Run your samplе tеsts on HyperExecute using our samplе Android and iOS applic

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
<!-- :::tip Sample repo
Download or Clone the code sample for the Virtual Devices from the LambdaTest GitHub repository to run the tests on the HyperExecute.
<a href="https://github.com/LambdaTest/hyp-virtual-device-appium" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::
::: -->

## Step 2: Setup the CLI in your Test Suite

Expand Down
4 changes: 2 additions & 2 deletions docs/hyperexecute-smart-ui-sdk-selenium-csharp.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ After creating the project, you will get your `PROJECT_TOKEN`. You need to keep

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
<!-- :::tip Sample repo
Download or Clone the code sample for the Selenium - JavaScript framework from the LambdaTest GitHub repository to run the tests on the HyperExecute.
<a href="https://github.com/LambdaTest/hyperexecute-smartui-sdk-selenium-csharp" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::
::: -->

### Update the Dependencies

Expand Down
112 changes: 112 additions & 0 deletions docs/kane-ai-api-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
id: kane-ai-api-testing
title: KaneAI - API Testing
hide_title: false
sidebar_label: API Testing
description: Learn how to test api via kane ai
keywords:
- lambdatest automation
- lambdatest kaneai
- kaneai scroll elements
- kaneai sidebar scroll
url: https://www.lambdatest.com/support/docs/kane-ai-api-testing/
site_name: LambdaTest
slug: kane-ai-api-testing/
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "KaneAI Jira Integration",
"item": "https://www.lambdatest.com/support/docs/kane-ai-api-testing/"
}]
})
}}
></script>
This document provides a detailed guide to performing API testing using KaneAI. The API testing feature allows for comprehensive backend testing, complementing existing UI testing capabilities. Follow the instructions below to execute API tests using the PetStore API as an example.

## 1. Adding an API in a Web Test

To start API testing on KaneAI, create a web test using the PetStore API, a commonly available sample. This will allow you to demonstrate API testing capabilities effectively.

- **Step**: Add an API through the slash command and navigate to the API module.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image1.jpg').default} alt="kenai-jira integration" className="doc_img"/>


## 2. Adding a Curl Command

Within the API module, you can input the curl command to configure the API settings automatically.

- **Step**: Paste your curl command into the designated area. KaneAI will populate all necessary details. You may choose to validate the API response or add it directly to the test steps.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image2.jpg').default} alt="kenai-jira integration" className="doc_img"/>


## 3. Validating API Response on KaneAI

To ensure the API works as expected, use the validation feature. This step confirms that the API responds correctly and can be added to test steps.

- **Step**: Click the 'validate' option to check the API response. A 200 response status indicates successful validation, automatically adding the API to your test steps. You can now proceed to submit multiple APIs simultaneously if needed.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image3.jpg').default} alt="kenai-jira integration" className="doc_img"/>


## 4. Adding Non-Success APIs in Test Steps

For APIs that do not return a 200 status, you can review the response body and manually add them to the test steps as required.

- **Step**: If the API returns a 400 Bad Request or another error, it will not be added automatically. Review the response and add the API manually if needed.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image8.jpg').default} alt="kenai-jira integration" className="doc_img"/>


## 5. Adding Multiple APIs in One Go

KaneAI allows batch processing of multiple APIs to streamline testing. This feature is helpful for scenarios requiring the execution of several API calls in succession.

- **Step**: Add multiple APIs by clicking the plus icon and selecting each API, or paste multiple curl commands to add them automatically to the test steps.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image10.jpg').default} alt="kenai-jira integration" className="doc_img"/>


## 6. Handling Different HTTP Methods

KaneAI supports various HTTP methods like POST, PUT, GET, and DELETE, allowing you to test diverse API interactions.

- **Step**: Add APIs using different HTTP methods, such as a PUT or DELETE command. Validate each API as before, and if successful, they will be automatically included in the test steps.


<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image6.jpg').default} alt="kenai-jira integration" className="doc_img"/>

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image9.jpg').default} alt="kenai-jira integration" className="doc_img"/>

## 7. Executing and Reviewing Test Steps

Once all APIs are added, KaneAI enables simultaneous execution, with details available on methods used, response statuses, and execution times.

- **Step**: Click to execute all added APIs in one go and review the response details for insights into API performance and data returned.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/api-testing/image13.jpg').default} alt="kenai-jira integration" className="doc_img"/>


This structure provides logical groupings for different aspects of API testing with KaneAI, making it easier to follow each type of action required for comprehensive API testing.
87 changes: 87 additions & 0 deletions docs/kane-ai-jira-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
id: kane-ai-jira-integration
title: KaneAI - Jira Integration
hide_title: false
sidebar_label: Jira Integration
description: Learn how to integrate your jira tickets with KaneAI and test planner using Atalssian Marketplace
keywords:
- lambdatest automation
- lambdatest kaneai
- kaneai scroll elements
- kaneai sidebar scroll
url: https://www.lambdatest.com/support/docs/kane-ai-jira-integration/
site_name: LambdaTest
slug: kane-ai-jira-integration/
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "KaneAI Jira Integration",
"item": "https://www.lambdatest.com/support/docs/kane-ai-jira-integration/"
}]
})
}}
></script>
The "Jira integration" feature allows you to generate test cases from your Jira tickets automatically. This feature leverages AI to analyze the content of Jira tickets and transform written test case descriptions into executable test cases on the LambdaTest platform. This documentation provides a detailed guide to help you understand and utilize this feature effectively.

## Key Benefits of the Kane AI Jira Integration:
- **Automated Test Creation :** Quickly transform test case descriptions in Jira into executable test cases without manual setup.
- **Efficient QA Workflow :** Simplify testing processes by managing test creation directly from Jira, saving time and reducing errors.
- **Reduced Bug Risk :** AI-powered test creation helps reduce the likelihood of bugs by ensuring all outlined test cases are covered and refined.

## Step-by-Step Guide
### Step 1: Install LambdaTest Application for Jira
Visit the Atlassian Marketplace, locate the **LambdaTest AI Cloud** application for Jira and install app on your Jira instance.

:::note
Currently in the **Beta**. Please reach out to our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>support team</span> to enable the KaneAI for your organization.
:::

<img loading="lazy" src={require('../assets/images/kane-ai/features/jira-integration/marketplace.png').default} alt="kenai-jira integration" className="doc_img"/>

### Step 2: Define Test Cases in a Jira Ticket
- **Create or Open a Jira Ticket :** Start by creating a Jira ticket or accessing an existing ticket where you want to outline test cases.
- **Write Test Case Details :** In the comments section, add detailed information about the test cases you want to execute. Clearly describe each test case's steps, conditions, expected outcomes, and any other relevant information to help Kane AI generate accurate tests.

### Step 3: Generate Test Cases Using Kane AI
To trigger Kane AI, add the comment to your Jira ticket calling LambdaTest application, for example:

```bash
@LambdaTest create test case based on the details of this Jira
```
> **Note :** This comment signals Kane AI to analyze the Jira ticket content and automatically create test cases.
After you post the comment, Kane AI will process the request and respond with a confirmation message. The response includes a link to LambdaTest where you can review, modify, and schedule the generated test case.
<img loading="lazy" src={require('../assets/images/kane-ai/features/jira-integration/jira-test-case.webp').default} alt="kenai-jira integration" className="doc_img"/>
### Step 4: Review and Schedule the Test Case on LambdaTest
- **Access the Test Case :** Click on the link provided by Kane AI in the Jira comment. This will create a [Test Plan](/support/docs/kane-ai-test-plan/#step-2-define-your-state-outcomes-error-messages-constraints-and-user-inputs) for you to review and execute via KaneAI.
- **Review Test Case Details :** Check the generated test case for accuracy. You can review test steps, expected outcomes, and conditions to ensure they align with your requirements.
- **Schedule the Task for KaneAI :** Once verified, schedule the task for KaneAI to generate and automate the test case on its own.
### Step 5: Check the test execution
Click on the Live Preview button to enter the playground and check the live execution of your test based on your defined objective.
<img loading="lazy" src={require('../assets/images/kane-ai/features/jira-integration/live-preview.png').default} alt="kenai-jira integration" className="doc_img"/>
Loading

0 comments on commit e325049

Please sign in to comment.