/robot-framework-reporting

Primary LanguageHTMLApache License 2.0Apache-2.0

robot-framework-reporting

This repository demonstrates multiple approaches towards reporting and monitoring of Robot Framework test results.

It will be used to demonstrate the following:

  • Using the Results Package of the Robot Framework API to generate custom reports
  • Creating a Markdown report for GitHub Actions
  • Publishing Test Results to a PosgreSQL database and visualizing the results using Grafana
  • Using a Listener to capture test results and publish them to InfluxDB and visualize the results using Grafana
  • Using Allure to generate a visually appealing report
  • Sending notifications to Slack and MS Teams using Apprise
  • Using ReportPortal to publish test results and visualize them

Open the project in Gitpod.io

Open in Gitpod
Try it out in Gitpod

Try it out in Google CoLab

Try it out in CoLab
Try it out in CoLab

Structure of the repository

The repository is structured as follows:

The repository is structured into the following sections:

  • 01_resultmodel:
    This section demonstrates how to use the ExecutionResult and ResultVisitor of the Robot Framework API to generate custom reports.

    1. Run some Robot Framework tests and produce an output.xml
    2. Run python 01_resultmodel/report-results.py <PathToOutput.xml> <PathToMarkdownFile> to generate a markdown report

  • 02_report_to_postgres:
    This section demonstrates how to publish test results to a PostgreSQL database and visualize the results using Grafana.

    1. Start the docker scripts (from project root)
      1. create_network.sh
      2. start_postgres.sh
      3. start_grafana.sh
    2. cd 02_report_to_postgres
    3. Run send_results.sh to send multiple test results to postgres
    4. Open localhost:3000 to login to Grafana and check the PostgreSQL Dashboard

  • 03_allure:
    This section demonstrates how to use Allure to generate a visually appealing report.

  • 04_listener_influxdb:
    This section demonstrates how to use a Listener to monitor test execution in realtime and publish them to InfluxDB and visualize the results using Grafana.

    1. Start the docker scripts (from project root)
      1. create_network.sh (if not already done)
      2. start_influxdb.sh
      3. start_grafana.sh (if not already done)
    2. Run 04_listener_influxdb/run_with_listener.sh from project root to execute tests and send results in real-time
    3. Open localhost:3000 to login to Grafana and check the InfluxDB Dashboard

  • 05_notifications:
    This section demonstrates how to send notifications to Slack and MS Teams using Apprise.

    1. Set up Webhook for MS Teams or Slack Channel
    2. Run some Robot Framework tests and produce an output.xml
    3. Adjust the 05_notifications/report_to_msteams.pyand 05_notifications/report_to_slack.py to your needs (output.xml path the Webhook data is current hardcoded)
    4. Run 05_notifications/report_to_msteams.pyor 05_notifications/report_to_slack.py and try send notifications to your Teams/Slack Channel

  • 06_reportportal:
    This section demonstrates how to publish test results to ReportPortal and visualize them.

    1. Run your own Report Portal instance using the 06_reportportal/docker-compose.yml
    cd 06_reportportal
docker-compose -p reportportal up -d --force-recreate

    or register for a trial at Report Portal
    2. Set up a user, a project (e.g. robocon-io) and generate an API Token for your user 3. Adjust and Run 06_reportportal/run_and_publish.sh from project root to run tests and publish them to Report Portal

Docker Containers for PostgreSQL, InfluxDB and Grafana

For the examples in folders 02_report_to_postgres and 04_listener_influxdb to work, you need to have PostgreSQL, InfluxDB and Grafana running.

You can find starter scripts to run PostgreSQL, InfluxDB and Grafana in Docker containers in the docker directory.

  • create_network.sh creates a Docker network with the name robot
    This is necessary to allow the containers to communicate with each other.
  • start_postgres.sh starts a PostgreSQL container with the name postgres
    • User: postgres
    • Password: robotframework
  • start_influxdb.sh starts an InfluxDB container with the name influxdb
    • User: admin
    • Password: my-password
    • Organization: robotframework
    • Bucket: results
  • start_grafana.sh starts a Grafana container with the name grafana
    Datasources for PostgreSQL and InfluxDB are created automatically.
    • User: admin
    • Password: robocon