Skip to content

Commit

Permalink
Merge branch 'refs/heads/v1.4.0' into Test-damies13#196-for-Issue-dam…
Browse files Browse the repository at this point in the history
  • Loading branch information
ArekKuczynski committed Oct 17, 2024
2 parents 45517e0 + ecf1c88 commit 527afd1
Show file tree
Hide file tree
Showing 13 changed files with 389 additions and 92 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Doc/Images/MacOS_Reporter_v1.4.0_DataTable_Plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Doc/Images/MacOS_Reporter_v1.4.0_DataTable_PlanPreview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 29 additions & 4 deletions Doc/rfswarm_reporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ When Report is selected, the settings pane will display settings the global repo
| Date Format | Here you can select the date format you wish to use in the report (defaults to yyyy-mm-dd) |
| Time Format | Here you can select the time format you wish to use in the report (defaults to HH:MM) |
| Time Zone | Times in rfswarm are stored using epoch time also known as Unix timestamp, as such all times are UTC with no timezone offset. To display the expected times rfswram Reporter needs to know the timeszone to apply to the timestamp. This should default to the timezone of your local machine, however you may want to display times in your report for another timezone. |
| Start Time | This value is extracted from the results database, to display it on the title page, enable the checkbox in the display column |
| End Time | This value is extracted from the results database, to display it on the title page, enable the checkbox in the display column |
| Start Time | The default value is extracted from the results database, You can adjust the time to constrain this report's data to a specific time range. To display it on the title page, enable the checkbox in the display column |
| End Time | The default value is extracted from the results database, You can adjust the time to constrain this report's data to a specific time range. To display it on the title page, enable the checkbox in the display column |
| Logo Image | This setting lets you add a picture to the title page of your report, typically this would be your organisation's logo, but it can be anything you want. the field is read only but will show the filename of the file you selected. Click the ![image](Images/REP_picture.gif)Select Picture button and browse to the image you want to use. Then enable the checkbox in the display column |
| Font | This setting allows you to choose the font and font size to be used throughout the report. Headings and titles use the same font however the font size will be scaled proportionally to the base font size. |
| Highlight Colour | This setting allows you to choose a colour for headings and column headings, Click the ![image](Images/REP_color_swatch.gif)Colour Swatch button next to the colour preview to bring up the system colour picker and choose a colour. For best results choose the colour that matches your organisation's branding. |
Expand Down Expand Up @@ -150,6 +150,11 @@ The note section is used for adding free text sections to your report, some exam
#### Data Graph Section
The data graph section is used for displaying graphs of test results and other metrics collected during the test.

**Start Time** - Allows you to constrain this graph's data to a specific time range.

**End Time** - Allows you to constrain this graph's data to a specific time range.

> ![Image](Images/MacOS_Reporter_v1.0.0_DataGraph_Settings.png)
> ![Image](Images/MacOS_Reporter_v1.0.0_DataGraph_Settings_Type.png)
Expand All @@ -161,10 +166,10 @@ The data sources for the graphs can be:

##### Data Graph Plan
The Plan Data Graph allows you to include the graph from the plan tab of the RFSwarm Manager in your test report.
> ![Image](Images/MacOS_Reporter_v1.4.0_DataTable_Plan.png)
> ![Image](Images/MacOS_Reporter_v1.4.0_DataGraph_Plan.png)
**Show Total** - If enabled, shows a line for the total number of planned robots. The image below shows an example with Show Total enabled.
> ![Image](Images/MacOS_Reporter_v1.4.0_DataTable_PlanPreview.png)
> ![Image](Images/MacOS_Reporter_v1.4.0_DataGraph_PlanPreview.png)
##### Data Graph Metric
> ![Image](Images/MacOS_Reporter_v1.0.0_DataGraph_Metric.png)
Expand Down Expand Up @@ -228,16 +233,32 @@ The data table section is used for displaying tables of test results and other m
**Show graph colours** - When enabled will display a colour swatch in the first column of the table that matches the first data column to the matching data value on a related graph, this is useful for creating legend tables.

**Start Time** - Allows you to constrain this table's data to a specific time range.

**End Time** - Allows you to constrain this table's data to a specific time range.

