Merge pull request #138 from iivanou/ssl_verification

Add ability to disable SSL verification

Author: HardNorth

README.md

@@ -80,6 +80,9 @@ NOT REQUIRED:
 --variable RP_ATTACH_XUNIT:"True"
     - Default value is "False", attaches Robot Framework XUnit result file to
       the launch.
+--variable RP_VERIFY_SSL:"True"
+    - Default value is "True", disables SSL verification for HTTP requests.
+      Also, you can specify a full path to your certificate as the value.
 ```
 
 Custom logger which supports attachments can be used in Python keywords.

robotframework_reportportal/listener.py

@@ -103,7 +103,8 @@ def service(self):
                 uuid=self.variables.uuid,
                 log_batch_size=self.variables.log_batch_size,
                 pool_size=self.variables.pool_size,
-                skipped_issue=self.variables.skipped_issue
+                skipped_issue=self.variables.skipped_issue,
+                verify_ssl=self.variables.verify_ssl
             )
         return self._service
 

robotframework_reportportal/service.py

@@ -68,7 +68,7 @@ def _get_launch_attributes(self, cmd_attrs):
         return attributes + _dict_to_payload(system_attributes)
 
     def init_service(self, endpoint, project, uuid, log_batch_size, pool_size,
-                     skipped_issue=True):
+                     skipped_issue=True, verify_ssl=True):
         """Initialize common reportportal client.
 
         :param endpoint:       Report Portal API endpoint
@@ -78,6 +78,7 @@ def init_service(self, endpoint, project, uuid, log_batch_size, pool_size,
         :param pool_size:      HTTPAdapter max pool size
         :param skipped_issue   Mark skipped test items with 'To Investigate',
                                default value 'True'
+        :param verify_ssl:     Disable SSL verification
         """
         if self.rp is None:
             logger.debug(
@@ -90,7 +91,9 @@ def init_service(self, endpoint, project, uuid, log_batch_size, pool_size,
                 token=uuid,
                 log_batch_size=log_batch_size,
                 max_pool_size=pool_size,
-                is_skipped_an_issue=skipped_issue)
+                is_skipped_an_issue=skipped_issue,
+                verify_ssl=verify_ssl
+            )
         else:
             raise RobotServiceException(
                 'RobotFrameworkService is already initialized.')

robotframework_reportportal/service.pyi

@@ -1,7 +1,7 @@
 from logging import Logger
 from reportportal_client.service import ReportPortalService
 from .model import Keyword as Keyword, Launch as Launch, LogMessage as LogMessage, Suite as Suite, Test as Test
-from typing import List, Optional, Text
+from typing import List, Optional, Text, Union
 
 logger: Logger
 
@@ -13,7 +13,7 @@ class RobotService:
     rp: Optional[ReportPortalService] = ...
     def __init__(self) -> None: ...
     def _get_launch_attributes(self, cmd_attrs: List) -> List: ...
-    def init_service(self, endpoint: Text, project: Text, uuid: Text, log_batch_size: int, pool_size: int, skipped_issue:bool) -> None: ...
+    def init_service(self, endpoint: Text, project: Text, uuid: Text, log_batch_size: int, pool_size: int, skipped_issue: bool, verify_ssl: Union[Text, bool]) -> None: ...
     def terminate_service(self) -> None: ...
     def start_launch(self, launch: Launch, mode: Optional[Text] = ..., rerun: bool = ...,
                      rerun_of: Optional[Text] = ..., ts: Optional[Text] = ..., skip_analytics: Optional[bool] = ...) -> Text: ...

robotframework_reportportal/variables.py

@@ -12,7 +12,7 @@
 limitations under the License.
 """
 
-from os import getenv
+from os import getenv, path
 from distutils.util import strtobool
 
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
@@ -145,3 +145,11 @@ def uuid(self):
                 'Missing parameter RP_UUID for robot run\n'
                 'You should pass -v RP_UUID:<uuid_value>')
         return self._uuid
+
+    @property
+    def verify_ssl(self):
+        """Get value of the verify_ssl parameter for the client."""
+        verify_ssl = get_variable('RP_VERIFY_SSL', default='True')
+        if path.exists(verify_ssl):
+            return verify_ssl
+        return bool(strtobool(verify_ssl))

robotframework_reportportal/variables.pyi

@@ -1,10 +1,16 @@
-from typing import Dict, List, Optional, Text
+from typing import Dict, List, Optional, Text, Union
 
 _variables: Dict
 
 def get_variable(name: Text, default: Optional[Text] = ...) -> Optional[Text]: ...
 
 class Variables:
+    _endpoint: Optional[Text] = ...
+    _launch_name: Optional[Text] = ...
+    _pabot_pool_id: Optional[int] = ...
+    _pabot_used: Optional[Text] = ...
+    _project: Optional[Text] = ...
+    _uuid: Optional[Text] = ...
     attach_log: bool = ...
     attach_report: bool = ...
     attach_xunit: bool = ...
@@ -27,8 +33,10 @@ class Variables:
     @property
     def pabot_pool_id(self) -> int: ...
     @property
-    def pabot_used(self) -> Optional[str]: ...
+    def pabot_used(self) -> Optional[Text]: ...
     @property
     def project(self) -> Text: ...
     @property
     def uuid(self) -> Text: ...
+    @property
+    def verify_ssl(self) -> Union[bool, Text]: ...

tests/unit/conftest.py

@@ -19,6 +19,7 @@
 from six.moves import mock
 
 from robotframework_reportportal.listener import listener
+from robotframework_reportportal.variables import Variables
 from robotframework_reportportal.result_visitor import RobotResultsVisitor
 
 
@@ -27,13 +28,15 @@ def visitor():
     return RobotResultsVisitor()
 
 
+@mock.patch('robotframework_reportportal.variables.strtobool', mock.Mock())
+@mock.patch('robotframework_reportportal.variables.get_variable', mock.Mock())
 @fixture()
 def mock_variables():
-    mock_variables = mock.Mock()
-    mock_variables.endpoint = "http://localhost:8080"
-    mock_variables.launch_name = "Robot"
-    mock_variables.project = "default_personal"
-    mock_variables.uuid = "test_uuid"
+    mock_variables = Variables()
+    mock_variables._endpoint = "http://localhost:8080"
+    mock_variables._launch_name = "Robot"
+    mock_variables._project = "default_personal"
+    mock_variables._uuid = "test_uuid"
     mock_variables.launch_attributes = ''
     mock_variables.launch_id = None
     mock_variables.launch_doc = None
@@ -43,7 +46,7 @@ def mock_variables():
     mock_variables.skip_analytics = None
     mock_variables.test_attributes = []
     mock_variables.skip_analytics = True
-    mock_variables.pabot_used = None
+    mock_variables._pabot_used = False
     mock_variables.skipped_issue = True
     return mock_variables
 

tests/unit/test_listener.py

@@ -123,11 +123,37 @@ def test_skipped_issue_variable_bypass(self, mock_client_init,
         mock_variables.skipped_issue = skipped_issue_value
         mock_listener = listener()
         mock_listener._variables = mock_variables
-        mock_listener.service
+        _ = mock_listener.service
         assert mock_client_init.call_count == 1
         args, kwargs = mock_client_init.call_args
         assert kwargs['is_skipped_an_issue'] == skipped_issue_value
 
+    @mock.patch('robotframework_reportportal.variables.get_variable')
+    @mock.patch(REPORT_PORTAL_SERVICE)
+    @pytest.mark.parametrize(
+        'get_var_value, verify_ssl_value, path_exists_value', [
+            ('True', True, False),
+            ('False', False, False),
+            ('/path/to/cert', '/path/to/cert', True)
+        ])
+    def test_verify_ssl_variable_bypass(self,
+                                        mock_client_init,
+                                        get_var_mock,
+                                        mock_variables,
+                                        get_var_value,
+                                        verify_ssl_value,
+                                        path_exists_value):
+        """Test case for the RP_VERIFY_SSL bypass."""
+        get_var_mock.return_value = get_var_value
+        with mock.patch('robotframework_reportportal.variables.path.exists',
+                        return_value=path_exists_value):
+            mock_listener = listener()
+            mock_listener._variables = mock_variables
+            _ = mock_listener.service
+            assert mock_client_init.call_count == 1
+            args, kwargs = mock_client_init.call_args
+            assert kwargs['verify_ssl'] == verify_ssl_value
+
     @mock.patch(REPORT_PORTAL_SERVICE)
     def test_test_case_id(self, mock_client_init, mock_listener,
                           test_attributes):