Issue #322 - Automatically upload reports to AWS S3 after each execution (#321)

* Ensure the output directory exists when the test run ID is set
* Optionally upload test reports to S3

Co-authored-by: Paul Podgorsek <[email protected]>

Author: Nilsty

Dockerfile

@@ -30,6 +30,7 @@ ENV ROBOT_GID 1000
 
 # Dependency versions
 ENV ALPINE_GLIBC 2.31-r0
+ENV AWS_CLI_VERSION 1.18.200
 ENV CHROMIUM_VERSION 86.0
 ENV DATABASE_LIBRARY_VERSION 1.2
 ENV DATETIMETZ_VERSION 1.0.6
@@ -45,6 +46,9 @@ ENV SELENIUM_LIBRARY_VERSION 4.5.0
 ENV SSH_LIBRARY_VERSION 3.5.1
 ENV XVFB_VERSION 1.20
 
+# By default, no reports are uploaded to AWS S3
+ENV AWS_UPLOAD_TO_S3 false
+
 # Prepare binaries to be executed
 COPY bin/chromedriver.sh /opt/robotframework/bin/chromedriver
 COPY bin/chromium-browser.sh /opt/robotframework/bin/chromium-browser
@@ -88,6 +92,9 @@ RUN apk update \
     robotframework-sshlibrary==$SSH_LIBRARY_VERSION \
     PyYAML \
 
+# Install awscli to be able to upload test reports to AWS S3
+    awscli==$AWS_CLI_VERSION \
+
 # Download the glibc package for Alpine Linux from its GitHub repository
   && wget -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub \
     && wget -q "https://github.com/sgerrand/alpine-pkg-glibc/releases/download/$ALPINE_GLIBC/glibc-$ALPINE_GLIBC.apk" \

README.md

@@ -27,6 +27,7 @@ The versions used are:
 * [Robot Framework SSHLibrary](https://github.com/robotframework/SSHLibrary) 3.5.1
 * Firefox ESR 78
 * Chromium 86.0
+* [Amazon AWS CLI](https://pypi.org/project/awscli/) 1.18.200
 
 As stated by [the official GitHub project](https://github.com/robotframework/Selenium2Library), starting from version 3.0, Selenium2Library is renamed to SeleniumLibrary and this project exists mainly to help with transitioning. The Selenium2Library 3.0.0 is also the last release and for new releases, please look at the [SeleniumLibrary](https://github.com/robotframework/SeleniumLibrary) project.
 
@@ -159,6 +160,33 @@ The pipeline stage can also rely on a Docker agent, as shown in the example belo
         }
     }
 
+### Defining a test run ID
+
+When relying on Continuous Integration tools, it can be useful to define a test run ID such as the build number or branch name to avoid overwriting consecutive execution reports.
+
+For that purpose, the `ROBOT_TEST_RUN_ID` variable was introduced:
+* If the test run ID is empty, the reports folder will be: `${ROBOT_REPORTS_DIR}/`
+* If the test run ID was provided, the reports folder will be: `${ROBOT_REPORTS_DIR}/${ROBOT_TEST_RUN_ID}/`
+
+It can simply be passed during the execution, such as:
+
+    docker run \
+        -e ROBOT_TEST_RUN_ID="feature/branch-name" \
+        ppodgorsek/robot-framework:latest
+
+By default, the test run ID is empty.
+
+### Upload test reports to an AWS S3 bucket
+
+To upload the report of a test run to an S3 bucket, you need to define the following environment variables:
+    
+    docker run \
+        -e AWS_ACCESS_KEY_ID=<your AWS key> \
+        -e AWS_SECRET_ACCESS_KEY=<your AWS secret> \
+        -e AWS_DEFAULT_REGION=<your AWS region e.g. eu-central-1> \
+        -e AWS_BUCKET_NAME=<name of your S3 bucket> \
+        ppodgorsek/robot-framework:latest
+
 ## Testing this project
 
 Not convinced yet? Simple tests have been prepared in the `test/` folder, you can run them using the following commands:

bin/run-tests-in-virtual-screen.sh

@@ -2,13 +2,30 @@
 
 HOME=${ROBOT_WORK_DIR}
 
+if [ "${ROBOT_TEST_RUN_ID}" = "" ]
+then
+    ROBOT_REPORTS_FINAL_DIR="${ROBOT_REPORTS_DIR}"
+else
+    REPORTS_DIR_HAS_TRAILING_SLASH=`echo ${ROBOT_REPORTS_DIR} | grep '/$'`
+
+    if [ ${REPORTS_DIR_HAS_TRAILING_SLASH} -eq 0 ]
+    then
+        ROBOT_REPORTS_FINAL_DIR="${ROBOT_REPORTS_DIR}${ROBOT_TEST_RUN_ID}"
+    else
+        ROBOT_REPORTS_FINAL_DIR="${ROBOT_REPORTS_DIR}/${ROBOT_TEST_RUN_ID}"
+    fi
+fi
+
+# Ensure the output folder exists
+mkdir -p ${ROBOT_REPORTS_FINAL_DIR}
+
 # No need for the overhead of Pabot if no parallelisation is required
 if [ $ROBOT_THREADS -eq 1 ]
 then
     xvfb-run \
         --server-args="-screen 0 ${SCREEN_WIDTH}x${SCREEN_HEIGHT}x${SCREEN_COLOUR_DEPTH} -ac" \
         robot \
-        --outputDir $ROBOT_REPORTS_DIR \
+        --outputDir $ROBOT_REPORTS_FINAL_DIR \
         ${ROBOT_OPTIONS} \
         $ROBOT_TESTS_DIR
 else
@@ -18,7 +35,14 @@ else
         --verbose \
         --processes $ROBOT_THREADS \
         ${PABOT_OPTIONS} \
-        --outputDir $ROBOT_REPORTS_DIR \
+        --outputDir $ROBOT_REPORTS_FINAL_DIR \
         ${ROBOT_OPTIONS} \
         $ROBOT_TESTS_DIR
 fi
+
+if [ ${AWS_UPLOAD_TO_S3} = true ]
+then
+    echo "Uploading report to AWS S3..."
+    aws s3 sync $ROBOT_REPORTS_FINAL_DIR/ s3://${AWS_BUCKET_NAME}/robot-reports/
+    echo "Reports have been successfully uploaded to AWS S3!"
+fi