Merge pull request #319 from ppodgorsek/feature/install-datetimetz

* Update Dockerfile
* Update README.md

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

Author: ppodgorsek

.github/workflows/docker-build.yml

@@ -72,3 +72,6 @@ jobs:
       - name: Custom User and Group Test
         run:
           docker run --user=2000:2000 --shm-size=1g -v `pwd`/test:/opt/robotframework/tests:Z -e BROWSER=$BROWSER $IMAGE_NAME
+      - name: Datetime
+        run:
+          docker run --user=2000:2000 --shm-size=1g -v `pwd`/test:/opt/robotframework/tests:Z -e BROWSER=$BROWSER -e TZ="America/New_York" $IMAGE_NAME

Dockerfile

@@ -17,6 +17,9 @@ ENV SCREEN_COLOUR_DEPTH 24
 ENV SCREEN_HEIGHT 1080
 ENV SCREEN_WIDTH 1920
 
+# Setup the timezone to use, defaults to UTC
+ENV TZ UTC
+
 # Set number of threads for parallel execution
 # By default, no parallelisation
 ENV ROBOT_THREADS 1
@@ -29,6 +32,7 @@ ENV ROBOT_GID 1000
 ENV ALPINE_GLIBC 2.31-r0
 ENV CHROMIUM_VERSION 86.0
 ENV DATABASE_LIBRARY_VERSION 1.2
+ENV DATETIMETZ_VERSION 1.0.6
 ENV FAKER_VERSION 5.0.0
 ENV FIREFOX_VERSION 78
 ENV FTP_LIBRARY_VERSION 1.9
@@ -63,6 +67,7 @@ RUN apk update \
     "chromium-chromedriver~$CHROMIUM_VERSION" \
     "firefox-esr~$FIREFOX_VERSION" \
     xauth \
+    tzdata \
     "xvfb-run~$XVFB_VERSION" \
   && mv /usr/lib/chromium/chrome /usr/lib/chromium/chrome-original \
   && ln -sfv /opt/robotframework/bin/chromium-browser /usr/lib/chromium/chrome \
@@ -73,6 +78,7 @@ RUN apk update \
     --no-cache-dir \
     robotframework==$ROBOT_FRAMEWORK_VERSION \
     robotframework-databaselibrary==$DATABASE_LIBRARY_VERSION \
+    robotframework-datetime-tz==$DATETIMETZ_VERSION \
     robotframework-faker==$FAKER_VERSION \
     robotframework-ftplibrary==$FTP_LIBRARY_VERSION \
     robotframework-imaplibrary2==$IMAP_LIBRARY_VERSION \
@@ -99,6 +105,7 @@ RUN apk update \
     && mv geckodriver /opt/robotframework/drivers/geckodriver \
     && rm geckodriver-$GECKO_DRIVER_VERSION-linux64.tar.gz \
 
+# Clean up buildtime dependencies
   && apk del --no-cache --update-cache .build-deps
 
 # Create the default report and work folders with the default user to avoid runtime issues

README.md

@@ -17,6 +17,7 @@ The versions used are:
 
 * [Robot Framework](https://github.com/robotframework/robotframework) 3.2.2
 * [Robot Framework DatabaseLibrary](https://github.com/franz-see/Robotframework-Database-Library) 1.2
+* [Robot Framework DateTimeTZ](https://github.com/testautomation/DateTimeTZ) 1.0.6
 * [Robot Framework Faker](https://github.com/guykisel/robotframework-faker) 5.0.0
 * [Robot Framework FTPLibrary](https://github.com/kowalpy/Robot-Framework-FTP-Library) 1.9
 * [Robot Framework IMAPLibrary 2](https://pypi.org/project/robotframework-imaplibrary2/) 0.3.8
@@ -92,6 +93,16 @@ This project includes the IMAP library which allows Robot Framework to connect t
 
 A suggestion to automate email testing is to run a [Mailcatcher instance in Docker which allows IMAP connections](https://github.com/estelora/docker-mailcatcher-imap). This will ensure emails are discarded once the tests have been run.
 
+### Dealing with Datetimes and Timezones
+
+This project is meant to allow your tests to run anywhere. Sometimes that can be in a different timezone than your local one or of the location under test. To help solve such issues, this image includes the [DateTimeTZ Library](https://testautomation.github.io/DateTimeTZ/doc/DateTimeTZ.html).
+
+To set the timezone used inside the Docker image, you can set the `TZ` environment variable:
+
+    docker run \
+        -e TZ=America/New_York \
+        ppodgorsek/robot-framework:latest
+
 ## Security consideration
 
 By default, containers are implicitly run using `--user=1000:1000`, please remember to adjust that command-line setting accordingly, for example:

test/faker.robot

@@ -56,6 +56,4 @@ Can call Password
     ${pass}=    Password    5823    ${True}    ${False}    ${True}    ${True}
     Length Should Be    ${pass}    5823
     ${pass}=    Password    ${5823}    ${True}    ${False}    ${True}    ${True}
-    Length Should Be    ${pass}    5823
-
-*** Keywords ***
+    Length Should Be    ${pass}    5823

test/timezones.robot

@@ -0,0 +1,9 @@
+*** Settings ***
+Force Tags        timezone
+Test Timeout      1 minute
+Library           DateTimeTZ
+
+*** Test Cases ***
+Get Time with Datetime
+    ${ts}=    Get Timestamp
+    Set Test Message	${ts}