Implement interface for collection of the system information

Author: Anton Lysenko

reportportal_client/service.py

@@ -14,12 +14,13 @@
 limitations under the License.
 """
 
-
 import collections
 import json
 import requests
 import uuid
 import logging
+import pkg_resources
+import platform
 
 import six
 from requests.adapters import HTTPAdapter
@@ -42,14 +43,15 @@ def _convert_string(value):
     return str(value)
 
 
-def _list_to_payload(dictionary):
+def _dict_to_payload(dictionary):
     """Convert dict to list of dicts.
 
     :param dictionary: initial dict
     :return list: list of dicts
     """
+    system = dictionary.pop("system", False)
     return [
-        {"key": key, "value": _convert_string(value)}
+        {"key": key, "value": _convert_string(value), "system": system}
         for key, value in sorted(dictionary.items())
     ]
 
@@ -206,7 +208,7 @@ def start_launch(self,
                      **kwargs):
         """Start a new launch with the given parameters."""
         if attributes is not None:
-            attributes = _list_to_payload(attributes)
+            attributes = _dict_to_payload(attributes)
         data = {
             "name": name,
             "description": description,
@@ -261,9 +263,9 @@ def start_test_item(self,
             }
         """
         if attributes:
-            attributes = _list_to_payload(attributes)
+            attributes = _dict_to_payload(attributes)
         if parameters:
-            parameters = _list_to_payload(parameters)
+            parameters = _dict_to_payload(parameters)
 
         data = {
             "name": name,
@@ -309,7 +311,7 @@ def finish_test_item(self,
             issue = {"issue_type": "NOT_ISSUE"}
 
         if attributes:
-            attributes = _list_to_payload(attributes)
+            attributes = _dict_to_payload(attributes)
 
         data = {
             "endTime": end_time,
@@ -426,3 +428,28 @@ def log_batch(self, log_data, item_id=None):
         logger.debug("log_batch response: %s", r.text)
 
         return _get_data(r)
+
+    @staticmethod
+    def get_system_information(agent_name='agent_name'):
+        """
+        Get system information about agent, os, cpu, system, etc.
+
+        :param agent_name: Name of the agent: pytest-reportportal,
+                              roborframework-reportportal,
+                              nosetest-reportportal,
+                              behave-reportportal
+        :return: dict {'agent': pytest-pytest 5.0.5,
+                       'os': 'Windows',
+                       'cpu': 'AMD',
+                       'machine': "Windows10_pc"}
+        """
+        try:
+            agent_version = pkg_resources.get_distribution(agent_name)
+            agent = '{0}-{1}'.format(agent_name, agent_version)
+        except pkg_resources.DistributionNotFound:
+            agent = 'not found'
+
+        return {'agent': agent,
+                'os': platform.system(),
+                'cpu': platform.processor(),
+                'machine': platform.machine()}

tests/test_service.py

@@ -1,19 +1,21 @@
 """This modules includes unit tests for the service.py module."""
 
-
 from datetime import datetime
-from six.moves import mock
+from pkg_resources import DistributionNotFound
 
 from delayed_assert import expect, assert_expectations
+import pytest
+from six.moves import mock
 
 from reportportal_client.service import (
     _convert_string,
+    _dict_to_payload,
     _get_data,
     _get_id,
     _get_json,
     _get_messages,
     _get_msg,
-    _list_to_payload
+    ReportPortalService
 )
 
 
@@ -26,12 +28,13 @@ def test_check_convert_to_string(self):
         expect(lambda: isinstance(_convert_string("Hello world"), str))
         assert_expectations()
 
-    def test_list_to_payload(self):
-        """Test convert dict to list of dicts."""
-        initial_dict = {'key': "value", 'key1': 'value1'}
-        expected_list = [{'key': 'key', 'value': 'value'},
-                         {'key': 'key1', 'value': 'value1'}]
-        assert _list_to_payload(initial_dict) == expected_list
+    @pytest.mark.parametrize('system', [True, False])
+    def test_dict_to_payload_with_system_key(self, system):
+        """Test convert dict to list of dicts with key system."""
+        initial_dict = {"aa": 1, "b": 2, "system": system}
+        expected_list = [{'key': 'aa', 'value': '1', 'system': system},
+                         {'key': 'b', 'value': '2', 'system': system}]
+        assert _dict_to_payload(initial_dict) == expected_list
 
     def test_get_id(self, response):
         """Test for the get_id function."""
@@ -82,3 +85,37 @@ def test_finish_launch(self, mock_get, rp_service):
         mock_get.return_value = {"id": 111}
         _get_msg = rp_service.finish_launch('name', datetime.now().isoformat())
         assert _get_msg == {"id": 111}
+
+    @mock.patch('platform.system', mock.Mock(return_value='linux'))
+    @mock.patch('platform.machine', mock.Mock(return_value='Windows-PC'))
+    @mock.patch('platform.processor', mock.Mock(return_value='amd'))
+    @mock.patch('pkg_resources.get_distribution',
+                mock.Mock(return_value='pytest 5.0'))
+    def test_get_system_information(self):
+        """Test for validate get_system_information."""
+
+        expected_result = {'agent': 'pytest-pytest 5.0',
+                           'cpu': 'amd',
+                           'machine': 'Windows-PC',
+                           'os': 'linux'}
+
+        cond = (ReportPortalService.get_system_information('pytest')
+                == expected_result)
+        assert cond
+
+    @mock.patch('platform.system', mock.Mock(return_value='linux'))
+    @mock.patch('platform.machine', mock.Mock(return_value='Windows-PC'))
+    @mock.patch('platform.processor', mock.Mock(return_value='amd'))
+    @mock.patch('pkg_resources.get_distribution',
+                mock.Mock(side_effect=DistributionNotFound))
+    def test_get_system_information_without_pkg(self):
+        """Test in negative form for validate get_system_information."""
+
+        expected_result = {'agent': 'not found',
+                           'cpu': 'amd',
+                           'machine': 'Windows-PC',
+                           'os': 'linux'}
+
+        cond = (ReportPortalService.get_system_information('pytest')
+                == expected_result)
+        assert cond