Make it possible to add item attributes as key/value pairs, not just values

Author: el0ny

pytest_reportportal/helpers.py

@@ -0,0 +1,27 @@
+"""This module includes help functions for both plugin and service modules."""
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def get_attributes(rp_attributes):
+    """Generate list of attributes for RP.
+
+    :param list rp_attributes: rp_attributes option value
+    :return list:                     List of dictionaries to be passed to the
+                                      RP Python client
+    """
+    attrs = []
+    for rp_attr in rp_attributes:
+        try:
+            key, value = rp_attr.split(':')
+            attr_dict = {'key': key, 'value': value}
+        except ValueError:
+            attr_dict = {'value': rp_attr}
+
+        if all(value for value in attr_dict.values()):
+            attrs.append(attr_dict)
+            continue
+        log.debug('Failed to process "{0}" attribute, attribute value'
+                  ' should not be empty.'.format(rp_attr))
+    return attrs

pytest_reportportal/plugin.py

@@ -14,6 +14,7 @@
 from reportportal_client.errors import ResponseError
 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
@@ -41,29 +42,6 @@ def is_master(config):
     return not hasattr(config, 'slaveinput')
 
 
-def get_launch_attributes(rp_launch_attributes):
-    """Generate list of launch attributes for RP.
-
-    :param list rp_launch_attributes: rp_launch_attributes option value
-    :return list:                     List of dictionaries to be passed to the
-                                      RP Python client
-    """
-    launch_attrs = []
-    for rp_attr in rp_launch_attributes:
-        try:
-            key, value = rp_attr.split(':')
-            attr_dict = {'key': key, 'value': value}
-        except ValueError:
-            attr_dict = {'value': rp_attr}
-
-        if all(value for value in attr_dict.values()):
-            launch_attrs.append(attr_dict)
-            continue
-        log.debug('Failed to process "{0}" attribute, attribute value'
-                  ' should not be empty.'.format(rp_attr))
-    return launch_attrs
-
-
 @pytest.mark.optionalhook
 def pytest_configure_node(node):
     """
@@ -110,7 +88,7 @@ def pytest_sessionstart(session):
             session.config.py_test_service.rp = None
             return
 
-        attributes = get_launch_attributes(
+        attributes = get_attributes(
             session.config.getini('rp_launch_attributes'))
         session.config.py_test_service.start_launch(
             session.config.option.rp_launch,

pytest_reportportal/service.py

@@ -31,6 +31,8 @@
 from six import with_metaclass
 from six.moves import queue
 
+from .helpers import get_attributes
+
 log = logging.getLogger(__name__)
 
 
@@ -630,13 +632,12 @@ def get_marker_value(item, keyword):
             get_marker = getattr(item, "get_closest_marker")
         except AttributeError:
             get_marker = getattr(item, "get_marker")
-        attributes = [{"value": get_marker_value(item, k)}
-                      for k in item.keywords if get_marker(k) is not None
-                      and k not in self.ignored_attributes]
 
-        attributes.extend([{"value": tag} for tag in
-                           item.session.config.getini('rp_tests_attributes')])
-        return attributes
+        raw_attrs = [get_marker_value(item, k)
+                     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)
 
     def _get_parameters(self, item):
         """

tests/test_helpers.py

@@ -0,0 +1,10 @@
+"""This modules includes unit tests for helpers."""
+
+from pytest_reportportal.helpers import get_attributes
+
+
+def test_get__attributes():
+    """Test get_attributes functionality."""
+    expected_out = [{'value': 'Tag'}, {'key': 'Key', 'value': 'Value'}]
+    out = get_attributes(['Tag', 'Key:Value', ''])
+    assert expected_out == out

tests/test_plugin.py

@@ -9,7 +9,6 @@
 
 from reportportal_client.errors import ResponseError
 from pytest_reportportal.plugin import (
-    get_launch_attributes,
     pytest_configure,
     pytest_sessionstart
 )
@@ -78,13 +77,6 @@ def test_uuid_env_var_override(mocked_session):
     assert kwargs.get('uuid') == 'foobar'
 
 
-def test_get_launch_attributes():
-    """Test get_launch_attributes functionality."""
-    expected_out = [{'value': 'Tag'}, {'key': 'Key', 'value': 'Value'}]
-    out = get_launch_attributes(['Tag', 'Key:Value', ''])
-    assert expected_out == out
-
-
 def test_portal_on_maintenance(mocked_session):
     """
     Test if portal on maintenance.

tests/test_service.py

@@ -12,13 +12,20 @@ def test_item_attributes(mocked_item, rp_service):
 
     def getini(option):
         if option == 'rp_tests_attributes':
-            return ['ini_marker']
+            return ['ini_marker', 'test_ini_key:test_ini_value']
 
     def get_closest_marker(name):
-        return {'test_marker': pytest.mark.test_marker}.get(name)
+        return {'test_marker': pytest.mark.test_marker,
+                'test_decorator_key':
+                    pytest.mark.test_decorator_key('test_decorator_value')
+                }.get(name)
 
     class NodeKeywords(object):
-        _keywords = ['pytestmark', 'ini_marker', 'test_marker']
+        _keywords = ['pytestmark',
+                     'ini_marker',
+                     'test_marker',
+                     'test_decorator_key',
+                     'test_ini_key']
 
         def __iter__(self):
             return iter(self._keywords)
@@ -27,7 +34,12 @@ def __iter__(self):
     mocked_item.keywords = NodeKeywords()
     mocked_item.get_closest_marker = get_closest_marker
     markers = rp_service._get_item_markers(mocked_item)
-    assert markers == [{'value': 'test_marker'}, {'value': 'ini_marker'}]
+    assert markers == [{'value': 'test_marker'},
+                       {'key': 'test_decorator_key',
+                        'value': 'test_decorator_value'},
+                       {'value': 'ini_marker'},
+                       {'key': 'test_ini_key',
+                        'value': 'test_ini_value'}]
 
 
 def test_get_item_parameters(mocked_item, rp_service):
@@ -45,7 +57,7 @@ def test_get_item_parameters(mocked_item, rp_service):
 @mock.patch('reportportal_client.service.ReportPortalService.start_test_item')
 def test_code_ref_bypass(mocked_item_start, mocked_item, mocked_session,
                          rp_service):
-    """ Test that a test code reference constructed and bypassed to a client
+    """ Test that a test code reference constructed and bypassed to a client.
 
     :param mocked_item_start: mocked start_test_item method reference
     :param mocked_item:       a mocked test item