From f3dcc090248ef76c777422a688df17ece0036f3c Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Fri, 31 May 2024 10:47:58 +0530 Subject: [PATCH] Updated Step Settings & Added APIs for Results Updated Test Step Settings and Added a new doc for fetching test results at all levels using APIs. --- src/left-nav-title.json | 3 +- .../examples/rerun-test-cases-in-test-run.md | 2 +- ...me-test-plan-multiple-times-in-parallel.md | 4 +- .../examples/schedule-test-plan-with-API.md | 4 +- .../examples/trigger-multiple-test-plans.md | 2 +- .../trigger-test-plan-wait-completion.md | 4 +- .../update-test-case-results-using-API.md | 4 +- .../examples/values-of-test-data-profile.md | 2 +- .../docs/api/get-project-wide-information.md | 2 +- .../docs/api/test-results-at-all-levels.md | 234 ++++++++++++++++++ .../upload-and-update-test-data-profile.md | 2 +- .../step-settings.md | 16 +- .../docs/test-cases/manage/add-edit-delete.md | 31 +-- 13 files changed, 262 insertions(+), 48 deletions(-) create mode 100644 src/pages/docs/api/test-results-at-all-levels.md diff --git a/src/left-nav-title.json b/src/left-nav-title.json index f78dbf4d..bd349111 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -673,5 +673,6 @@ }, "error-handling": { "/docs/salesforce-testing/error-handling/": "Error Handling On Metadata Refresh" - } + }, + "test-results-at-all-levels": { "/docs/api/test-results-at-all-levels/": "Fetch Test Results (All Levels)" } } \ No newline at end of file diff --git a/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md b/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md index 4398dd2e..a2cea956 100644 --- a/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md +++ b/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md @@ -3,7 +3,7 @@ title: "Rerun Test Cases from Run Results using API" page_title: "Rerun Test Cases from Run Results using APII" metadesc: "Learn in detail how to rerun failed test cases, all test cases, or custom test cases from a particular test run result in Testsigma using REST API." noindex: false -order: 21.67 +order: 21.87 page_id: "Rerun Test Cases from a Test Run" warning: false contextual_links: diff --git a/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md b/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md index 97ae1d13..619ea01c 100644 --- a/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md +++ b/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md @@ -1,8 +1,8 @@ --- -title: "Run the same Test Plan multiple times in Parallel" +title: "Run the Same Test Plan Multiple Times in Parallel" metadesc: "This document discusses how one test plan can be run multiple times, in parallel, using the REST API calls | Run same test plan multiple times" noindex: false -order: 21.63 +order: 21.83 page_id: "Run the same Test Plan multiple times in Parallel" search_keyword: "" warning: false diff --git a/src/pages/docs/api/examples/schedule-test-plan-with-API.md b/src/pages/docs/api/examples/schedule-test-plan-with-API.md index 946b06db..02536f8d 100644 --- a/src/pages/docs/api/examples/schedule-test-plan-with-API.md +++ b/src/pages/docs/api/examples/schedule-test-plan-with-API.md @@ -1,9 +1,9 @@ --- -title: "Schedule, Update and Delete a test plan using API" +title: "Schedule, Update & Delete a Test Plan Using API" page_title: "Schedule a test plan using API" metadesc: "With Testsigma, you can create, update, and delete a schedule for test plan using API. Learn how to schedule, update and delete a test plan using REST API" noindex: false -order: 21.64 +order: 21.84 page_id: "Schedule, Update and Delete a test plan using API" warning: false contextual_links: diff --git a/src/pages/docs/api/examples/trigger-multiple-test-plans.md b/src/pages/docs/api/examples/trigger-multiple-test-plans.md index c0cb6ae3..c14e157b 100644 --- a/src/pages/docs/api/examples/trigger-multiple-test-plans.md +++ b/src/pages/docs/api/examples/trigger-multiple-test-plans.md @@ -2,7 +2,7 @@ title: "Trigger Multiple Test Plans Consecutively" metadesc: "How to trigger multiple Test Plans remotely using REST API. With this you can run a Mobile Test Plan after executing a Web Test Plan" noindex: false -order: 21.61 +order: 21.81 page_id: "Trigger Multiple Test Plans Consecutively" search_keyword: "" warning: false diff --git a/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md b/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md index b01a0cbd..7459266b 100644 --- a/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md +++ b/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md @@ -1,8 +1,8 @@ --- -title: "Trigger Test Plan remotely and wait until Completion" +title: "Trigger Test Plans Remotely & Wait Until Completion" metadesc: "This article discusses in detail on how to trigger a Test Plan remotely using REST API and wait until the Test Run completion before publishing the test results" noindex: false -order: 21.62 +order: 21.82 page_id: "Trigger Test Plan remotely and wait until Completion" search_keyword: "" warning: false diff --git a/src/pages/docs/api/examples/update-test-case-results-using-API.md b/src/pages/docs/api/examples/update-test-case-results-using-API.md index 6abc7ee5..6ac95d88 100644 --- a/src/pages/docs/api/examples/update-test-case-results-using-API.md +++ b/src/pages/docs/api/examples/update-test-case-results-using-API.md @@ -1,9 +1,9 @@ --- -title: "Update Test Case results using API" +title: "Update Test Case Results Using API" page_title: "Update Test Case results using API" metadesc: "This article discusses in detail on how to update Test Case results as Passed, Failed, and Not Executed using API using REST API in Testsigma." noindex: false -order: 21.65 +order: 21.85 page_id: "Update Test Case results using API" warning: false --- diff --git a/src/pages/docs/api/examples/values-of-test-data-profile.md b/src/pages/docs/api/examples/values-of-test-data-profile.md index b2f4ca3f..bfd0345f 100644 --- a/src/pages/docs/api/examples/values-of-test-data-profile.md +++ b/src/pages/docs/api/examples/values-of-test-data-profile.md @@ -3,7 +3,7 @@ title: "Create and update values of Test Data Profile using REST API" page_title: "Update Test Case results using API" metadesc: "Learn how to create, update, and delete values of Test Data Profile using REST API in Testsigma | Detailed steps to create, update, and delete values of Test Data Profile" noindex: false -order: 21.66 +order: 21.86 page_id: "Create, update, and delete values of Test Data Profile using API" warning: false contextual_links: diff --git a/src/pages/docs/api/get-project-wide-information.md b/src/pages/docs/api/get-project-wide-information.md index f419a040..a88f2987 100644 --- a/src/pages/docs/api/get-project-wide-information.md +++ b/src/pages/docs/api/get-project-wide-information.md @@ -1,5 +1,5 @@ --- -title: "Get Project wide information" +title: "Get Project Wide Information" page_title: "Get information for your Testsigma Project" metadesc: "Learn how to get detailed information for your Testsigma Project - users, suites, tags, requirement, and testcase priority using APIs" noindex: false diff --git a/src/pages/docs/api/test-results-at-all-levels.md b/src/pages/docs/api/test-results-at-all-levels.md new file mode 100644 index 00000000..2d79c2a1 --- /dev/null +++ b/src/pages/docs/api/test-results-at-all-levels.md @@ -0,0 +1,234 @@ +--- +title: "Fetch Test Results at all Levels Using APIs" +page_title: "Test Results at all Levels Using APIs" +metadesc: "This article discusses how to fetch test results at test plan, test machine, test suite, test case, and step levels using APIs in Testsigma Application." +noindex: false +order: 21.7 +page_id: "Test Results at all Levels Using APIs" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Fetch Test Plan Details" + url: "#fetch-test-plan-details" +- type: link + name: "Fetch Test Machine Details" + url: "#fetch-test-machine-details" +- type: link + name: "Fetch Test Suite Details" + url: "#fetch-test-suite-details" +- type: link + name: "Fetch Test Case Details" + url: "#fetch-test-case-details" +- type: link + name: "Fetch Test Step Details" + url: "#fetch-test-step-details" +--- + +--- + +You can leverage Testsigma APIs to fetch detailed test results at all levels. Whether you need results for an entire test plan, a specific test machine, a test suite, an individual test case, or even the test step level, Testsigma's APIs give you the necessary endpoints to get this data. This article discusses how to fetch these results in Testsigma. + + +--- + +## **Prerequisites** + +- You should have an API Key. See, [generate API Keys in Testsigma](https://testsigma.com/docs/configuration/api-keys/). +- You should have a [Test Plan Run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id) + +--- + +## **Fetch Test Plan Details** + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body** | {
"id": 517,
"testPlanId": 420,
"buildNo": null,
"result": "FAILURE",
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:33:17Z",
"duration": 238000,
"executor": "bharath.k@testsigma.com",
"triggeredType": "MANUAL",
"metrics": {
"id": 162,
"testPlanResultId": 517,
"totalCount": 8,
"failedCount": 4,
"passedCount": 4,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedPlanTotalCount": 8,
"consolidatedPlanFailedCount": 4,
"consolidatedPlanPassedCount": 4,
"consolidatedPlanStoppedCount": 0,
"consolidatedPlanNotExecutedCount": 0,
"consolidatedPlanQueuedCount": 0,
"consolidatedPlanRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 226000,
"consolidatedDuration": 226000
}
} | + +In the response body above, we fetched the test plan results with ID 517. + +
+ +**INDEX:** + +``` +URL: /api/v2/test_runs?query=&page= +TYPE: GET +TS_QUERY: chained with , (ex: query=testPlanId:1,result:PASSED) + +operator: + +: = EQUAL +! = NOT EQUAL +> = GRATER THAN +< = LESS THAN +~ = LIKE +@ = IN +; = NOT IN +$ = CONTAINS + +STATUS: 200/401/500/400 + +pagination: { page: , pageSize: , isLast: , totalElements: } + +``` + +--- + +## **Fetch Test Machine Details** + + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_machine_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body** | {
"id": 1434,
"testRunId": 517,
"result": "FAILURE",
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:31:40Z",
"duration": 141000,
"deviceConfiguration": {
"title": "Windows Chrome",
"osVersion": "11",
"browser": "GoogleChrome",
"browserVersion": "123.0",
"resolution": "1920x1080",
"platform": "Windows",
"deviceName": null,
"hostName": "agent.testsigma.com",
"osType": "WINDOWS"
},
"metrics": {
"id": 165,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 4,
"failedCount": 2,
"passedCount": 2,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedTotalCount": 4,
"consolidatedFailedCount": 2,
"consolidatedPassedCount": 2,
"consolidatedStoppedCount": 0,
"consolidatedNotExecutedCount": 0,
"consolidatedQueuedCount": 0,
"consolidatedRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 129000,
"consolidatedDuration": 129000
},
"appDetails": null
} | + +In the response body above, we fetched the test machine results with ID 1434. + +**INDEX:** + +``` +URL: /api/v2/test_runs/{run_id}/test_machine_results?query=&page= +TYPE: GET +TS_QUERY: chained with , (ex: query=result:PASSED) + +operator: + +: = EQUAL +! = NOT EQUAL +> = GRATER THAN +< = LESS THAN +~ = LIKE +@ = IN +; = NOT IN +$ = CONTAINS + +STATUS: 200/401/500/400 + +pagination: { page: , pageSize: , isLast: , totalElements: } + +``` + +--- + +## **Fetch Test Suite Details** + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body** | {
"id": 1383,
"suiteId": 359,
"testRunId": 517,
"testMachineRunId": 1434,
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:30:33Z",
"duration": 74000,
"result": "FAILURE",
"metrics": {
"id": 293,
"testSuiteResultId": 1383,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 2,
"failedCount": 1,
"passedCount": 1,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedTotalCount": 2,
"consolidatedFailedCount": 1,
"consolidatedPassedCount": 1,
"consolidatedStoppedCount": 0,
"consolidatedNotExecutedCount": 0,
"consolidatedQueuedCount": 0,
"consolidatedRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 62000,
"consolidatedDuration": 62000
}
} | + +In the response body above, we fetched the test suite results with ID 1383. + + +**INDEX:** + +``` +URL: /api/v2/test_runs/{run_id}/test_suite_results?query=&page= +TYPE: GET +TS_QUERY: chained with , (ex: query=result:PASSED) + +operator: + +: = EQUAL +! = NOT EQUAL +> = GRATER THAN +< = LESS THAN +~ = LIKE +@ = IN +; = NOT IN +$ = CONTAINS + +STATUS: 200/401/500/400 + +pagination: { page: , pageSize: , isLast: , totalElements: } + +``` + +--- + +## **Fetch Test Case Details** + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body** | {
"id": 3857,
"testCaseId": 609,
"startTime": "2024-05-29T07:29:31Z",
"endTime": "2024-05-29T07:29:55Z",
"duration": 23038,
"result": "FAILURE",
"isDisabled": false,
"isDataDriven": false,
"metrics": {
"id": 1089,
"testCaseResultId": 3857,
"testSuiteResultId": 1383,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 6,
"failedCount": 1,
"passedCount": 3,
"stoppedCount": 0,
"notExecutedCount": 2,
"queuedCount": 0,
"skippedCount": 0,
"runningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 23038,
"consolidatedDuration": 23038
}
} | + +In the response body above, we fetched the test case results with ID 3857. + +**INDEX:** + +``` +URL: /api/v2/test_runs/{run_id}/test_case_results?query=&page= +TYPE: GET +TS_QUERY: chained with , (ex: query=result:PASSED) + +operator: + +: = EQUAL +! = NOT EQUAL +> = GRATER THAN +< = LESS THAN +~ = LIKE +@ = IN +; = NOT IN +$ = CONTAINS + +STATUS: 200/401/500/400 + +pagination: { page: , pageSize: , isLast: , totalElements: } + +``` + +--- + +## **Fetch Test Step Details** + + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results//step_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body** | {
"content": [
{ "id": "3c51e933-7e15-41a0-893b-38e38b8258a2",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2847,
"type": "NLP\_TEXT",
"action": "Navigate to https://simply-travel.testsigma.com/",
"message": "Successfully opened given URL.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:32Z",
"endTime": "2024-05-29T07:29:33Z",
"duration": 1133,
"visualEnabled": false },
{ "id": "c3a8fbeb-b508-41d2-83f7-6a0ca152e234",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2848,
"type": "NLP\_TEXT",
"action": "Click on Login or Sign Up Button",
"message": "Successfully performed click action.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:37Z",
"endTime": "2024-05-29T07:29:39Z",
"duration": 2040,
"visualEnabled": false },
{ "id": "36bbdc50-ca05-4289-8342-c9e20d0491a4",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2849,
"type": "NLP\_TEXT",
"action": "Click on Login Button",
"message": "Successfully performed click action.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:42Z",
"endTime": "2024-05-29T07:29:44Z",
"duration": 1539,
"visualEnabled": false },
{ "id": "abefa297-cb14-48f4-b9e8-60db12854c03",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2850,
"type": "NLP\_TEXT",
"action": "Select the radio button Mobile Number Radio Button",
"message": "Unable to perform click/check action on element, Element is not displayed.",
"errorCode": 1000001,
"errorType": "ASSERT\_ERROR",
"result": "FAILURE",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:47Z",
"endTime": "2024-05-29T07:29:51Z",
"duration": 3803,
"visualEnabled": false },
{ "id": "49b04ef4-40fa-476f-b2a7-17d7a6e68230",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2851,
"type": "NLP\_TEXT",
"action": "Enter 9876543212 in the Mobile Number Radio Button field",
"message": "Major Test step failed .",
"errorCode": null,
"errorType": null,
"result": "NOT\_EXECUTED",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:54Z",
"endTime": "2024-05-29T07:29:54Z",
"duration": 1,
"visualEnabled": false },
{ "id": "0a2c386f-5639-4276-b69e-f8715cd7a85c",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2852,
"type": "NLP\_TEXT",
"action": "Click on Continue Button",
"message": "Major Test step failed .",
"errorCode": null,
"errorType": null,
"result": "NOT\_EXECUTED",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:54Z",
"endTime": null,
"duration": 0,
"visualEnabled": false }
],
"totalElements": null,
"totalPages": 1,
"pageable": null,
"last": false,
"numberOfElements": 6,
"first": true,
"sort": null,
"number": 0,
"size": 100,
"empty": false,
} | + +In the response body above, we fetched the test step results of a test case with result ID 3857. + +**INDEX:** + +``` +URL: /api/v2/test_runs/{run_id}/test_case_results/{case_result_id}/step_results?query=&page= +TYPE: GET +TS_QUERY: chained with , (ex: query=result:PASSED) + +operator: + +: = EQUAL +! = NOT EQUAL +> = GRATER THAN +< = LESS THAN +~ = LIKE +@ = IN +; = NOT IN +$ = CONTAINS + +STATUS: 200/401/500/400 + +pagination: { page: , pageSize: , isLast: , totalElements: } + +``` + +--- \ No newline at end of file diff --git a/src/pages/docs/api/upload-and-update-test-data-profile.md b/src/pages/docs/api/upload-and-update-test-data-profile.md index 88f6b2e5..9a16f0fb 100644 --- a/src/pages/docs/api/upload-and-update-test-data-profile.md +++ b/src/pages/docs/api/upload-and-update-test-data-profile.md @@ -1,5 +1,5 @@ --- -title: "Upload and update test data profile" +title: "Upload & Update Test Data Profile" page_title: "Upload/update test data profile via API in Testsigma" metadesc: "This article discusses in detail on REST API endpoints used for uploading the Apps and Attachments for test data profile in Testsigma Application." noindex: false diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md index 3f38a91a..4465edf5 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md @@ -1,5 +1,5 @@ --- -title: "Test Step Settings" +title: "Test Step Settings for Test Cases" page_title: "Test Step Settings | Testsigma Documentation" metadesc: "Configure wait times, retries, visuals, and other settings for efficient test automation in Testsigma using Test Step Settings and customise test execution." noindex: false @@ -22,7 +22,7 @@ contextual_links: --- -In Testsigma, you can control how each test step behaves in your test cases by using test step settings. These settings allow you to decide how your test cases run and show results. You can also use them to set step conditions and attempt them again if required. +Controlling the behavior of each test step can be important to enhance your test coverage. Test Step Settings in Testsigma helps you decide how test cases run and show their results. With these settings, you can define step conditions, determine actions to take when test steps fail, set no of retries if necessary, and more. This enhanced control over the test step also improves the reliability of test results. --- @@ -39,21 +39,25 @@ In Testsigma, you can control how each test step behaves in your test cases by u ## **Use Test Step Settings** -To use **test step settings**, click either the **Settings** icon or the **ellipsis** icon on a particular test step. Then, choose **Step Settings** from the list that appears to open the **Test Step Settings** panel on the test case page. +To access **Test Step Settings**, click **kebab menu** on any test step, and choose **Step Settings** from the list. Below is a summary of the available settings: | **Settings** | **Description** | |:------------------|:-------------| -|**Max wait time**|Set the Maximum Wait Time limit for completing the test step. It will fail if the test step takes longer than the specified time (up to a maximum of 120 seconds).| -|**No. of Retries on Step Failure**|Select the **Number of Retries on Step Failure** from the dropdown menu (up to 10 times) to decide how many times you want to attempt to execute the test step again if it fails.| +|**Max. wait time (<120 secs)**|Set the maximum wait time limit for completing the test step. It will fail if the test step takes longer than the specified time (up to a maximum of 120 seconds).| +|**Retries on step failure (<=10)**|Give the number of retries on step failure to decide how many times you want to attempt to execute the test step if it fails.| +|**Screenshot capture**|Specify one of the following options for screenshot capture at the step level:
  • Always: Captures a screenshot irrespective of the step result.
  • Only on step failure: Captures a screenshot only if the step fails.
  • No screenshot required: Does not capture a screenshot.
  • **Use step level settings**: This option leaves the settings the same    as saved at the test step level. (Only available during execution)
