Merge pull request #1151 from amanchopra1905/stage

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';
-
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -57,7 +54,7 @@ You have to clearly state your goal or define the functionality that you want to
 
 Once your objective is defined, press enter and KaneAI will start analyzing the required actions to achieve the desired outcome.
 
-<img loading="lazy" src={require('../assets/images/kane-ai/kane-test-planner.png').default} alt="Image" width="1347" height="616"  className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan/kane-test-planner.png').default} alt="Image" className="doc_img"/>
 
 ### Step 2: Define your State, Outcomes, Error Messages, Constraints, and User Inputs
 
@@ -66,7 +63,7 @@ Once your objective is defined, press enter and KaneAI will start analyzing the
 - **Constraints :** These are the conditions or limitations under which the test is conducted. For example, you might constrain the testing to specific browsers, devices, or operating systems.
 - **User Inputs :** This refers to any information or data that the user needs to provide during the test. For example, in a login test, the user input would be the username and password.
 
-<img loading="lazy" src={require('../assets/images/kane-ai/kane-ai-write-test-plan.png').default} alt="Image" width="1347" height="616"  className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan/kane-ai-write-test-plan.png').default} alt="Image" className="doc_img"/>
 
 Now click on the **Review and Scheule test** button.
 
@@ -77,15 +74,15 @@ In the right side, you willget an option to select your Project, Folder in which
 
 Click on **Schedule Test** button.
 
-<img loading="lazy" src={require('../assets/images/kane-ai/kane-ai-test-planner-review.png').default} alt="Image" className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-review.png').default} alt="Image" className="doc_img"/>
 
 ### Step 4: 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/kane-ai-test-planner-live-preview.png').default} alt="Image" className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan/kane-ai-test-planner-live-preview.png').default} alt="Image" className="doc_img"/>
 
 You will be redirected to playground where your tests will be getting executed and you can check the complete process.
 
-<img loading="lazy" src={require('../assets/images/kane-ai/kane-test-plan-result.png').default} alt="Image" className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan/kane-test-plan-result.png').default} alt="Image" className="doc_img"/>
 
 > You can now go to the **Test Manager** where you have saved your test case and trigger it on HyperExecute.

docs/kaneai-ci-cd-automation.md

@@ -0,0 +1,134 @@
+---
+id: kaneai-ci-cd-automation
+title: Automating Test Plan Execution with CI/CD on KaneAI
+hide_title: false
+sidebar_label: Test Automation with CI/CD
+description: Automate test plan execution on KaneAI with CI/CD tools like GitHub Actions and Jenkins. Follow our step-by-step guide for seamless integration.
+keywords:
+  - lambdatest automation
+  - lambdatest kaneai
+  - kaneai guided walkthrough
+  - kane ai test plan
+  - hyperexecute
+  - test plan
+  - test manager
+  - ci/cd
+  - jenkins
+  - github actions
+  - api
+  - postman
+url: https://www.lambdatest.com/support/docs/kaneai-ci-cd-automation
+site_name: LambdaTest
+slug: kaneai-ci-cd-automation/
+---
+
+<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 CI/CD Automation",
+          "item": "https://www.lambdatest.com/support/docs/kaneai-ci-cd-automation"
+        }]
+      })
+    }}
+></script>
+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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image1.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+:::
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image2.png').default} alt="Image" className="doc_img"/>
+
+### 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 <Base64Auth>' \
+--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
+}'
+```
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image3.png').default} alt="Image" className="doc_img"/>
+
+#### Example API Response:
+```yaml
+{
+    "jobID": "aea5602b-abcd-1234-abcd-1234abcd1234",
+    "testBuildID": "01LAMBDATEST2024KANEAIJ8NPGDP",
+    "jobLink": "https://hyperexecute.lambdatest.com/hyperexecute/task?jobId=<job-id>"
+}
+```
+
+### Step 4: Configure the API Call
+Replace `<TestPlanID>` 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image4.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+:::
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image5.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image6.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/image7.png').default} alt="Image" className="doc_img"/>
+
+## Video Explanation
+<video class="right-side" width="100%" controls id="vid">
+<source src= {require('../assets/images/kane-ai/test-manager/test-plan-ci-cd/output.mp4').default} type="video/mp4" />
+</video>

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/
+---
+
+<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 Test Plan",
+          "item": "https://www.lambdatest.com/support/docs/kaneai-hyperexecute-test-plan-execution"
+        }]
+      })
+    }}
+></script>
+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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step1.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step3.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step4.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step5.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step6.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step7.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step8.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png').default} alt="Image" className="doc_img"/>
+
+### 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.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step10.png').default} alt="Image" className="doc_img"/>
+
+### Step 11: Monitor Execution on HyperExecute
+- Navigate to the HyperExecute page.
+- Observe the discovery and rapid execution of test cases.
+
+<img loading="lazy" src={require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step11.png').default} alt="Image" className="doc_img"/>
+
+## Video Explanation
+<video class="right-side" width="100%" controls id="vid">
+<source src= {require('../assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/output.mp4').default} type="video/mp4" />
+</video>

sidebars.js

@@ -1048,9 +1048,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,