diff --git a/src/pages/docs/FAQs/web-apps/failure-to-link-text-capture.md b/src/pages/docs/FAQs/web-apps/failure-to-link-text-capture.md new file mode 100644 index 00000000..c49b5427 --- /dev/null +++ b/src/pages/docs/FAQs/web-apps/failure-to-link-text-capture.md @@ -0,0 +1,142 @@ +--- +title: "Test Case Failures Due to Link Text Capture Issues" +pagetitle: "Resolving Test Case Failures Due to Link Text Capture Issues" +metadesc: "Test Case Failures due to link text capture issues? Learn how to fix mismatches between UI and HTML text in automated tests to avoid errors." +noindex: false +order: 24.17 +page_id: "test-case-failures-due-to-link-text-capture-issues" +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Identifying Link Text Capture Issues" + url: "#identifying-link-text-capture-issues" +- type: link + name: "Changing Element Details" + url: "#changing-element-details" +- type: link + name: "Dealing with UI and HTML Text Mismatches" + url: "#dealing-with-ui-and-html-text-mismatches" +--- + +--- + +In automated testing, test failures often occur when the recorder captures link text differently between the UI and HTML, such as in uppercase in the UI and lowercase in HTML. This guide helps you identify the issue and adjust settings to ensure you capture the correct elements in your tests, avoiding these failures. + +--- + +## **Prerequisites** + +Before you proceed, ensure you know how to create or update an [Element](https://testsigma.com/docs/elements/web-apps/create-manually/) and a [Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). + +--- + +## **Identifying Link Text Capture Issues** + +- Check if the recorder captures link text from the HTML instead of the visible text in the UI. +- Compare the captured text with what you see in the UI to spot differences. ![view link text capture issue](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/login_link_text_element.png) + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Changing Element Details** + +- Change the locator setting in your test automation tool from **Link text** to **XPath**. +- This adjustment allows the recorder to identify the element based on its structure rather than just the text. +- If needed, manually update the captured link text to match the UI-visible text, ensuring the test case reflects what users see on the screen. ![updating element from link text](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/changing_element_details_from_linktext.gif) + +[[info | NOTE:]] +| Using XPath or other reliable locators reduces the risk of capturing incorrect text, especially when differences exist between UI and HTML text. + +--- + +## **Dealing with UI and HTML Text Mismatches** + +- Compare the UI text with the HTML source to identify any inconsistencies that might cause the recorder to capture the wrong text. +- Modify your test case to use the visible UI text for element identification. +- Ensure the locator strategy aligns with the format users see in the UI. +- Consider using unique attributes like data-test-id or other identifiers instead of relying solely on link text. This approach minimises the risk of mismatches between the UI and HTML representations. + + + +
+
+ ℹ️Example: +
+ +
+ +[[info | NOTE:]] +| - You should implement more automated solutions (like XPath or unique attributes) to enhance test stability and reduce the need for ongoing manual intervention. +| - In contrast, manual updates to captured text can resolve specific issues. + +--- + + diff --git a/src/pages/docs/FAQs/web-apps/viewing-full-testplan-execution-video.md b/src/pages/docs/FAQs/web-apps/viewing-full-testplan-execution-video.md new file mode 100644 index 00000000..2809f5a8 --- /dev/null +++ b/src/pages/docs/FAQs/web-apps/viewing-full-testplan-execution-video.md @@ -0,0 +1,65 @@ +--- +title: "Viewing the Full Video of the Test Plan Execution" +pagetitle: "Full Test Plan Execution Video: Steps to Access and View" +metadesc: "Viewing the full video of the test plan execution is easy. Re-run your test plan with the reset session disabled to see the complete execution video." +noindex: false +order: 24.18 +page_id: "viewing-the-full-video-of-the-test-plan-execution" +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Understanding the Reset Session Feature" + url: "#understanding-the-reset-session-feature" +- type: link + name: "Disabling the Reset Session for every test case" + url: "#disabling-the-reset-session-for-every-test-case" +- type: link + name: "Viewing the Full Execution Video" + url: "#viewing-the-full-execution-video" +--- + +--- + +You might face an issue where you can only view the video for individual test cases rather than the entire test plan. Enabling the reset session feature for each test machine causes the video recording to stop after each test case. This documentation will guide you through resolving this issue. + +--- + +## **Prerequisites** + +Before you proceed, ensure you understand the concepts of creating a [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/), [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [Test Machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). + +--- + +## **Understanding the Reset Session Feature** + +- The **Reset Session** feature resets the environment before each test case runs, ensuring that each test starts fresh. +- However, this action causes the video recording to stop and restart with each test case, resulting in separate videos for each test instead of one complete video for the entire test plan. +- As a result, you only see individual test case videos rather than a full video of the whole test plan execution. + +--- + +## **Disabling the Reset Session for every test case** + +1. Navigate to **Test Plans** and create a new test plan or open an existing one. +2. On the **Create** or **Edit Test Plan** page, go to the **Add Test Suites & Link Machine Profiles** tab. +3. If the test machine is already linked, click the **Settings** icon under the **Test Machine** tab. Click the **Link to Test Machine** icon to add a new machine profile. +4. In the **Edit Test Machine or Device Profile** overlay, locate the checkbox labelled **Reset session for every test case**. +5. Uncheck this box to disable the reset session for all test cases. +6. Click **Create** or **Update Profile** to save your changes. ![disable reset session for test machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/disabling_reset_session_for_machine.gif) + +--- + +## **Viewing the Full Execution Video** + +1. **Re-run** the test plan with the reset session feature turned off. Ensure the test plan is executed. +2. After the execution, go to the **Run Result** section and open Test Run to view the video. +3. Click on the **Test Machines** tab and then click **Play Video** to watch the full test plan execution video as a single file. ![viewing full execution video](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/viewing_full_execution_video.gif) + +--- + diff --git a/src/pages/docs/FAQs/web-apps/visual-differences-ignored-areas.md b/src/pages/docs/FAQs/web-apps/visual-differences-ignored-areas.md new file mode 100644 index 00000000..3c697a48 --- /dev/null +++ b/src/pages/docs/FAQs/web-apps/visual-differences-ignored-areas.md @@ -0,0 +1,58 @@ +--- +title: "Visual Differences Not Highlighted in Ignored Areas of Test Case" +pagetitle: "Visual Differences Not Highlighted in Ignored Areas" +metadesc: "Learn how to identify and resolve issues where visual differences are not highlighted in ignored regions of test cases. Ensure accurate visual testing results." +noindex: false +order: 24.19 +page_id: "visual-differences=not-highlighted-in-ignored-areas-of-test-case" +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Identifying and Adjusting Ignored Regions" + url: "#identifying-and-adjusting-ignored-regions" +- type: link + name: "Re-running and Reviewing Visual Differences" + url: "#re-running-and-reviewing-visual-differences" +--- + +--- + +Visual differences in test cases may not be highlighted if they fall within ignored regions. This document will help you resolve issues where visual differences in test cases are not highlighted because they fall within ignored regions. It will guide you in identifying and resolving this issue by walking you through the necessary adjustments to your test case settings. + +--- + +## **Prerequisites** + +Before you proceed, ensure you know how to use [Visual Testing](https://testsigma.com/docs/visual-testing/configure-test-steps/). + +--- + +## **Identifying and Adjusting Ignored Regions** + +1. Open your test case where the visual differences are not highlighted. +2. Click **Ad-hoc Runs** in the right navigation bar, then click **View Details** to open the test case result page. ![view test case result details page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/view_details_test_case_result.png) +3. Click the **Camera** icon to open the Visual Difference overlay screen. +4. Select **Select region to ignore from visual comparison** and choose the areas you want to exclude from the visual comparison. ![highlight the region to igonre](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/select_ignore_region_from_visual_comparison.gif) +5. You can resize or move the ignored area by selecting **Resize/Move Ignored Regions** and adjusting the selected region on the screen as needed. +6. Review the regions you marked as ignored and click **Save**. +[[info | NOTE:]] +| Note: In this test case, check the box to ignore the same region for all steps. +7. Check the box to **Mark as the base image**. ![resize igonred region and mark base image](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/resize_igonre_region_mark_baseimage.gif) +8. Compare the current image with the reference image to identify any visual differences. +9. Confirm that these differences fall within the ignored regions. + +--- + +## **Re-running and Reviewing Visual Differences** + +- Re-run the test case and view the execution results. +- Check if the visual differences are now appropriately highlighted. +- Review the updated test results to ensure all visual differences are highlighted correctly. + +--- diff --git a/src/pages/docs/debugging/results-on-local-devices.md b/src/pages/docs/debugging/results-on-local-devices.md index c1d5aec3..dc2062f0 100644 --- a/src/pages/docs/debugging/results-on-local-devices.md +++ b/src/pages/docs/debugging/results-on-local-devices.md @@ -58,7 +58,7 @@ Before starting the debugging process, ensure the following: - Enable the **Run till Failed** step toggle to execute the test steps until a specific step fails. If this toggle is disabled, the test case will execute from start to end. - Set a debug point by selecting a test step from the dropdown menu. - Select **External Path** and provide the application's publicly accessible URL or **Uploaded Apps** and select the application from uploaded apps in Testsigma. -4. Click **Debug Now** to start the debugging process. The debugger screen will open, showing the test steps, related information, and the device screen. ![launch debug mode on android or ios devices](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/running_debugging_on-android_or_ios_device.gif) +4. Click **Debug Now** to start the debugging process. The debugger screen will open, showing the test steps, related information, and the device screen. ![launch debug mode on android or ios devices](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/launch_debugger_android_ios.gif) --- @@ -78,14 +78,14 @@ Debug points are specific locations in your test steps where you want the execut When the execution pauses at a debug point, you can perform the following actions: - **Resume Execution**: Continue the test execution from the paused point. - **Run This Step**: Execute the current step immediately. -- **Step Over:** Skip the current step and move to the next one. ![interacting with debug points during mobile debugging](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/interacting_with_debug_points_during_mobile_debugging.png) +- **Step Over:** Skip the current step and move to the next one. ![interacting with debug points during mobile debugging](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/interacting_with_debug_points_mobile_debugger.png) --- ## **Inspecting Test Execution Details on Mobile** - **Add Source**: When you reach a debug point, the **Add Source** section provides information about the test step's source code, allowing you to understand the context and behavior of the code being executed. -- **Selected Element Details**: In the **Selected Element** section, view details about the UI elements involved in the test step. This includes properties and attributes that are crucial for debugging element-related issues. +- **Selected Element Details**: In the **Selected Element** section, view details about the UI elements involved in the test step. This includes properties and attributes that are crucial for debugging element-related issues. ![inspecting element details and add source code](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/inspecting_element_details_debugger.gif) - **Step Result**: The **Step Result** section shows the outcome of the test step, including pass/fail status and any associated error messages. This information helps diagnose issues and verify whether the test step has behaved as expected. --- @@ -94,7 +94,7 @@ When the execution pauses at a debug point, you can perform the following action During test case execution, you can visually follow each step. If an error occurs or a debug point is reached: - Testsigma will highlight the problematic step. -- Use the provided resources, including Add Source, Selected Element, and Step Result, to analyze the issue and determine the necessary fixes. ![identifying errors during mobile test case execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/identifying_mobile_test_case_execution.gif) +- Use the provided resources, including **Add Source**, **Selected Element**, and **Step Result**, to analyze the issue and determine the necessary fixes. ![identifying errors during mobile test case execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/identifying_errors_during_step_result_mobile_debugger.png) --- @@ -103,7 +103,7 @@ During test case execution, you can visually follow each step. If an error occur A common issue is the **Element Not Found** error, where an element visible on the device is reported as not found. To address this: 1. View the message for the test step. If the element is not found, click **Element** to view its properties. -2. Analyze the issue, update the element properties if needed, then click **Options** and select **Resume Execution** from the previously paused step. ![troubleshooting element not found error on mobile devices](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/troubleshooting_element_not_found_error_on_mobile_devices.gif) +2. Analyze the issue, update the element properties if needed, then click **Options** and select **Resume Execution** from the previously paused step. ![troubleshooting element not found error on mobile devices](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/troubleshooting_element_not_found_error_mobiledebugger.gif) ---