Skip to content
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.

Sign up for GitHub

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

Removed 404 links & added appropriate interlinks #427

Merged
merged 1 commit into from
Jun 4, 2024
Merged

Removed 404 links & added appropriate interlinks #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions src/pages/docs/best-practices/best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases
1. You define the expected outcomes of automated test cases and specify the validations to be performed at specific points in time as verifications to understand the concept of assertions.
2. Navigate to **Help** > **Actions List** on the Test Case details page to find **NLPs** with assertions in Testsigma. ![Action Lists](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/action_list.png)
3. A failed verification in a test case marks the overall test case as failed by default. If validation fails, the remaining test steps will be skipped, and the test case execution will be aborted.
4. To implement soft assertions for scenarios that require execution of remaining steps after a test step failure, follow the steps below and for more information, refer to [Test Step Settings](https://testsigma.com/docs/test-cases/create-test-steps/actions-and-options-recorder/step-settings/):
4. To implement soft assertions for scenarios that require execution of remaining steps after a test step failure, follow the steps below and for more information, refer to [test step settings](https://testsigma.com/docs/test-cases/create-test-steps/actions-and-options-recorder/step-settings/):
- Hover over the test step, click **Option**, and choose **Step Settings** from the dropdown.
- Uncheck **Stop Test Case execution on Test Step failure** and click **Update**.
- You can configure specific steps to continue executing even if verification fails.
Expand All @@ -82,14 +82,14 @@ Testsigma Automation Standards emphasise the reusability of automated test cases
1. Filter, segment, and organise test cases for easy identification to streamline test management processes and quickly locate specific tests.
2. **Label or map relevant requirements** to test cases to facilitate filtering and improve accessibility. Users can filter and save test cases in separate views based on labelled or mapped requirements.
3. During test case creation or editing, you can add labels. The label field is available by default in the test case. ![Requirements and Labels](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/req_labels.png)
4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information, refer to [Save Test Case Filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter).
4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information, refer to [save test case filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter).

---

## **Customisation and Extensibility**

1. You can use **add-ons to extend Testsigma's repository** of actions and create custom NLPs for specific actions that are not available in the built-in Actions List.
2. Share your add-ons or leverage existing ones with the test automation community through the Add-ons Community Marketplace. You can use add-ons to provide additional functionality and expand the capabilities of Testsigma. For more information, refer to [Create an Add-on](https://testsigma.com/docs/addons/create/).
2. Share your add-ons or leverage existing ones with the test automation community through the Add-ons Community Marketplace. You can use add-ons to provide additional functionality and expand the capabilities of Testsigma. For more information, refer to [create an add-on](https://testsigma.com/docs/addons/create/).

[[info | Example:]]
| You create an add-on for verifying text from two DOM elements.
Expand All @@ -98,7 +98,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

## **Reusability and Modularity**

1. To avoid duplication and simplify test maintenance, use **Step Groups** as common reusable functions across test cases. Step Groups promote modular test design and easy maintenance by separating reusable components from the test flow. Any changes made to a Step Group will be reflected in all test cases that invoke it. For more information, refer to [Step Groups](https://testsigma.com/docs/test-cases/step-types/step-group/).
1. To avoid duplication and simplify test maintenance, use **Step Groups** as common reusable functions across test cases. Step Groups promote modular test design and easy maintenance by separating reusable components from the test flow. Any changes made to a Step Group will be reflected in all test cases that invoke it. For more information, refer to [step sroups](https://testsigma.com/docs/test-cases/step-types/step-group/).

[[info | Example:]]
| Create a Step Group to reuse login functionality in multiple test cases.
Expand All @@ -109,13 +109,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

## **Element Management**

1. Create elements with proper naming conventions to enable reuse in multiple test cases. For more information, refer to [Create an Element](https://testsigma.com/docs/elements/web-apps/create-manually/).
1. Create elements with proper naming conventions to enable reuse in multiple test cases. For more information, refer to [create an element](https://testsigma.com/docs/elements/web-apps/create-manually/).

[[info | Example:]]
| Use descriptive names such as "UsernameInput" or "LoginButton" to make them easy to identify.

2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information, refer to [Create a Shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom).
3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information, refer to [Save Element Filters](https://testsigma.com/docs/elements/overview/#save-element-filter).
2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information, refer to [create a shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom).
3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information, refer to [save element filters](https://testsigma.com/docs/elements/overview/#save-element-filter).

[[info | Example:]]
| Create a view that displays elements related to the ''Login'' screen for quick reference.
Expand All @@ -126,15 +126,15 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

|Scope|Description|Usage|
|---|---|---|
|**Environment**|<li>The value stays constant during the test execution. The environment variable's values cannot be overwritten.</li><li>Any test case in any test suite can be accessed.</li><li>To create an Environment, navigate to **Test Data** > **Environments** > **Create**. For more information, refer to [Environments](https://testsigma.com/docs/test-data/create-environment-data/)</li>|<li>Define base URLs or configuration settings specific to the environment.</li><li>Create test steps using the data type <strong>* url</strong>.</li><li>Example: //button[text()=’*\|url\|’]</li>|
|**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information, refer to [Runtime Variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific data or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’] </li>|
|**Test Data Profile**|<li>You can link specific test cases. You can update the values in test data profiles from other test cases.</li><li>To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information, refer to [Test Data Profile](https://testsigma.com/docs/test-data/create-data-profiles/)</li>|<li>Use data-driven testing and maintain test data sets.</li><li>Create test steps using the data type **@ username**.</li><li>Example: //button[text()=’@\|username\|’]</li>|
|**Environment**|<li>The value stays constant during the test execution. The environment variable's values cannot be overwritten.</li><li>Any test case in any test suite can be accessed.</li><li>To create an Environment, navigate to **Test Data** > **Environments** > **Create**. For more information, refer to [environments](https://testsigma.com/docs/test-data/create-environment-data/)</li>|<li>Define base URLs or configuration settings specific to the environment.</li><li>Create test steps using the data type <strong>* url</strong>.</li><li>Example: //button[text()=’*\|url\|’]</li>|
|**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information, refer to [runtime variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific data or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’] </li>|
|**Test Data Profile**|<li>You can link specific test cases. You can update the values in test data profiles from other test cases.</li><li>To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information, refer to [test data profile](https://testsigma.com/docs/test-data/create-data-profiles/)</li>|<li>Use data-driven testing and maintain test data sets.</li><li>Create test steps using the data type **@ username**.</li><li>Example: //button[text()=’@\|username\|’]</li>|

---

## **Data-Driven Testing**

1. Enable the data-driven toggle in test cases and use Test Data Profiles to perform the same action with different test data sets for data-driven testing. For more information, refer to [Data-Driven Testing](https://testsigma.com/tutorials/test-cases/data-driven-testing/).
1. Enable the data-driven toggle in test cases and use Test Data Profiles to perform the same action with different test data sets for data-driven testing. For more information, refer to [data driven testing](https://testsigma.com/tutorials/test-cases/data-driven-testing/).
2. Test Data Profiles use key-value pair format to store project configuration data, database connection details, and project settings for easy access and reuse of test data.

[[info | Example:]]
Expand Down Expand Up @@ -164,13 +164,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

## **Configuration for Test Execution**

1. Upload attachments for test steps in **Test Data** > **Uploads** and follow the maximum file size limit of **1024 MB**. The system always considers the latest version of the uploaded file. For more information, refer to [Uploads](https://testsigma.com/docs/uploads/upload-files/).
2. Configure **Desired Capabilities** for cross-browser testing with specific browser configurations. You can configure Desired Capabilities for ad-hoc runs and test plans. For more information, refer to [Desired Capabilities](https://testsigma.com/docs/desired-capabilities/overview/).
1. Upload attachments for test steps in **Test Data** > **Uploads** and follow the maximum file size limit of **1024 MB**. The system always considers the latest version of the uploaded file. For more information, refer to [uploads](https://testsigma.com/docs/uploads/upload-files/).
2. Configure **Desired Capabilities** for cross-browser testing with specific browser configurations. You can configure Desired Capabilities for ad-hoc runs and test plans. For more information, refer to [desired capabilities](https://testsigma.com/docs/desired-capabilities/overview/).

[[info | Example:]]
| Specify the desired capabilities of the targeted testing, such as browser version or device type.

3. Ensure you put test cases in the Ready state before adding them to a Test Suite. Organise relevant tests into test suites for better organisation and execution. For more information, refer to [Test Suites](https://testsigma.com/docs/test-management/test-suites/overview/).
3. Ensure you put test cases in the Ready state before adding them to a Test Suite. Organise relevant tests into test suites for better organisation and execution. For more information, refer to [test suites](https://testsigma.com/docs/test-management/test-suites/overview/).

[[info | Example:]]
| Create a "Login Suite" and add all relevant login-related test cases for efficient execution.
Expand All @@ -179,13 +179,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

## **Execution and Test Plan Run**

1. Run test case and test plan in **Headless** mode to reduce execution time and eliminate element loading time. For more information, refer to [Headless Browser Testing](https://testsigma.com/docs/test-management/test-plans/headless-testing/).
1. Run test case and test plan in **Headless** mode to reduce execution time and eliminate element loading time. For more information, refer to [headless browser testing](https://testsigma.com/docs/test-management/test-plans/headless-testing/).

[[info | Example:]]
| To achieve faster test execution, execute the test plan without a visible browser.

2. Use the **Partial Run** option in the Test Plan to exclude consistently failing test suites from runs; you can exclude or disable tests for execution from the Test Machines & Suites Selection in the Test Plan. For more information, refer to [Partial Run](https://testsigma.com/docs/runs/test-plan-executions/#partial-test-runs).
3. Use the **Schedule** feature to run the test plan automatically without manual intervention. For more information, refer to [Schedule a Test Plan](https://testsigma.com/docs/test-management/test-plans/schedule-plans/).
2. Use the **Partial Run** option in the Test Plan to exclude consistently failing test suites from runs; you can exclude or disable tests for execution from the Test Machines & Suites Selection in the Test Plan. For more information, refer to [partial run](https://testsigma.com/docs/runs/test-plan-executions/#partial-test-runs).
3. Use the **Schedule** feature to run the test plan automatically without manual intervention. For more information, refer to [schedule a test plan](https://testsigma.com/docs/test-management/test-plans/schedule-plans/).

[[info | Example:]]
| Schedule unattended testing during non-business hours by executing the test plan.
Expand All @@ -194,7 +194,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases

## **Testsigma Recorder Extension**

1. Use the Testsigma Recorder Extension to record user interactions on web applications. Customise and modify the recorded test steps to align with the desired test case behaviour. For more information, refer to [Recording Test Steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).
1. Use the Testsigma Recorder Extension to record user interactions on web applications. Customise and modify the recorded test steps to align with the desired test case behaviour. For more information, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder).
2. Use the **Automatic Element Identification** feature of the recorder extension to easily capture elements and apply validations and verifications during recording to ensure that test steps include necessary assertions.

---
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/elements/web-apps/shadow-dom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To perform reliable tests, you need to find these elements. This guide will expl

## **Prerequisites**

You must understand specific concepts such as creating [Projects](https://testsigma.com/docs/projects/overview/), [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [Elements](https://testsigma.com/docs/elements/overview/), and [Recording Test Steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).
You must understand specific concepts such as creating [projects](https://testsigma.com/docs/projects/overview/), [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [elements](https://testsigma.com/docs/elements/overview/), and [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder).

---

Expand Down Expand Up @@ -63,8 +63,8 @@ Follow the below steps to identify if a webpage uses Shadow DOM:

This section will demonstrate how to capture and store shadow DOM elements using Testsigma. For this demonstration, we'll use the shopping website [shop.polymer-project](https://shop.polymer-project.org/).

1. Navigate to **Create Tests** > **Elements** in the left side navbar. Click on **Create Element** at the top right corner of the **Elements List** page to capture the Element on the webpage. ![Create Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/elementstab_shadowdom.png)
2. Click **Create Element** to open an overlay screen on the right side of the page. Click **Record Element** within this overlay to easily capture the Element. Open the webpage in a new tab and click on the **Element** you want to capture. Then, click **Capture** to record the Element in the Record Element pop-up menu. ![Record Shadowdom Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/record_element_shadowdom.gif)
1. Navigate to **Create Tests** > **Elements** in the left side navbar. Click on **Create Element** at the top right corner of the **Elements List** page to capture the Element on the webpage. ![create elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/elementstab_shadowdom.png)
2. Click **Create Element** to open an overlay screen on the right side of the page. Click **Record Element** within this overlay to easily capture the Element. Open the webpage in a new tab and click on the **Element** you want to capture. Then, click **Capture** to record the Element in the Record Element pop-up menu. ![record shadowdom element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/record_element_shadowdom.gif)
3. Alternatively, manually fill in the **Name** and **Screen Name**, **Element Type**, **Element Value**, and **Host Values** fields to capture the Element.
4. Fill in the fields with the element **Name** and **Screen Name**. Then, choose **CSS Selector** as the **Element Type** from the dropdown menu since only CSS selectors can access elements within shadow DOM.
5. To obtain the CSS Selector, **right-click** on the webpage and choose **Inspect** to open **Chrome Developer Tools**. Then, you must locate the Element you need using the **Select Element in the page to inspect it** icon.
Expand Down
Loading
Loading