{"id":10545,"date":"2019-01-28T04:34:19","date_gmt":"2019-01-28T09:34:19","guid":{"rendered":"https:\/\/qxf2.com\/blog\/?p=10545"},"modified":"2019-01-28T06:26:56","modified_gmt":"2019-01-28T11:26:56","slug":"sending-images-and-log-messages-to-reportportal","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/sending-images-and-log-messages-to-reportportal\/","title":{"rendered":"Sending images and log messages to ReportPortal"},"content":{"rendered":"

Problem:<\/strong> There is not much information on how to send or attach images to ReportPortal<\/a><\/p>\n

\n

Why this post?<\/h3>\n

We started using ReportPortal for reporting automation test results. Along with the test results we also need to send log messages and images\/screenshot to ReportPortal. These are useful artifacts which help people monitoring them check the success and failure reasons and take necessary actions.<\/p>\n

We were not able to find information on how to send a screenshot to ReportPortal easily and had to spend some time to get it going. So this blog post is to share our knowledge on how to send the images to ReportPortal using pytest.<\/p>\n

Note:<\/strong> This is in continuation to our previous post on ReportPortal integration with pytestnd pytest markers<\/a><\/p>\n

\n

How to send logs and images to ReportPortal<\/h3>\n

1. Sending log messages<\/strong>
\nThe agent-python-pytest<\/a> plugin provides a python logging handle which can be used in conftest.py file.<\/p>\n

@pytest.fixture(scope=\"session\")\r\ndef rp_logger(request):\r\n    import logging\r\n    # Import Report Portal logger and handler to the test module.\r\n    from pytest_reportportal import RPLogger, RPLogHandler\r\n    # Setting up a logging.\r\n    logging.setLoggerClass(RPLogger)\r\n    logger = logging.getLogger(__name__)\r\n    logger.setLevel(logging.DEBUG)\r\n    # Create handler for Report Portal.\r\n    rp_handler = RPLogHandler(request.node.config.py_test_service)\r\n    # Set INFO level for Report Portal handler.\r\n    rp_handler.setLevel(logging.INFO)\r\n    return logger\r\n<\/pre>\n
We can then use the rp_logger<\/em> in tests to send log messages easily.<\/p>\n
def test_launch_success(rp_logger):\r\n    rp_logger.info(\"A GUI test. Launch Qxf2.com\")\r\n<\/pre>\n
2. Sending screenshot<\/strong>
\nWe can use the same method rp_logger<\/em> along with the attachment details to send image to ReportPortal. We need to pass the image_name which will be the name of the image in ReportPortal, data which is the image and the mime<\/a> type.<\/p>\n
rp_logger.info(\r\n            image_name,\r\n            attachment={\r\n                \"data\": image,\r\n                \"mime\": \"application\/octet-stream\"\r\n            },\r\n        )\r\n<\/pre>\n
We have created a separate method save_screenshot_reportportal() which takes in an image and sends it to ReportPortal. We also need to open the .png(binary file) before sending the image file.<\/p>\n
Below is the complete code for the test file.<\/p>\n
# Sample test to load Qxf2.com and send image to ReportPortal\r\n\r\nimport pytest\r\nfrom selenium import webdriver\r\n\r\n@pytest.mark.gui_test()\r\ndef test_launch_success(rp_logger):\r\n    \"Launch Qxf2 and save image\"\r\n    # Log message to ReportPortal\r\n    rp_logger.info(\"GUI Test. Launch Qxf2.com\")\r\n    driver = webdriver.Chrome()\r\n    driver.get(\"https:\/\/qxf2.com\")\r\n    image_name = \"Test_Launch_Success\"\r\n    driver.save_screenshot(image_name+'.png')\r\n    # Save screenshot to ReportPortal\r\n    save_screenshot_reportportal(rp_logger,image_name)\r\n\r\n\r\ndef save_screenshot_reportportal(rp_logger,image_name):\r\n    \"Method to save image to ReportPortal\"\r\n    try:\r\n        with open(image_name+'.png', \"rb\") as fh:\r\n            image = fh.read()\r\n        \r\n        rp_logger.info(\r\n            image_name,\r\n            attachment={\r\n                \"data\": image,\r\n                \"mime\": \"application\/octet-stream\"\r\n            },\r\n        )\r\n    except Exception as e:\r\n        print(\"Exception when trying to save screenshot to reportportal: %s\" %str(e))\r\n\r\n\r\n@pytest.mark.api_test()\r\ndef test_api():\r\n    print (\"API Test\")\r\n    pass\r\n\r\n<\/pre>\n
3. Running the test<\/strong>
\nWe can use the same conftest file mentioned in the previous post<\/a> by adding the rp_logger method mentioned in step 1 and run the test<\/p>\n
\"ReportPortal_Test_Run\"<\/a><\/p>\n
\"ReportPortal_Attachment\"<\/a><\/p>\n
There we go, we now have our screenshots and log messages attached in ReportPortal. Enjoy testing and reporting…<\/p>\n
\n
References:<\/h3>\n
1. ReportPortal python client<\/a>
\n2. agent-python-pytest<\/a><\/p>\n
\n","protected":false},"excerpt":{"rendered":"
Problem: There is not much information on how to send or attach images to ReportPortal Why this post? We started using ReportPortal for reporting automation test results. Along with the test results we also need to send log messages and images\/screenshot to ReportPortal. These are useful artifacts which help people monitoring them check the success and failure reasons and take […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[107,18,181],"tags":[],"class_list":["post-10545","post","type-post","status-publish","format-standard","hentry","category-pytest","category-python","category-reportportal"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/10545","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=10545"}],"version-history":[{"count":13,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/10545\/revisions"}],"predecessor-version":[{"id":10620,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/10545\/revisions\/10620"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=10545"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=10545"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=10545"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}