Code reference bypass

Author: HardNorth

reportportal_client/service.py

@@ -258,6 +258,7 @@ def start_test_item(self,
                         parameters=None,
                         parent_item_id=None,
                         has_stats=True,
+                        code_ref=None,
                         **kwargs):
         """
         Item_type can be.
@@ -287,7 +288,8 @@ def start_test_item(self,
             "launchUuid": self.launch_id,
             "type": item_type,
             "parameters": parameters,
-            "hasStats": has_stats
+            "hasStats": has_stats,
+            "codeRef": code_ref
         }
         if parent_item_id:
             url = uri_join(self.base_url_v2, "item", parent_item_id)

requirements.txt

@@ -0,0 +1,4 @@
+requests>=2.23.0
+six
+pytest
+delayed-assert

setup.py

@@ -4,6 +4,9 @@
 
 __version__ = '5.0.4'
 
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
 setup(
     name='reportportal-client',
     packages=find_packages(),
@@ -22,5 +25,5 @@
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8'
     ],
-    install_requires=['requests>=2.4.2', 'six']
+    install_requires=requirements
 )

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
 
-from delayed_assert import assert_expectations, expect
 import pytest
+from delayed_assert import assert_expectations, expect
+from pkg_resources import DistributionNotFound
 from six.moves import mock
 
 from reportportal_client.service import (
@@ -24,40 +24,40 @@ class TestServiceFunctions:
 
     def test_check_convert_to_string(self):
         """Test for support and convert strings to utf-8."""
-        expect(_convert_string("Hello world") == 'Hello world')
-        expect(lambda: isinstance(_convert_string("Hello world"), str))
+        expect(_convert_string('Hello world') == 'Hello world')
+        expect(lambda: isinstance(_convert_string('Hello world'), str))
         assert_expectations()
 
     @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}
+        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."""
-        assert _get_id(response(200, {"id": 123})) == 123
+        assert _get_id(response(200, {'id': 123})) == 123
 
     def test_get_msg(self, response):
         """Test for the get_msg function."""
-        fake_json = {"id": 123}
+        fake_json = {'id': 123}
         assert _get_msg(response(200, fake_json)) == fake_json
 
     def test_get_data(self, response):
         """Test for the get_data function."""
-        fake_json = {"id": 123}
+        fake_json = {'id': 123}
         assert _get_data(response(200, fake_json)) == fake_json
 
     def test_get_json(self, response):
         """Test for the get_json function."""
-        fake_json = {"id": 123}
+        fake_json = {'id': 123}
         assert _get_json(response(200, fake_json)) == fake_json
 
     def test_get_messages(self):
         """Test for the get_messages function."""
-        data = {"responses": [{"errorCode": 422, "message": "error"}]}
+        data = {'responses': [{'errorCode': 422, 'message': 'error'}]}
         assert _get_messages(data) == ['422: error']
 
 
@@ -71,7 +71,7 @@ def test_start_launch(self, mock_get, rp_service):
         :param mock_get:   Mocked _get_data() function
         :param rp_service: Pytest fixture
         """
-        mock_get.return_value = {"id": 111}
+        mock_get.return_value = {'id': 111}
         launch_id = rp_service.start_launch('name', datetime.now().isoformat())
         assert launch_id == 111
 
@@ -82,10 +82,10 @@ def test_finish_launch(self, mock_get, rp_service):
         :param mock_get:   Mocked _get_msg() function
         :param rp_service: Pytest fixture
         """
-        mock_get.return_value = {"id": 111}
+        mock_get.return_value = {'id': 111}
         _get_msg = rp_service.finish_launch(
             'name', datetime.now().isoformat())
-        assert _get_msg == {"id": 111}
+        assert _get_msg == {'id': 111}
 
     @mock.patch('platform.system', mock.Mock(return_value='linux'))
     @mock.patch('platform.machine', mock.Mock(return_value='Windows-PC'))
@@ -131,3 +131,70 @@ def test_get_system_information_without_pkg(self):
         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):
+        """Test for validate start_test_item.
+
+        :param: rp_service: fixture of ReportPortal
+        """
+        rp_start = rp_service.start_test_item(name='name',
+                                              start_time=1591032041348,
+                                              item_type='STORY')
+        expected_result = dict(json={'name': 'name',
+                                     'description': None,
+                                     'attributes': None,
+                                     'startTime': 1591032041348,
+                                     'launchUuid': 111,
+                                     'type': 'STORY', 'parameters': None,
+                                     'hasStats': True,
+                                     'codeRef': None},
+                               url='http://endpoint/api/v2/project/item',
+                               verify=True)
+
+        rp_service.session.post.assert_called_with(**expected_result)
+        assert rp_start == 123
+
+    start_item_optional = [
+        ('code_ref', '/path/to/test - test_item', 'codeRef',
+         '/path/to/test - test_item'),
+        ('attributes', {'attr1': True}, 'attributes',
+         [{'key': 'attr1', 'value': 'True', 'system': False}])
+    ]
+
+    @pytest.mark.parametrize(
+        'field_name,field_value,expected_name,expected_value',
+        start_item_optional)
+    @mock.patch('reportportal_client.service._get_data',
+                mock.Mock(return_value={'id': 123}))
+    def test_start_item_code_optional_params(self, rp_service, field_name,
+                                             field_value, expected_name,
+                                             expected_value):
+        """Test for validate different fields in start_test_item.
+
+        :param: rp_service:     fixture of ReportPortal
+        :param: field_name:     a name of a field bypassed to
+        rp_service.start_test_item method
+        :param: field_value:    a value of a  field bypassed to
+        rp_service.start_test_item method
+        :param: expected_name:  a name of a field which should be in the result
+        JSON request
+        :param: expected_value: an exact value of a field which should be in
+        the result JSON request
+        """
+        rp_service.start_test_item(name='name', start_time=1591032041348,
+                                   item_type='STORY',
+                                   **{field_name: field_value})
+        expected_result = dict(json={'name': 'name',
+                                     'description': None,
+                                     'attributes': None,
+                                     'startTime': 1591032041348,
+                                     'launchUuid': 111,
+                                     'type': 'STORY', 'parameters': None,
+                                     'hasStats': True,
+                                     'codeRef': None},
+                               url='http://endpoint/api/v2/project/item',
+                               verify=True)
+        expected_result['json'][expected_name] = expected_value
+        rp_service.session.post.assert_called_with(**expected_result)