| |**Pre-Requisite**|Select a prerequisite step from the list of available steps in the same test case. This step must be successfully done before the current step runs.| |**Stop Test Case execution on Test Step**|It allows you to terminate test execution if the test fails at any step. By default, this option is checked, and test case execution will stop if the test step fails.| |**Ignore this step result in Test Case Result**|It allows you to exclude the outcome of a particular step from the overall test result.| |**Disable Step**|It allows you to capture and compare the visual appearance of an application's user interface between different builds or versions.| |**Enable Visual Testing for the Step**|You can disable the test step by choosing this option, and the test step will not run. By default, this option is unchecked.| +|**Highlight element in screenshot**|Choose this option to highlight elements on the product screen for each step. Contact Testsigma support to enable this feature.

Navigation: **Settings > Preferences > Highlight element in screenshot**
| -Here is a quick GIF demonstrating the above workflow: ![Test Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting.gif) +Here’s a quick GIF demonstrating how to access & update the test step settings. + +![Test Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststepsettingsnew.gif) --- diff --git a/src/pages/docs/test-cases/manage/add-edit-delete.md b/src/pages/docs/test-cases/manage/add-edit-delete.md index d015676a..68f87d31 100644 --- a/src/pages/docs/test-cases/manage/add-edit-delete.md +++ b/src/pages/docs/test-cases/manage/add-edit-delete.md @@ -1,6 +1,6 @@ --- -title: "Test Cases" -pagetitle: "Manage Test Cases | Testsigma Documentaion" +title: "Manage Test Cases" +pagetitle: "Manage Test Cases" metadesc: "Effortlessly manage your test cases in Testsigma by seamlessly creating, editing, deleting, and recovering them. Streamline your test case management process, adapt to changing project needs, and ensure comprehensive test coverage." noindex: false order: 4.10 @@ -15,9 +15,6 @@ contextual_links: - type: link name: "Create Test Case" url: "#create-test-case" -- type: link - name: "Test Step Settings" - url: "#test-step-settings" - type: link name: "Test Case - Advanced Options" url: "#test-case----advanced-options" @@ -41,7 +38,7 @@ Testsigma provides a comprehensive and user-friendly solution for efficiently cr ## **Prerequisites** -Ensure you create a [project](https://testsigma.com/docs/projects/overview/) before creating or editing test cases in Testsigma. +- Ensure you create a [project](https://testsigma.com/docs/projects/overview/) before creating test cases in Testsigma. --- @@ -59,28 +56,6 @@ Ensure you create a [project](https://testsigma.com/docs/projects/overview/) bef --- -## **Test Step Settings** - -You can access the test step settings by clicking the kebab menu for any test step. - -**1. Max. wait time (<120 secs.)**: Specify the maximum wait time for the test step to execute, which should be less than 120 seconds. - -**2. Retries on step failure (<=10)**: Specify the number of retries on test step failure, which should not exceed 10 retries. - -**3. Screenshot capture**: Specify one of the following options for screenshot capture at the test step level: - -- **Always**: Captures a screenshot irrespective of the test step result. - -- **Only on step failure**: Captures a screenshot only if the test step fails. - -- **No screenshot required**: Does not capture a screenshot. - -Here’s a quick GIF demonstrating how to access the test step settings. - -![Test Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststepsettings.gif) - ---- - ## **Test Case - Advanced Options** Use the right-side navbar on the **Test Case Details** page to access Advanced Options for better management and grouping of test cases while creating **Test Suites** and **Test Plans** and to improve understanding of test coverage.