Skip to content

Commit b255122

Browse files
authored
Merge pull request #2043 from Ishavyas9/main
Update kaneai-ci-cd-automation.md
2 parents b526c7e + af3f2ea commit b255122

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

docs/kaneai-ci-cd-automation.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ Replace `<TestRunID>` with the actual ID from the URL and set additional optiona
7979
- **tunnel**: Add the parameter and tunnel name if you want to run using LambdaTest Tunnel for private applications. See more details for tunnel [here](https://www.lambdatest.com/support/docs/kane-ai-geolocation-tunnel-proxy/#tunnel-support).
8080
- **dedicated_proxy**: Add the region of the dedicated proxy such as _us_ or _eu_, #Optional, either tunnel or dedicated proxy or geolocation can be used in a single API call.
8181
- **geolocation**: Add the resgion of the geolocation that you want to run your tests from. You can find the list of support geolocations [here](https://www.lambdatest.com/support/docs/selenium-geolocation-capabilities/).
82+
- **environment_id**: Define the environment on which you want to run the test run if required.
83+
- **retry_on_failure**: Define if you want to retry in case of failure (Boolean). If "retry_on_failure" is false, the default max retries will still be 1.
84+
- **max_retries**: Define the number of maximum retries you want (Max value 5). Default retries 1.
85+
- **timezone**: Define the timezone you want to choose for test run in UTC+01:00 format.
8286
- **app_profiling**: Add true if you want to track app profiling metrics in your test. You can find more details [here](https://www.lambdatest.com/support/docs/appium-app-performance-analytics/).
8387
- **performance**: Add true if you want generate Lighthouse report for your web tests. Supported on limited OS browser combinations. Additionally, Setting this as true could potentially slow down the execution time. You can find more details [here](https://www.lambdatest.com/support/docs/view-lighthouse-performance-metrics/).
8488
- **accessibility**: Set as true if you want to run accessibility test on all your tests in the test run. Setting this as true could potentially slow down the execution time.
@@ -92,18 +96,31 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute
9296
--header 'Authorization: Basic <Base64Auth>' \
9397
--data '{
9498
"test_run_id": "YOUR_TEST_RUN_ID", #enter test run id
95-
"concurrency": 1, # Optional, Default 1
99+
"concurrency": 1, # Optional, default 1
96100
"title": "UNIQUE_BUILD_NAME", #Optional
97101
"console_logs": "false", #Optional for web tests, options - false, error, warn, info, true
98-
"network_logs": "false", #Optional to capture network requests during the test
102+
"network_logs": "false", #Optional to capture network calls during the test
103+
"network_full_har": "false", #Optional, Only for web, to capture complete network requests & response during the test
99104
"region": "YOUR_DESIRED_REGION", #Optional for web tests, options - eastus, centralindia
100105
"mobile_region": "YOUR_DESIRED_REGION", #Optional for mobile tests, options - us,eu,ap
101106
"tunnel": "tunnel-name", #Optional, either tunnel or dedicated proxy or geolocation can be used
102107
"dedicated_proxy": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used
103-
"geolocation": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used.
108+
"geolocation": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used
109+
"environment_id": 0, #Optional, default null, to define the environment for test run
110+
"retry_on_failure": "true", #Optional, default true, to define if retry is needed in case of failure
111+
"max_retries": 1, #Optional, default 1, to define the number of retries needed if retry_on_failure is enabled
112+
"timezone": "UTC+01:00", #Optional, Only for web, to define the timezone using which the test runs should run
104113
"app_profiling": "false", #Optional for performance metrics for native mobile apps
105114
"performance": "false", #Optional for lighthouse report for web tests
106115
"accessibility": "false", #Optional only for web tests
116+
"network_throttle": {
117+
"label": "No Throttling",
118+
"value": "default",
119+
"download_speed": 0,
120+
"upload_speed": 0,
121+
"latency": 0,
122+
"honor_network": true
123+
}, #Optional, only for mobile tests, to define if sessions needs to be enabled with network throttling enabled
107124
"replaced_url": [
108125
{
109126
"pattern_url": "TEST_URL_1",

0 commit comments

Comments
 (0)