Common artributes' generator for agents.

Author: iivanou

reportportal_client/helpers.py

@@ -0,0 +1,46 @@
+"""This module contains common functions-helpers of the client and agents.
+
+Copyright (c) 2018 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
+
+logger = logging.getLogger(__name__)
+
+
+def gen_attributes(rp_attributes):
+    """Generate list of attributes for the API request.
+
+    Example of input list:
+    ['tag_name:tag_value1', 'tag_value2']
+    Output of the function for the given input list:
+    [{'key': 'tag_name', 'value': 'tag_value1'}, {'value': 'tag_value2'}]
+
+    :param rp_attributes: List of attributes(tags)
+    :return:              Correctly created list of dictionaries
+                          to be passed to RP
+    """
+    attrs = []
+    for rp_attr in rp_attributes:
+        try:
+            key, value = rp_attr.split(':')
+            attr_dict = {'key': key, 'value': value}
+        except ValueError as exc:
+            logger.exception(str(exc))
+            attr_dict = {'value': rp_attr}
+
+        if all(attr_dict.values()):
+            attrs.append(attr_dict)
+            continue
+        logger.debug('Failed to process "{0}" attribute, attribute value'
+                     ' should not be empty.'.format(rp_attr))
+    return attrs

reportportal_client/helpers.pyi

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

setup.py

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

tests/test_helpers.py

@@ -0,0 +1,10 @@
+"""This modules contains unit tests for the helpers module."""
+
+from reportportal_client.helpers import gen_attributes
+
+
+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