-
Notifications
You must be signed in to change notification settings - Fork 40
kane ai cicd and test plan hyp docs #1151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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.
Binary file not shown.
Binary file added
BIN
+17.5 MB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/output.mp4
Binary file not shown.
Binary file added
BIN
+96.6 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+98.6 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+98.8 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+100 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+101 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+97.3 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+103 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+95.6 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+99.8 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+101 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+98.3 KB
assets/images/kane-ai/test-manager/test-plan-execute-hyperexecute/step9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.