From 434ec965d5b598351e609cbca3200042b9677e49 Mon Sep 17 00:00:00 2001
From: garciadeblas <gerardo.garciadeblas@telefonica.com>
Date: Thu, 23 Jun 2022 14:00:01 +0200
Subject: [PATCH] Add instructions in README to post-process Robot output files

Change-Id: Iface2d03e3b2fcb02c4bd22aa690584e9afdccbf
Signed-off-by: garciadeblas <gerardo.garciadeblas@telefonica.com>
---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f7245e6..7eff36f 100644
--- a/README.md
+++ b/README.md
@@ -91,7 +91,7 @@ robot -d reports -i <testing_tags> testsuite/
 
 ### From docker container
 
-It is possible to run the tests directly from the repository or using a docker container with the tests
+It is possible to run the tests directly from the repository or using a docker container with the tests.
 
 Create the docker container:
 
@@ -203,6 +203,34 @@ to destroy the deployments immediately, the following tags are used:
   check the behavior executing with the "verify" tag. Finally, use the "cleanup"
   tag. 
 
+## Post-processing Robot output files
+
+The output files of Robot include tyipically three files:
+
+- `report.html`: overview of the test execution results in HTML format
+- `log.html`: details about the executed test cases in HTML format
+- `output.xml`: all the test execution results in machine readable XML format
+
+More information about these files [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#output-file).
+
+It is possible to use the tool `rebot`, included as part of the Robot Framework, to post-process the output file `output.xml`.
+
+```bash
+# To re-generate log and report from output.xml:
+rebot [-d <output_folder>] output.xml
+
+# To re-generate log and report (and optionally new output.xml) to include only certain tags:
+rebot [-d <output_folder>] -i <tag1> -i <tag2> ... -i <tagN> [-o <new_output_xml>] output.xml
+
+# To re-generate log and report (and optionally new output.xml) excluding certain tags:
+rebot [-d <output_folder>] -e <tag1> -e <tag2> ... -e <tagN> [-o <new_output_xml>] output.xml
+
+# To merge several test executions:
+rebot [-d <output_folder>] --merge output1.xml output2.xml ... outputN.xml
+```
+
+More information about post-processing Robot output files [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#post-processing-outputs)
+
 ## Built With
 
 * [Python](www.python.org/) - The language used
-- 
2.25.1