Implement sending events to GA

Author: iivanou

reportportal_client/external/__init__.py

@@ -0,0 +1,16 @@
+"""This package contains handles connections with external services.
+
+Copyright (c) 2020 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""

reportportal_client/external/constants.py

@@ -0,0 +1,33 @@
+"""This module contains constants for the external services.
+
+Copyright (c) 2020 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import base64
+
+
+def _decode_string(text):
+    """Decode value of the given string.
+
+    :param text: Encoded string
+    :return:     Decoded value
+    """
+    base64_bytes = text.encode('ascii')
+    message_bytes = base64.b64decode(base64_bytes)
+    return message_bytes.decode('ascii')
+
+
+GA_INSTANCE = _decode_string('VUEtMTczNDU2ODA5LTE=')
+GA_ENDPOINT = 'https://www.google-analytics.com/collect'

reportportal_client/external/constants.pyi

@@ -0,0 +1,6 @@
+from typing import Text
+
+def _decode_string(text: Text) -> Text: ...
+
+GA_INSTANCE: Text
+GA_ENDPOINT: Text

reportportal_client/external/google_analytics.py

@@ -0,0 +1,63 @@
+"""This modules contains interfaces for communications with GA.
+
+Copyright (c) 2020 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import logging
+from pkg_resources import get_distribution
+import requests
+from uuid import uuid4
+
+from .constants import GA_INSTANCE, GA_ENDPOINT
+
+logger = logging.getLogger(__name__)
+
+
+def _get_client_info():
+    """Get name of the client and its version.
+
+    :return: ('reportportal-client', '5.0.4')
+    """
+    client = get_distribution('reportportal-client')
+    return client.project_name, client.version
+
+
+def send_event(agent_name, agent_version):
+    """Send an event to GA about client and agent versions with their names.
+
+    :param agent_name:    Name of the agent that uses the client
+    :param agent_version: Version of the agent
+    """
+    client_name, client_version = _get_client_info()
+    payload = {
+        'v': '1',
+        'tid': GA_INSTANCE,
+        'aip': '1',
+        'cid': str(uuid4()),
+        't': 'event',
+        'ec': 'Client name "{}", version "{}"'.format(
+            client_name, client_version
+        ),
+        'ea': 'Start launch',
+        'el': 'Agent name "{}", version "{}"'.format(
+            agent_name, agent_version
+        )
+    }
+    headers = {'User-Agent': 'Universal Analytics'}
+    try:
+        return requests.post(url=GA_ENDPOINT, data=payload, headers=headers)
+    except requests.exceptions.RequestException as err:
+        logger.debug('Failed to send data to Google Analytics: %s',
+                     str(err))

reportportal_client/external/google_analytics.pyi

@@ -0,0 +1,10 @@
+from logging import Logger
+import requests
+from .constants import GA_ENDPOINT as GA_ENDPOINT, GA_INSTANCE as GA_INSTANCE
+from typing import Text
+
+logger: Logger
+
+def _get_client_info() -> tuple: ...
+
+def send_event(agent_name: Text, agent_version: Text) -> requests.Response: ...

tests/test_analytics.py

@@ -0,0 +1,70 @@
+"""This module contains unit tests for analytics used in the project.
+
+Copyright (c) 2020 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from requests.exceptions import RequestException
+
+from six.moves import mock
+
+from reportportal_client.external.constants import GA_ENDPOINT, GA_INSTANCE
+from reportportal_client.external.google_analytics import send_event
+
+
+@mock.patch('reportportal_client.external.google_analytics.uuid4',
+            mock.Mock(return_value=555))
+@mock.patch('reportportal_client.external.google_analytics.requests.post')
+@mock.patch('reportportal_client.external.google_analytics.get_distribution')
+def test_send_event(mocked_distribution, mocked_requests):
+    """Test functionality of the send_event() function.
+
+    :param mocked_distribution: Mocked get_distribution() function
+    :param mocked_requests:     Mocked requests module
+    """
+    expected_cl_version, expected_cl_name = '5.0.4', 'reportportal-client'
+    agent_version, agent_name = '5.0.5', 'pytest-reportportal'
+    mocked_distribution.return_value.version = expected_cl_version
+    mocked_distribution.return_value.project_name = expected_cl_name
+
+    expected_headers = {'User-Agent': 'Universal Analytics'}
+
+    expected_data = {
+        'v': '1',
+        'tid': GA_INSTANCE,
+        'aip': '1',
+        'cid': '555',
+        't': 'event',
+        'ec': 'Client name "{}", version "{}"'.format(
+            expected_cl_name, expected_cl_version
+        ),
+        'ea': 'Start launch',
+        'el': 'Agent name "{}", version "{}"'.format(
+            agent_name, agent_version
+        )
+    }
+    send_event(agent_name, agent_version)
+    mocked_requests.assert_called_with(
+        url=GA_ENDPOINT, data=expected_data, headers=expected_headers)
+
+
+@mock.patch('reportportal_client.external.google_analytics.uuid4',
+            mock.Mock(return_value=555))
+@mock.patch('reportportal_client.external.google_analytics.requests.post',
+            mock.Mock(side_effect=RequestException))
+@mock.patch('reportportal_client.external.google_analytics.get_distribution',
+            mock.Mock())
+def test_send_event_raises():
+    """Test that the send_event() does not raise exceptions."""
+    send_event('pytest-reportportal', '5.0.5')

tests/test_service.py

@@ -1,10 +1,10 @@
 """This modules includes unit tests for the service.py module."""
 
 from datetime import datetime
+from pkg_resources import DistributionNotFound
 
-import pytest
 from delayed_assert import assert_expectations, expect
-from pkg_resources import DistributionNotFound
+import pytest
 from six.moves import mock
 
 from reportportal_client.service import (