diff --git a/src/pages/docs/FAQs/web-apps/automating-captcha.md b/src/pages/docs/FAQs/web-apps/automating-captcha.md index a5205e49..d8b1e52a 100644 --- a/src/pages/docs/FAQs/web-apps/automating-captcha.md +++ b/src/pages/docs/FAQs/web-apps/automating-captcha.md @@ -10,10 +10,10 @@ contextual_links: name: "Contents" - type: link name: "1. Why is CAPTCHA used?" - url: "#1-why-is-captcha-used?" + url: "#1-why-is-captcha-used" - type: link name: "2. Can I automate CAPTCHA testing in my test environment?" - url: "#2-can-i-automate-captcha-testing-in-my-test-environment?" + url: "#2-can-i-automate-captcha-testing-in-my-test-environment" --- --- diff --git a/src/pages/docs/FAQs/web-apps/why-chrome-extension.md b/src/pages/docs/FAQs/web-apps/why-chrome-extension.md index 4f0b8a34..fe6991dd 100644 --- a/src/pages/docs/FAQs/web-apps/why-chrome-extension.md +++ b/src/pages/docs/FAQs/web-apps/why-chrome-extension.md @@ -28,7 +28,7 @@ With Testsigma’s Chrome Extension you capture these elements and record the us
--- -##**Security Disclaimer** +## **Security Disclaimer** * Testsigma Chrome Extension doesn’t track user browsing outside the application and does not collect private information such as IP address and passwords. * We don’t modify the source code of your application. diff --git a/src/pages/docs/agent/setup-on-kubernetes.md b/src/pages/docs/agent/setup-on-kubernetes.md index bd359b9c..ab45fb98 100644 --- a/src/pages/docs/agent/setup-on-kubernetes.md +++ b/src/pages/docs/agent/setup-on-kubernetes.md @@ -438,6 +438,6 @@ kubectl -n testsigma delete pvc data-ts-agent-testsigma-agent-0 | Pod rejected on creation | The namespace enforces the `restricted` Pod Security Standard. The agent image requires `baseline`. | | Browser crashes mid test | The browser needs more shared memory. Raise `browsers.chrome.shmSize` and its memory limit together. | -For issues with agent startup or registration itself, see [Agent - Startup and Registration Errors](https://testsigma.com/docs/agent/troubleshooting/setup-issues/). +For issues with agent startup or registration itself, see [Agent - Startup and Registration Errors](https://testsigma.com/docs/agent/troubleshooting/how-to-fix-setup-issues/). --- diff --git a/src/pages/docs/agent/troubleshooting/how-to-fix-setup-issues.md b/src/pages/docs/agent/troubleshooting/how-to-fix-setup-issues.md index 8e89e6c0..3b9c17f2 100644 --- a/src/pages/docs/agent/troubleshooting/how-to-fix-setup-issues.md +++ b/src/pages/docs/agent/troubleshooting/how-to-fix-setup-issues.md @@ -177,7 +177,7 @@ Follow the below steps to fix the issue. 2. Restart the Agent. 3. If the Agent is not updated, update the Agent. *For more information, refer to the [documentation on updating Agents](https://testsigma.com/docs/agent/update-agent-manually/)*. -If the above troubleshooting steps does not resolve the issue, contact Testsigma support at [support@testsigma.com](mailto:support@testsigma.com) with the Agent logs files. *For more information on how to fetch agent logs refer to the [documentation on torubleshooting agent logs](https://testsigma.com/docs/agent/troubleshooting/logs/)*. +If the above troubleshooting steps does not resolve the issue, contact Testsigma support at [support@testsigma.com](mailto:support@testsigma.com) with the Agent logs files. *For more information on how to fetch agent logs refer to the [documentation on troubleshooting agent logs](https://testsigma.com/docs/agent/troubleshooting/how-to-configure-agent-logs/)*. --- diff --git a/src/pages/docs/agent/update-drivers-manually.md b/src/pages/docs/agent/update-drivers-manually.md index 1c3f1870..076f3094 100644 --- a/src/pages/docs/agent/update-drivers-manually.md +++ b/src/pages/docs/agent/update-drivers-manually.md @@ -19,7 +19,7 @@ contextual_links: url: "#adding-drivers-manually" - type: link name: "Additional steps for Mac or Linux" - url: "#additional-steps-for-maclinux" + url: "#additional-steps-for-mac-or-linux" --- diff --git a/src/pages/docs/ai-agents/analyzer.md b/src/pages/docs/ai-agents/analyzer.md index 2c730b4e..57d9ba8e 100644 --- a/src/pages/docs/ai-agents/analyzer.md +++ b/src/pages/docs/ai-agents/analyzer.md @@ -43,44 +43,47 @@ The Analyzer Agent analyzes a failed test step and returns the error type, the r 2. Select the run that contains failed test steps. -3. Open the test case with failures and select the failed test step. +3. Click the test case with failures. - The step header shows the error message. Click **Read more** to see the full message. The **Analysis** tab shows the error code, such as **#NO_SUCH_ELEMENT**, along with the **Visual Evidence** section. +4. On the **Test Case Results** page, select the failed step. -4. Click **Analyze with Agent** in the action bar at the bottom of the page. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Analyze_with_Agent_Results.png) + The **ANALYZER VERDICT** section on the step already shows a short analysis of the failure. Use the Analyzer Agent for suggested fixes you can apply, follow-up questions, and bug reports. For details on the verdict, refer to the [documentation on debugging test case failures](https://testsigma.com/docs/runs/debug-test-case-failures/). -5. Review the analysis, which displays: - - - **Error Type**: The category of failure identified during execution, such as ELEMENT_NOT_FOUND. - - **Root Cause**: An explanation of why the step failed, based on the error message and the captured evidence. - - **Visual Evidence**: The screenshot captured at the time of execution. Click **Expand Images** to view it at full size, or the download icon to save it. - - **Suggestions**: A numbered list of ways to resolve the failure. +5. Click **Analyze with Agent** in the action bar at the bottom of the page. + ![Analyze with Agent](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Analyze_with_Agent_Results_2.png) + + The **Analyzer with Atto** panel opens and reads "Analyzing step failure..." while it runs. + +6. Review the analysis. + ![Anayzer Analysis](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Anayzer_Analysis.png) + + | **Section** | **What it shows** | + |---|---| + | **Error Type** | The failure type identified during execution | + | **Root Cause** | Why the step failed | + | **Visual Evidence** | Screenshots **At the time of Recording** and **At the time of Execution**. Only the execution screenshot appears when no recording screenshot exists. | + | **Suggestions** | Numbered fixes you can apply to the step | [[info | **NOTE**:]] | To ask a follow-up question about the failure, enter it in **Debug with Atto** and click **Analyze**. -**Additional Information**: Responses are generated by Atto AI. Review the analysis before acting on it. Use the feedback icons or **Give Feedback** to tell us how useful it was. - --- ## **Apply Fix Using Analyzer Agent** -1. In the **Suggestions** list, select the suggestion you want to apply. +1. In the **Suggestions** list, select one suggestion. **Apply Fix** stays disabled until you select one. - [[info | **NOTE**:]] - | You can select only one suggestion at a time. +2. Click **Apply Fix**. Atto returns an **Add/Update Step** card. -2. Click **Apply Fix**. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Analyze_with_Agent_Results.png) +3. Click **Add/Update Step**. + ![Add Step](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Apply_Fix_Update_Step.png) + In the step list, the updated step appears as an extra row below the original steps, marked with the Analyzer icon. The current result still shows the original step as failed, because the change applies from the next run. - Atto generates the fix and returns an **Update Test Step** card explaining what it found, followed by the current version of the step and the proposed version. +4. Re-run the test to confirm the fix. + - For a test plan run, click the run number in the breadcrumb to return to **Run Results**, then click **Rerun**. + - For a dry run, click **Re-Run** in the page header. -3. Compare the two versions of the step. - -4. Click **Update Step** to apply the change. - -5. Rerun the test to validate the fix. + The next run uses the updated step. --- @@ -98,6 +101,8 @@ The Analyzer Agent analyzes a failed test step and returns the error type, the r [[info | **NOTE**:]] | The fields displayed vary based on the selected bug tracking tool. -**Additional Information**: If the tool returns no projects, check that the credentials configured for it have access to the projects you expect. For Jira, the panel reads "For given JIRA Credentials, the projects list is empty. Please make sure it has the right access to required projects on JIRA". +>

Additional Information