> ![Image](Images/MacOS_Reporter_v1.0.0_DataTable_Settings_Type.png)
**Rename Columns** - This section allows you to change the default English column names, to another name you prefer or the equivalent in your preferred language

The data sources for the graphs can be:
- [Plan](#data-table-plan)
- [Metric](#data-table-metric)
- [Result](#data-table-result)
- [ResultSummary](#data-table-resultsummary)
- [Custom SQL](#data-table-sql)

##### Data Table Plan
The Plan Data Table allows you to include the test row data from the plan tab of the RFSwarm Manager in your test report.
> ![Image](Images/MacOS_Reporter_v1.4.0_DataTable_Plan.png)
**Show Column** - If disabled, hides the column from the report

**Options** - Allows you to choose what is shown in the column, currently only the script column has an option that allows you to choose between the filename of the robot file or the full path of the robot file

The image below shows an example with Show graph colours and all columns enabled.
> ![Image](Images/MacOS_Reporter_v1.4.0_DataTable_PlanPreview.png)
##### Data Table Metric
> ![Image](Images/MacOS_Reporter_v1.0.0_DataTable_Metric.png)
Expand Down Expand Up @@ -311,6 +332,10 @@ Also note that **Show graph colours** will use values of the first data column t
The data table section is used for displaying error details for any failed keywords during the test. This report section queries the results database for FAIL results, then uses the test group number, the robot number and the iteration to identify the correct output.xml file, it then reads the error detail and also finds any related screenshots included in the failed keyword.
> ![Image](Images/Linux_Reporter_v1.2.0_ErrorDetails_Settings.png)
**Start Time** - Allows you to constrain this error details section's data to a specific time range.

**End Time** - Allows you to constrain this error details section's data to a specific time range.

**Show screenshots** - If the test library takes screenshots of the AUT when a keyword fails, this setting will include any screenshot found in the report.

**Group by result name** - This setting will group all errors related to the same result name together and provides a count of the number of total errors for this result name.
Expand Down
69 changes: 69 additions & 0 deletions Tests/Regression/Reporter/GUI_Features.robot
Original file line number Diff line number Diff line change
Expand Up @@ -805,5 +805,74 @@ Verify Plan Graph - With Total
... Close GUI AND
... Remove File ${resultfile}

Verify Plan Table
[Tags] ubuntu-latest macos-latest windows-latest Issue #141
Log To Console ${\n}TAGS: ${TEST TAGS}
Make Clipboard Not None
${testdata}= Set Variable Issue-#140
${resultdata}= Set Variable 20230728_130340_Odoo-demo
${basefolder}= Set Variable ${CURDIR}${/}testdata${/}${testdata}
Should Exist ${basefolder}
Log to console basefolder: ${basefolder} console=True
${resultfolder}= Set Variable ${basefolder}${/}${resultdata}
${resultfile}= Set Variable ${basefolder}${/}${resultdata}${/}${resultdata}.report
Should Exist ${resultfolder}
Log resultfolder: ${resultfolder} console=True
Should Not Exist ${resultfile}

# pass a default ini file with extended height to ensure that default values are used
Open GUI -d ${resultfolder} -i ${basefolder}${/}RFSwarmReporter.ini
# Run Keyword And Continue On Failure Wait For Status PreviewLoaded 120
Wait For Status PreviewLoaded

Click Section Report

Click Button AddSection

Click To The Below Of Image reporter_${platform}_label_sectionname.png 20
Type Issue #141
Click Button OK
# Take A Screenshot
Click Section Issue#141

Select Field With Label Type

# Take A Screenshot
Select Option DataTable
# Take A Screenshot

Run Keyword And Continue On Failure Wait For Status PreviewLoaded

# Take A Screenshot
Select Field With Label DataTypeWide

# Take A Screenshot
Select Option Plan

Wait For Status PreviewLoaded

# Take A Screenshot
Select Field With Label ShowGraphColours

# Take A Screenshot
Wait For Status PreviewLoaded

# Take A Screenshot
Click Tab Preview

Take A Screenshot

Set Confidence 0.7
Locate reporter_${platform}_table_plan.png
Set Confidence 0.9

[Teardown] Run Keywords
... Set Confidence 0.9 AND
... Close GUI AND
... Remove File ${resultfile}


#


#
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 527afd1

Please sign in to comment.