Add reporting to GA

Author: iivanou

README.rst

@@ -12,6 +12,7 @@ Pytest plugin for reporting test results of Pytest to the Reportal Portal.
 * Launching
 * Send attachement (screenshots)
 * Troubleshooting
+* Integration with GA
 * Copyright Notice
 
 Usage
@@ -253,6 +254,17 @@ deactivate :code:`pytest_reportportal` plugin with command like:
     py.test -p no:pytest_reportportal ./tests
 
 
+Integration with GA
+-------------------
+ReportPortal is now supporting integrations with more than 15 test frameworks simultaneously. In order to define the most popular agents and plan the team workload accordingly, we are using Google analytics.
+
+ReportPortal collects information about agent name and its version only. This information is sent to Google analytics on the launch start. Please help us to make our work effective.
+If you still want to switch Off Google analytics, please change env variable the way below.
+
+.. code-block:: bash
+
+    export ALLURE_NO_ANALYTICS=1
+
 
 Copyright Notice
 ----------------

pytest_reportportal/helpers.py

@@ -10,11 +10,13 @@
 import pytest
 import requests
 import time
+
 from pytest_reportportal import LAUNCH_WAIT_TIMEOUT
 from reportportal_client.errors import ResponseError
+from reportportal_client.helpers import gen_attributes
+
 from .service import PyTestServiceClass
 from .listener import RPReportListener
-from .helpers import get_attributes
 
 try:
     # This try/except can go away once we support pytest >= 3.3
@@ -88,7 +90,7 @@ def pytest_sessionstart(session):
             session.config.py_test_service.rp = None
             return
 
-        attributes = get_attributes(
+        attributes = gen_attributes(
             session.config.getini('rp_launch_attributes'))
         session.config.py_test_service.start_launch(
             session.config.option.rp_launch,

pytest_reportportal/plugin.py

@@ -1,6 +1,7 @@
 """This module includes Service functions for work with pytest agent."""
 
 import logging
+from os import getenv
 import sys
 import traceback
 from time import time
@@ -27,11 +28,16 @@
 from _pytest.unittest import TestCaseFunction, UnitTestCase
 
 from reportportal_client import ReportPortalService
+from reportportal_client.external.google_analytics import send_event
+from reportportal_client.helpers import (
+    gen_attributes,
+    get_launch_sys_attrs,
+    get_package_version
+)
 from reportportal_client.service import _dict_to_payload
 from six import with_metaclass
 from six.moves import queue
 
-from .helpers import get_attributes
 
 log = logging.getLogger(__name__)
 
@@ -95,12 +101,14 @@ class PyTestServiceClass(with_metaclass(Singleton, object)):
 
     def __init__(self):
         """Initialize instance attributes."""
-        self._agent_name = 'pytest-reportportal'
         self._errors = queue.Queue()
         self._hier_parts = {}
         self._issue_types = {}
         self._item_parts = {}
         self._loglevels = ('TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR')
+        self._skip_analytics = getenv('ALLURE_NO_ANALYTICS')
+        self.agent_name = 'pytest-reportportal'
+        self.agent_version = get_package_version(self.agent_name)
         self.ignore_errors = True
         self.ignored_attributes = []
         self.log_batch_size = 20
@@ -189,6 +197,8 @@ def start_launch(self,
         log.debug('ReportPortal - Start launch: request_body=%s', sl_pt)
         item_id = self.rp.start_launch(**sl_pt)
         log.debug('ReportPortal - Launch started: id=%s', item_id)
+        if not self._skip_analytics:
+            send_event(self.agent_name, self.agent_version)
         return item_id
 
     def collect_tests(self, session):
@@ -604,12 +614,10 @@ def _get_launch_attributes(self, ini_attrs):
         :param list ini_attrs: List for attributes from the pytest.ini file
         """
         attributes = ini_attrs or []
-
-        system_info = self.rp.get_system_information(self._agent_name)
-        system_info['system'] = True
-        system_attributes = _dict_to_payload(system_info)
-
-        return attributes + system_attributes
+        system_attributes = get_launch_sys_attrs()
+        system_attributes['agent'] = (
+            '{}-{}'.format(self.agent_name, self.agent_version))
+        return attributes + _dict_to_payload(system_attributes)
 
     def _get_item_markers(self, item):
         """
@@ -639,7 +647,7 @@ def get_marker_value(item, keyword):
                      for k in item.keywords if get_marker(k) is not None
                      and k not in self.ignored_attributes]
         raw_attrs.extend(item.session.config.getini('rp_tests_attributes'))
-        return get_attributes(raw_attrs)
+        return gen_attributes(raw_attrs)
 
     def _get_parameters(self, item):
         """

pytest_reportportal/service.py

@@ -1,4 +1,4 @@
 dill>=0.2.7.1
 pytest>=3.0.7
-reportportal-client>=5.0.3
-six>=1.13.0
+reportportal-client>=5.0.6
+six>=1.15.0

requirements.txt

@@ -5,7 +5,7 @@
 from setuptools import setup
 
 
-__version__ = '5.0.5'
+__version__ = '5.0.6'
 
 
 def read_file(fname):