Documentation Updates for Issues #103, #133 and #163

Doc/FAQ.md

@@ -2,6 +2,7 @@
 # rfswarm (Robot Framework Swarm) Frequently Asked Questions
 [Return to Index](README.md)
 
+- [How are issues prioritised](#how-are-issues-prioritised)
 - [Can I run the Agent and the Manager on the same machine?](#can-i-run-the-agent-and-the-manager-on-the-same-machine)
 - [The Agent doesn't connect to the Manager?](#the-agent-doesnt-connect-to-the-manager)
 - [I have some experience in performance testing, can you translate the terminology between rfswarm and tool xzy?](#i-have-some-experience-in-performance-testing-can-you-translate-the-terminology-between-rfswarm-and-tool-xzy)
@@ -10,6 +11,20 @@
 - [Is there a tutorial on how to use rfswarm?](#is-there-a-tutorial-on-how-to-use-rfswarm)
 - [does rfswarm support IPv6?](#does-rfswarm-support-ipv6)
 
+## How are issues prioritised?
+
+This table shows how issues are prioritised:
+
+| Priority | Description |
+|--|--|
+| 1 | Bugs that multiple project sponsors have identified as needing priority |
+| 2 | Bugs that a project sponsor has identified as needing priority |
+| 3 | Bugs that have the most thumbs up (:+1) |
+| 4 | Any remaining Bugs |
+| 5 | Feature requests that multiple project sponsors have identified as needing priority |
+| 6 | Feature requests that a project sponsor has identified as needing priority |
+| 7 | Feature requests that have the most thumbs up (:+1) |
+| 8 | Any remaining Feature requests |
 
 ## Can I run the Agent and the Manager on the same machine?
 

Doc/rfswarm_manager.md

@@ -87,8 +87,8 @@ The columns under the graph:
 
 ##### Scenario settings
 At the moment there is only one scenario setting, the upload logs setting, this allows you to control when the agent will upload the logs for the test cases being run.
-> ![image](Images/MacOS_Run_v1.0.0_Settings.png)
-> ![image](Images/MacOS_Run_v1.0.0_Settings_UploadLogs.png)
+> ![image](Images/Linux_Plan_v1.2.0_Settings.png)
+> ![image](Images/Linux_Plan_v1.2.0_Settings_UploadLogs.png)
 
 The options are:
 | Option | Action |
@@ -98,10 +98,42 @@ The options are:
 | All Deferred | All test result logs will be deferred until the last robot has stopped on the agent |
 
 \* In earlier releases before v1.0.0 the agent always followed the default case.
+##### Test Defaults settings
+The test defaults settings allow you to set default default setting values for all test groups. These settings allow you to change and define what the default values are but can still be overridden for an individual test group in the [Additional settings for test group](#additional-settings-for-test-group-) screen
+> ![image](Images/Linux_Plan_v1.2.0_Settings.png)
+
+###### Exclude libraries
+The default value is "BuiltIn,String,OperatingSystem,perftest", this is the same default value as used in the [agent settings](./rfswarm_agent.md#exclude-libraries) and if you leave this default but change the agent the settings set on the agent will override this setting.
+By configuring this setting you can adjust which keyword's response times are reported in the test results.
+If you change this setting here from the default, then the agent setting will be overridden with the settings used here for all test groups.
+
+|agent ini setting|scenario setting|test group setting|result|
+|---|---|---|
+|default|default|default|default (BuiltIn,String,OperatingSystem,perftest)|
+|configured|default|default|agent ini setting|
+|default|configured|default|scenario setting|
+|default|default|configured|test group setting|
+|default|configured|configured|test group setting|
+|configured|configured|default|scenario setting|
+|configured|configured|configured|test group setting|
+
+###### Robot Options
+By default this setting is blank and in most cases wouldn't be used, it allows you to pass additional command-line options to the robot executable, to find out what options can be passed run
+`robot -h`
+On any machine that has Robot Framework installed
+
+###### Test Repeater
+This setting when enabled will cause Robot Framework to repeat the selected test case in the same test suite continually until either a the test fails or the scenario ends.
+
+This gives the ability to use the Suite Startup for steps such as open browser or app login, before running the test, have the test run many times with the same login or browser window, and then call logout or close browser at the end of the test suite
+
+By default this setting is disabled, retaining the behaviour from RFSwarm versions prior to v1.2.0, where the test case executed only once in the test suite, the suite ended and the robot exited and a new robot was started every iteration.
+
+Enabling this setting here will enable it for all test groups
 
 ##### Manager settings
-The manager settings allows you to access settings that were previously only accessable from the ini file
-> ![image](Images/MacOS_Run_v1.0.0_Settings.png)
+The manager settings allows you to access settings that were previously only accessible from the ini file
+> ![image](Images/Linux_Plan_v1.2.0_Settings.png)
 
 **Bind IP Address**
 
@@ -136,25 +168,27 @@ e.g. 2 - if the time now is 9:05 PM and you planned to start at 9:00 AM, so ente
 
 #### Additional settings for test group ![image](Images/GUI_btn_cog.gif)
 When clicking on this button a dialogue will be presented that allows you to configure some additional settings for the test group, by default the dialogue will look like this:
-> ![image](Images/MacOS_Plan_v0.7.0_Test_Settings.png)
+> ![image](Images/Linux_Plan_v1.2.0_Test_Settings.png)
 
 ##### Exclude libraries
 The default value is "BuiltIn,String,OperatingSystem,perftest", this is the same default value as used in the [agent settings](./rfswarm_agent.md#exclude-libraries) and if you leave this default but change the agent the settings set on the agent will override this setting.
 By configuring this setting you can adjust which keyword's response times are reported in the test results.
 If you change this setting here from the default, then for this particular test group the agent setting will be overridden with the settings used here
 
-|agent ini setting|test group setting|result|
-|---|---|---|
-|default|default|default (BuiltIn,String,OperatingSystem,perftest)|
-|configured|default|agent ini setting|
-|default|configured|test group setting|
-|configured|configured|test group setting|
-
 ##### Robot Options
 By default this setting is blank and in most cases wouldn't be used, it allows you to pass additional command-line options to the robot executable, to find out what options can be passed run
 `robot -h`
 On any machine that has Robot Framework installed
 
+##### Test Repeater
+This setting when enabled will cause Robot Framework to repeat the selected test case in the same test suite continually until either a the test fails or the scenario ends.
+
+This gives the ability to use the Suite Startup for steps such as open browser or app login, before running the test, have the test run many times with the same login or browser window, and then call logout or close browser at the end of the test suite
+
+By default this setting is disabled, retaining the behaviour from RFSwarm versions prior to v1.2.0, where the test case executed only once in the test suite, the suite ended and the robot exited and a new robot was started every iteration.
+
+Enabling/disabling this setting here will enable it for this test groups
+
 ##### Agent Filter
 You can use this setting to modify the default [agent assignment](#agent-assignment) to require test cases to require agents with particular properties or to exclude agents with particular properties.
 
@@ -172,7 +206,7 @@ Here are some examples of when you might need this setting:
 The combination of multiple require and exclude rules, the default and custom agent properties should allow you to have the control needed to target your test groups to specific agent or groups of agents as needed.
 
 Here is an example of configuring the Filter Rules and using the Robot options:
-> ![image](Images/MacOS_Plan_v0.8.0_Test_Settings_Filter_Rules.png)
+> ![image](Images/Linux_Plan_v1.2.0_Test_Settings_Filter_Rules.png)
 
 
 ### Run

Doc/rfswarm_reporter.md

@@ -13,6 +13,7 @@ rfswarm Reporter is the reporting tool component, you would use this at some poi
     - [Note](#note-section)
     - [Data Graph](#data-graph-section)
     - [Data Table](#data-table-section)
+		- [Error Details](#error-details)
   - [Example Report](#example-report)
 - [Command-line Interface](#command-line-interface)
 - [Install and Setup](#install-and-setup)
@@ -120,6 +121,7 @@ Each section is used to display different types of information, the various sect
 - [Note](#note-section)
 - [Data Graph](#data-graph-section)
 - [Data Table](#data-table-section)
+- [Error Details](#error-details)
 
 #### Heading Section
 The heading section is used for grouping subsections that contain related information, so the only setting here is the heading name which allows you to change the name of the section.
@@ -220,6 +222,8 @@ The data table section is used for displaying tables of test results and other m
 
 > ![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:
 - [Metric](#data-table-metric)
 - [Result](#data-table-result)
@@ -295,6 +299,18 @@ When constructing the SQL for graphs, it's important to note that the column nam
 Also note that **Show graph colours** will use values of the first data column to match the colours for each table row to the line colours on a graph.
 > ![Image](Images/MacOS_Reporter_v1.0.0_DataTable_SQL.png)
 
+#### Error Details Section
+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)
+
+**Show screenshots** - If the test library takes screen shots 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.
+
+**Group by error text** - This setting will group all errors with the same or similar first line, for example if you get 50 stack traces when the AUT server crashed, you may not want to see the full text of all the stack traces, you just want an example stack trace and a count of how many stack traces were received. If selected only the detail (and screenshot) of the first error will be displayed, if you want to see the detail of every error unselect this option.
+
+**Rename Labels** - This section allows you to change the default English labels, to another name you prefer or the equivalent in your preferred language
+
 ### Example Report
 This is an example of a template you could create and use for reporting your test results. It shows some of the capabilities of the reporting tool.
 > ![Image](Images/MacOS_Reporter_v1.0.0_Example_Report.png)