Move functionality for getting system info to helpers

Author: iivanou

reportportal_client/helpers.py

@@ -13,6 +13,8 @@
 """
 
 import logging
+from pkg_resources import DistributionNotFound, get_distribution
+from platform import machine, processor, system
 
 logger = logging.getLogger(__name__)
 
@@ -44,3 +46,31 @@ def gen_attributes(rp_attributes):
         logger.debug('Failed to process "{0}" attribute, attribute value'
                      ' should not be empty.'.format(rp_attr))
     return attrs
+
+
+def get_launch_sys_attrs():
+    """Generate attributes for the launch containing system information.
+
+    :return: dict {'os': 'Windows',
+                   'cpu': 'AMD',
+                   'machine': 'Windows10_pc'}
+    """
+    return {
+        'os': system(),
+        'cpu': processor() or 'unknown',
+        'machine': machine(),
+        'system': True  # This one is the flag for RP to hide these attributes
+    }
+
+
+def get_package_version(package_name):
+    """Get version of the given package.
+
+    :param package_name: Name of the package
+    :return:             Version of the package
+    """
+    try:
+        package_version = get_distribution(package_name).version
+    except DistributionNotFound:
+        package_version = 'not found'
+    return package_version

reportportal_client/helpers.pyi

@@ -1,6 +1,10 @@
 from logging import Logger
-from typing import Dict, List
+from typing import Dict, List, Text
 
 logger: Logger
 
 def gen_attributes(rp_attributes: List) -> List[Dict]: ...
+
+def get_launch_sys_attrs() -> Dict[Text]: ...
+
+def get_package_version(package_name: Text) -> Text: ...

reportportal_client/service.py

@@ -20,8 +20,6 @@
 import requests
 import uuid
 import logging
-import pkg_resources
-import platform
 
 import six
 from six.moves.collections_abc import Mapping
@@ -532,29 +530,3 @@ def log_batch(self, log_data, item_id=None, force=False):
                     continue
                 else:
                     raise
-
-    @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).version
-            agent = '{0}-{1}'.format(agent_name, agent_version)
-        except pkg_resources.DistributionNotFound:
-            agent = 'not found'
-
-        return {'agent': agent,
-                'os': platform.system(),
-                'cpu': platform.processor() or 'unknown',
-                'machine': platform.machine()}

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup, find_packages
 
-__version__ = '5.0.5'
+__version__ = '5.0.6'
 
 with open('requirements.txt') as f:
     requirements = f.read().splitlines()

tests/test_helpers.py

@@ -1,10 +1,51 @@
 """This modules contains unit tests for the helpers module."""
 
-from reportportal_client.helpers import gen_attributes
+from six.moves import mock
+
+from reportportal_client.helpers import (
+    gen_attributes,
+    get_launch_sys_attrs,
+    get_package_version
+)
 
 
 def test_gen_attributes():
     """Test functionality of the gen_attributes function."""
     expected_out = [{'value': 'Tag'}, {'key': 'Key', 'value': 'Value'}]
     out = gen_attributes(['Tag', 'Key:Value', ''])
     assert expected_out == out
+
+
+@mock.patch('reportportal_client.helpers.system',
+            mock.Mock(return_value='linux'))
+@mock.patch('reportportal_client.helpers.machine',
+            mock.Mock(return_value='Windows-PC'))
+@mock.patch('reportportal_client.helpers.processor',
+            mock.Mock(return_value='amd'))
+def test_get_launch_sys_attrs():
+    """Test for validate get_launch_sys_attrs function."""
+    expected_result = {'cpu': 'amd',
+                       'machine': 'Windows-PC',
+                       'os': 'linux',
+                       'system': True}
+    assert get_launch_sys_attrs() == expected_result
+
+
+@mock.patch('reportportal_client.helpers.system', mock.Mock())
+@mock.patch('reportportal_client.helpers.machine', mock.Mock())
+@mock.patch('reportportal_client.helpers.processor',
+            mock.Mock(return_value=''))
+def test_get_launch_sys_attrs_docker():
+    """Test that cpu key value is not empty.
+
+    platform.processor() returns empty string in case it was called
+    inside of the Docker container. API does not allow empty values
+    for the attributes.
+    """
+    result = get_launch_sys_attrs()
+    assert result['cpu'] == 'unknown'
+
+
+def test_get_package_version():
+    """Test for the get_package_version() function-helper."""
+    assert get_package_version('noname') == 'not found'

tests/test_service.py

@@ -1,7 +1,6 @@
 """This modules includes unit tests for the service.py module."""
 
 from datetime import datetime
-from pkg_resources import DistributionNotFound
 
 from delayed_assert import assert_expectations, expect
 import pytest
@@ -14,8 +13,7 @@
     _get_id,
     _get_json,
     _get_messages,
-    _get_msg,
-    ReportPortalService
+    _get_msg
 )
 
 
@@ -236,51 +234,6 @@ def test_get_launch_ui_url_no_id(self, rp_service, monkeypatch):
         assert url == '{0}/ui/#{1}/launches/all'.format(rp_service.endpoint,
                                                         rp_service.project)
 
-    @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')
-    def test_get_system_information(self, distro):
-        """Test for validate get_system_information."""
-        distro.return_value.version = '5.0'
-        expected_result = {'agent': 'reportportal-client-5.0',
-                           'cpu': 'amd',
-                           'machine': 'Windows-PC',
-                           'os': 'linux'}
-        cond = (ReportPortalService.get_system_information(
-            'reportportal-client') == expected_result)
-        assert cond
-
-    @mock.patch('platform.system', mock.Mock())
-    @mock.patch('platform.machine', mock.Mock())
-    @mock.patch('platform.processor', mock.Mock(return_value=''))
-    @mock.patch('pkg_resources.get_distribution', mock.Mock())
-    def test_get_system_information_docker(self):
-        """Test that cpu key value is not empty.
-
-        platform.processor() returns empty string in case it was called
-        inside of the Docker container. API does not allow empty values
-        for the attributes.
-        """
-        result = ReportPortalService.get_system_information('pytest')
-        assert result['cpu'] == 'unknown'
-
-    @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
-
     @mock.patch('reportportal_client.service._get_data',
                 mock.Mock(return_value={'id': 123}))
     def test_start_item(self, rp_service):