robotframework-reportportal 5.6.5

Agent for reporting RobotFramework test results to ReportPortal

ReportPortal integration for RobotFramework

A RobotFramework Listener to report test results to ReportPortal

DISCLAIMER: We use Google Analytics for sending anonymous usage information such as agent's and client's names, and their versions after a successful launch start. This information might help us to improve both ReportPortal backend and client sides. It is used by the ReportPortal team only and is not supposed for sharing with 3rd parties.

• Installation
• Usage
• Send attachement (screenshots)
• Integration with GA
• Copyright Notice

Installation

First you need to install RobotFramework:

pip install robotframework

The latest stable version of library is available on PyPI:

pip install robotframework-reportportal

Usage

Properties

For reporting results to ReportPortal you need to pass some variables to robot run:

Required:

These variable should be specified in either case:

--listener robotframework_reportportal.listener
--variable RP_ENDPOINT:"your_reportportal_url"
--variable RP_LAUNCH:"launch_name"
--variable RP_PROJECT:"reportportal_project_name"

And also one type of authorization is required: API Key or OAuth 2.0 Password grant:

--variable RP_API_KEY:"your_user_api_key"
    - You can get it in the User Profile section on the UI.

Or:

--variable RP_OAUTH_URI:"https://reportportal.example.com/uat/sso/oauth/token"
    - OAuth 2.0 token endpoint URL for password grant authentication. **Required** if API key is not used.
--variable RP_OAUTH_USERNAME:"my_username"
    - OAuth 2.0 username for password grant authentication. **Required** if OAuth 2.0 is used.
--variable RP_OAUTH_PASSWORD:"my_password"
    - OAuth 2.0 password for password grant authentication. **Required** if OAuth 2.0 is used.
--variable RP_OAUTH_CLIENT_ID:"client_id"
    - OAuth 2.0 client identifier. **Required** if OAuth 2.0 is used.
--variable RP_OAUTH_CLIENT_SECRET:"client_id_secret"
    - OAuth 2.0 client secret. **Optional** for OAuth 2.0 authentication.
--variable RP_OAUTH_SCOPE:"offline_access"
    - OAuth 2.0 access token scope. **Optional** for OAuth 2.0 authentication.

Optional:

--variable RP_CLIENT_TYPE:"SYNC"
    - Type of the under-the-hood ReportPortal client implementation. Possible values: [SYNC, ASYNC_THREAD, ASYNC_BATCHED].
--variable RP_LAUNCH_UUID:"id_of_existing_rp_launch"
    - ID of existing ReportPortal launch
--variable RP_LAUNCH_DOC:"some_documentation_for_launch"
    - Description for the launch
--variable RP_LAUNCH_ATTRIBUTES:"RF tag_name:tag_value"
    - Space-separated list of tags/attributes for the launch
--variable RP_LAUNCH_UUID_PRINT:"True"
    - Default value is "False", enables printing Launch UUID on test run start.
--variable RP_LAUNCH_UUID_PRINT_OUTPUT:"stderr"
    - Default value is "stdout", Launch UUID print output. Possible values: [stderr, stdout].
--variable RP_TEST_ATTRIBUTES:"key1:value1 key1:value2 tag key2:value3"
    - Space-separated list of tags/attributes for the tests
--variable RP_CONNECT_TIMEOUT:"20"
    - Default value is "10.0", connection timeout to ReportPortal server.
--variable RP_READ_TIMEOUT:"20"
    - Default value is "10.0", response read timeout for ReportPortal connection.
--variable RP_LOG_BATCH_SIZE:"10"
    - Default value is "20", affects size of async batch log requests
--variable RP_LOG_BATCH_PAYLOAD_LIMIT:"10240000"
    - Default value is "65000000", maximum payload size of async batch log requests
--variable RP_RERUN:"True"
    - Default is "False". Enables rerun mode for the last launch.
--variable RP_RERUN_OF:"xxxxx-xxxx-xxxx-lauch-uuid"
    - Default is "None". Enables rerun mode for the launch with the specified
      UUID. Should be used in combination with the RP_RERUN option.
--variable RP_SKIPPED_ISSUE:"True"
    - Default value is "True", marks skipped test items with 'To Investigate'
--variable RP_ATTACH_LOG:"True"
    - Default value is "False", attaches Robot Framework HTML log file to
      the launch.
--variable RP_ATTACH_REPORT:"True"
    - Default value is "False", attaches Robot Framework HTML report file to
      the launch.
--variable RP_ATTACH_XUNIT:"True"
    - Default value is "False", attaches Robot Framework XUnit result file to
      the launch.
--variable RP_VERIFY_SSL:"True"
    - Default value is "True", disables SSL verification for HTTP requests.
      Also, you can specify a full path to your certificate as the value.
--variable RP_REMOVE_KEYWORDS:"True"
    - Default value is "False", remove  keywords from reporting, passed with '--remove-keywords' Robot's argument.
--variable RP_FLATTEN_KEYWORDS:"True"
    - Default value is "False", flatten keywords on reporting, passed with '--flatten-keywords' Robot's argument.

Logging

Custom logger which supports attachments can be used in Python keywords. Usage of this logger is similar to the standard robot.api.logger with addition of an extra kwarg "attachment":

import subprocess
from robotframework_reportportal import logger


def log_free_memory():
    logger.debug("Collecting free memory statistics!")
    logger.debug(
        "Memory consumption report",
        attachment={
            "name": "free_memory.txt",
            "data": subprocess.check_output("free -h".split()),
            "mime": "text/plain",
        },
    )

Test case ID

It's possible to tag tests the following way test_case_id:12345 using default Robot Framework tagging functionality. ID specified after : will be sent to ReportPortal.

Send attachment (screenshots)

https://github.com/reportportal/client-Python#send-attachement-screenshots

Copyright Notice

Licensed under the Apache 2.0 license (see the LICENSE.txt file).