ReportPortal.io

• ReportPortal.io
  • Repositories structure
    • ReportPortal high level architecture
    • ReportPortal repositories structure
  • Installation steps
    • Simple setup with Docker
    • Production-ready set and Custom deployment with Docker
  • Integration. How to get log data in
  • Contribution
  • Documentation
  • Community / Support
  • License

Repositories structure

ReportPortal high level architecture

ReportPortal repositories structure

Report Portal organized into multiple repositories.

ReportPortal server side consists of the following services:

• service-authorization Authorization Service. In charge of access tokens distribution
• service-api API Service. Application Backend
• service-ui UI Service. Application Frontend
• service-index Index Service. Info and health checks per service.
• service-analyzer Analyzer Service. Finds most relevant test fail problem.
• gateway Traefik Gateway Service. Main entry point to application. Port used by gateway should be opened and accessible from outside network.
• rabbitmq Load balancer for client requests. Bus for messages between servers.
• minio Attachments storage.

Available plugins developed by ReportPortal team:

• plugin-bts-jira JIRA Plugin. Interaction with JIRA. Link to download
• plugin-bts-rally Rally Plugin. Interaction with Rally. Link to download
• plugin-saucelabs Sauce Labs Plugin. Interaction with Sauce Labs. Link to download

Client side adapters related repositories:

• client-* - API integrations. Http clients, which process HTTP request sending.
• agent-* - Frameworks integration. Custom reporters/listeners, which monitor test events and trigger event sending via client-*
• logger-* - Logging integration. Logger appenders, which help to collect logs, bind it with test-case item via agent-* and send to server via client-*

Other repositories stored according to next rules

• service-* - micro-services which are a part of Application
• commons-* - common libraries, models, etc., used by micro-services

Installation steps

Simple setup with Docker

It's the best way for demo purposes and small teams. The database is already in the docker-compose.

1. Install Docker (Engine, Compose)

2. Download Example of docker-compose descriptor to any folder

3. Deploy ReportPortal using docker compose plugin within the same folder

docker compose -p reportportal up

To start ReportPortal in daemon mode, add '-d' argument:

docker compose -p reportportal up -d

1. Open in your browser IP address of deployed environment at port 8080

http://IP_ADDRESS:8080

1. Use next login\pass for access:

• default\1q2w3e
• superadmin\erebus.

Please change admin password for security.

Mentioned compose file deploy all available Bug Tracking System integrations, which not always needed, but use resources.

Production-ready set and Custom deployment with Docker

For production usage, we recommend:

• choose only required Bug Tracking System integration service. Exclude the rest

To customize deployment and make it production-ready please follow customization steps and details

Integration. How to get log data in

You should add Client Side code inside your test automation. It consists of:

• client-* - API integrations. Http clients, which process HTTP request sending. E.g. for Java (client-java-*)
• agent-* - Frameworks integration. Custom reporters/listeners, which monitor test events and trigger event sending via client-*
• logger-* - Logging integration. Logger appenders, which helps to collect logs, bind it with test-case via agent-* and send to server via client-*

Integration steps and documentation

Contribution

There are many different ways to contribute to Report Portal's development, just find the one that best fits with your skills. Examples of contributions we would love to receive include:

• Code patches
• Documentation improvements
• Translations
• Bug reports
• Patch reviews
• UI enhancements

Big features are also welcome but if you want to see your contributions included in Report Portal codebase we strongly recommend you start by initiating a chat through our Team in Slack.

Contribution details

Documentation

• User Manual
• Wiki and Guides
• Docker Compose Guide - Comprehensive guide for Docker Compose deployment, environment variables, anchors, and submodules
• S3 Storage on EC2 with Docker - Guide for setting up S3 storage on AWS EC2 with Docker

Community / Support

• Slack chat
• Security Advisories
• GitHub Issues
• Stackoverflow Questions
• Twitter
• YouTube Channel

License

Report Portal is Apache 2.0.