From 71664de784abd201f5aad94b11de23ce8c09840c Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Tue, 10 Dec 2024 16:20:47 +0530 Subject: [PATCH 1/2] Updated Run Results docs as per updated UI (#552) Updated Run Results docs as per updated UI as per the ticket https://testsigma.atlassian.net/browse/IDEA-2102. --- src/left-nav-title.json | 7 +- .../export-reports/export-report-pdf.md | 6 +- .../export-reports/export-report-xls.md | 6 +- .../export-reports/export-reports-junit.md | 6 +- .../docs/reports/runs/custom-pdf-report.md | 22 +-- .../docs/reports/runs/drill-down-reports.md | 170 +++++++++++------- .../reports/runs/filter-custom-reports.md | 71 +++----- src/pages/docs/reports/runs/overview.md | 28 +-- src/pages/docs/runs/test-plan-executions.md | 14 +- 9 files changed, 168 insertions(+), 162 deletions(-) diff --git a/src/left-nav-title.json b/src/left-nav-title.json index 091a0adb..f08f0eaf 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -358,7 +358,7 @@ "/docs/reports/runs/rerun/": "ReRun" }, "drill-down-reports": { - "/docs/reports/runs/drill-down-reports/": "Drill-down Reports" + "/docs/reports/runs/drill-down-reports/": "Test Plan Run Results" }, "test-machine-reports": { "/docs/reports/runs/test-machine-reports/": "Test Machine Level Reports" @@ -370,7 +370,7 @@ "/docs/reports/runs/test-case-reports/": "Test Case Reports" }, "filter-custom-reports": { - "/docs/reports/runs/filter-custom-reports": "Filters & Custom Reports" + "/docs/reports/runs/filter-custom-reports": "Filters on Run Results" }, "export-report-junit": { "/docs/reports/runs/export-report-junit/": "Export Reports - JUnit" @@ -690,5 +690,6 @@ "generate-tdp": {"/docs/genai-capabilities/generate-tdp/": "Generate TDP Using Copilot"}, "smtp-configuration": {"/docs/configuration/smtp-configuration/": "SMTP Configuration"}, "generate-wda-file": {"/docs/configuration/generate-wda-file/": "Create WDA File" }, - "environments": {"/docs/api/environments/": "Manage Environments"} + "environments": {"/docs/api/environments/": "Manage Environments"}, + "runs": {"/docs/reports/runs/": "Results & Reports"} } \ No newline at end of file diff --git a/src/pages/docs/reports/export-reports/export-report-pdf.md b/src/pages/docs/reports/export-reports/export-report-pdf.md index 3841ba92..600df672 100644 --- a/src/pages/docs/reports/export-reports/export-report-pdf.md +++ b/src/pages/docs/reports/export-reports/export-report-pdf.md @@ -23,9 +23,9 @@ In Testsigma, you can effortlessly export PDF reports with screenshots for your --- -## **Prerequisites** - -Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. +> ## **Prerequisites** +> +> Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. [[info | **NOTE**:]] | Please contact us at **support@testsigma.com** or use the **Instant Chat** option to enable this exclusive feature provided by **Testsigma Enterprise**. diff --git a/src/pages/docs/reports/export-reports/export-report-xls.md b/src/pages/docs/reports/export-reports/export-report-xls.md index 883a5e45..04ca6666 100644 --- a/src/pages/docs/reports/export-reports/export-report-xls.md +++ b/src/pages/docs/reports/export-reports/export-report-xls.md @@ -23,9 +23,9 @@ Effortlessly generate detailed Excel reports for your test runs in Testsigma. Th --- -## **Prerequisites** - -Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. +> ## **Prerequisites** +> +> Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. [[info | **NOTE**:]] | Please contact us at **support@testsigma.com** or use the **Instant Chat** option to enable this exclusive feature provided by **Testsigma Enterprise**. diff --git a/src/pages/docs/reports/export-reports/export-reports-junit.md b/src/pages/docs/reports/export-reports/export-reports-junit.md index aade9af9..d2ef36e1 100644 --- a/src/pages/docs/reports/export-reports/export-reports-junit.md +++ b/src/pages/docs/reports/export-reports/export-reports-junit.md @@ -23,9 +23,9 @@ You can conveniently export your test plan reports in XML format, specifically i --- -## **Prerequisites** - -Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. +> ## **Prerequisites** +> +> Before exporting reports, you must understand specific concepts, such as creating [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), conducting [Test Runs](https://testsigma.com/docs/reports/runs/overview/), and having access to export test reports. [[info | **NOTE**:]] | Please contact us at **support@testsigma.com** or use the **Instant Chat** option to enable this exclusive feature provided by **Testsigma Enterprise**. diff --git a/src/pages/docs/reports/runs/custom-pdf-report.md b/src/pages/docs/reports/runs/custom-pdf-report.md index 52c9215d..fc0786ca 100644 --- a/src/pages/docs/reports/runs/custom-pdf-report.md +++ b/src/pages/docs/reports/runs/custom-pdf-report.md @@ -36,17 +36,17 @@ Custom PDF Report Generator in Testsigma allows you to create detailed and custo --- -## **Prerequisites** - -Before you begin, ensure you have the following: - -- An [API Key ](https://testsigma.com/docs/reports/runs/filter-custom-reports/) from your Testsigma account. - -- **Java 17** or a newer version installed on your system. - -- You can request the **JAR file** from the Customer Support team and download it before executing a Custom PDF Report Generation. - -- An **HTML template** for the PDF report. [Click here](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Custom_Report_Template.txt) to download the HTML template. +> ## **Prerequisites** +> +> Before you begin, ensure you have the following: +> +> - An [API Key ](https://testsigma.com/docs/reports/runs/filter-custom-reports/) from your Testsigma account. +> +> - **Java 17** or a newer version installed on your system. +> +> - You can request the **JAR file** from the Customer Support team and download it before executing a Custom PDF Report Generation. +> +> - An **HTML template** for the PDF report. [Click here](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Custom_Report_Template.txt) to download the HTML template. --- diff --git a/src/pages/docs/reports/runs/drill-down-reports.md b/src/pages/docs/reports/runs/drill-down-reports.md index 13757192..625a8a93 100644 --- a/src/pages/docs/reports/runs/drill-down-reports.md +++ b/src/pages/docs/reports/runs/drill-down-reports.md @@ -1,9 +1,9 @@ --- -title: "Drill Down Reports in Testsigma" -metadesc: "Drill-down reports let you access data at all layers. Learn how to use drill-down reports in the test execution results of automated tests in Testsigma" +title: "Test Plan Run Results in Testsigma" +metadesc: "View and download reports from the Run Results page in Testsigma | This page provides detailed results at the test cases, suites, and machines levels." noindex: false order: 13.23 -page_id: "Drill Down Reports in Testsigma" +page_id: "Test Plan Run Results" warning: false contextual_links: - type: section @@ -12,117 +12,163 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "How to Use Drill-down Reports in Testsigma" - url: "#how-to-use-drill-down-reports-in-testsigma" + name: "Steps to View Test Suite Results" + url: "#steps-to-view-test-suite-results" - type: link - name: "Steps to Generate Test Case Reports" - url: "#steps-to-generate-test-case-reports" + name: "Steps to View Test Case Results" + url: "#steps-to-view-test-case-results" - type: link - name: "Steps to Generate Test Suite Reports" - url: "#steps-to-generate-test-suite-reports" + name: "Steps to View Test Machine Results" + url: "#steps-to-view-test-machine-results" - type: link - name: "Steps to Generate Test Machine Reports" - url: "#steps-to-generate-test-machine-reports" + name: "Test Runs in Run Results" + url: "#test-runs-in-run-results" - type: link - name: "Additional Actions on Results" - url: "#additional-actions-on-results" + name: "Overview of Tests in Run Results" + url: "#overview-of-tests-in-run-results" +- type: link + name: "Exporting the Test Reports" + url: "#exporting-the-test-reports" +- type: link + name: "Available Shortcuts in Run Results" + url: "#available-shortcuts-in-run-results" --- --- -The users will have better satisfaction when the application does not have bugs, technical glitches, performance issues, or usability issues. When these issues increase, the quality decreases, which results in bad UX. That's when drill-down reports come in handy. +In Testsigma, you can view and download reports from the Run Results page. This page provides results at the test cases, suites, and machines levels and also helps you check test runs, view the run overview, and see the count of passed/failed tests along with the reasons for failure. This article provides an overview of the Run Results page in Testsigma. -In Testsigma, you can view/download reports at multiple levels and find specific details, like the number of tests failed and the reason for failures or machines causing more problems. You can assess the application's quality and address issues from this data. --- -## **Prerequisites** +> ## **Prerequisites** +> +> Before you begin, make sure you have created and executed a [test plan](https://testsigma.com/docs/test-management/test-plans/overview/). -- You should know how to [create a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case). +--- -- You should know how to [create a test suite](https://testsigma.com/docs/test-management/test-plans/overview/#steps-to-create-a-test-plan). +## **Steps to View Test Suite Results** -- You should know how to [create a test plan](https://testsigma.com/docs/test-management/test-suites/overview/#creating-a-test-suit). +1. From the left navigation bar, go to **Run Results** and click on the test plan for which you want to check the results. + ![Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Test_Suites.png) ---- +2. By default, you’ll see the results at test suite level. + ![Results at Test Suite Level](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Default_Page.png) -## **How to Use Drill-down Reports in Testsigma:** +3. You can expand the test suite to check test case results inside the suite. + ![Expand Test Suite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Expan_Test_Suite_Run_Results.png) + +4. The symbols shown with the arrow in the image below indicate the number of test suites running in parallel and the number of test cases running in parallel within each test suite. + ![Parallel Settings Indicators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Parallel_Settings_In_Test_Suites.png) -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) +--- -2. From **Test Plan Result** page, you can view **Test Case** reports. -![Test Case Report](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtcr.png) +## **Steps to View Test Case Results** +1. On the **Run Results** page, select **Test Cases** from the dropdown menu. + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Test_Cases.png) -[[info | **NOTE**:]] -| You can also view reports at test suite and test machine level by clicking on **Test Suite** and **Test Machine**. -| ![Reoprts](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtstm.png) +2. The page displays all test cases from all test suites. + ![Test Cases in all Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Cases_In_All_Suites.png) -3. You can choose the different runs from the dropdown to see how the results have changed for different builds. -![Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrrabuilds.png) +3. You can hover over a failed test case to view a brief description of the reason for failure. + ![Failure Dialog Box](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Failure_Dialog_Test_Cases.png) +4. Click a test case to view its detailed results. ---- +5. On the **Test Case Results** page, you can view all the test steps along with the **Data, Settings, Metadata**, and **Step Details**. + ![Detailed Result of a Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Detailed_Test_Case_Result.png) +6. Click **More details** to access additional information. + ![More Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/More_Details_On_Test_Case_Result.png) -## **Steps to Generate Test Case Reports** +--- +## **Steps to View Test Machine Results** -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) +1. On the **Run Results** page, select **Test Machines** from the dropdown menu. + ![Test Machine Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Machine_Run_Results.png) -2. Results are available in **Test Case**, **Test Suite**, and **Test Machine** level. Click on **Test Case** to view the results grouped by **Test Cases**. -![Test Case Report](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtcr.png) +2. The page displays all test machines included in the test plan. + ![All Test Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/All_Test_Machines_Run_Results.png) +3. Click a test machine to expand and view the test suites it contains. + ![Expand Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Expand_Test_Machine_Run_Result.png) --- +## **Test Runs in Run Results** + +1. From the **Test Runs** panel, select different runs to compare how the results have changed. + ![Test Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Runs_In_Run_Results.png) -## **Steps to Generate Test Suite Reports** +2. Click **Rerun** in the top-right corner to rerun the test plan by selecting the appropriate rerun options. + ![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ReRun_from_Run_Results.png) -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) +[[info | **NOTE**:]] +| 1. Only 10 reruns are available for each build. +| ![Rerun Limit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Rerun_Limits_Run_Results.png) +| +| 2. Once you click **Rerun**, you'll see the following options. +| - **All Test Cases:** This will rerun all the test cases in the selected run. +| - **All Failed Test Cases:** This will rerun all the failed test cases in the selected run. +| - **Select Cases for Re-Run:** This will allow you to select the test cases you want to rerun. +| +| 3. Click **Start execution** to rerun the test plan. -2. Results are available in **Test Case**, **Test Suite**, and **Test Machine** level. Click on **Test Suite** to view the results grouped by **Test Suites**. -![Test Suite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtestsuite.png) -3. You can also check test case results inside test suite by clicking on the **Test suite** of your choice. -![Test Case in Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtstclr.png) +1. To compare the current rerun result with the previous result, click **Compare Run**. + ![Compare Test Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Compare_Runs_In_Run_Results.png) +2. This opens the **Rerun** overlay, where you can view a detailed comparison at all levels. + ![Rerun Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Compare_Runs_Overlay.png) --- -## **Steps to Generate Test Machine Reports** +## **Overview of Tests in Run Results** -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) +1. The **Run Overview** section of the **Run Results** page is dynamic and provides a summary of tests at all levels for the selected run. + ![Run Overview](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Overview_Run_Results.png) -2. Results are available in **Test Case**, **Test Suite**, and **Test Machine** level. Click on **Test Machine** to view the results grouped by **Test Machines**. -![Test Machine Reports](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtmr.png) +2. This section displays the **Last Run, Test Plan Settings**, and **Accessibility Test Overview**. + ![Run Overview Section](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Overview_Section_Run_Results.png) -3. You can also check test suite results inside test machine by clicking on the **Test Machine** of your choice. -![Test Suite in Test Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtsitm.png) +3. Click **View Runs** to view all runs, **More Settings** to access additional settings, and **View Report** to check the **Accessibility Testing Report**. + ![View Overlay Components](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Overview_Overlay_Comps.png) +--- +## **Exporting the Test Reports** -Here is a quick GIF demonstrating how to view test reports in Testsigma. -![Reports](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DrillDownReports.gif) +1. Click the **Export** icon and select the desired download format from the dropdown menu. + ![Export Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Export_Run_Results.png) ---- +2. For **PDF format**, the **Export PDF** dialog appears. Select the appropriate options and click **Export**. + ![Export PDF](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Export_Run_Results_In_PDF.png) -## **Additional Actions on Results** - -There are multiple actions that you can take on these results. These actions are: +3. For **JUnit format**, the report is downloaded instantly as an **XML file**. -1. **Rerun**: You can initiate reruns of the test cases by clicking on Rerrun. -![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrrerun.png) +4. For **XLSX format**, a downloadable link of the report is sent to your email. -2. **Export Reports**: You can download the report in Junit and MS Excel Sheet at test case/test suite/test machine levels by clicking on the **Export** icon. -![Export Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrreicon.png) +--- -3. **Test Run Details**: You can see the test run details below the result overview. -![Test Run Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtrdetails.png) +## **Available Shortcuts in Run Results** + +### **For Mac:** +- **Option + C**: View results at the test case level +- **Option + S**: View results at the test suite level +- **Option + M**: View results at the test machine level +- **Option + H**: Open/close run history +- **Option + F**: Open filters +- **Option + O**: Open/close run overview + +### **For Windows:** +- **Alt + C**: View results at the test case level +- **Alt + S**: View results at the test suite level +- **Alt + M**: View results at the test machine level +- **Alt + H**: Open/close run history +- **Alt + F**: Open filters +- **Alt + O**: Open/close run overview --- \ No newline at end of file diff --git a/src/pages/docs/reports/runs/filter-custom-reports.md b/src/pages/docs/reports/runs/filter-custom-reports.md index 67df0b8e..d2471763 100644 --- a/src/pages/docs/reports/runs/filter-custom-reports.md +++ b/src/pages/docs/reports/runs/filter-custom-reports.md @@ -1,9 +1,9 @@ --- -title: "Filters & Custom Reports" -metadesc: "Filters in Run Results will help you create custom reports based on different criteria for your team. Learn how filters in run results in Testsigma" +title: "Filters on the Run Results Page" +metadesc: "Quickly view the enhanced run results for the selected test plan by applying filters | Learn how to apply filters on run results page in Testsigma" noindex: false order: 13.27 -page_id: "Filters & Custom Reports" +page_id: "Filters on Run Results" warning: false contextual_links: - type: section @@ -12,66 +12,53 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Steps to Generate Filtered Reports" - url: "#steps-to-generate-filtered-reports" -- type: link - name: "Test Plan Run History Filters and reports" - url: "#test-plan-run-history-filters-and-reports" -- type: link - name: "Test case result list view" - url: "#test-case-result-list-view" ---- - + name: "Applying Filters on the Run Results Page" + url: "#applying-filters-on-the-run-results-page" --- -Once the test plan execution is complete, you can filter out the data based on different criteria. Filters in run results will help you create custom reports for your team. - --- -## **Prerequisites** - - -- You should know [how to create a test plan](https://testsigma.com/docs/test-management/test-plans/overview/#steps-to-create-a-test-plan). - -- You should know about [drill down reports in Testsigma](https://testsigma.com/docs/reports/runs/drill-down-reports/). +In Testsigma, you can quickly view the Run Results by using filters. The filters are available for Test Runs, Test Levels, and the Donut Chart in the Run Overview section. This article discusses using filters on the Run Results page in Testsigma. +Quickly view the run results of a test plan by applying filters | Learn how to apply filters on run results page in Testsigma --- -## **Steps to Generate Filtered Reports** +> ## **Prerequisites** +> +> Before you begin, make sure you have created and executed a [test plan](https://testsigma.com/docs/test-management/test-plans/overview/). -1. Navigation to **Dashboard > Run Results** and click on a test plan result. -![Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/fcrnavrr.png) - - -2. On **Results** page, **click** on **Add Filters**. -![Add Filters](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/fcecoaf.png) - - -3. You can filter by **Last Run Result**, **Type**, **Priority**, **Created By**, **Assignee**, **Reviewer**, **Requirement**, **Test Suites**, **Requirement Type**, **Labels**, **Created Date** and **Updated Date**. -![Filters](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/fcrafilters.png) - - -[[info | **NOTE**:]] -| Once the filter is applied, you can export the filtered data to an **Excel** or a **JUnit XML** report by clicking on **Export** icon. -| ![Export Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/fceexprt.png) +--- +## **Applying Filters on the Run Results Page** +1. From the left navigation bar, go to **Run Results** and click on the test plan for which you want to check the results. + ![Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Test_Suites.png) +2. By default, you’ll see the results at test suite level. + ![Results at Test Suite Level](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Default_Page.png) -### **Some Important Filters** +3. To apply filters to the **Test Runs** panel, click the **Filters** icon on the panel. + ![Test Runs Filter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Runs_Filter.png) + +4. Add the desired filters and click **Apply**. + ![Apply Filter to Test Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Apply_Test_Runs_Filter.png) -- **Type**: If you want to filter out the results based on the test plan run result type, you need to select the appropriate result type in the filter. +5. To apply filters to the tests, select **Test Cases, Suites, or Machines** from the dropdown menu, then click the **Filters** icon. + ![Filter for Tests](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Tests_Filters_On_Run_Results.png) -- **Assignee**: If you want to filter out the results based on the test case assignee, select the appropriate assignee in the filter. +6. Add the desired filters and click **Apply**. + ![Apply Filters to Tests](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Apply_Filters_To_Tests.png) +7. You can also click the status on the chart in the **Run Overview** and apply filters using the same icon highlighted in **Step 6**. -Similarly, you can apply other filters to filter your test cases based on Result, Type, Priority, Created By, Reviewer, Requirement, Requirement Type, etc. +Here's a quick GIF demonstrating how to apply filters on the run results Page. + ![Applying Filters](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Filters_On_RunResults.gif) -*For more information on filtering and downloading reports on test case, test suite or test machine levels, refer to [drill down reports](https://testsigma.com/docs/reports/runs/drill-down-reports/).* +*For more information on viewing and downloading results of a test plan on test case, test suite or test machine levels, see [Test Plan Run Results](https://testsigma.com/docs/reports/runs/drill-down-reports/).* diff --git a/src/pages/docs/reports/runs/overview.md b/src/pages/docs/reports/runs/overview.md index 0e37e8cb..62648586 100644 --- a/src/pages/docs/reports/runs/overview.md +++ b/src/pages/docs/reports/runs/overview.md @@ -18,9 +18,7 @@ contextual_links: --- -The purpose of test automation is to be able to understand the state of quality in your application quickly. To understand the quality, you need to understand the results of your test execution, and that's where test reports come in. - -In Testsigma, you can view reports directly in the application. Reports are automatically created and help debug failing tests and help managers understand the state of quality of the application under test (AUT). This article discusses the overview of run results page in Testsigma. +In Testsigma, you can view results directly in the application. Results are automatically created and help debug failing tests and help managers understand the state of quality of the application under test (AUT). This article discusses the overview of Run Results page in Testsigma. --- @@ -43,28 +41,4 @@ Here is a quick GIF demonstrating actions possible on run results page. Testers may need to rerun failed test cases, or all test cases from a particular test run result, after a hotfix or a change in environment. Follow the steps below to rerun test cases from test run results in Testsigma. ---- - -## **Steps to Rerun from Run Results** - -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) - - -2. From results page, click on **Rerun**. -![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/rrtresults.png) - - -3. On the **Re-run options** prompt, you will see the following options: -![Options](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/rrtrstcs.png) - - **All Test Cases:** This will rerun all the test cases in the selected run. - - **All Failed Test Cases:** This will rerun all the failed test cases in the selected run. - - **Select Cases for Re-Run:** This will allow you to select the test cases you want to rerun. - -4. Choose the option and click on **Start execution** to rerun. -![Start execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/rrstexec.png) - -Here is a quick GIF demonstrating how to rerun tests from run results in Testsigma. -![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/reruntp.gif) - --- \ No newline at end of file diff --git a/src/pages/docs/runs/test-plan-executions.md b/src/pages/docs/runs/test-plan-executions.md index d25d2494..1e8032f9 100644 --- a/src/pages/docs/runs/test-plan-executions.md +++ b/src/pages/docs/runs/test-plan-executions.md @@ -118,18 +118,16 @@ Once you have applied the filters, you can: ## **Test Plan Run Results** -1. Navigate to **Run Results** page and click on a **Test Plan Result**. -![Test Plan Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrnav.png) - - -2. From **Test Plan Result** page, you can view **Test Case** reports. -![Test Case Report](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtcr.png) +1. From the left navigation bar, go to **Run Results** and click on the test plan for which you want to check the results. + ![Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Test_Suites.png) +2. By default, you’ll see the results at test suite level. + ![Results at Test Suite Level](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Results_Default_Page.png) [[info | **NOTE**:]] | You can also view reports at test suite and test machine level by clicking on **Test Suite** and **Test Machine**. -| ![Reoprts](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ddrrtstm.png) - +| ![Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Dropdown_Run_Results.gif) +*For more information on viewing and downloading results of a test plan on test case, test suite or test machine levels, see [Test Plan Run Results](https://testsigma.com/docs/reports/runs/drill-down-reports/).* --- \ No newline at end of file From 18cf57da05da0875e06d26978943e46a63c54ddf Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Wed, 11 Dec 2024 11:49:03 +0530 Subject: [PATCH 2/2] Updated docs as per the feedback (#553) --- src/pages/docs/reports/runs/drill-down-reports.md | 11 +++++++---- src/pages/docs/reports/runs/filter-custom-reports.md | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/src/pages/docs/reports/runs/drill-down-reports.md b/src/pages/docs/reports/runs/drill-down-reports.md index 625a8a93..98930627 100644 --- a/src/pages/docs/reports/runs/drill-down-reports.md +++ b/src/pages/docs/reports/runs/drill-down-reports.md @@ -36,7 +36,7 @@ contextual_links: --- -In Testsigma, you can view and download reports from the Run Results page. This page provides results at the test cases, suites, and machines levels and also helps you check test runs, view the run overview, and see the count of passed/failed tests along with the reasons for failure. This article provides an overview of the Run Results page in Testsigma. +In Testsigma, you can view and download reports from the Run Results page. This page provides results at the test cases, test suites, and test machine level and also helps you check test runs, view the run overview, and see the count of passed/failed tests along with the reasons for failure. This article provides an overview of the Run Results page in Testsigma. --- @@ -77,7 +77,7 @@ In Testsigma, you can view and download reports from the Run Results page. This 4. Click a test case to view its detailed results. -5. On the **Test Case Results** page, you can view all the test steps along with the **Data, Settings, Metadata**, and **Step Details**. +5. On the **Test Case Results** page, you can view all the test steps along with the **Element Information, Test Data, Settings, Metadata**, and **Step Details**. ![Detailed Result of a Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Detailed_Test_Case_Result.png) 6. Click **More details** to access additional information. @@ -93,6 +93,9 @@ In Testsigma, you can view and download reports from the Run Results page. This 2. The page displays all test machines included in the test plan. ![All Test Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/All_Test_Machines_Run_Results.png) + [[info | **NOTE**:]] + | To view the test cases part of the test machine, navigate to the **Test Suites** view and apply a **Test Machine** filter. This provides a view of all test cases in the selected test suite and test machine. + 3. Click a test machine to expand and view the test suites it contains. ![Expand Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Expand_Test_Machine_Run_Result.png) @@ -100,14 +103,14 @@ In Testsigma, you can view and download reports from the Run Results page. This ## **Test Runs in Run Results** -1. From the **Test Runs** panel, select different runs to compare how the results have changed. +1. From the **Test Runs** panel, select a different run to view its corresponding test run results. ![Test Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Runs_In_Run_Results.png) 2. Click **Rerun** in the top-right corner to rerun the test plan by selecting the appropriate rerun options. ![Rerun](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ReRun_from_Run_Results.png) [[info | **NOTE**:]] -| 1. Only 10 reruns are available for each build. +| 1. Each run ID has a maximum rerun limit of 10. We recommend using reruns wisely. | ![Rerun Limit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Rerun_Limits_Run_Results.png) | | 2. Once you click **Rerun**, you'll see the following options. diff --git a/src/pages/docs/reports/runs/filter-custom-reports.md b/src/pages/docs/reports/runs/filter-custom-reports.md index d2471763..38307b20 100644 --- a/src/pages/docs/reports/runs/filter-custom-reports.md +++ b/src/pages/docs/reports/runs/filter-custom-reports.md @@ -51,7 +51,7 @@ Quickly view the run results of a test plan by applying filters | Learn how to a 6. Add the desired filters and click **Apply**. ![Apply Filters to Tests](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Apply_Filters_To_Tests.png) -7. You can also click the status on the chart in the **Run Overview** and apply filters using the same icon highlighted in **Step 6**. +7. You can click a status in the chart within the **Run Overview** to apply additional filters on top of it. Here's a quick GIF demonstrating how to apply filters on the run results Page.