From c6e636b36a85f54294f889907475e4c2f5738149 Mon Sep 17 00:00:00 2001 From: ShubhamSuri <70204532+surishubham@users.noreply.github.com> Date: Tue, 18 Mar 2025 19:11:56 +0530 Subject: [PATCH 1/2] Merge pull request #1417 from Private1647/stage Added accessibility, tunnel & dynamic url details in API --- docs/kaneai-ci-cd-automation.md | 39 +++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/docs/kaneai-ci-cd-automation.md b/docs/kaneai-ci-cd-automation.md index fc8894af8..d3cb899ba 100644 --- a/docs/kaneai-ci-cd-automation.md +++ b/docs/kaneai-ci-cd-automation.md @@ -68,6 +68,17 @@ Open the test run to view its URL. Copy the Test Run ID from the URL. This ID wi A list of test instances with various configurations will be displayed for each test run. ::: + +### Step 3: 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. +- **tunnel :** Add the parameter and tunnel name if you want to run using LambdaTest Tunnel. +- **accessibility :** Set as true if you want to run accessibility test on all your tests in the test run. (Could potentially slow the execution down if set as true) +- **replaced_url :** To be used to dynamically replace any pattern URL in test cases with the replacement URL for entire test run. + #### Example API Call: ```yaml @@ -78,11 +89,26 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute "test_run_id": "YOUR_TEST_RUN_ID", #enter test run id "concurrency": 1, # Optional, Default 1 "title": "UNIQUE_BUILD_NAME", #Optional - "region": "YOUR_DESIRED_REGION" #eastus, centralindia + "region": "YOUR_DESIRED_REGION", #eastus, centralindia + "tunnel":"tunnel-name", #Optional to be used if running via tunnel + "accessibility": false, #Optional + "replaced_url": [ + { + "pattern_url": "TEST_URL_1", + "replacement_url": "REPLACED_TEST_URL_1" + }, + { + "pattern_url": "TEST_URL_2", + "replacement_url": "REPLACED_TEST_URL_2" + }, + { + "pattern_url": "TEST_URL_3", + "replacement_url": "REPLACED_TEST_URL_3" + } + ] #Optional to be used to dynamically replace any pattern URL in test cases with the replacement URL }' ``` - #### Sample API Response: The API response contains the job ID for both jobs created for desktop web tests as well as mobile tests on real devices. Here is a sample response for a test run which contains both app and web test cases: @@ -97,15 +123,6 @@ The API response contains the job ID for both jobs created for desktop web tests } ``` -### Step 3: 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. - -Confirm that the job title is unique to avoid conflicts. Select a region if you require a specific allocation for your devices. - ### Step 4: Authenticate and Trigger the Job - Provide your LambdaTest username and access key for Basic Authentication. From 178ec24d972f5ad0e4b75b8984a2b106bca1e80b Mon Sep 17 00:00:00 2001 From: ShubhamSuri <70204532+surishubham@users.noreply.github.com> Date: Tue, 18 Mar 2025 19:26:40 +0530 Subject: [PATCH 2/2] Merge pull request #1419 from Private1647/stage Missed a space --- docs/kaneai-ci-cd-automation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kaneai-ci-cd-automation.md b/docs/kaneai-ci-cd-automation.md index d3cb899ba..aa3baa48e 100644 --- a/docs/kaneai-ci-cd-automation.md +++ b/docs/kaneai-ci-cd-automation.md @@ -90,7 +90,7 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute "concurrency": 1, # Optional, Default 1 "title": "UNIQUE_BUILD_NAME", #Optional "region": "YOUR_DESIRED_REGION", #eastus, centralindia - "tunnel":"tunnel-name", #Optional to be used if running via tunnel + "tunnel": "tunnel-name", #Optional to be used if running via tunnel "accessibility": false, #Optional "replaced_url": [ {