diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image1.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image1.png new file mode 100644 index 000000000..40caa6645 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image1.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image2.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image2.png new file mode 100644 index 000000000..08c636b26 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image2.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image3.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image3.png new file mode 100644 index 000000000..08f12bf53 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image3.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image4.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image4.png new file mode 100644 index 000000000..b56954c74 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image4.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image5.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image5.png new file mode 100644 index 000000000..0a681d3df Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image5.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image6.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image6.png new file mode 100644 index 000000000..88b35df10 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image6.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/image7.png b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image7.png new file mode 100644 index 000000000..c54218601 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/image7.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-ci-cd/output.mp4 b/assets/images/kane-ai/test-manager/test-plan-ci-cd/output.mp4 new file mode 100644 index 000000000..e7b79be5a Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-ci-cd/output.mp4 differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/output.mp4 b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/output.mp4 new file mode 100644 index 000000000..1eabb8b1f Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/output.mp4 differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step1.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step1.png new file mode 100644 index 000000000..d846162ad Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step1.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step10.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step10.png new file mode 100644 index 000000000..1cea5cbe8 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step10.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step11.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step11.png new file mode 100644 index 000000000..463ffc7c1 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step11.png 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 new file mode 100644 index 000000000..ab749928e Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step3.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step3.png new file mode 100644 index 000000000..bfe7ccaf5 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step3.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step4.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step4.png new file mode 100644 index 000000000..3c5a66340 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step4.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step5.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step5.png new file mode 100644 index 000000000..cbbfc362d Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step5.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step6.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step6.png new file mode 100644 index 000000000..14da7783b Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step6.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step7.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step7.png new file mode 100644 index 000000000..3316b841b Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step7.png differ diff --git a/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step8.png b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step8.png new file mode 100644 index 000000000..82582c533 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step8.png 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 new file mode 100644 index 000000000..72e61f365 Binary files /dev/null and b/assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png differ diff --git a/assets/images/kane-ai/kane-ai-test-planner-live-preview.png b/assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-live-preview.png similarity index 100% rename from assets/images/kane-ai/kane-ai-test-planner-live-preview.png rename to assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-live-preview.png diff --git a/assets/images/kane-ai/kane-ai-test-planner-review.png b/assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-review.png similarity index 100% rename from assets/images/kane-ai/kane-ai-test-planner-review.png rename to assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-review.png diff --git a/assets/images/kane-ai/kane-ai-write-test-plan.png b/assets/images/kane-ai/test-manager/test-plan/kane-ai-write-test-plan.png similarity index 100% rename from assets/images/kane-ai/kane-ai-write-test-plan.png rename to assets/images/kane-ai/test-manager/test-plan/kane-ai-write-test-plan.png diff --git a/assets/images/kane-ai/kane-test-plan-result.png b/assets/images/kane-ai/test-manager/test-plan/kane-test-plan-result.png similarity index 100% rename from assets/images/kane-ai/kane-test-plan-result.png rename to assets/images/kane-ai/test-manager/test-plan/kane-test-plan-result.png diff --git a/assets/images/kane-ai/kane-test-planner.png b/assets/images/kane-ai/test-manager/test-plan/kane-test-planner.png similarity index 100% rename from assets/images/kane-ai/kane-test-planner.png rename to assets/images/kane-ai/test-manager/test-plan/kane-test-planner.png diff --git a/docs/kane-ai-test-plan.md b/docs/kane-ai-test-plan.md index 3faf3f835..90ca5f5e4 100644 --- a/docs/kane-ai-test-plan.md +++ b/docs/kane-ai-test-plan.md @@ -14,9 +14,6 @@ site_name: LambdaTest slug: kane-ai-test-plan/ --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - +This guide provides a detailed walkthrough for automating the execution of test plans using CI/CD tools such as GitHub Actions or Jenkins on the KaneAI platform. By following these steps, you can effortlessly integrate test plan executions with your pipelines. + +## Prerequisites +- Access to Test Manager. +- A project with KaneAI-generated test cases. +- Credentials for LambdaTest platform. + +## Step-by-Step Guide +### Step 1: Navigate to the Test Manager +- Log in to the KaneAI platform and go to the Test Manager page. +- Access the project where the test plan is located. + +Image + +### Step 2: Locate the 'Test Plans' Section +Inside your selected project, navigate to the Test Plans section. Select the desired test plan for integration or direct triggering from your CI/CD pipeline. + +:::tip +A list of test instances with various configurations will be displayed for each test plan. +::: + +Image + +### Step 3: Copy the Test Plan ID +Open the test plan to view its URL. Copy the Test Plan ID from the URL. This ID will be used in the API call for integration. + +#### Example API Call: + +```yaml +curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Basic ' \ +--data '{ + "test_plan_id": "YOUR_TEST_PLAN_ID", #enter test plan id + "concurrency": 1, # Optional, Default 1 + "title": "UNIQUE_BUILD_NAME", #Optional + "region": "YOUR_DESIRED_REGION" #eastus, centralindia +}' +``` + +Image + +#### Example API Response: +```yaml +{ + "jobID": "aea5602b-abcd-1234-abcd-1234abcd1234", + "testBuildID": "01LAMBDATEST2024KANEAIJ8NPGDP", + "jobLink": "https://hyperexecute.lambdatest.com/hyperexecute/task?jobId=" +} +``` + +### Step 4: Configure the API Call +Replace `` with the actual ID from the URL and set additional optional parameters: + +- **Concurrency :** Defaults to 1 if not specified. +- **Title :** Assign a unique job title; a random one will be generated if omitted. +- **Region :** Choose a region such as eastus or centralindia. + +Image + +### Step 5: Ensure Job Details Are Unique +Confirm that the job title is unique to avoid conflicts. Select a region if you require a specific allocation for your devices. + +:::tip Best Practice +Assign clear and descriptive titles to distinguish between jobs. +::: + +Image + +### Step 6: Authenticate and Trigger the Job +- Provide your LambdaTest username and access key for Basic Authentication. +- Submit the API call to trigger the job. The process will start within seconds. + +> **Important :** Keep your credentials secure to maintain platform integrity. + +Image + +### Step 7: Monitor Test Executions +- Follow the link provided in the API response to view the HyperExecute Job. +- Monitor running executions in real time through the dashboard. + +Image + +## Video Explanation + \ No newline at end of file diff --git a/docs/kaneai-hyperexecute-test-plan-execution.md b/docs/kaneai-hyperexecute-test-plan-execution.md new file mode 100644 index 000000000..dd8e46244 --- /dev/null +++ b/docs/kaneai-hyperexecute-test-plan-execution.md @@ -0,0 +1,131 @@ +--- +id: kaneai-hyperexecute-test-plan-execution +title: Create and Execute your Test Plan for KaneAI Generated Tests on HyperExecute +hide_title: false +sidebar_label: Execute Test Plans on HyperExecute +description: Learn how to execute KaneAI-generated test plans directly on HyperExecute with this step-by-step guide for efficient and rapid test execution. +keywords: + - lambdatest automation + - lambdatest kaneai + - kaneai guided walkthrough + - kane ai test plan + - hyperexecute + - test plan + - test manager + - generate and manage test cases +url: https://www.lambdatest.com/support/docs/kaneai-hyperexecute-test-plan-execution +site_name: LambdaTest +slug: kaneai-hyperexecute-test-plan-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. + +## Prerequisites +- Access to Test Manager. +- A project with KaneAI-generated test cases. +- Credentials for LambdaTest platform. + +## Step-by-Step Guide +### Step 1: Navigate to the Projects Page +- Log in to Test Manager. Navigate to the Projects page and select the desired project. +- Proceed to the Test Cases section. + +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. +- Provide the following details: + - **Name :** e.g., Demo Test Plan 123. + - **Description :** A brief overview of the plan. + - **Type :** Choose KaneAI Generated Test Cases. + +Image + +### Step 4: Select and Add Test Cases +- Click Next to view available test cases. +- Select the required test cases for the plan. +- Click Add Test Case to include them. + +Image + +### Step 5: 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 +- 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 +- Enter the following details: + - **OS :** e.g., Monterey. + - **Browser :** e.g., Chrome 131. + - **Name :** e.g., Chrome 131 Mac OS Monterey. +- Save the configuration. + +Image + +### Step 8: Link and Save Test Plan 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 +- 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. +- Click Execute to run the tests. + +Image + +### Step 11: Monitor Execution on HyperExecute +- Navigate to the HyperExecute page. +- Observe the discovery and rapid execution of test cases. + +Image + +## Video Explanation + \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 93b15d12c..0a7e3d50c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1032,9 +1032,18 @@ module.exports = { "kane-ai-web-test", "kane-ai-guided-walkthrough", "kane-ai-app-test", - "kane-ai-test-plan" ], }, + { + type: "category", + collapsed: true, + label: "Test Manager", + items: [ + "kane-ai-test-plan", + "kaneai-hyperexecute-test-plan-execution", + "kaneai-ci-cd-automation" + ] + }, { type: "category", collapsed: true,