Skip to content

Commit

Permalink
Updated Documents as per React UI - Set 4 (#295)
Browse files Browse the repository at this point in the history 
* Updated Documents as per React UI - Set 4

* Updated Meta Description

---------

Co-authored-by: Pratheep Velicherla <[email protected]>
  • Loading branch information
@sangithravichandran @PratheepV
sangithravichandran and PratheepV authored Oct 5, 2023
1 parent 6836e21 commit 0caa9e1
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 148 deletions.
131 changes: 43 additions & 88 deletions src/pages/docs/test-cases/create-steps-nl/step-actions.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Test Step Actions"
metadesc: "The Test Case details page give all gives all the possible actions in the Test Case. Learn about different actions you can perform on Test Steps in Testsigma"
title: "Test Step Options"
page_title: "Test Step Options | Testsigma Documentation"
metadesc: "Explore Testsigma's Test Step Options - Configure, manage, and optimise your test steps efficiently. Enhance testing workflow with customisation and control."
noindex: false
order: 4.42
page_id: "Test Step Actions"
Expand All @@ -9,133 +10,87 @@ contextual_links:
- type: section
name: "Contents"
- type: link
name: "1. Clone"
url: "#1-clone"
name: "Clear Step"
url: "#clear-step"
- type: link
name: "2. Edit"
url: "#2-edit"
name: "Step Settings"
url: "#step-settings"
- type: link
name: "3. Delete"
url: "#3-delete"
name: "Disable Step"
url: "#disable-step"
- type: link
name: "4. More Details"
url: "#4-more-details"
name: "Ignore Step Result"
url: "#ignore-step-result"
- type: link
name: "5. Add Step"
url: "#5-add-step"
name: "Enable Visual Testing"
url: "#enable-visual-testing"
- type: link
name: "6. Add a Step Inside"
url: "#6-add-a-step-inside"
name: "Clone Step"
url: "#clone-step"
- type: link
name: "7. Add Break"
url: "#7-add-break"
- type: link
name: "8. Add Continue"
url: "#8-add-continue"
name: "Delete Step"
url: "#delete-step"
---

---

The Test Case details page lists all the Test Steps available in the Test Case. Here is a list of all actions that can be performed on a test step:

1. Clone
2. Edit
3. Delete
4. More details
5. Add Step
6. Add a Step Inside
7. Add Break
8. Add Continue
In Testsigma, you can customise test steps within a test case using Test Step Options. These options allow you to control and customise various aspects of test execution, such as data inputs, assertions, and behaviour, enhancing the test scenario's flexibility and accuracy.

&emsp;
Here is a list of all options you can perform on a test step.
1. **Clear Step**
2. **Step Settings**
3. **Disable Step**
4. **Ignore Step Result**
5. **Enable Visual Testing**
6. **Clone Step**
7. **Delete Step**

---
## **1. Clone**
When you need to duplicate a Step, you can simply click on the Clone icon to make a copy of the current Test Step into the next step.

![Clone Step in Test Case Details](https://docs.testsigma.com/images/step-actions/clone-step-gif.gif)
### **Prerequesties**

&emsp;
Before using Test Step Options, ensure that you understand specific concepts such as creating a [Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), managing [Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/).

---
## **2. Edit**
Click the Edit icon to edit the Test Step and make the changes.
Click on Update to save or click Cancel to discard changes.

Using edit, you can change test data, element, or the Action Test Step altogether.

![Edit Step in Test Case Details](https://docs.testsigma.com/images/step-actions/edit-step-gif.gif)

Alternatively, You can also edit the test data and element inline, steps to be followed are:
1. Click on the test data or the element that needs to be changed.
2. The required field should become editable.
3. Do the changes inline.
4. Click outside the step.
5. The change should be saved.
## **Clear Step**

&emsp;
Click on the **test step**, then click the **Eraser** icon to clear the step in a single click. Clearing the test step will remove any existing actions or data within the step. ![Clear Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_clearstep.png)

---
## **3. Delete**

To delete a test step, click on the delete button and confirm the deletion.
## **Step Settings**

![Delete Step in Test Case Details](https://docs.testsigma.com/images/step-actions/delete-step-gif.gif)

&emsp;
Click on the **test step**, then click the **Settings** icon or the **ellipsis** icon to open a dropdown list of **Test Step Settings**. Select the **Step Settings** option from this list to configure particular settings for the test step, such as timeouts, retries, prerequisites, or other settings. Refer to [Test Step Settings](https://testsigma.com/docs/test-cases/create-steps-nl/step-settings/) for more information. ![Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_stepsetting.png)

---
##**4. More Details**
To see more details about the test case, click on the more details icon. You can check the details about a Test Step such as

* Is the step Disabled
* Maximum wait time for the step to fail
* Test Data used in the Step
* element used in the Step

![More Details in Test Case Details page](https://docs.testsigma.com/images/step-actions/more-details-gif.gif)
## **Disable Step**

&emsp;
Click on the **test step**, then click on either the **Forbidden** icon or the **ellipsis** button to open a dropdown list of **Test Step Settings**. Select the **Disable step** option from this list to temporarily deactivate the selected step in the test case. This will prevent the test step from running during execution. ![Disable Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_diablestep.png)

---
## **5. Add Step**

Generally, there will be two Add Step buttons available on a Test Step, one on top of the step and another below the step.
To add a step before the current Step, click on the Add Step button on top of the current step.
To add a step after the current Step, click on the Add Step button below the current step.

![Add Step in Test Case Details](https://docs.testsigma.com/images/step-actions/add-step-gif.gif)
## **Ignore Step Result**

&emsp;
Click on the **test step**, and then click the **ellipsis** icon to open a dropdown list of **Test Step Settings**, then select the **Ignore Step Result** option from this list to exclude the outcome of a specific step from the overall test result. ![Ignore Step Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_ignorestep.png)

---
## **6. Add a Step Inside**
When you want to add a Test Step as a child step inside a block rather than as a next sibling step, you can use this option.

![Add Step actions in Test Step Actions](https://docs.testsigma.com/images/step-actions/test-step-actions-add-a-step-inside.png)
## **Enable Visual Testing**


For the IF Step, the Add a Step Inside button adds a step as the last step inside the If block as compared to the Add Step button which adds a step after the If block.

&emsp;
Click on the **test step**, and then click the **ellipsis** icon to open a dropdown list of **Test Step Settings**. Select the **Enable Visual Testing** option from this list to capture and compare how the user interface of an application looks between different builds or versions. Refer to [Visual Testing](https://testsigma.com/docs/visual-testing/configure-test-steps/) for more information. ![Enable Visual Testing](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_enablevisual.png)

---
## **7. Add Break**

Use this button to add a Break in a While loop. This breaks out of the While Loop and continues the next step below the While loop block.

![Add Break in Test Case Details](https://docs.testsigma.com/images/step-actions/while-loop-brek-continue-actions.png)
## **Clone Step**

In the above image, The BREAK LOOP in step 2.1.3.3 breaks the loop at step 2 and goes to step 3.

&emsp;
Click on the **test step**, then click the **ellipsis** icon to open a dropdown list of **Test Step Settings** and select the **Clone Step** option. It will create an identical copy of the selected step, which saves time when you need multiple similar steps within the same test case. ![Clone Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_clonestep.png)

---
## **8. Add Continue**

This adds a Continue Step in a While loop. As in the case of a normal Continue statement in a while loop, this skips the remaining steps in the current loop iteration and starts the next iteration for the While loop.

![Add Continue in Test Case Details ](https://docs.testsigma.com/images/step-actions/while-loop-break-continue-actions.png)
## **Delete Step**

Click on the **test step**, then click the **ellipsis** icon to open a dropdown list of **Test Step Settings**. Select the **Delete Step** option from this list, permanently removing the selected step from the test case, helping streamline test maintenance and organisation. ![Delete Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting_deletestep.png)

In the above image, The CONTINUE LOOP in step 2.1.4.3 skips the current loop iteration and goes to the next iteration at step 2.1 within the same While loop.
---
51 changes: 28 additions & 23 deletions src/pages/docs/test-cases/create-steps-nl/step-settings.md
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,57 @@
---
title: "Test Step Settings"
metadesc: "Test steps have few settings that help you do necessary changes. Learn about the the available Test step settings in Testsigma and how to use them"
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
order: 4.41
page_id: "Test Step Settings"
page_id: "test-step-settings-testsigma"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Change Test Step Stettings"
url: "#change-test-step-stettings"
name: "Use Test Step Settings"
url: "#use-test-step-settings"
- type: link
name: "Update Step Settings"
url: "#update-step-settings"
---

---

Every test step in the test authoring interface has a few settings that help you make necessary modifications during test step creation; for example, you can increase or decrease the default wait time specifically for the current step, disable the test step, or make it mandatory, etc.
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.

---

### **Prerequisites**

This document assumes you understand how to create a test case; if not, see [Creating Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case). 
Before using the Test Step Settings, you must understand specific concepts such as [Projects](https://testsigma.com/docs/projects/overview/), [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), how to [Create Test Steps](https://testsigma.com/docs/test-cases/create-steps-nl/overview/) and [Test Step Options](https://testsigma.com/docs/test-cases/create-steps-nl/step-actions/).

---
## **Change Test Step Settings**

On the Test Steps page, click the ellipsis icon on a particular test step to open the Test Step Settings panel.

![three horizontal dots icon](https://docs.testsigma.com/images/step-settings/three-horizontal-dots-icon.png)
## **Use Test Step Settings**

![Advanced Options overlay while creating a Test Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/teststepdetails.png)
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.

Every test step has a few settings, which are described in the table below.
Below is a summary of the available settings:

| Settings | Usage |
| **Settings** | **Description** |
|:------------------|:-------------|
|Maximum Wait Time|Set the maximum waiting time for the current test step.|
|Prerequisite |Add a prerequisite test case to be executed before the current test case.|
|No. of Retries on Step Failure|It allows test steps to be automatically retried if they fail to execute or produce an unexpected result.|
|Stop Test Case execution on Test Step failure|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 Step Result in Test Case Result |It allows you to exclude the outcome of a particular step from the overall test result.|
|Enable Visual Testing for this step|It allows you to capture and compare the visual appearance of an application's user interface between different builds or versions.|
|Disable Test Step|You can disable the test step by choosing this option, and the test step will not run. By default, this option is unchecked.|
|**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.|
|**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.|

Here’s how to access and use test step settings.

![gif for test step settings usage](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/teststepdetails.gif)
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)

---

## **Update Step Settings**

To update several test steps, click the **checkboxes** next to the **test steps** you want to update and then click on **Update Settings** in the menu bar to open a popup window where you can make changes to the settings. ![Update Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/update_testsettings.gif)

[[info | NOTE:]]
| Update Step Setting does not allow updating the **Pre-Requisite** and **Number of Retries on Step Failure**. You should use Test Step Settings for each step individually.
Loading

0 comments on commit 0caa9e1

Please sign in to comment.