+> +> If the tool returns no projects, check that the credentials configured for it have access to the projects you expect. For Jira, the panel reads "For given JIRA Credentials, the projects list is empty. Please make sure it has the right access to required projects on JIRA". --- 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 b7d880bb..1cb2d1dd 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 @@ -30,7 +30,7 @@ You should already be familiar with creating and running Test Plans. Refer to th | You need to authenticate these requests with your Testsigma API Key. To know more about obtaining API Keys, refer to the [documentation on generating API keys](https://testsigma.com/docs/configuration/api-keys/) --- -##**Checking the Test Run Results** +## **Checking the Test Run Results** The below steps give an overview of how the script given at the bottom of this page works: @@ -53,7 +53,7 @@ We can poll the Test Plan Execution Results API with this Run ID at regular inte We have provided the Powershell and Bash scripts for the same below. Please feel free to make changes as required and plug the same into your CI Pipeline. --- -##**Powershell script** +## **Powershell script** The Script triggers the executions and also waits until the Timeout(MAX\_WAIT\_TIME\_FOR\_SCRIPT\_TO\_EXIT) for the execution to complete. @@ -182,7 +182,7 @@ saveFinalResponseToAFile --- -##**Bash Script** +## **Bash Script** ```shell #!/bin/bash diff --git a/src/pages/docs/atto/generative-ai/byok/supported-llms/openai.md b/src/pages/docs/atto/generative-ai/byok/supported-llms/openai.md index 4645ef69..2313056b 100644 --- a/src/pages/docs/atto/generative-ai/byok/supported-llms/openai.md +++ b/src/pages/docs/atto/generative-ai/byok/supported-llms/openai.md @@ -14,7 +14,7 @@ contextual_links: url: "#prerequisites" - type: link name: "Steps to Get OpenAI Details" - url: "#Steps-to-get-openai-details" + url: "#steps-to-get-openai-details" --- --- diff --git a/src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md b/src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md index 0bc6267c..ddcf19ca 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md @@ -99,6 +99,6 @@ When you generate automated test cases, Atto checks for existing test cases. If [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). --- diff --git a/src/pages/docs/atto/generative-ai/generate-tests/desktop.md b/src/pages/docs/atto/generative-ai/generate-tests/desktop.md index b238b352..fa4ecd97 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/desktop.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/desktop.md @@ -82,6 +82,6 @@ Testsigma’s Gen AI capabilities help you streamline test case creation for Des [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). --- diff --git a/src/pages/docs/atto/generative-ai/generate-tests/mobile-web.md b/src/pages/docs/atto/generative-ai/generate-tests/mobile-web.md index 627088a8..5db4703c 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/mobile-web.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/mobile-web.md @@ -101,7 +101,7 @@ You can generate test cases for mobile web applications using Testsigma’s Gene [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). --- \ No newline at end of file diff --git a/src/pages/docs/atto/generative-ai/generate-tests/mobile.md b/src/pages/docs/atto/generative-ai/generate-tests/mobile.md index 46a537f6..7c4a3ec8 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/mobile.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/mobile.md @@ -98,7 +98,7 @@ You can generate test cases for android and iOS applications using Testsigma’s [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent in Testsigma](https://testsigma.com/docs/ai-agents/generator/). diff --git a/src/pages/docs/atto/generative-ai/generate-tests/salesforce.md b/src/pages/docs/atto/generative-ai/generate-tests/salesforce.md index 8386d483..305c007f 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/salesforce.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/salesforce.md @@ -76,6 +76,6 @@ You can quickly generate test cases for Salesforce requirements in Testsigma usi [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). --- \ No newline at end of file diff --git a/src/pages/docs/atto/generative-ai/generate-tests/web.md b/src/pages/docs/atto/generative-ai/generate-tests/web.md index 62c150d9..6ad1aafa 100644 --- a/src/pages/docs/atto/generative-ai/generate-tests/web.md +++ b/src/pages/docs/atto/generative-ai/generate-tests/web.md @@ -101,6 +101,6 @@ You can generate test cases for web and mobile web applications using Testsigma [[info | **NOTE**:]] | - To learn about **Agentic Learning**, please refer to the [documentation on Generator Agent](https://testsigma.com/docs/ai-agents/generator/). -| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](http://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). +| - To understand the difference between **Run with Copilot** and **Agentic Learning**, please refer to the [documentation on Run with Copilot vs Agentic Learning](https://testsigma.com/docs/atto/generative-ai/copilot/agentic-learning-vs-copilot/). --- \ No newline at end of file diff --git a/src/pages/docs/atto/generative-ai/overview.md b/src/pages/docs/atto/generative-ai/overview.md index a6870605..305c95d9 100644 --- a/src/pages/docs/atto/generative-ai/overview.md +++ b/src/pages/docs/atto/generative-ai/overview.md @@ -14,7 +14,7 @@ contextual_links: url: "#prerequisites" - type: link name: "Testsigma Copiot Capabilities" - url: "#testsigma-copiot-capabilities" + url: "#testsigma-copilot-capabilities" - type: link name: "Generate Tests from Generative AI" url: "#generate-tests-from-generative-ai" diff --git a/src/pages/docs/auto-healing/auto-healing-insights.md b/src/pages/docs/auto-healing/auto-healing-insights.md index 91355acc..b400b89c 100644 --- a/src/pages/docs/auto-healing/auto-healing-insights.md +++ b/src/pages/docs/auto-healing/auto-healing-insights.md @@ -13,17 +13,11 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Identify Healed Steps in a Run" - url: "#identify-healed-steps-in-a-run" + name: "Review a Healed Step in Run Results" + url: "#review-a-healed-step-in-run-results" - type: link - name: "Review the Heal on the Analysis Tab" - url: "#review-the-heal-on-the-analysis-tab" -- type: link - name: "View Autoheal Details" - url: "#view-autoheal-details" -- type: link - name: "Read the Locator Trace" - url: "#read-the-locator-trace" + name: "Locators Tried" + url: "#locators-tried" - type: link name: "When a Heal Fails" url: "#when-a-heal-fails" @@ -46,65 +40,69 @@ Review how auto-healing behaved during a run to see which locator failed, what r --- -## **Identify Healed Steps in a Run** +## **Review a Healed Step in Run Results** -1. Open the test case results for the run. +When a saved locator fails during execution, Testsigma searches for the element and continues the run with a new locator. The step's status reads **Healed**, and the new locator is kept as a pending heal until you approve it. -2. Select the healed step. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Auto_Healing_Insights_New.png) +1. On the **Test Case Results** page, select a step that shows the auto-heal icon. + ![Auto_Healing_Insights_New](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Auto_Healing_Insights_New.png) -[[info | **NOTE**:]] -| A healed step reports **Passed**, because the step completed. The run itself carries a **Healed** status in the run list, which distinguishes it from a run that passed without intervention. +2. Review the **Healed this step** card below the step header. + ![Review Healed Step](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Healed_this_step.png) ---- + The **Locator change** section shows two values: + - **Previous · recorded**: The saved locator that failed, shown struck through. + - **Current · applied**: The locator Testsigma used to continue the run. -## **Review the Heal on the Analysis Tab** + The count at the bottom of the card shows how many linked artifacts use this element. + -The **Analysis** tab shows a **Healed this step** card explaining what happened: "Existing locator failed during execution, and we've auto-healed it using AI. The element locator was updated with a new XPath to ensure your test continues to run smoothly." +3. Click **Locators tried** to see how Testsigma found the element. For details, refer to [Locators Tried](#locators-tried). -Choose one of the following: -![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Healed_Details_in_Results.png) -- Click **Approve as Primary** to make the healed locator the locator the test uses from now on. -- Click **Ignore** to leave the original locator in place. The heal still applied to this run only. +4. Click **Approve as Primary**. This will open **Autoheal Details** panel, showing the element name and the locator type used for the heal, such as **Autohealed using CSS Selector**. The failed locator appears struck through above the new one. -[[info | **NOTE**:]] -| In the **Visual Evidence** section, the current run panel carries a **Healed** badge, and the **Element** field has an edit icon for correcting the locator directly. +5. Click **Update**. The **Update Element** dialog opens. + ![Update Element](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Update_Locator_with_Autoheal_Details.png) ---- +6. Review the test cases listed under **Linked to Test Cases**. Click the open icon next to a test case to view it in a new tab. -## **View Autoheal Details** +7. Click **Update** to update the element in all linked test cases. + ![Update](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Update_with_New_Locator_Value.png) + The **Healed this step** card now shows **Approved**. -Open the **Autoheal Details** panel to see exactly which locator changed. -The panel shows: -![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Auto_HeaL_Accept_Reject.png) -- The element that was healed, named at the top. -- The prompt "Do you want to update the autohealed element in all the linked test cases?" with **Update** and **Ignore** buttons. -- The healing method and how long it took, such as "Autohealed using CSS Selector" and "32s 912ms". -- The locator that failed, struck through, followed by the locator that replaced it. +--- -Click **Update** to apply the healed locator across every test case linked to the element, or **Ignore** to leave those test cases unchanged. +## **Locators Tried** -**Additional Information**: Use the feedback icons under "Is this autoheal helpful?" to tell us whether the heal was correct. The same feedback icons appear on the auto-healed banner above the step list. +![Locators Tried](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Locators_tried.png) ---- +The **Locators tried** panel lists each stage of the search in the order it runs. The panel header shows the step number, the number of stages, and how the element was found. -## **Read the Locator Trace** +| **Stage** | **What it does** | +|---|---| +| **Primary** | Tries the primary locator saved on the element. Every step starts here. | +| **Last Working** | Tries the locator that found the element in the previous run. It is kept on the element as a pending heal and is not part of the backup pool. | +| **Backup Pool** | Makes a single pass over the live screen to see which stored backup locators still resolve. No action is performed on the page at this stage. | +| **Relearn Screen** | Reads the screen as the app rendered it and writes new locators for the element. The result is kept as a pending heal and is tried first on the next run. | -Every auto-heal event records a locator trace: the full sequence the engine worked through to arrive at a heal, and whether that heal succeeded or failed. +![Locators Tried Panel](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Locators_Tried_Panel.png) -Use the trace to understand why a particular locator was chosen, or why no replacement could be found. +Each stage shows its outcome, such as **Did not match**, **Skipped**, or **Located**. Each locator in a stage shows: +- Its result, such as **NOT FOUND**, **AGREED**, or **NEW**. +- Its source and type, such as **smart-recorder · csspath**. +- Its role, such as **PRIMARY**, **LAST WORKING**, **ANCHOR**, or **CANDIDATE**. +- Its quality, **Good** or **Fragile**. -**Additional Information**: The locator trace is provided by the Auto Heal V2 architecture. +>

Additional Information

+> +> A pending heal is not the element's primary locator. Testsigma tries it before searching again on later runs, but the primary locator changes only when you click **Approve as Primary**. --- ## **When a Heal Fails** -A heal attempt that fails gets the same root cause treatment as a failed step. Open the **Root cause** block on the **Analysis** tab and click **Explain this failure** to see why the engine could not resolve the element. - -[[info | **NOTE**:]] -| This requires Analyzer V2. Without it, a failed heal reports that it did not succeed, but no explanation is generated. +When auto-healing cannot find the element, the step fails. Select the failed step and review the **ERROR** and **ANALYZER VERDICT** sections to see why the element could not be resolved. For details, refer to the [documentation on debugging test case failures](https://testsigma.com/docs/runs/debug-test-case-failures/). --- @@ -112,7 +110,7 @@ A heal attempt that fails gets the same root cause treatment as a failed step. O If you would rather not accept the healed locator, you have two alternatives: -- **Update element** corrects the locator directly. In the **Visual Evidence** section, the **Element** field on the current run side carries an edit icon for this. +- **Update element** corrects the locator directly. - **Relearn step** re-captures the step so a fresh locator is recorded. --- diff --git a/src/pages/docs/continuous-integration/github-cicd.md b/src/pages/docs/continuous-integration/github-cicd.md index 1448fd19..a5d76a7b 100644 --- a/src/pages/docs/continuous-integration/github-cicd.md +++ b/src/pages/docs/continuous-integration/github-cicd.md @@ -9,7 +9,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-requisites:" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "For Github CICD Integration" url: "#for-github-cicd-integration" diff --git a/src/pages/docs/continuous-integration/gitlab-cicd.md b/src/pages/docs/continuous-integration/gitlab-cicd.md index f231a673..e0fc92dc 100644 --- a/src/pages/docs/continuous-integration/gitlab-cicd.md +++ b/src/pages/docs/continuous-integration/gitlab-cicd.md @@ -10,10 +10,10 @@ contextual_links: name: "Contents" - type: link name: "Pre-requisites:" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "Steps to integrate GitLab with Testsigma" - url: "#steps-to-integrate-gitLab-with-testsigma" + url: "#steps-to-integrate-gitlab-with-testsigma" --- diff --git a/src/pages/docs/continuous-integration/jenkins.md b/src/pages/docs/continuous-integration/jenkins.md index 9bb799e1..913d3a24 100644 --- a/src/pages/docs/continuous-integration/jenkins.md +++ b/src/pages/docs/continuous-integration/jenkins.md @@ -37,7 +37,7 @@ Jenkins is an open-source automation server used for CI/CD and build automation. > Before you begin, ensure that you have: > - Reviewed the following documentation: > 1. [Generating API keys](https://testsigma.com/docs/configuration/api-keys/). -> 2. [Getting a test plan ID](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/get-test-plan-id.png). +> 2. [Getting a test plan ID](https://testsigma.com/docs/continuous-integration/get-test-plan-details/). > - A working **Jenkins** server with administrative access. --- diff --git a/src/pages/docs/continuous-integration/shell-script.md b/src/pages/docs/continuous-integration/shell-script.md index 39962a54..c3e93fe3 100644 --- a/src/pages/docs/continuous-integration/shell-script.md +++ b/src/pages/docs/continuous-integration/shell-script.md @@ -10,7 +10,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-requisites:" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "For Powershell Script" url: "#for-powershell-script" diff --git a/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce.md b/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce.md index e446ffb8..d760df31 100644 --- a/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce.md +++ b/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce.md @@ -11,7 +11,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-Requisite" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "Pre-Requisite Software and Service Installation" url: "#pre-requisite-software-and-service-installation" diff --git a/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue.md b/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue.md index 420151f5..5f7df674 100644 --- a/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue.md +++ b/src/pages/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue.md @@ -11,7 +11,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-Requisite" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "Pre-Requisite Software and Service Installation" url: "#pre-requisite-software-and-service-installation" diff --git a/src/pages/docs/contributing/open-source-dev-environment-setup/windows-and-intelliJ-ue.md b/src/pages/docs/contributing/open-source-dev-environment-setup/windows-and-intelliJ-ue.md index 2fea664c..2ef7e68a 100644 --- a/src/pages/docs/contributing/open-source-dev-environment-setup/windows-and-intelliJ-ue.md +++ b/src/pages/docs/contributing/open-source-dev-environment-setup/windows-and-intelliJ-ue.md @@ -36,7 +36,7 @@ contextual_links:
-## **Pre-Requisite Software and Service Installation**
+## **Pre-Requisite Software and Service Installation** **OPEN JDK 11 or greater**
Open JDK 11 can be installed from Oracle. Please make sure JDK 11 or above is taken into consideration as there are a few unsupported libraries below JDK 11 while setting up the dev environment. diff --git a/src/pages/docs/contributing/setup-dev-environment-addons.md b/src/pages/docs/contributing/setup-dev-environment-addons.md index bdc347ea..df7a2f19 100644 --- a/src/pages/docs/contributing/setup-dev-environment-addons.md +++ b/src/pages/docs/contributing/setup-dev-environment-addons.md @@ -14,7 +14,7 @@ contextual_links: url: "#prerequisites" - type: link name: "Setup Instructions" - url: "#setup-instruction" + url: "#setup-instructions" - type: link name: "Contributors" url: "#contributors" diff --git a/src/pages/docs/desired-capabilities/biometric-authentication.md b/src/pages/docs/desired-capabilities/biometric-authentication.md index 61fe5bde..d5656d69 100644 --- a/src/pages/docs/desired-capabilities/biometric-authentication.md +++ b/src/pages/docs/desired-capabilities/biometric-authentication.md @@ -15,7 +15,7 @@ contextual_links: url: "#prerequisites" - type: link name: "How to Add Biometric Authentication Desired Capability?" - url: "#how-to-add-biometric-authentication-desired-capability?" + url: "#how-to-add-biometric-authentication-desired-capability" - type: link name: Using Biometric Authentication Desired Capability" url: "#using-biometric-authentication-desired-capability" diff --git a/src/pages/docs/desired-capabilities/emulate-mobile-devices-with-chrome.md b/src/pages/docs/desired-capabilities/emulate-mobile-devices-with-chrome.md index 109b2fed..b9b54be4 100644 --- a/src/pages/docs/desired-capabilities/emulate-mobile-devices-with-chrome.md +++ b/src/pages/docs/desired-capabilities/emulate-mobile-devices-with-chrome.md @@ -25,7 +25,7 @@ contextual_links: Chrome Browser provides a built-in feature to emulate mobile device screen resolutions. This can be useful for testing the responsiveness of your website on mobile devices, without the time and effort required to set up a full mobile automation system. You can test for mobile even without a dedicated device. --- -##**Obtaining the device name** +## **Obtaining the device name** 1.Open the Browser Developer Console by pressing the F12 key or Ctrl+Shift+I (For Mac, Command+Shift+I). You can also right-click on any web page and select ‘Inspect’ from the menu to open the ‘Developer Console - Elements’ Tab. @@ -49,7 +49,7 @@ You can use the name of any of the above-given default devices while automating This is possible by specifying the device name in the Desired Capabilities while defining a Test Environment as shown in the next section. --- -##**Using available Devices for emulation** +## **Using available Devices for emulation** You should already know how to add Desired Capabilities to your Tests. Refer to the [documentation on managing desired capabilities](https://testsigma.com/docs/desired-capabilities/overview/). @@ -64,7 +64,7 @@ On execution, it will display as mobile device view as shown here: ![Chrome Dev tools Default device Mobile view](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/chrome-dev-tools-default-device-mobile-view.png) --- -##**Advanced: Using a Custom Device for emulation** +## **Advanced: Using a Custom Device for emulation** You can use a custom Device Resolution by providing the width, height, pixelRatio and userAgent values. diff --git a/src/pages/docs/desired-capabilities/enable-browser-console-logs.md b/src/pages/docs/desired-capabilities/enable-browser-console-logs.md index ab5b07f0..86ad7f56 100644 --- a/src/pages/docs/desired-capabilities/enable-browser-console-logs.md +++ b/src/pages/docs/desired-capabilities/enable-browser-console-logs.md @@ -15,7 +15,7 @@ contextual_links: url: "#desired-capabilities-for-console-logs" - type: link name: "Enable Console Log in Ad-hoc Run" - url: "#enable-console-log-in-ad-hoc-run" + url: "#enable-console-log-in-ad-hoc-runs" - type: link name: "Enable Console Log in Test Plan" url: "#enable-console-log-in-test-plan" diff --git a/src/pages/docs/desired-capabilities/set-geo-location.md b/src/pages/docs/desired-capabilities/set-geo-location.md index 15ca0a3b..0e3e2b54 100644 --- a/src/pages/docs/desired-capabilities/set-geo-location.md +++ b/src/pages/docs/desired-capabilities/set-geo-location.md @@ -25,7 +25,7 @@ For setting the location of the Test Environment where the Tests are run, we jus You should already know how to add Desired Capabilities to your Tests. Refer to the [documentation on configuring desired capabilities](https://testsigma.com/docs/desired-capabilities/overview/) --- -##**Setting Desired Capabilities in different Browsers** +## **Setting Desired Capabilities in different Browsers** ### **Google Chrome** @@ -60,7 +60,7 @@ Similarly, the value for the location **'Central Park, NYC, USA'** will be **{"l | Setting the Geolocation is not yet supported in IE and Safari --- -##**Example websites to test current location** +## **Example websites to test current location** You can use https://www.mapcoordinates.net/en for the latitude and longitude information for your desired location, and https://mycurrentlocation.net/ to check current location. diff --git a/src/pages/docs/elements/web-apps/supported-locator-types.md b/src/pages/docs/elements/web-apps/supported-locator-types.md index d85c41fe..195932fd 100644 --- a/src/pages/docs/elements/web-apps/supported-locator-types.md +++ b/src/pages/docs/elements/web-apps/supported-locator-types.md @@ -28,7 +28,7 @@ contextual_links: url: "#5-name" - type: link name: "Class Name" - url: "#6class-name" + url: "#6-class-name" - type: link name: "Tag Name" url: "#7-tag-name" diff --git a/src/pages/docs/projects/requirements.md b/src/pages/docs/projects/requirements.md index 18b015cf..8b87483a 100644 --- a/src/pages/docs/projects/requirements.md +++ b/src/pages/docs/projects/requirements.md @@ -11,7 +11,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-requisites" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "Create a Requirement" url: "#create-a-requirement" diff --git a/src/pages/docs/reports/runs/drill-down-reports.md b/src/pages/docs/reports/runs/drill-down-reports.md index d2a2b69f..38668081 100644 --- a/src/pages/docs/reports/runs/drill-down-reports.md +++ b/src/pages/docs/reports/runs/drill-down-reports.md @@ -1,6 +1,6 @@ --- title: "Test Plan Run Results in Testsigma" -metadesc: "View and download reports from the Run Results page in Testsigma | Drill into results at the test case, suite, and machine level, read step analysis, and compare runs." +metadesc: "View and download reports from the Run Results page in Testsigma | Drill into results at the test case, suite, and machine level, read step details, and compare runs." noindex: false order: 14.23 page_id: "Test Plan Run Results" @@ -17,12 +17,15 @@ contextual_links: - type: link name: "Steps to View Test Case Results" url: "#steps-to-view-test-case-results" -- type: link - name: "Step Details Tabs" - url: "#step-details-tabs" - type: link name: "Steps to View Test Machine Results" url: "#steps-to-view-test-machine-results" +- type: link + name: "View a Test Case Run in Progress" + url: "#view-a-test-case-run-in-progress" +- type: link + name: "Step Details Panels" + url: "#step-details-panels" - type: link name: "Test Runs in Run Results" url: "#test-runs-in-run-results" @@ -48,7 +51,7 @@ contextual_links: --- -View and download reports from the **Run Results** page. The page presents results at the test case, test suite, and test machine level, and shows the count of passed and failed tests along with the reason for each failure. Drill into a single step to read its analysis, check its logs, and compare it against an earlier run. +View and download reports from the **Run Results** page. The page presents results at the test case, test suite, and test machine level, and shows the count of passed and failed tests along with the reason for each failure. Drill into a single step to read its details and errors, check its logs, and compare it against an earlier run. --- @@ -65,8 +68,8 @@ View and download reports from the **Run Results** page. The page presents resul 1. From the left navigation bar, go to **Run Results** and click the test plan for which you want to check the results. -2. Results open at test suite level by default. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Test_Suite_Level_Results.png) +2. Results open at the test suite level by default. + ![Test Suite Level Results](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Test_Suite_Level_Results.png) 3. Expand a test suite to check the test case results inside it. @@ -89,48 +92,44 @@ View and download reports from the **Run Results** page. The page presents resul 4. Click a test case to view its detailed results. -5. On the **Test Case Results** page, the step list appears on the left, headed by the step count and the number of failed steps. Select a step to open its details on the right. Drag the divider between the two panes to resize either side. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Results_Divider.png) - +5. On the **Test Case Results** page, the step list appears on the left, headed by the step count. Select a step to open its details on the right. + ![Results Divider](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Results_Divider.png) -6. Review the step header, which shows the step number, its duration, its status, and the result message. On a failed step, the header shows the error message with a **Read more** link. + Each step in the list shows its status icon. A healed step also shows the auto-heal icon at the end of its row. -7. Click **Affected tests** to see what else depends on the element this step uses. The **Affected Instances** panel opens with counts across **Test Cases**, **Step Groups**, **Test Suites**, and **Test Plans**. - -8. Click **More details** to open **Test Case Overview**, which shows the step breakdown across **Passed**, **Failed**, **Not Executed**, and **Stopped**, along with the run message and **Machine Details**. + [[info | **NOTE**:]] + | When a run contains healed steps, a banner above the step list shows how many steps were auto-healed. Use the thumbs up and thumbs down icons on the banner to rate the heal. ---- +6. Review the step details on the right. -## **Step Details Tabs** + The header above the step list shows the total run duration, the browser version, and the operating system version. The step header shows the step status, start time, duration, step number, and step action. -Each step presents its details across five tabs. + The **THIS RUN** section shows the screenshot captured for the step. Click the expand icon to view it full size, or the download icon to save it. Below the screenshot, the step details show: -| **Tab** | **What it contains** | -|---|---| -| **Analysis** | The step result summary, the **Root cause** block on a failed step, and the **Visual Evidence** section comparing the authoring screenshot against this run | -| **Locators** | The locators used for the step | -| **Logs** | Selenium, console, and network logs for the step or for the whole run | -| **Step Settings** | Maximum wait time, prerequisite, whether the step result is ignored in the test case result, and whether visual testing is enabled for the step | -| **Metadata** | Test data and its type, along with the step ID and action | - -![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Analysis_Tab_results.png) + | **Field** | **What it shows** | + |---|---| + | **Element** | The element the step targets. Steps without an element read "This step targets no element". | + | **Locator** | The locator type and value used for the element | + | **Run Type** | The type of run that produced this result | + | **Test data type** and **Test data** | The data type and the value passed to the step | + | **Start time** and **Duration** | When the step started and how long it ran | + | **Step level timeout** and **Plan level timeout** | The wait limits applied to the step | + | **Error code** and **Error message** | The error raised during execution, if any | -Below the two panels, the **Analysis** tab lists the element, element name, run type, action, start time, duration, step level timeout, plan level timeout, error code, error message, test data type, and test data for each side of the comparison. The **Page source** section at the bottom holds the captured HTML for each side as a downloadable file. + [[info | **NOTE**:]] + | For a failed step, the **ERROR** and **ANALYZER VERDICT** sections appear above **THIS RUN**. For details, refer to the [documentation on debugging test case failures](https://testsigma.com/docs/runs/debug-test-case-failures/). -On a failed step, the tab opens with the error code for the failure, such as **#NO\_SUCH\_ELEMENT**. +7. Click **Affected tests** to see what else depends on the element this step uses. The **Affected Instances** panel opens with tabs for **Test Cases**, **Step Groups**, **Test Suites**, and **Test Plans**, each with its count. -[[info | **NOTE**:]] -| For details on reading the logs and investigating a failure, refer to the [documentation on debugging test case failures](https://testsigma.com/docs/runs/debug-test-case-failures/). For a root cause explanation and suggested fixes, refer to the [documentation on the Analyzer Agent](https://testsigma.com/docs/ai-agents/analyzer/). +8. Click **More details** to open **Test Case Overview**, which shows the step breakdown across **Passed**, **Failed**, **Not Executed**, and **Stopped**, the run message, and **Machine Details**. --- ## **Steps to View Test Machine Results** 1. On the **Run Results** page, select **Test Machines** from the dropdown menu. - 2. The page displays all test machines included in the test plan. - 3. Click a test machine to expand and view the test suites it contains. @@ -138,25 +137,47 @@ On a failed step, the tab opens with the error code for the failure, such as **# [[info | **NOTE**:]] | To view the test cases that are part of a test machine, go to the **Test Suites** view and apply a **Test Machine** filter. This shows all test cases in the selected test suite and test machine. + +--- + +## **Step Details Panels** + +The icons in the step header open side panels with more information about the selected step. + +| **Panel** | **What it contains** | +|---|---| +| **1. Locators** | The locator search for a healed step. Appears only on healed steps. For details, refer to the [documentation on auto-healing insights](https://testsigma.com/docs/auto-healing/auto-healing-insights/). | +| **2. Logs** | Console and network logs, for the step or a wider scope, with a download option | +| **3. Step Settings** | Maximum wait time, prerequisite, and whether the step stops the test case on failure, is ignored in the test case result, or uses visual testing, Smart Execution, or accessibility testing | +| **4. Metadata** | The step's test data and type, its ID and action, whether it uses a password, whether it was migrated, any additional data, and its step type and priority | + +![Step Details Panel](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Step_Details_Panels.png) + +Click the close icon to return to the step details. + --- ## **Test Runs in Run Results** -1. From the **Test Runs** panel, select a different run to view its corresponding test run results. - +1. From the **Test Runs** panel, select a run to view its test run results. -2. Click **Rerun** in the top-right corner to rerun the test plan by selecting the appropriate rerun options. +2. Click **Rerun** in the top-right corner. + ![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_from_Results.png) + +3. Select a rerun option: + - **All Test Cases**: Reruns all the test cases in the selected run. + - **All Failed Test Cases**: Reruns only the test cases that failed in the selected run. + - **Select Cases for Re-Run**: Reruns only the test cases you select. + ![Rerun Options](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_Options.png) +4. Click **Start execution**. + +[[info | **NOTE**:]] +| Each run ID has a maximum rerun limit of 10. + [[info | **NOTE**:]] -| 1. Each run ID has a maximum rerun limit of 10. We recommend using reruns wisely. -| -| 2. After you click **Rerun**, the following options appear: -| - **All Test Cases**: Reruns all the test cases in the selected run. -| - **All Failed Test Cases**: Reruns all the failed test cases in the selected run. -| - **Select Cases for Re-Run**: Lets you select the test cases you want to rerun. -| -| 3. Click **Start execution** to rerun the test plan. +| When a [test suite](https://testsigma.com/docs/test-suites/overview/#setting-pre-requisite-rerun-options) or [test machine](https://testsigma.com/docs/test-plans/manage-test-machines/#setting-pre-requisite-rerun-options-for-a-test-machine) has a prerequisite, its **Rerun options** setting decides what happens to the prerequisite during a rerun. With **Always run Pre-Requisite**, the prerequisite runs again in full before the failed test cases. With **Only execute failed Pre-Requisite iteration(s)**, only the prerequisite iterations that failed run again, so passed test cases aren't re-executed. --- @@ -165,13 +186,12 @@ On a failed step, the tab opens with the error code for the failure, such as **# Compare two runs of the same test case side by side. 1. On the **Test Case Results** page, click **Compare Runs**. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Run_Results.png) + ![Compare Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Run_Results.png) 2. Select a run from the list at the top of either panel. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Between_Runs.png) -Each panel shows the run's duration, date, step count, and failed count, followed by every step with its own duration. + ![Compare Between Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Between_Runs.png) -Comparison also spans the steps on either side of the failure, because the step that reports an error is often not the step that caused it. + Each panel shows the run's duration, date, step count, and failed count, followed by every step with its own duration. [[info | **NOTE**:]] | The run list includes **Authoring Run**, which holds the values captured when the test case was authored, along with each earlier run identified by its run ID. Every entry shows its run type and its status as **Passed**, **Failed**, or **Healed**, so you can pick the last run that behaved as expected without opening runs one by one. @@ -182,13 +202,14 @@ Comparison also spans the steps on either side of the failure, because the step Compare one step against the same step in another run. -1. On the **Analysis** tab, in the **Visual Evidence** section, click **Compare Steps**. The step comparison overlay opens. The step under comparison appears in the breadcrumb. - - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Step_Results.png) +1. In the **THIS RUN** section of the step, click **Compare Steps**. The step comparison overlay opens, with the step under comparison in the breadcrumb. + ![Compare Step Results](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Compare_Step_Results.png) + + The left panel defaults to **Authoring Time**, and the right panel shows the current run with its date and time and its status, such as **Passed** or **Healed**. To change the comparison, select a different run from the list at the top of either panel. 2. From the **View** list, select a comparison mode. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Comparison_Mode.png) + ![Comparison Mode](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Comparison_Mode.png) | **Mode** | **What it shows** | |---|---| @@ -197,9 +218,9 @@ Compare one step against the same step in another run. | **Current Step Only** | The current run's screenshot on its own | | **Element Source** | A diff of the captured page source across the two runs, alongside the locator value for each | - In **Overlay Wipe**, the capture recorded at authoring time and the capture taken during execution load into a single frame separated by a vertical divider. Drag the handle on the divider to wipe between them. Stacking the two makes a shifted control, a modal that did not close, or a reflowed layout visible at once, rather than something to find by comparing two panels. + In **Overlay Wipe**, the capture recorded at authoring time and the capture taken during execution load into a single frame separated by a vertical divider. Drag the handle on the divider to wipe between them. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Overlay_Wipe.png) + ![Overlay and Wipe](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Overlay_Wipe.png) 3. Click **Screens** to compare screenshots only, or **Screens + Details** to show the step details beneath each screenshot. @@ -210,14 +231,14 @@ Compare one step against the same step in another run. 4. To compare a different step, select a step from the **Change Step** list. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Change_Step_in_Results.png) + ![Change Step in Results](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Change_Step_in_Results.png) Each entry shows the step number, the step name, its duration, and its status, including **Not Executed** for steps the run never reached. -5. Click the download icon to download the comparison artifacts. +5. Click the download icon on a panel to save that screenshot, or the download icon at the top right to save the full comparison. [[info | **NOTE**:]] -| The baseline panel defaults to **Authoring Time** and is marked **Recorded**. When a step targets no element, the panel reads "No recorded evidence captured for this step". +| When a step targets no element, the left panel reads "No recorded evidence captured for this step". --- @@ -241,11 +262,11 @@ Compare one step against the same step in another run. 2. For **PDF** format, the **Export PDF** dialog appears. Select the appropriate options and click **Export**. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Export_Results_in_PDF.png) + ![Export Results in PDF](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Export_Results_in_PDF.png) 3. For **JUnit** format, the report is downloaded instantly as an XML file. -4. For **XLSX** format, a downloadable link of the report is sent to your email. +4. For **XLSX** format, a download link to the report is sent to your email. --- @@ -276,4 +297,4 @@ The **Run Results** page shows the values as they were when the run executed. Re [[info | **NOTE**:]] | Runs that executed before this release fall back to the current name of each item, and show a hyphen (-) where the item has since been deleted. ---- \ No newline at end of file +--- diff --git a/src/pages/docs/runs/debug-test-case-failures.md b/src/pages/docs/runs/debug-test-case-failures.md index c645bebb..fc7bb413 100644 --- a/src/pages/docs/runs/debug-test-case-failures.md +++ b/src/pages/docs/runs/debug-test-case-failures.md @@ -1,6 +1,6 @@ --- title: "Debug Test Case Failures" -metadesc: "How to debug a failed test case in Testsigma | Open the failing step, read its analysis, check its logs, and compare it against an earlier run." +metadesc: "How to debug a failed test case in Testsigma | Open the failing step, read the error and the analyzer verdict, check its logs, and compare it against an earlier run." noindex: false order: 9.71 page_id: "debug-test-case-failures" @@ -15,11 +15,11 @@ contextual_links: name: "Open the Failing Step" url: "#open-the-failing-step" - type: link - name: "Read the Analysis" - url: "#read-the-analysis" + name: "Read the Error and the Analyzer Verdict" + url: "#read-the-error-and-the-analyzer-verdict" - type: link - name: "Explain the Failure" - url: "#explain-the-failure" + name: "When the Failure Started at an Earlier Step" + url: "#when-the-failure-started-at-an-earlier-step" - type: link name: "Check the Logs" url: "#check-the-logs" @@ -42,7 +42,7 @@ contextual_links: --- -Investigate a failed test case from the **Run Results** page. Open the failing step, read its analysis, check its logs, and compare it against an earlier run. Testsigma captures a screenshot, the element details, and the logs for the step. +Investigate a failed test case from the **Run Results** page. Open the failing step, read the error and the analyzer verdict, check its logs, and compare it against an earlier run. Testsigma captures a screenshot, the element details, and the logs for the step. --- @@ -62,79 +62,110 @@ Investigate a failed test case from the **Run Results** page. Open the failing s 3. Select the failed step from the step list on the left. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Failed_Step_in_Results.png) + ![Failed Step in Results](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Select_Failed_Step_in_Run_Results.png) The list is headed by the step count and the number of failed steps. Each step carries an icon showing whether it passed, failed, or was not executed. Drag the divider between the step list and the details pane to resize either side. - The step header shows the step number, its duration, its status, and the error message. Click **Read more** to see the full message. - - The details pane on the right carries the **Analysis**, **Locators**, **Logs**, **Step Settings**, and **Metadata** tabs. + The step header shows the step status, start time, duration, step number, and step action. [[info | **NOTE**:]] -| The step that reports a failure is not always the step that caused it. Check the steps immediately before it as well. +| The step that reports a failure is not always the step that caused it. For details, refer to [When the Failure Started at an Earlier Step](#when-the-failure-started-at-an-earlier-step). --- -## **Read the Analysis** +## **Read the Error and the Analyzer Verdict** -The **Analysis** tab opens with the error code for the failure, such as **#NO\_SUCH\_ELEMENT**. Below it, the **Visual Evidence** section places the screenshot captured at authoring time next to the one captured in this run. +For a failed step, the **ERROR** and **ANALYZER VERDICT** sections appear below the step header. +![ERROR & ANALYZER VERDICT](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Error_and_Verdict.png) -![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Analysis_Tab_in_Results.png) +1. Review the **ERROR** section, which shows the error code and the error message. Click **Read more** for the full message. -Below the two panels, the tab lists the element, element name, run type, action, start time, duration, step level timeout, plan level timeout, error code, error message, test data type, and test data for each side. Use the icons on a screenshot to expand it or download it. + When the page contains iframes or shadow DOM hosts that were not searched, the error message says so. If the element is inside one of them, add a step to switch into it before the failed step. -At the bottom of the tab, the **Page source** section holds the captured HTML for each side. Click the file name to open it, or the download icon to save it. +2. Review the **ANALYZER VERDICT** section below it. Testsigma analyzes the failure automatically when you open the step. -[[info | **NOTE**:]] -| The authoring panel is marked **Recorded**. When no screenshot exists for a side, the panel reads "No screenshot captured". When a step targets no element, it reads "This step targets no element, so nothing was captured when it was authored". + The verdict contains: + + | **Part** | **What it shows** | + |---|---| + | Category | The type of failure, shown as a badge, such as **Flow divergence** | + | Summary | One line naming the failed step and the cause, followed by a short explanation | + | **REASON** | Why the step failed, compared against the passing baseline. Click **Read more** to expand it. | + | Recommendation | What to change, and how to confirm the fix | + | Evidence | What the screenshots show for this run and the baseline | + | Fix | A named fix with a one-line description. When Testsigma can make the change for you, the fix lists options to select and an **Apply fix** button. | + +3. To compare the failed step against the baseline, click **Compare Steps** in the **THIS RUN** section. + +4. To fix the step, do one of the following: + - If the verdict lists fix options, select one and click **Apply fix**. + - Click **Analyze with Agent** at the bottom of the page to open the **Analyzer with Atto** panel. The panel lists suggestions you can apply, lets you ask Atto follow-up questions, and lets you report the failure as a bug. For details, refer to the [documentation on the Analyzer Agent](https://testsigma.com/docs/ai-agents/analyzer/). -**Additional Information**: For a root cause explanation and suggested fixes, click **Analyze with Agent** in the action bar at the bottom of the page. Refer to the [documentation on the Analyzer Agent](https://testsigma.com/docs/ai-agents/analyzer/). +[[info | **NOTE**:]] +| Steps after the failed step are not run when the step is set to stop the test case on failure. These steps show the not executed icon. --- -## **Explain the Failure** +## **When the Failure Started at an Earlier Step** + +A step can fail because the run left the recorded path before it. An earlier step opens a different page from the one recorded, or does not finish loading it, so the element the failed step needs never appears. The failed step reports the error, but the cause lies in the steps before it. + +The verdict category shows which of these happened. -Testsigma can read the step's error, screenshot, page source, and heal attempts, and explain what broke. +| **Category** | **What happened** | **Fix** | +|---|---|---| +| **Flow divergence** | The run reached a different page from the one recorded, so the element the step targets does not exist on the current page. | Re-record the steps from the point where the run left the recorded path, or add the missing navigation before the failed step. | +| **Prerequisite not completed** | An earlier step did not finish as recorded, such as a page that had not finished loading, so the next step could not find its element. | Select the fix option in the verdict, such as **Add a wait for the page to settle**, and click **Apply fix**. | -1. On the **Analysis** tab, find the **Root cause** card. +1. On the **Test Case Results** page, select the failed step. -2. Click **Explain this failure**. +2. Review the **ANALYZER VERDICT** section. + ![ANALYZER VERDICT](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Flow_Change_Failure.png) + - The category badge reads **Flow divergence** or **Prerequisite not completed**. + - The summary names the failed step and what was on the page instead, such as a product page where a search page was expected. + - **REASON** explains how the run left the recorded path, and whether earlier failures caused it or it is an independent deviation. Click **Read more** to expand it. + - The recommendation names the step from which to re-record, or what to add before the failed step. - ![](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Explain_Failure_in_Results.png) +3. Select the steps before the failed step in the step list, and check their screenshots in the **THIS RUN** section to find where the run left the recorded path. - The explanation opens with a one-line summary of what failed, such as "Step failed: no Shop Back to School link on Google homepage", followed by the reasoning and a recommended change. +4. Fix the test case: + - For **Flow divergence**, edit the test case and re-record the steps from the point where the run diverged, or add the navigation step that is missing. + - For **Prerequisite not completed**, select the fix option in the verdict and click **Apply fix**. -3. Click **Read less** to collapse the explanation, or **Read more** to expand it again. +5. Re-run the test to confirm the fix. [[info | **NOTE**:]] -| The **Root cause** card requires Analyzer V2. Without it, the page works as described everywhere else, but the card does not appear and failure analysis is available through **Analyze with Agent** in the action bar instead. +| Not every verdict has an **Apply fix** button. When the fix requires re-recording steps, the verdict names the fix and describes it, but you make the change in the test case. --- ## **Check the Logs** -1. Open the **Logs** tab. +1. In the step header, click the **Logs** icon. The **Logs** panel opens on the right. -2. Select **Selenium**, **Console**, or **Network**. +2. Click **Console** or **Network**. + ![Console or Network](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Execution_Logs_for_Step.png) -3. Use the scope list to switch between **This step** and the whole run. +3. From the scope list, select **This step** to see only the logs captured during the step. -4. Click **Jump to error** to move to the first error in the log. + The **Network** tab shows the number of failed requests, the time window the requests started in, and a table of requests with their status, method, URL, size, and time. The total request count appears below the table. -5. Click the download icon to save the log. +4. Click the download icon to save the logs. [[info | **NOTE**:]] | Some logs have no step markers. When that happens, the log shows every entry for the run and displays the message "Not scoped to this step: this log has no step markers, so the whole run is shown". -**Additional Information**: Network logs are captured only when they are switched on for the test machine, and they arrive once the lab finishes uploading them. Until then, the **Network** tab reads "No network log was recorded for this run". +>

Additional Information

+> +> Network logs are captured only when they are switched on for the test machine, and they appear once the upload from the test machine finishes. Until then, the **Network** tab reads "No network log was recorded for this run". --- ## **Check Whether a Step Was Healed** -When auto-healing resolves a locator mid-run, a banner above the step list reports how many steps were healed, and the **Analysis** tab shows a **Healed this step** card with **Approve as Primary** and **Ignore**. +When auto-healing resolves a locator during the run, the step's status reads **Healed**, and the step shows the auto-heal icon in the step list. A banner above the step list shows how many steps were healed. -A healed step reports **Passed**, because the step completed. For the full workflow, refer to the [documentation on auto-healing insights](https://testsigma.com/docs/auto-healing/auto-healing-insights/). +Select the healed step to see the **Healed this step** card with the locator change and the **Approve as Primary** button. For the full workflow, refer to the [documentation on auto-healing insights](https://testsigma.com/docs/auto-healing/auto-healing-insights/). --- @@ -143,9 +174,7 @@ A healed step reports **Passed**, because the step completed. For the full workf Comparing a failing step against an earlier run shows what changed between them. There are two entry points: - Click **Compare Runs** in the page header to compare the whole test case across two runs, step by step. -- Click **Compare Steps** in the **Visual Evidence** section to compare the current step alone, using the screenshot and element source comparison modes. - -Comparison also spans the steps on either side of the failure, because the step that reports an error is often not the step that caused it. +- Click **Compare Steps** in the **THIS RUN** section to compare the current step alone. For both workflows, refer to the [documentation on test plan run results](https://testsigma.com/docs/reports/runs/drill-down-reports/). @@ -173,11 +202,10 @@ When an element causes a failure, check which other tests depend on it before yo Resolve the failure without leaving the results page. +- If the **ANALYZER VERDICT** section lists fix options, select one and click **Apply fix**. When the run left the recorded path, re-record the affected steps instead. - Click **Analyze with Agent** in the action bar to get the error type, the root cause, and a set of suggestions you can apply as a step update. - Click **Run using Copilot** in the action bar to rerun the test case interactively. -- Use **Update element** to correct a locator yourself. On the current run side of **Visual Evidence**, the **Element** field carries an edit icon for this. -- Use **Relearn step** to re-capture the step. -- Where auto-healing fired, approve or reject the healed element directly on the first screen. +- For a healed step, approve the new locator from the **Healed this step** card. For details, refer to the [documentation on auto-healing insights](https://testsigma.com/docs/auto-healing/auto-healing-insights/). --- diff --git a/src/pages/docs/runs/run-on-cloud-vendor-platforms.md b/src/pages/docs/runs/run-on-cloud-vendor-platforms.md index 75e22eb3..7f58413c 100644 --- a/src/pages/docs/runs/run-on-cloud-vendor-platforms.md +++ b/src/pages/docs/runs/run-on-cloud-vendor-platforms.md @@ -10,7 +10,7 @@ contextual_links: name: "Contents" - type: link name: "Pre-requisites" - url: "#pre-requisites" + url: "#prerequisites" - type: link name: "How to run test cases and test plans on cloud vendor platforms with Testsigma" url: "#how-to-run-test-cases-and-test-plans-on-cloud-vendor-platforms-with-testsigma" diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md index b82f6a7e..d2b4ead9 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md @@ -11,7 +11,7 @@ contextual_links: name: "Contents" - type: link name: "Prerequesties" - url: "#prerequesties" + url: "#prerequisites" - type: link name: "Clear Step" url: "#clear-step" diff --git a/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md b/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md index acc3d155..4e9c97e1 100644 --- a/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md @@ -17,7 +17,7 @@ contextual_links: url: "#selecting-numberfunctions-as-a-function-type-for-data-generator" - type: link name: "Custom Calculation" - url: "#custom-calculations" + url: "#custom-calculation" --- --- diff --git a/src/pages/docs/test-data/data-generators/phone-function-type.md b/src/pages/docs/test-data/data-generators/phone-function-type.md index dda44471..7d148a85 100644 --- a/src/pages/docs/test-data/data-generators/phone-function-type.md +++ b/src/pages/docs/test-data/data-generators/phone-function-type.md @@ -17,10 +17,10 @@ contextual_links: url: "#selecting-phone-number-as-a-function-type-for-data-generator" - type: link name: "Cell Phone" - url: "#cellphone" + url: "#cell-phone" - type: link name: "Phone Number" - url: "#phonenumber" + url: "#phone-number" --- --- diff --git a/src/pages/docs/test-data/types/parameter.md b/src/pages/docs/test-data/types/parameter.md index 3b739df8..f6645ce9 100644 --- a/src/pages/docs/test-data/types/parameter.md +++ b/src/pages/docs/test-data/types/parameter.md @@ -10,7 +10,7 @@ contextual_links: name: "Contents" - type: link name: "How to Use Parameters in a Test Case?" - url: "#how-to-use-parameters-in-a-test-case?" + url: "#how-to-use-parameters-in-a-test-case" --- --- diff --git a/src/pages/docs/test-plans/after-test.md b/src/pages/docs/test-plans/after-test.md index 30fe15aa..2928645e 100644 --- a/src/pages/docs/test-plans/after-test.md +++ b/src/pages/docs/test-plans/after-test.md @@ -11,7 +11,7 @@ contextual_links: name: "Contents" - type: link name: "After test in Test Cases" - url: "#after-test-in-test-cases" + url: "#aftertest-in-test-cases" - type: link name: "After test in Step groups" url: "#after-test-in-step-groups" diff --git a/src/pages/docs/test-plans/cross-browser-testing.md b/src/pages/docs/test-plans/cross-browser-testing.md index b2a23bd3..ed6924ba 100644 --- a/src/pages/docs/test-plans/cross-browser-testing.md +++ b/src/pages/docs/test-plans/cross-browser-testing.md @@ -37,13 +37,13 @@ Cross Browser Testing is testing web applications across multiple browsers to en ## **Steps to Enable Cross Browser Testing** -1. Navigate to **Test Machines & Suites Selection** under the **Create Test Plan** page. *For more information on creating a test plan, refer to the [documentation on creating test plans](https://testsigma.com/docs/test-management/test-plans/overview/)*. +1. Navigate to **Test Machines & Suites Selection** under the **Create Test Plan** page. *For more information on creating a test plan, refer to the [documentation on creating test plans](https://testsigma.com/docs/test-plans/overview/)*. ![Test Plan](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_cb_1.png) -2. Under the **Test machines & suites selection** tab, select the test suite for which you want to add the test machine for test execution. *For more information on adding test suites to a test plan, refer to the [documentation on adding test suites to a test plan](https://testsigma.com/docs/test-management/test-plans/manage-test-suites/)*. +2. Under the **Test machines & suites selection** tab, select the test suite for which you want to add the test machine for test execution. *For more information on adding test suites to a test plan, refer to the [documentation on adding test suites to a test plan](https://testsigma.com/docs/test-plans/manage-test-suites/)*. ![Test Suites](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_cb_2.png) -3. Once you have selected the test suites, select the test machines to run the corresponding test suite. *For more information on adding test machines to a test plan, refer to the [documentation on adding test machines to a test plan](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/)*. +3. Once you have selected the test suites, select the test machines to run the corresponding test suite. *For more information on adding test machines to a test plan, refer to the [documentation on adding test machines to a test plan](https://testsigma.com/docs/test-plans/manage-test-machines/)*. ![Test Machines](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_cb_3.png) Note that, for *Cross Browser Testing*, test machines and test suites are selected separately. On execution, all the selected test suites are run on all selected test machines (in parallel or sequentially - depending on your selection). diff --git a/src/pages/docs/test-plans/distributed-testing.md b/src/pages/docs/test-plans/distributed-testing.md index 9fcbd6bd..543f15d1 100644 --- a/src/pages/docs/test-plans/distributed-testing.md +++ b/src/pages/docs/test-plans/distributed-testing.md @@ -35,7 +35,7 @@ Distributed testing is achieved in Testsigma by splitting up test plan execution >

Prerequisites

> > Before you begin, ensure that you have referred to: -> 1. [Documentation on creating test plans](https://testsigma.com/docs/test-management/test-plans/overview/). +> 1. [Documentation on creating test plans](https://testsigma.com/docs/test-plans/overview/). > 2. [Documentation on creating test suites](https://testsigma.com/docs/test-suites/overview/). > 3. [Documentation on creating test machine](https://testsigma.com/docs/test-plans/manage-test-machines/). diff --git a/src/pages/docs/test-plans/manage-test-machines.md b/src/pages/docs/test-plans/manage-test-machines.md index 11b52a04..0758c155 100644 --- a/src/pages/docs/test-plans/manage-test-machines.md +++ b/src/pages/docs/test-plans/manage-test-machines.md @@ -17,6 +17,9 @@ contextual_links: - type: link name: "Adding a Test Machine From Edit Test Plan Page" url: "#adding-a-test-machine-from-edit-test-plan-page" +- type: link + name: "Setting Pre-Requisite Rerun Options for a Test Machine" + url: "#setting-pre-requisite-rerun-options-for-a-test-machine" - type: link name: "Delete test machine" url: "#delete-test-machine" @@ -94,6 +97,31 @@ Alternatively, you can also add new machines from the edit test plan page. --- +## **Setting Pre-Requisite Rerun Options for a Test Machine** + +Choose whether a prerequisite test machine runs again in full or only its failed iterations run when you rerun the test plan. + +1. In the **Add Test Suites & Link Machine Profiles** tab, click the **Link Machine to all suites**. This will oprn **Select test machine profiles** panel. + +[[info | NOTE:]] +| To link a test machine to a single test suite, click the test machine icon next to that test suite's name. + +2. Click the **Test machine settings** on the test machine profile you want to configure. This will open **Edit test machine/device profile** panel. + +3. From the **Pre-requisite test machine** list, select the prerequisite test machine. + +4. Click **Rerun options**. This will open **Pre-Requisite Rerun Options** dialog. + ![Pre-Requisite Rerun Options for Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_for_Test_Machines.png) + +5. Select **Always run Pre-Requisite** or **Only execute failed Pre-Requisite iteration(s)**. + ![Rerun Options for Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_Options_for_Machines.png) + +6. Click **Save**. + +7. Click **Update Profile**. + +--- + ## **Delete Test Machine** 1. Navigate to **Test Plan** and click on an existing test plan. diff --git a/src/pages/docs/test-plans/overview.md b/src/pages/docs/test-plans/overview.md index 1b525417..3187cfeb 100644 --- a/src/pages/docs/test-plans/overview.md +++ b/src/pages/docs/test-plans/overview.md @@ -86,7 +86,7 @@ In Testsigma, the Test Plan helps plan and organise software testing. The Test P - **Element Timeout**: Duration for which the test should wait for the element to load.![Additional Settings](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_plans_9.png) - **Accessibility Testing**: Enable this option to verify that the application meets accessibility standards, ensuring equal access and usability for users with disabilities. It follows WCAG guidelines to maintain compliance. Once enabled, accessibility reports are generated and shared via notifications. You can also select the appropriate **WCAG Version & Conformance Level** based on your requirements. Note that this feature is currently supported only on **Safari** and **Firefox** browsers. ![Accessibility Testing](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_plans_10.png) - **Recovery Actions**: Click **Recovery Actions** to open the recovery actions section and define what actions should happen. ![Recovery Actions](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_plans_11.png) - - **Post Plan Hook**: Select the Post Plan Hook and define actions or tasks to be performed once the test plan is executed and conditions are met (for more information, refer to [Post Plan Hook](https://testsigma.com/docs/test-management/test-plans/post-plan-hook/)). ![Post Plan](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_plans_12.png) + - **Post Plan Hook**: Select the Post Plan Hook and define actions or tasks to be performed once the test plan is executed and conditions are met (for more information, refer to [Post Plan Hook](https://testsigma.com/docs/test-plans/post-plan-hook/)). ![Post Plan](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_plans_12.png) --- diff --git a/src/pages/docs/test-suites/overview.md b/src/pages/docs/test-suites/overview.md index 3dd7b37b..79ef33d7 100644 --- a/src/pages/docs/test-suites/overview.md +++ b/src/pages/docs/test-suites/overview.md @@ -21,6 +21,9 @@ contextual_links: - type: link name: "Editing a Test Suite" url: "#editing-a-test-suite" +- type: link + name: "Setting Pre-Requisite Rerun Options" + url: "#setting-pre-requisite-rerun-options" - type: link name: "Deleting a Test Suite" url: "#deleting-a-test-suite" @@ -60,7 +63,7 @@ On the Test Suites List page, you will have the below options: 1. Navigate to **Test Suites** in the left-side navbar. Click the **Create Test Suite** button in the top right corner of the Test Suites List page. Provide below details to **Create Test Suite**: 2. **Name(Required)**: Enter the **title** of the Test Suite in the Name field on the Create Test Suite page. 3. **Description**: You can enable the toggle switch for the **Description** and provide a brief description explaining the test suite's purpose and scope. This will help your team members understand the objectives of the test suite. -4. **Pre-Requisite**: Specify any **Pre-Requisite** for executing the test suite, such as specific test data, system configurations, or test environment setup. +4. **Pre-Requisite**: Specify any **Pre-Requisite** for executing the test suite, such as specific test data, system configurations, or test environment setup. To control how the prerequisite behaves on test plan reruns, see [Setting Pre-Requisite Rerun Options](#setting-pre-requisite-rerun-options). 5. **Label**: You can assign a **Label** to the test suite. This will allow easier management of multiple test suites, as labels can be used for categorisation and filtering. ![Name](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_suites_4.png) 6. **Add/Remove Test Cases**: Click the **Add/Remove Test Cases** button to add or remove test cases from the Test Suite. An **Add/Remove Test Case** overlay will appear, allowing you to select test cases from the **Available Test Case** list by checking the box next to them or clicking the **+** icon to select individual test cases. @@ -96,6 +99,34 @@ On the Test Suites List page, you will have the below options: ![Info](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_suites_14.png) 7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of test suite. ![Edit Test Suite](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/update_suites_15.png) + +--- + +## **Setting Pre-Requisite Rerun Options** + +Choose whether a prerequisite test suite runs again in full or only its failed iterations run when you rerun the test plan. + +1. From the left navigation bar, navigate to **Test Suites**. + +2. Click **Create Test Suite** in the top-right corner. To update an existing test suite, click the **ellipsis** icon for the test suite and select **Edit**. + +3. From the **Pre-Requisite** list, select the prerequisite test suite. + +4. Click **Rerun options**. This will open **Pre-Requisite Rerun Options** dialog. + ![Rerun Options](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_for_Test_Suites.png) + +5. Select one of the following options: + - **Always run Pre-Requisite**: Runs the prerequisite test suite again in full every time you rerun the test plan. + - **Only execute failed Pre-Requisite iteration(s)**: Runs only the prerequisite iterations that failed in the selected run. + ![Pre-Requisite Rerun Options](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Rerun_Options_for_Suites.png) + +6. Click **Save**. + +7. Click **Create**. + +[[info | NOTE:]] +| Select **Always run Pre-Requisite** when the prerequisite generates runtime data, such as an order ID or a session token, that later test cases use. + --- ## **Deleting a Test Suite** diff --git a/src/templates/page.scss b/src/templates/page.scss index 3c3eca3c..99979c7c 100644 --- a/src/templates/page.scss +++ b/src/templates/page.scss @@ -435,6 +435,27 @@ blockquote:has(#prerequisites){ font-weight: 700; padding-left: 2rem; } + +blockquote:has(.additional-info){ + border: 1px solid #C1C7D0; + background: #FFFFFF; + color: #172B4D; + padding: 22px 20px 18px; + margin-top: 30px; + margin-bottom: 30px; + border-radius: 8px; + background-image: url("data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMDAiIGhlaWdodD0iMjAwIiB2aWV3Qm94PSIwIDAgMjQgMjQiIGZpbGw9Im5vbmUiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjkiIHN0cm9rZT0iIzQyNTI2RSIgc3Ryb2tlLXdpZHRoPSIyIi8+PHBhdGggZmlsbD0iIzQyNTI2RSIgZD0iTTExIDE3aDJ2LTZoLTJ2NlptMS04cS40MjUgMCAuNzEzLS4yODhUMTMgOHEwLS40MjUtLjI4OC0uNzEzVDEyIDdxLS40MjUgMC0uNzEzLjI4OFQxMSA4cTAgLjQyNS4yODguNzEzVDEyIDlaIi8+PC9zdmc+"); + background-size: 1.5rem; + background-position: 1.5rem 2.1rem; + background-repeat: no-repeat; + > * { + padding-left: 2rem; + } +} +.additional-info{ + font-size: 22px; + font-weight: 700; +} .edit-button { padding-top: 40px; @media (min-width:992px) {