diff --git a/assets/images/kane-ai/features/datasets/1.png b/assets/images/kane-ai/features/datasets/1.png new file mode 100644 index 000000000..bb83284dd Binary files /dev/null and b/assets/images/kane-ai/features/datasets/1.png differ diff --git a/assets/images/kane-ai/features/datasets/2.png b/assets/images/kane-ai/features/datasets/2.png new file mode 100644 index 000000000..17f759bbf Binary files /dev/null and b/assets/images/kane-ai/features/datasets/2.png differ diff --git a/assets/images/kane-ai/features/datasets/3.png b/assets/images/kane-ai/features/datasets/3.png new file mode 100644 index 000000000..757ac215d Binary files /dev/null and b/assets/images/kane-ai/features/datasets/3.png differ diff --git a/assets/images/kane-ai/features/datasets/4.png b/assets/images/kane-ai/features/datasets/4.png new file mode 100644 index 000000000..c7db9b4c0 Binary files /dev/null and b/assets/images/kane-ai/features/datasets/4.png differ diff --git a/assets/images/kane-ai/features/datasets/5.png b/assets/images/kane-ai/features/datasets/5.png new file mode 100644 index 000000000..77a9a23da Binary files /dev/null and b/assets/images/kane-ai/features/datasets/5.png differ diff --git a/assets/images/kane-ai/features/datasets/6.png b/assets/images/kane-ai/features/datasets/6.png new file mode 100644 index 000000000..47b183c1b Binary files /dev/null and b/assets/images/kane-ai/features/datasets/6.png differ diff --git a/assets/images/kane-ai/features/datasets/7.png b/assets/images/kane-ai/features/datasets/7.png new file mode 100644 index 000000000..bac00372c Binary files /dev/null and b/assets/images/kane-ai/features/datasets/7.png differ diff --git a/assets/images/kane-ai/features/datasets/8.png b/assets/images/kane-ai/features/datasets/8.png new file mode 100644 index 000000000..bc7a8a26a Binary files /dev/null and b/assets/images/kane-ai/features/datasets/8.png differ diff --git a/assets/images/kane-ai/features/datasets/output.mp4 b/assets/images/kane-ai/features/datasets/output.mp4 new file mode 100644 index 000000000..e1c53ce30 Binary files /dev/null and b/assets/images/kane-ai/features/datasets/output.mp4 differ diff --git a/assets/images/kane-ai/features/parameters/1.png b/assets/images/kane-ai/features/parameters/1.png new file mode 100644 index 000000000..d1b7c8327 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/1.png differ diff --git a/assets/images/kane-ai/features/parameters/10.png b/assets/images/kane-ai/features/parameters/10.png new file mode 100644 index 000000000..2b0108f01 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/10.png differ diff --git a/assets/images/kane-ai/features/parameters/11.png b/assets/images/kane-ai/features/parameters/11.png new file mode 100644 index 000000000..674aa1b38 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/11.png differ diff --git a/assets/images/kane-ai/features/parameters/12.png b/assets/images/kane-ai/features/parameters/12.png new file mode 100644 index 000000000..43e128000 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/12.png differ diff --git a/assets/images/kane-ai/features/parameters/13.png b/assets/images/kane-ai/features/parameters/13.png new file mode 100644 index 000000000..6870da669 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/13.png differ diff --git a/assets/images/kane-ai/features/parameters/3.png b/assets/images/kane-ai/features/parameters/3.png new file mode 100644 index 000000000..d31ffd39d Binary files /dev/null and b/assets/images/kane-ai/features/parameters/3.png differ diff --git a/assets/images/kane-ai/features/parameters/4.png b/assets/images/kane-ai/features/parameters/4.png new file mode 100644 index 000000000..0a8f1bfb2 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/4.png differ diff --git a/assets/images/kane-ai/features/parameters/7.png b/assets/images/kane-ai/features/parameters/7.png new file mode 100644 index 000000000..c03e6f003 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/7.png differ diff --git a/assets/images/kane-ai/features/parameters/8.png b/assets/images/kane-ai/features/parameters/8.png new file mode 100644 index 000000000..d6d8d20f9 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/8.png differ diff --git a/assets/images/kane-ai/features/parameters/9.png b/assets/images/kane-ai/features/parameters/9.png new file mode 100644 index 000000000..1a562b251 Binary files /dev/null and b/assets/images/kane-ai/features/parameters/9.png differ diff --git a/assets/images/kane-ai/features/parameters/output.mp4 b/assets/images/kane-ai/features/parameters/output.mp4 new file mode 100644 index 000000000..a5dd252ae Binary files /dev/null and b/assets/images/kane-ai/features/parameters/output.mp4 differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png deleted file mode 100644 index ab749928e..000000000 Binary files a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png and /dev/null differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png deleted file mode 100644 index 72e61f365..000000000 Binary files a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png and /dev/null differ diff --git a/docs/kane-ai-using-datasets.md b/docs/kane-ai-using-datasets.md new file mode 100644 index 000000000..e346486a4 --- /dev/null +++ b/docs/kane-ai-using-datasets.md @@ -0,0 +1,96 @@ +--- +id: kane-ai-using-datasets +title: KaneAI - Using Datasets on Test Manager +hide_title: false +sidebar_label: Datasets +description: Learn how to use datasets in the KaneAI test cases +keywords: + - lambdatest automation + - lambdatest kaneai + - kaneai scroll elements + - kaneai sidebar scroll +url: https://www.lambdatest.com/support/docs/kane-ai-using-datasets/ +site_name: LambdaTest +slug: kane-ai-using-datasets/ +--- + +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"; + + +Datasets in KaneAI-LambdaTest allow you to manage and reuse input values for test cases efficiently. This guide explains how to create, edit, and manage these data sets while utilizing parameters to run test cases with a variety of inputs, improving flexibility and reducing manual data entry. + +## Accessing Datasets within a Project +Navigate to the Parameters section within your project and review existing data sets under this section. +> **Note :** Parameters act as placeholders for data, enabling test cases to use varying inputs. + +Image + +Every test case which uses parameters in KaneAI automatically generates a default data set during authoring. Example: A default data set might capture initial values like form submissions. +> Default Datasets are immutable in nature i.e. they cannot be modified. + +Image + +## Creating and Editing Datasets +- To create a dataset, navigate to the Datasets section, click "Create Dataset," and define parameters and values as needed. +- For existing datasets, access the version history of a default dataset, create a copy, and edit the copied dataset to update or add values seamlessly. + +Image + +## Adding Data to Datasets +Open the editable Dataset. Click on "**Add a Row After**". Enter your desired values (e.g., 5 or Mike). + +Image + +### Autofill with AI + +Alternatively, you can use the **Autofill with AI** option to automatically populate data fields. AI generates values based on the parameter's name, saving time and effort. + +Image + +### Importing Data via CSV Files +Prepare your data set in CSV format. Use the Import Data feature in the data set editor and verify imported data and save the test case to ensure synchronization. + +Image + +## Utilizing Version History +- **Version Tracking :** All changes to data sets are recorded. +- **Revert or Restore :** Easily revert to a previous version if needed. +- **Backup Assurance :** Ensure data integrity with a maintained history of edits. + +Image + +## Executing Test Cases with Parameters +Combine multiple data sets with their respective parameters. +Execute test cases using these data sets to simulate diverse input scenarios. + +Image + +## Video Explanation + diff --git a/docs/kane-ai-using-json-variables.md b/docs/kane-ai-using-json-variables.md index 865f66107..2c5cf4098 100644 --- a/docs/kane-ai-using-json-variables.md +++ b/docs/kane-ai-using-json-variables.md @@ -2,7 +2,7 @@ id: kane-ai-using-json-variables title: KaneAI - Utilizing JSON Variables for Assertions hide_title: false -sidebar_label: JSON Variables Guide +sidebar_label: JSON Variables description: Learn how to use JSON variables in the KaneAI test cases for assertions keywords: - lambdatest automation diff --git a/docs/kane-ai-using-parameters.md b/docs/kane-ai-using-parameters.md new file mode 100644 index 000000000..542d4f823 --- /dev/null +++ b/docs/kane-ai-using-parameters.md @@ -0,0 +1,116 @@ +--- +id: kane-ai-using-parameters +title: KaneAI - Using Parameters +hide_title: false +sidebar_label: Parameters +description: Learn how to use parameters in the KaneAI test cases +keywords: + - lambdatest automation + - lambdatest kaneai + - kaneai scroll elements + - kaneai sidebar scroll +url: https://www.lambdatest.com/support/docs/kane-ai-using-parameters/ +site_name: LambdaTest +slug: kane-ai-using-parameters/ +--- + +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"; + + +This guide provides a detailed walkthrough for utilizing parameters in KaneAI to streamline test case management and execute tests with various data inputs. By leveraging data parameters, testers and developers can manage configurations effortlessly. Follow the step-by-step instructions below for successful implementation. + +## Key Features of Parameters in KaneAI +- **Dynamic Data Input :** Use parameters to define and input test data dynamically during test execution. +- **Multiple Configurations :** Simplify the execution of tests with different data sets. +- **Seamless Test Management :** Centralized management of parameters improves efficiency and reduces redundancy. + +## Define Parameters in a Web or App Agent Test +- Navigate to the specific web agent test URL and configure the test to accept input parameters. + +Image + +## Create a parameter in a test +- Confirm that parameters are already defined in the system. To add a new parameter, use one of the following methods to define the parameter: + - Type a **`slash (/)`** and select the Parameter option. + - Click the Plus icon and choose the Parameter icon. + +Click **Create Parameter** to save. + +Image + +## Reference the parameter in test step +Reference any parameter using **dollar-curly braces syntax** (e.g.,`${phone_number}`). Enter the name in its designated input field. + +Image + +## Step 4: Test Summary Page +Upon completing the test, review the Test Summary Page, where all utilized parameters are clearly displayed, and the corresponding generated code is readily available for seamless integration into future test scenarios. +Image + +## Using parameters for test runs + +### Step 1: Navigate to Test Project +Open the Test Project dashboard and go to the **Test Run** section. + +Image + +### Step 2: Create a New Test Run +- Click **Create New Test Run** and name it (e.g., parameters test run). +- Select the KaneAI-generated test cases. +- Optionally, add a description or relevant tags. +- Click **Create Test Run**. + +Image + +### Step 3: Add Test Cases and Data Sets +- Select and add the desired test cases to the run. +- Specify configurations (e.g., Windows 10 Chrome). +- Attach the required data sets for the test run. + +Image + +### Step 4: Apply Data Sets +- Ensure the data sets containing necessary parameters are pre-filtered and accessible. +- Click **Apply** to confirm the Dataset selection. + +Image + +### Step 5: Save and Prepare for Execution +- Save the test run with the selected parameters and Datasets. The system will create test instances ready for execution in a hybrid environment. + +Image + +### Step 6: Execute Tests with Parameters +Utilize the parameters to run your test cases with different data sets and inputs. You can manage and monitor execution using the LambdaTest Test Manager interface. + +Image + +## Video Explanation + diff --git a/docs/kane-ai-using-variables.md b/docs/kane-ai-using-variables.md index a6f7d1ac4..4435e17ca 100644 --- a/docs/kane-ai-using-variables.md +++ b/docs/kane-ai-using-variables.md @@ -2,7 +2,7 @@ id: kane-ai-using-variables title: KaneAI - Using Variables in Test Cases hide_title: false -sidebar_label: Variables Guide +sidebar_label: Variables description: Learn how to use variables in the KaneAI test cases keywords: - lambdatest automation @@ -36,7 +36,7 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co },{ "@type": "ListItem", "position": 3, - "name": "KaneAI Jira Integration", + "name": "KaneAI Variables", "item": "https://www.lambdatest.com/support/docs/kane-ai-using-variables/" }] }) diff --git a/docs/kaneai-hyperexecute-test-plan-execution.md b/docs/kaneai-hyperexecute-test-run-execution.md similarity index 71% rename from docs/kaneai-hyperexecute-test-plan-execution.md rename to docs/kaneai-hyperexecute-test-run-execution.md index dd8e46244..a70d484c5 100644 --- a/docs/kaneai-hyperexecute-test-plan-execution.md +++ b/docs/kaneai-hyperexecute-test-run-execution.md @@ -1,5 +1,5 @@ --- -id: kaneai-hyperexecute-test-plan-execution +id: kaneai-hyperexecute-test-run-execution title: Create and Execute your Test Plan for KaneAI Generated Tests on HyperExecute hide_title: false sidebar_label: Execute Test Plans on HyperExecute @@ -13,9 +13,9 @@ keywords: - test plan - test manager - generate and manage test cases -url: https://www.lambdatest.com/support/docs/kaneai-hyperexecute-test-plan-execution +url: https://www.lambdatest.com/support/docs/kaneai-hyperexecute-test-run-execution site_name: LambdaTest -slug: kaneai-hyperexecute-test-plan-execution/ +slug: kaneai-hyperexecute-test-run-execution/ --- -This documentation outlines the steps to create a test plan for KaneAI generated tests using Test Manager. The steps include selecting test cases, setting configurations, and running tests with HyperExecute for efficient execution. Follow the instructions carefully to ensure seamless execution of the process. +This documentation outlines the steps to create a test run for KaneAI generated tests using Test Manager. The steps include selecting test cases, setting configurations, and running tests with HyperExecute for efficient execution. Follow the instructions carefully to ensure seamless execution of the process. ## Prerequisites - Access to Test Manager. @@ -55,42 +55,36 @@ This documentation outlines the steps to create a test plan for KaneAI generated Image -### Step 2: View and Select Test Cases -- Review the list of created test cases in the Test Cases section. -- Select the desired test cases and click Create Test Plan. - -Image - -### Step 3: Create a Test Plan -- Alternatively, go to the Test Plan section within the project. -- Click Create Test Plan. +### Step 2: Create a Test Plan +- Go to the Test Plan section within the project. +- Click Demo Test Plan. - Provide the following details: - **Name :** e.g., Demo Test Plan 123. - - **Description :** A brief overview of the plan. + - **Description :** A brief overview of the run. - **Type :** Choose KaneAI Generated Test Cases. Image -### Step 4: Select and Add Test Cases +### Step 3: Select and Add Test Cases - Click Next to view available test cases. -- Select the required test cases for the plan. +- Select the required test cases for the run. - Click Add Test Case to include them. Image -### Step 5: Assign and Configure Test Cases +### Step 4: Assign and Configure Test Cases - On the test plan page, review the added test cases. - Assign team members in bulk. - Update configurations as required. Image -### Step 6: Set Browser Configurations +### Step 5: Set Browser Configurations - Choose from available browser configurations. If a new configuration is needed, click on Create Configuration button and choose from thousands of configuration options. Image -### Step 7: Create New Configuration +### Step 6: Create New Configuration - Enter the following details: - **OS :** e.g., Monterey. - **Browser :** e.g., Chrome 131. @@ -99,19 +93,13 @@ This documentation outlines the steps to create a test plan for KaneAI generated Image -### Step 8: Link and Save Test Plan Configurations +### Step 7: Link and Save Test Run Configurations - Select the newly created configuration and link it to the selected test cases. - Confirm configurations and test cases and add additional test cases if required. Save the test plan. Image -### Step 9: Create a Build -- Once the test plan is saved, it will display test cases and configurations. Create a build and provide a name, e.g., Demo Build. -- The test plan is automatically linked to the build. You can also add a tag for filtering our your test plans. Now create the build. - -Image - -### Step 10: Run with HyperExecute +### Step 8: Run with HyperExecute - Initiate the run using HyperExecute by clicking **Run with HyperExecute**. - View all test instances in the dashboard. - Set the desired concurrency level, e.g., 5. @@ -119,7 +107,7 @@ This documentation outlines the steps to create a test plan for KaneAI generated Image -### Step 11: Monitor Execution on HyperExecute +### Step 9: Monitor Execution on HyperExecute - Navigate to the HyperExecute page. - Observe the discovery and rapid execution of test cases. diff --git a/sidebars.js b/sidebars.js index ceef7f9f3..cdc8bec78 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1027,7 +1027,7 @@ module.exports = { label: "Test Manager", items: [ "kane-ai-test-plan", - "kaneai-hyperexecute-test-plan-execution", + "kaneai-hyperexecute-test-run-execution", "kaneai-ci-cd-automation" ] }, @@ -1041,6 +1041,17 @@ module.exports = { "kane-ai-scroll-in-feature", "kane-ai-jira-integration", "kane-ai-api-testing", + { + type: "category", + collapsed: true, + label: "Variables and Parameters", + items: [ + "kane-ai-using-variables", + "kane-ai-using-json-variables", + "kane-ai-using-parameters", + "kane-ai-using-datasets" + ] + }, "kane-ai-modules" ], }, @@ -1051,16 +1062,6 @@ module.exports = { items: [ "kane-ai-command-guide", "kane-ai-web-test-writing-guidelines", - { - type: "category", - collapsed: true, - label: "Variables Guide", - link: { - type: "doc", - id: "kane-ai-using-variables" - }, - items: ["kane-ai-using-json-variables"] - }, ], }, {